Return Receivables Conciliation Report

Description

Returns the receivables conciliation report, allowing filtering by various parameters such as charge date, conciliation status, amounts, members, and branches.

🔑 Query Parameters

Parameter	Type	Required	Description
conciliationType	int32	Yes	Type of conciliation. E.g.: `0 - Equals`.
chargeDateStart	string	Yes	Start date of the charge (`yyyy-mm-dd`).
chargeDateEnd	string	Yes	End date of the charge (`yyyy-mm-dd`).
codErp	string	No	ERP code of the conciliator.
idsBranch	string	No	List of branch IDs separated by commas.
status	int32	No	Status of the conciliation: -1 - All 0 - Awaiting Conciliation 1 - Conciliated 2 - Manually Conciliated 3 - Justified 4 - Not Applicable 5 - Conciliated Evo `NOTE. Default value: -1 (negative)`
authorization	string	No	Authorization code of the transaction.
idMemberPayer	int32	No	ID of the member/payer of the transaction.
saleDateStart	string	No	Start date of the sale (`yyyy-mm-dd`).
saleDateEnd	string	No	End date of the sale (`yyyy-mm-dd`).
nsu	string	No	NSU (Unique Sequential Number) of the transaction.
tid	string	No	TID (Transaction Identifier) of the transaction.
amount	number	No	Amount of the transaction.
take	int32	No	Total number of records to be returned (maximum of 50). Default: `50`.
skip	int32	No	Total number of records to be ignored. Default: `0`.
orderBy	string	No	Name of the field to order the results.
orderDirection	string	No	Direction of the ordering: `"asc"` or `"desc"`.

📤 Response Structure

The response returns a list of records from the receivables conciliation report, containing information about charge, sale, payment, member payer, branch, and conciliation status.

Field	Type	Description
chargeDate	Datetime (yyyy-mm-dd)	Date and time of the charge.
idBranch	int32	Identifier of the branch.
branchName	string	Name of the branch.
codErp	string	null
idMemberPayer	int32	ID of the member/payer of the transaction.
payerName	string	Name of the payer.
saleItems	string	Description of the items/services linked to the sale.
tid	string	null
nsu	string	NSU (Unique Sequential Number) of the transaction.
authorization	string	Authorization code of the transaction.
brand	string	Card brand used in the transaction.
saleDate	Datetime (yyyy-mm-dd)	Date and time of the associated sale.
amount	number	Total amount of the transaction.
amountPaid	number	Amount effectively paid after fees/discounts.
statusEquals	int32	Status of the conciliation according to the informed type (`conciliationType`).

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

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

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Get receivables conciliation report

Return Receivables Conciliation Report

Description

🔑 Query Parameters

📤 Response Structure

Request

Request Code Samples

Responses

Get receivables conciliation report

Return Receivables Conciliation Report#

Description#

🔑 Query Parameters#

📤 Response Structure#

Request

Request Code Samples

Responses

Return Receivables Conciliation Report

Description

🔑 Query Parameters

📤 Response Structure