Get Debt History

Description

Returns a list of debts and their respective current statuses, similar to the Collections - Default report. It allows filtering by due dates, registration dates, payment dates, specific members, branch, member status, and debt status. The results can be paginated and accompanied by a financial summary with totals and averages.

🔑 Query Parameters

Parameter	Type	Required	Description
dueDateStart	string (date-time)	No	Filter by due date starting from an initial date (`format yyyy-mm-dd`).
dueDateEnd	string (date-time)	No	Filter by due date up to a final date (`format yyyy-mm-dd`).
registrationDateStart	string (date-time)	No	Filter by registration date starting from an initial date (`format yyyy-mm-dd`).
registrationDateEnd	string (date-time)	No	Filter by registration date up to a final date (`format yyyy-mm-dd`).
paymentDateStart	string (date-time)	No	Filter by payment date starting from an initial date (`format yyyy-mm-dd`).
paymentDateEnd	string (date-time)	No	Filter by payment date up to a final date (`format yyyy-mm-dd`).
membersIds	string	No	List of member IDs separated by commas.
take	int32	No	Number of records to be returned (maximum 50). Default: 50.
skip	int32	No	Number of records to be skipped in the listing (pagination). Default: 0.
idBranch	int32	No	Filter by branch ID (only for use with multi-branch keys and when membersIds is not empty).
memberStatus	string	No	Filter by member status. Possible values: `1` = Active, `2` = Inactive. Multiple values can be provided separated by commas (e.g., `1,2`).
debtStatus	string	No	Filter by debt status. Possible values: `1` = Open, `2` = Recovered, `3` = Canceled. Multiple values can be provided separated by commas (e.g., `1,2`).

📤 Response Structure

The response returns a paginated list of debts with member information, amounts, dates, and statuses, along with a summary of totals and averages.

Field	Type	Description
results	array<object>	List of debts found.
total	int32	Total number of records found.
summary	object	Summary with total values and averages of charges.

🧩 Structure of the `results` Object

Field	Type	Description
memberId	int32	ID of the member associated with the debt.
name	string	Name of the member.
memberStatus	string	Member status (Active/Inactive).
receivableId	int32	ID of the receivable.
receivableIdOrigin	int32	Origin ID of the receivable.
branchId	int32	ID of the branch associated with the debt.
branchName	string	Name of the branch associated with the debt.
dueDate	string (date-time)	Due date of the debt.
paymentDate	string (date-time)	Payment date of the debt (if any).
registerDate	string (date-time)	Registration date of the debt.
originalDueDate	string (date-time)	Original due date of the debt.
chargeDate	string (date-time)	Charge date.
daysLate	int32	Number of days overdue.
debtAmount	number	Amount of the debt.
paymentType	string	Type of payment used (e.g., card, boleto).
idPaymentType	int32	ID of the payment type.
debtStatus	string	Status of the debt (Open, Recovered, Canceled).
checkoutLink	string	Partial payment link for the debt.
checkoutLinkFullDebt	string	Full payment link for the total debt.
paymentOrigin	string	Origin of the payment.
idMemberMembership	int32	Identifier of the member's contract.
chargeAttemptsCount	int32	Count of charge attempts.
lastAcquirerDeclineReason	string	Last reason for the acquirer's decline.

🧩 Structure of the `summary` Object

Field	Type	Description
recoveredValue	number	Total recovered amount.
recoveryAverage	number	Average amount recovered per charge.
pendingValue	number	Total pending amount.
pendingAverage	number	Average pending amount per charge.

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

Responses

🟢200OK

application/json

Success

Body

Example

{
    "results": [
        {
            "memberId": 0,
            "name": "string",
            "memberStatus": "string",
            "receivableId": 0,
            "receivableIdOrigin": 0,
            "branchId": 0,
            "branchName": "string",
            "dueDate": "2019-08-24T14:15:22.123Z",
            "paymentDate": "2019-08-24T14:15:22.123Z",
            "registerDate": "2019-08-24T14:15:22.123Z",
            "originalDueDate": "2019-08-24T14:15:22.123Z",
            "chargeDate": "2019-08-24T14:15:22.123Z",
            "daysLate": 0,
            "debtAmount": 0,
            "paymentType": "string",
            "idPaymentType": 0,
            "debtStatus": "string",
            "checkoutLink": "string",
            "checkoutLinkFullDebt": "string",
            "paymentOrigin": "string",
            "idMemberMembership": 0,
            "chargeAttemptsCount": 0,
            "lastAcquirerDeclineReason": "string"
        }
    ],
    "total": 0,
    "summary": {
        "recoveredValue": 0,
        "recoveryAverage": 0,
        "pendingValue": 0,
        "pendingAverage": 0
    }
}

🟠400Bad Request

Gets a list of debts and current status (Similar to the Collections - Default report)

Get Debt History#

Description#

🔑 Query Parameters#

📤 Response Structure#

🧩 Structure of the results Object#

🧩 Structure of the summary Object#

Request