Sign in

v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Transaction routes API

Create a Transaction Route

Use this endpoint to create an Transaction Route.

post/v1/organizations/{organization_id}/ledgers/{ledger_id}/transaction-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.

Request body

titlestring required

Short text summarizing the purpose of the transaction. Used as an entry note for identification.

descriptionstring

A description for the Transaction Route.

operationRoutesstring[] required

A list of Operation Route IDs that define the source and destination logic for the transaction. Important: A transaction route must include at least one operation route with type "source" and at least one with type "destination".

metadataMetadata

An object containing key-value pairs to add as metadata, where the field name is the key and the field value is the value. For example, to add a Cost Center, use 'costCenter': 'BR_11101997'.

Constraints: keys must be at most 100 characters; string values at most 2000 characters. Nested objects are not allowed (values must be string, number, or boolean), the structure may not exceed a maximum depth of 10, and a maximum of 100 keys is permitted.

Response

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

idstring uuid

The unique identifier of the Transaction Route.

organizationIdstring uuid

The unique identifier of the Organization.

ledgerIdstring uuid

The unique identifier of the Ledger.

titlestring

Short text summarizing the purpose of the transaction. Used as an entry note for identification.

descriptionstring

A description for the Transaction Route.

createdAtstring date-time

Timestamp of creation (UTC).

updatedAtstring date-time

Timestamp of last update (UTC).

deletedAtstring date-time nullable

Timestamp of soft deletion, if applicable (UTC).

metadataMetadata

An object containing key-value pairs to add as metadata, where the field name is the key and the field value is the value. For example, to add a Cost Center, use 'costCenter': 'BR_11101997'.

Constraints: keys must be at most 100 characters; string values at most 2000 characters. Nested objects are not allowed (values must be string, number, or boolean), the structure may not exceed a maximum depth of 10, and a maximum of 100 keys is permitted.

Example response

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