Get Payables

Description

Retrieves a list of payables registered in the system. The endpoint allows applying various filters to refine the results based on dates, amounts, status, and banking data.

NOTE. Available for use with branch access key and also with General ADM access key.

🔑 Query Parameters

This endpoint supports optional filters through query parameters to refine the results.

Parameter	Type	Required	Description
description	string	No	Filters by the description of the account.
dateInputStart	date-time	No	Filters accounts with launch date from a date (YYYY-MM-DD).
dateInputEnd	date-time	No	Filters accounts with launch date until a date (YYYY-MM-DD).
dueDateStart	date-time	No	Filters accounts with due date from a date (YYYY-MM-DD).
dueDateEnd	date-time	No	Filters accounts with due date until a date (YYYY-MM-DD).
datePaymentStart	date-time	No	Filters accounts with payment date from a date (YYYY-MM-DD).
datePaymentEnd	date-time	No	Filters accounts with payment date until a date (YYYY-MM-DD).
compentenceStart	date-time	No	Filters accounts with competence date from a date (YYYY-MM-DD).
competenceEnd	date-time	No	Filters accounts with competence date until a date (YYYY-MM-DD).
bankAccount	string	No	Filters by associated bank accounts. Can use multiple IDs separated by commas, e.g., 2,215.
ammountStart	number	No	Filters accounts with minimum amount to pay.
ammountEnd	number	No	Filters accounts with maximum amount to pay.
accountStatus	string	No	Filters by the status of the account. Use IDs separated by commas: 1 - Open, 2 - Paid, 3 - Canceled.
take	int32	No	Total number of records to be returned. Default value: 50. Maximum allowed: 50.
skip	int32	No	Total number of records to be ignored (for pagination). Default value: 0.

📤 Response Structure

The response returns a list of registered payables, containing financial information, control dates, cost center, status, destination, bank account, and complementary data.

Field	Type	Description
`idPayable`	int32	Unique identifier of the payable.
`description`	string	Description of the payable.
`recipient`	string	Recipient of the payment.
`costCenter`	object	Cost center associated with the payable. See more below.
`inputDate`	date-time	Launch date of the payable.
`dueDate`	date-time	Due date of the payable.
`paymentDate`	date-time	Date on which the payment was made.
`competenceDate`	date-time	Accounting competence date of the payable.
`cancellationDate`	date-time	Cancellation date of the payable, if applicable.
`ammount`	number	Total amount of the payable.
`ammountPaid`	number	Amount actually paid.
`status`	object	Current status of the payable. See more below.
`destination`	object	Financial destination of the payment. See more below.
`bankAccount`	object	Bank account used for the payment. See more below.
`beneficiary`	string	Beneficiary of the payment.
`categories`	string	Category(ies) associated with the payable.
`observation`	string	Additional observations about the payable.

🧩 Structure of `costCenter` Object

Field	Type	Description
`id`	int32	Identifier of the cost center.
`name`	string	Name of the cost center.

🧩 Structure of `status` Object

Field	Type	Description
`id`	int32	Identifier of the status of the payable.
`name`	string	Name or description of the status.

🧩 Structure of `destination` Object

Field	Type	Description
`id`	int32	Identifier of the financial destination.
`name`	string	Name of the financial destination.

🧩 Structure of `bankAccount` Object

Field	Type	Description
`id`	int32	Identifier of the bank account.
`name`	string	Name or description of the bank account.

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

{
    "idPayable": 0,
    "description": "string",
    "recipient": "string",
    "costCenter": {
        "id": 0,
        "name": "string"
    },
    "inputDate": "2019-08-24T14:15:22.123Z",
    "dueDate": "2019-08-24T14:15:22.123Z",
    "paymentDate": "2019-08-24T14:15:22.123Z",
    "competenceDate": "2019-08-24T14:15:22.123Z",
    "cancellationDate": "2019-08-24T14:15:22.123Z",
    "ammount": 0,
    "ammountPaid": 0,
    "status": {
        "id": 0,
        "name": "string"
    },
    "destination": {
        "id": 0,
        "name": "string"
    },
    "bankAccount": {
        "id": 0,
        "name": "string"
    },
    "beneficiary": "string",
    "categories": "string",
    "observation": "string"
}

🟠400Bad Request

Get payables

Get Payables#

Description#

🔑 Query Parameters#

📤 Response Structure#

🧩 Structure of costCenter Object#

🧩 Structure of status Object#

🧩 Structure of destination Object#

🧩 Structure of bankAccount Object#

Request