Balance Statements Query

The balance statement can be queried using the GET /balance/{id}/journal method. The user will provide the desired period and pagination for the statement.

The default fields returned in the balance statement are:

Field	Description
id	The unique identifier of a journal entry record
type	The type of record indicating whether it is a debit or credit
transaction_id	Transaction identifier
transaction_type	User transaction type
entry_id	Entry identifier
entry_type	Entry name
entry_order	Entry creation order
amount	Entry amount
balance_after	Balance amount after the record creation
balance_seq_num	Sequential update number of the current balance
created_at	Transaction created datetime
settled_at	Transaction reference date (or accounting date)
parent_transaction_id	Parent Transaction Identifier
external_id	The user-assigned identifier at the time of transaction creation

Statement query example:

GET /balance/19720852-be40-489a-a3b3-985f51a0458c/journal

{
  "date_from": "",
  "date_to": "",
  "limit": 100,
  "cursor": 0
}

Response example:

{
  "metadata": {
    "limit": 100,
    "count": 10,
    "current_cursor": 0,
    "next_cursor": 1
  },
  "data": [
    {
      "id": "912ec803-b2ce-49e4-a541-068d495ab570",
      "type": "credit",
      "transaction_id": "c18be87a-c2db-a527-a47f-63d6105e89e2",
      "transaction_type": "pix_in",
      "entry_id": "82ce4744-f647-f1a5-a320-619d9c85d719",
      "entry_type": "main_amount",
      "entry_order": 1,
      "amount": 10000,
      "balance_after": 10000,
      "balance_seq_num": 1,
      "created_at": "2023-06-05T11:26:17.325Z",
      "settled_at": "2023-06-05",
      "parent_transaction_id": "ea355ff5-6a2e-a57e-708c-7ab94e79c7f6",
      "external_id": "teste 1",
      "metadata": {
        "key": "value"  
      }
    }
  ]
}