Consulta Pagamento

Essa consulta retorna os detalhes de documentos de arrecadação pagos.

PedidoDados

idSistema: PAGTOWEB
idServico: PAGAMENTOS71
versaoSistema: "1.0"

Dados de Entrada

Objeto IntervaloData:

Campo	Descrição	Tipo	Obrigatório
dataInicial	Formato AAAA-MM-DD	Data	NÃO
dataFinal	Formato AAAA-MM-DD	Data	NÃO

Objeto IntervaloValor:

Campo	Descrição	Tipo	Obrigatório
valorInicial		BigDecimal	NÃO
valorFinal		BigDecimal	NÃO

Objeto ParametroEmissaoComprovanteIC:

Campo	Descrição	Tipo	Obrigatório
numeroDocumento	Até 17 posições	String	NÃO

Objeto ParametroConsultaDocumentoIC:

Campo	Descrição	Tipo	Obrigatório
numeroDocumentoLista	Lista com números de documentos, cada número tem até 17 posições.	Lista<String>	NÃO
codigoReceitaLista	Lista com códigos de receita. Tamanho máx. do código: 4.	Lista<String>	NÃO
intervaloDataArrecadacao	Intervalo de data de arrecadação a ser pesquisado. A data de arrecadação é a data contábil da efetivação do pagamento.	IntervaloData	NÃO
intervaloValorTotalDocumento	Intervalo de valor total a ser pesquisado.	IntervaloValor	NÃO
codigoTipoDocumentoLista	Tipos de documento que serão retornados. Numérico. Tamanho máx. do código: 2	Lista<String>	NÃO
tamanhoDaPagina	Tamanho máx.: 100	Number	SIM
primeiroDaPagina	Começa em 0	Number	SIM

Exemplo: conteúdo body json de entrada

Quando pesquisado por intervaloDataArrecadacao

    {
        "contratante": {
            "numero": "99999999999",
            "tipo": 1
        },
        "autorPedidoDados": {
            "numero": "99999999999",
            "tipo": 1
        },
        "contribuinte": {
            "numero": "99999999999",
            "tipo": 1
        },
        "pedidoDados": {
            "idSistema": "PAGTOWEB",
            "idServico": "PAGAMENTOS71",
            "dados": "{ \"intervaloDataArrecadacao\": {\"dataInicial\": \"2019-09-01\", \"dataFinal\": \"2019-11-30\"}, \"primeiroDaPagina\": 0,\"tamanhoDaPagina\": 100}"
        }
    }

Quando pesquisado por codigoReceitaLista:

    {
        "contratante": {
            "numero": "99999999999999",
            "tipo": 2
        },
        "autorPedidoDados": {
            "numero": "99999999999999",
            "tipo": 2
        },
        "contribuinte": {
            "numero": "99999999999999",
            "tipo": 2
        },
        "pedidoDados": {
            "idSistema": "PAGTOWEB",
            "idServico": "PAGAMENTOS71",
            "dados": "{\"codigoReceitaLista\": [\"9999\", \"9999\"], \"primeiroDaPagina\": 0,\"tamanhoDaPagina\": 100}"
        }
    }

Quando pesquisado por intervaloValorTotalDocumento:

    {
        "contratante": {
            "numero": "99999999999999",
            "tipo": 2
        },
        "autorPedidoDados": {
            "numero": "99999999999999",
            "tipo": 2
        },
        "contribuinte": {
            "numero": "99999999999999",
            "tipo": 2
        },
        "pedidoDados": {
            "idSistema": "PAGTOWEB",
            "idServico": "PAGAMENTOS71",
            "dados": "{ \"intervaloDataArrecadacao\": {\"dataInicial\": \"2022-01-01\", \"dataFinal\": \"2022-01-31\"}, \"intervaloValorTotalDocumento\": {\"valorInicial\": 6000,\"valorFinal\": 13000}, \"primeiroDaPagina\": 0,\"tamanhoDaPagina\": 100}"
        }
    }

Os parâmetros de consulta, podem ser combinados. A consulta sempre retorna documentos do contribuinte informado em "contribuinte".

Dados de Saída

Campo	Descrição	Tipo
status	Status HTTP retornado no acionamento do serviço.	Number(3)
mensagens	Mensagem explicativa retornada no acionamento do serviço. É um array composto de Código e texto da mensagem. O campo Código é uma string de tamanho 5 que representa um código interno do negócio.	Array of String
dados	Estrutura de dados de retorno.	String (SCAPED STRING JSON: DocumentoArrecadacaoIC)

Objeto: ExtensaoReceita

Campo	Descrição	Tipo
codigo	Código da extensão de receita	String
descricao	Descrição da extensão de receita	String

Objeto: Receita

Campo	Descrição	Tipo
codigo	Código da receita	String
descricao	Descrição da receita	String
extensaoReceita	Extensão da receita	ExtensaoReceita

Objeto: TipoDocumento

Campo	Descrição	Tipo
codigo	Código do tipo de documento	String
descricao	Descrição do tipo de documento	String
descricaoAbreviada	Descrição abreviada do tipo de documento	String

Objeto: DesmembramentoIC

Campo	Descrição	Tipo
sequencial	Sequencial do desmembramento	String
receitaPrincipal	Receita principal	Receita
periodoApuracao	Período de apuração do débito/tributo do desmembramento (Formato: AAAA-MM-DDTHH:MI:SSZ Exemplo: 2019-01-01T00:00:00-03:00)	Data
dataVencimento	Período de vencimento do desmembramento (Formato: AAAA-MM-DDTHH:MI:SSZ Exemplo: 2019-01-01T00:00:00-03:00)	Data
valorTotal	Valor total do desmembramento	BigDecimal
valorPrincipal	Valor principal do desmembramento	BigDecimal
valorMulta	Valor multa do desmembramento	BigDecimal
valorJuros	Valor juros do desmembramento	BigDecimal
valorSaldoTotal	Saldo total do desmembramento	BigDecimal
valorSaldoPrincipal	Saldo principal do desmembramento	BigDecimal
valorSaldoMulta	Saldo multa do desmembramento	BigDecimal
valorSaldoJuros	Saldo juros do desmembramento	BigDecimal

Objeto: DocumentoArrecadacaoIC

Campo	Descrição	Tipo
numeroDocumento	Número do documento de arrecadação	String
tipo	Tipo do documento de arrecadação	TipoDocumento
periodoApuracao	Período de apuração do débito/tributo do pagamento (Formato: AAAA-MM-DDTHH:MI:SSZ Exemplo: 2019-01-01T00:00:00-03:00)	Data
dataArrecadacao	Data contábil da efetivação do pagamento (Formato: AAAA-MM-DDTHH:MI:SSZ Exemplo: 2019-01-01T00:00:00-03:00)	Data
dataVencimento	Data de vencimento do pagamento (Formato: AAAA-MM-DDTHH:MI:SSZ Exemplo: 2019-01-01T00:00:00-03:00)	Data
receitaPrincipal	Receita principal do pagamento	Receita
referencia	Número de referência do pagamento	String
valorTotal	Valor total do pagamento	BigDecimal
valorPrincipal	Valor principal do pagamento	BigDecimal
valorMulta	Valor multa do pagamento	BigDecimal
valorJuros	Valor juros do pagamento	BigDecimal
valorSaldoTotal	Saldo total do pagamento	BigDecimal
valorSaldoPrincipal	Saldo principal do pagamento	BigDecimal
valorSaldoMulta	Saldo multa do pagamento	BigDecimal
valorSaldoJuros	Saldo juros do pagamento	BigDecimal
desmembramentos	Desmembramentos	Lista<DesmembramentoIC>

Exemplo: conteúdo payload json de saída

Json de exemplo: Consulta Pagamento