v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Operation routes API

List Operation Routes

Use this endpoint to retrieve the details of all the Operation Routes you have created.

get/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes

Path parameters

organization_idstring uuid required

The unique identifier of the Organization associated with the Ledger.

ledger_idstring uuid required

The unique identifier of the associated Ledger.

Query parameters

limitinteger

The maximum number of items to include in the response.

start_datestring

The beginning of the period you want to retrieve. start_date and end_date are all-or-nothing: supplying only one returns 400. If both are omitted, a default window of the last 1 month is used.

end_datestring

The end of the period you want to retrieve. start_date and end_date are all-or-nothing: supplying only one returns 400. If both are omitted, a default window of the last 1 month is used.

sort_order'asc' | 'desc'

The order used to sort the results.

cursorstring

An encoded cursor token from a previous response (next_cursor or prev_cursor) to navigate forward or backward through results.

metadata.keystring

Filter by metadata using dot-notation. Replace key with your metadata field name (e.g. metadata.costCenter=BR_11101997).

Response

Indicates that the resource was successfully created and the operation was completed as expected.

next_cursorstring

Encoded cursor pointing to the next page of results.

prev_cursorstring

Encoded cursor pointing to the previous page of results.

limitinteger

The maximum number of items included in the response.

Example response

{
  "items": [
    {
      "account": {
        "validIf": "@external/BRL"
      }
    }
  ]
}