Sign in

v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Operation routes API

Create an Operation Route

Use this endpoint to create an Operation Route.

post/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.

Headers

Content-Typestring

The type of media of the resource. Recommended value is application/json.

X-Request-Idstring uuid

A unique identifier used to trace and track each request.

Authorizationstring

Bearer JWT token for authentication. Required when PLUGIN_AUTH_ENABLED=true (enforced in multi-tenant deployments). Optional in default OSS single-tenant mode. Format: Bearer <token>

Request body

codestring

An external reference used to identify the operation route. Deprecated: use rubric codes inside accountingEntries instead.

titlestring required

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

descriptionstring

Detailed description of the Operation Route purpose and usage.

operationType'source' | 'destination' | 'bidirectional' required

The type of the Operation Route. Use bidirectional when the route can operate in both directions.

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 request

{
  "account": {
    "validIf": "@external/BRL"
  }
}

Response

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

idstring uuid

The unique identifier of the Operation 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 operation. Used as an entry note for identification.

codestring

An external reference used to identify the operation route. Deprecated: use rubric codes inside accountingEntries instead.

descriptionstring

Detailed description of the Operation Route purpose and usage.

operationType'source' | 'destination' | 'bidirectional'

The type of the Operation Route. Use bidirectional when the route can operate in both directions.

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

{
  "account": {
    "validIf": "@external/BRL"
  }
}