Consulta de pagamento originado por lançamentos de terceiros

Liberação dos serviços

Para que a liberação dos serviços seja efetivada, entre em contato com o gestor do setor de marketing a fim de que seja realizada as tratativas de acordo de parceria.

Detalhamento dos recursos

Parâmetro obrigatório para o serviço de consulta de lançamentos

Campo	Descrição	Observação
sistemaOrigem	Sistema de origem do lançamento	Este campo deverá ser informação obrigatória para efetuar a consultas com os filtros abaixo

Filtros para o serviço de consulta de pagamentos originados por terceiros

Campo	Tipo	Exemplo de uso
idPagamento	Inteiro	idPagamento - 12345
tipoBaixa	Constante [AUTOMATICA,MANUAL,COMPENSACAO]	tipoBaixa - "AUTOMATICA"
dataPagamento	Data	dataPagamento = 2023-08-04
dataCredito	Data
dataBaixa	Data
tipoPagamento	Constante [SEM_PARCELA,NORMAL,INDEVIDO,PAGOS,PARCELADO,CANCELADA,ELIMINADA,SUSPENSA,REMIDA,ISENTO,INSCRITA]
dataHoraEstorno	Data-Hora	Data_hora (ex.: '2023-08-07 09:51:06.328')
idDebito	Inteiro
processo	Texto
idReferente	Inteiro
codigoReferente	Inteiro
tipoReferente	Constante [CONTRIBUINTE,ECONOMICOS,RECEITAS_DIVERSAS]
numeroParcela	Inteiro
numeroBaixa	Inteiro
ano	Inteiro
dataVencimento	Data
dataLancamento	Data
complementar	Constante [SIM,NÃO]
convenio.id	Inteiro
convenio.nroConvenio	Texto
convenio.banco.id	Inteiro
convenio.banco.numero	Texto
convenio.banco.sigla	Texto
receita.id	Inteiro
receita.abreviatura	Texto
receita.descricao	Texto
receita.classificacao	Constante [IMPOSTO,TAXA]
contribuinte.id	Inteiro
contribuinte.nome	Texto
contribuinte.cpfCnpj	Texto
creditoTributario.id	Inteiro
creditoTributario.abreviatura	Texto

Importante

No retorno dos pagamentos podemos ter mais de um registro para o mesmo pagamento, pois o retorno é por receita de débito pago, ou seja, para cada receita que existir para o débito, terá um retorno do pagamento.

Documentação dos serviços