Conta Consulta Pagamento

Essa consulta retorna um quantitativo de documentos de arrecadação pagos.

PedidoDados

idSistema: PAGTOWEB
idServico: CONTACONSDOCARRPG73
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 ParametroContaConsultaDocumentoIC:

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

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": "CONTACONSDOCARRPG73",
            "dados": "{ \"intervaloDataArrecadacao\": {\"dataInicial\": \"2019-09-01\", \"dataFinal\": \"2019-11-30\"}}"
        }
    }

Quando pesquisado por codigoReceitaLista:

    {
        "contratante": {
            "numero": "99999999999999",
            "tipo": 2
        },
        "autorPedidoDados": {
            "numero": "99999999999999",
            "tipo": 2
        },
        "contribuinte": {
            "numero": "99999999999999",
            "tipo": 2
        },
        "pedidoDados": {
            "idSistema": "PAGTOWEB",
            "idServico": "CONTACONSDOCARRPG73",
            "dados": "{\"codigoReceitaLista\": [\"9999\", \"9999\"]}"
        }
    }

Quando pesquisado por intervaloValorTotalDocumento:

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

Os parâmetros de consulta, podem ser combinados. A consulta sempre retorna quantidade de 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

Exemplo: conteúdo payload json de saída

Json de exemplo: Conta Consulta Pagamento