Sign in

v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Account types API

Create an Account Type

Use this endpoint to create an Account Type. You can create multiple Account Types, but they must be added one at a time.

post/v1/organizations/{organization_id}/ledgers/{ledger_id}/account-types

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

namestring required

Name of the Account Type.

descriptionstring

Description of the Account Type.

keyValuestring required

Unique identifier for the Account Type being created. Important: If the Account Types feature is enabled, this value becomes mandatory when creating accounts — only previously registered keyValues will be accepted in the type field of the Accounts API. Accepted characters: alphanumeric (uppercase and lowercase), dashes (-), and underscores (_).

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 Account Type.

organizationIdstring uuid

The unique identifier of the Organization.

ledgerIdstring uuid

The unique identifier of the Ledger.

namestring

Name of the Account Type.

descriptionstring

Description of the Account Type.

keyValuestring

Unique identifier for the Account Type created.

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.