Retornar Relatório de Conciliação de Recebíveis

Descrição

Retorna o relatório de conciliação de recebíveis, permitindo filtrar por diversos parâmetros como data de cobrança, status da conciliação, valores, membros e filiais.

🔑 Parâmetros de Consulta (Query Params)

Parâmetro	Tipo	Obrigatório	Descrição
conciliationType	int32	Sim	Tipo de conciliação. Ex.: `0 - Equals`.
chargeDateStart	string	Sim	Data inicial da cobrança (`yyyy-mm-dd`).
chargeDateEnd	string	Sim	Data final da cobrança (`yyyy-mm-dd`).
codErp	string	Não	Código ERP do conciliador.
idsBranch	string	Não	Lista de IDs de filiais separados por vírgula.
status	int32	Não	Status da conciliação: -1 - Todos 0 - Aguardando Conciliação 1 - Conciliado 2 - Conciliado Manualmente 3 - Justificado 4 - Não Aplicável 5 - Conciliado Evo `OBS. Valor padrão: -1 (negativo)`
authorization	string	Não	Código de autorização da transação.
idMemberPayer	int32	Não	ID do membro/pagador da transação.
saleDateStart	string	Não	Data inicial da venda (`yyyy-mm-dd`).
saleDateEnd	string	Não	Data final da venda (`yyyy-mm-dd`).
nsu	string	Não	NSU (Número Sequencial Único) da transação.
tid	string	Não	TID (Transaction Identifier) da transação.
amount	number	Não	Valor da transação.
take	int32	Não	Total de registros a serem retornados (máximo de 50). Default: `50`.
skip	int32	Não	Total de registros a serem ignorados. Default: `0`.
orderBy	string	Não	Nome do campo para ordenar os resultados.
orderDirection	string	Não	Direção da ordenação: `"asc"` ou `"desc"`.

📤 Estrutura da Resposta

A resposta retorna uma lista de registros do relatório de conciliação de recebíveis, contendo informações de cobrança, venda, pagamento, membro pagador, filial e status da conciliação.

Campo	Tipo	Descrição
chargeDate	Datetime (yyyy-mm-dd)	Data e hora da cobrança.
idBranch	int32	Identificador da filial.
branchName	string	Nome da filial.
codErp	string	null
idMemberPayer	int32	ID do membro/pagador da transação.
payerName	string	Nome do pagador.
saleItens	string	Descrição dos itens/serviços vinculados à venda.
tid	string	null
nsu	string	NSU (Número Sequencial Único) da transação.
authorization	string	Código de autorização da transação.
brand	string	Bandeira do cartão utilizado na transação.
saleDate	Datetime (yyyy-mm-dd)	Data e hora da venda associada.
amount	number	Valor total da transação.
amountPaid	number	Valor efetivamente pago após taxas/descontos.
statusEquals	int32	Status da conciliação conforme tipo informado (`conciliationType`).

Basic Auth

Envie suas requisições HTTP com um cabeçalho

Authorization

que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password

Exemplo:

Authorization: Basic *****************

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Get receivables conciliation report

Retornar Relatório de Conciliação de Recebíveis

Descrição

🔑 Parâmetros de Consulta (Query Params)

📤 Estrutura da Resposta

Requisição

Exemplos de Requisição

Respostas

Get receivables conciliation report

Retornar Relatório de Conciliação de Recebíveis#

Descrição#

🔑 Parâmetros de Consulta (Query Params)#

📤 Estrutura da Resposta#

Requisição

Exemplos de Requisição

Respostas

Retornar Relatório de Conciliação de Recebíveis

Descrição

🔑 Parâmetros de Consulta (Query Params)

📤 Estrutura da Resposta