POST
/
v1
/
organizations
/
{organization_id}
/
ledgers
/
{ledger_id}
/
account-types
Create an Account Type
curl --request POST \
  --url https://onboarding.sandbox.midaz.io/v1/organizations/{organization_id}/ledgers/{ledger_id}/account-types \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Cash Account",
  "description": "Account type for liquid assets held in cash or cash equivalents.",
  "keyValue": "CASH",
  "metadata": {
    "customField": "customValue"
  }
}'
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "keyValue": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "metadata": {}
}

Path Parameters

​
organization_id
string
required

The unique identifier of the Organization associated with the Ledger.

​
ledger_id
string
required

The unique identifier of the associated Ledger.

Body

application/json
​
name
string
required

Name of the Account Type.

​
keyValue
string
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: lowercase alphanumeric, dashes (-), and underscores (_).

​
description
string

Description of the Account Type.

​
metadata
object

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'.

Response

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

​
id
string<uui>

The unique identifier of the Account Type.

​
name
string

Name of the Account Type.

​
description
string

Dscription of the Account Type.

​
keyValue
string

Unique identifier for the Account Type created.

​
createdAt
string<date-time>

Timestamp of creation (UTC).

​
updatedAt
string<date-time>

Timestamp of last update (UTC).

​
deletedAt
string<date-time> | null

Timestamp of soft deletion, if applicable (UTC).

​
metadata
object

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'.