Ledger accounts

Ledger accounts are the categories in your bookkeeping, like revenue, costs, assets, and liabilities.

Returns information about a ledger account

GET

https://moneybird.com/api/v2

/{administration_id}/ledger_accounts/{id}{format}

Returns information about a ledger account.

Returns information about a ledger account › path Parameters

administration_id

administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id

identifier · pattern: ^\d+$ · required

A unique record identifier

format

string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

Returns information about a ledger account › Responses

A ledger account

ledger_account_response

id

identifier · pattern: ^\d+$

A unique record identifier

administration_id

administration_id · pattern: ^\d+$

A unique record identifier

name

string

account_type

string · enum

Enum values:

non_current_assets

current_assets

equity

non_current_liabilities

current_liabilities

revenue

direct_costs

expenses

account_id

string | null

parent_id

identifier_nullable · pattern: ^\d+$

A unique record identifier

active

boolean

created_at

timestamp · date-time

updated_at

timestamp · date-time

allowed_document_types

string[]

Enum values:

sales_invoice

purchase_invoice

general_journal_document

financial_mutation

payment

taxonomy_item_response

financial_account_id

identifier_nullable · pattern: ^\d+$

A unique record identifier

GET/{administration_id}/ledger_accounts/{id}{format}

curl --request GET \
  --url https://moneybird.com/api/v2/:administration_id/ledger_accounts/:id:format

Example Responses

{
  "id": "458026356994737217",
  "administration_id": "458026356994737217",
  "name": "name",
  "account_type": "non_current_assets",
  "account_id": "account_id",
  "parent_id": "458026356994737217",
  "active": true,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z",
  "allowed_document_types": [
    "sales_invoice"
  ],
  "taxonomy_item": {
    "taxonomy_version": "taxonomy_version",
    "code": "code",
    "name": "name",
    "name_english": "name_english",
    "reference": "reference"
  },
  "financial_account_id": "458026356994737217"
}

json

application/json

Deletes a ledger account

DELETE

https://moneybird.com/api/v2

/{administration_id}/ledger_accounts/{id}{format}

Deletes or deactivates a ledger account. First, an attempt is made to deactivate the ledger account. If that fails, an attempt is made to delete the ledger account. Always returns a 204 status code even if the ledger account could not be deleted or deactivated.

Deletes a ledger account › path Parameters

administration_id

administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id

identifier · pattern: ^\d+$ · required

A unique record identifier

format

string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

Deletes a ledger account › Responses

Ledger account deleted

No data returned

Updates a ledger account

PATCH

https://moneybird.com/api/v2

/{administration_id}/ledger_accounts/{id}{format}

Updates a ledger account.

Updates a ledger account › path Parameters

administration_id

administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id

identifier · pattern: ^\d+$ · required

A unique record identifier

format

string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

Updates a ledger account › Request Body

object

rgs_code

string

Existing RGS version 3.5 code, e.g. 'WMfoBelMfo'

Updates a ledger account › Responses

Ledger account updated

ledger_account_response

id

identifier · pattern: ^\d+$

A unique record identifier

administration_id

administration_id · pattern: ^\d+$

A unique record identifier

name

string

account_type

string · enum

Enum values:

non_current_assets

current_assets

equity

non_current_liabilities

current_liabilities

revenue

direct_costs

expenses

account_id

string | null

parent_id

identifier_nullable · pattern: ^\d+$

A unique record identifier

active

boolean

created_at

timestamp · date-time

updated_at

timestamp · date-time

allowed_document_types

string[]

Enum values:

sales_invoice

purchase_invoice

general_journal_document

financial_mutation

payment

taxonomy_item_response

financial_account_id

identifier_nullable · pattern: ^\d+$

A unique record identifier

PATCH/{administration_id}/ledger_accounts/{id}{format}

curl --request PATCH \
  --url https://moneybird.com/api/v2/:administration_id/ledger_accounts/:id:format \
  --header 'Content-Type: application/json' \
  --data '
{
  "ledger_account": {
    "name": "name",
    "account_id": "account_id",
    "account_type": "account_type",
    "parent_id": "458026356994737217",
    "allowed_document_types": "sales_invoice",
    "description": "description"
  },
  "rgs_code": "rgs_code"
}
'

Example Request Body

{
  "ledger_account": {
    "name": "name",
    "account_id": "account_id",
    "account_type": "account_type",
    "parent_id": "458026356994737217",
    "allowed_document_types": "sales_invoice",
    "description": "description"
  },
  "rgs_code": "rgs_code"
}

json

Example Responses

{
  "id": "458026356994737217",
  "administration_id": "458026356994737217",
  "name": "name",
  "account_type": "non_current_assets",
  "account_id": "account_id",
  "parent_id": "458026356994737217",
  "active": true,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z",
  "allowed_document_types": [
    "sales_invoice"
  ],
  "taxonomy_item": {
    "taxonomy_version": "taxonomy_version",
    "code": "code",
    "name": "name",
    "name_english": "name_english",
    "reference": "reference"
  },
  "financial_account_id": "458026356994737217"
}

json

application/json

List all ledger accounts of an administration

GET

https://moneybird.com/api/v2

/{administration_id}/ledger_accounts{format}

Returns a list of all the ledger accounts in the administration.

Pagination is not supported for this endpoint.

List all ledger accounts of an administration › path Parameters

administration_id

administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

format

string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

List all ledger accounts of an administration › Responses

200

A list of ledger accounts

ledger_account_response[]

ledger_account_response

id

identifier · pattern: ^\d+$

A unique record identifier

administration_id

administration_id · pattern: ^\d+$

A unique record identifier

name

string

account_type

string · enum

Enum values:

non_current_assets

current_assets

equity

non_current_liabilities

current_liabilities

revenue

direct_costs

expenses

account_id

string | null

parent_id

identifier_nullable · pattern: ^\d+$

A unique record identifier

active

boolean

created_at

timestamp · date-time

updated_at

timestamp · date-time

allowed_document_types

string[]

Enum values:

sales_invoice

purchase_invoice

general_journal_document

financial_mutation

payment

taxonomy_item_response

financial_account_id

identifier_nullable · pattern: ^\d+$

A unique record identifier

GET/{administration_id}/ledger_accounts{format}

curl --request GET \
  --url https://moneybird.com/api/v2/:administration_id/ledger_accounts:format

Example Responses

[
  {
    "id": "458026356994737217",
    "administration_id": "458026356994737217",
    "name": "name",
    "account_type": "non_current_assets",
    "account_id": "account_id",
    "parent_id": "458026356994737217",
    "active": true,
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z",
    "allowed_document_types": [
      "sales_invoice"
    ],
    "taxonomy_item": {
      "taxonomy_version": "taxonomy_version",
      "code": "code",
      "name": "name",
      "name_english": "name_english",
      "reference": "reference"
    },
    "financial_account_id": "458026356994737217"
  }
]

json

application/json

Creates a new ledger account

POST

https://moneybird.com/api/v2

/{administration_id}/ledger_accounts{format}

The account_type determines the kind of ledger account, this can be any of the following values: non_current_assets, current_assets, equity, provisions, non_current_liabilities, current_liabilities, revenue, direct_costs, expenses, other_income_expenses

By providing the parent_id, it is possible to create a tree of ledger accounts. Make sure the account_types of the parent and child equal.

Creates a new ledger account › path Parameters

administration_id

administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

format

string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

Creates a new ledger account › Request Body

rgs_code

string · required

Existing RGS version 3.5 code, e.g. 'WMfoBelMfo'

object

Creates a new ledger account › Responses

Ledger account created

ledger_account_response

id

identifier · pattern: ^\d+$

A unique record identifier

administration_id

administration_id · pattern: ^\d+$

A unique record identifier

name

string

account_type

string · enum

Enum values:

non_current_assets

current_assets

equity

non_current_liabilities

current_liabilities

revenue

direct_costs

expenses

account_id

string | null

parent_id

identifier_nullable · pattern: ^\d+$

A unique record identifier

active

boolean

created_at

timestamp · date-time

updated_at

timestamp · date-time

allowed_document_types

string[]

Enum values:

sales_invoice

purchase_invoice

general_journal_document

financial_mutation

payment

taxonomy_item_response

financial_account_id

identifier_nullable · pattern: ^\d+$

A unique record identifier

POST/{administration_id}/ledger_accounts{format}

curl --request POST \
  --url https://moneybird.com/api/v2/:administration_id/ledger_accounts:format \
  --header 'Content-Type: application/json' \
  --data '
{
  "ledger_account": {
    "name": "name",
    "account_type": "account_type",
    "account_id": "458026356994737217",
    "parent_id": "458026356994737217",
    "allowed_document_types": "sales_invoice",
    "description": "description"
  },
  "rgs_code": "rgs_code"
}
'

Example Request Body

{
  "ledger_account": {
    "name": "name",
    "account_type": "account_type",
    "account_id": "458026356994737217",
    "parent_id": "458026356994737217",
    "allowed_document_types": "sales_invoice",
    "description": "description"
  },
  "rgs_code": "rgs_code"
}

json

Example Responses

{
  "id": "458026356994737217",
  "administration_id": "458026356994737217",
  "name": "name",
  "account_type": "non_current_assets",
  "account_id": "account_id",
  "parent_id": "458026356994737217",
  "active": true,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z",
  "allowed_document_types": [
    "sales_invoice"
  ],
  "taxonomy_item": {
    "taxonomy_version": "taxonomy_version",
    "code": "code",
    "name": "name",
    "name_english": "name_english",
    "reference": "reference"
  },
  "financial_account_id": "458026356994737217"
}

json

application/json

Identities Payments

Returns information about a ledger account

GET

https://moneybird.com/api/v2

/{administration_id}/ledger_accounts/{id}{format}

Returns information about a ledger account.

Returns information about a ledger account › path Parameters

administration_id

administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id

identifier · pattern: ^\d+$ · required

A unique record identifier

format

string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

Returns information about a ledger account › Responses

A ledger account

ledger_account_response

id

identifier · pattern: ^\d+$

A unique record identifier

administration_id

administration_id · pattern: ^\d+$

A unique record identifier

name

string

account_type

string · enum

Enum values:

non_current_assets

current_assets

equity

non_current_liabilities

current_liabilities

revenue

direct_costs

expenses

account_id

string | null

parent_id

identifier_nullable · pattern: ^\d+$

A unique record identifier

active

boolean

created_at

timestamp · date-time

updated_at

timestamp · date-time

allowed_document_types

string[]

Enum values:

sales_invoice

purchase_invoice

general_journal_document

financial_mutation

payment

taxonomy_item_response

financial_account_id

identifier_nullable · pattern: ^\d+$

A unique record identifier

Deletes a ledger account

DELETE

https://moneybird.com/api/v2

/{administration_id}/ledger_accounts/{id}{format}

Deletes a ledger account › path Parameters

administration_id

administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id

identifier · pattern: ^\d+$ · required

A unique record identifier

format

string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

Deletes a ledger account › Responses

Ledger account deleted

No data returned

Updates a ledger account

PATCH

https://moneybird.com/api/v2

/{administration_id}/ledger_accounts/{id}{format}

Updates a ledger account.

Updates a ledger account › path Parameters

administration_id

administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id

identifier · pattern: ^\d+$ · required

A unique record identifier

format

string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

Updates a ledger account › Request Body

object

rgs_code

string

Existing RGS version 3.5 code, e.g. 'WMfoBelMfo'

Updates a ledger account › Responses

Ledger account updated

ledger_account_response

id

identifier · pattern: ^\d+$

A unique record identifier

administration_id

administration_id · pattern: ^\d+$

A unique record identifier

name

string

account_type

string · enum

Enum values:

non_current_assets

current_assets

equity

non_current_liabilities

current_liabilities

revenue

direct_costs

expenses

account_id

string | null

parent_id

identifier_nullable · pattern: ^\d+$

A unique record identifier

active

boolean

created_at

timestamp · date-time

updated_at

timestamp · date-time

allowed_document_types

string[]

Enum values:

sales_invoice

purchase_invoice

general_journal_document

financial_mutation

payment

taxonomy_item_response

financial_account_id

identifier_nullable · pattern: ^\d+$

A unique record identifier

List all ledger accounts of an administration

GET

https://moneybird.com/api/v2

/{administration_id}/ledger_accounts{format}

Returns a list of all the ledger accounts in the administration.

Pagination is not supported for this endpoint.

List all ledger accounts of an administration › path Parameters

administration_id

administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

format

string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

List all ledger accounts of an administration › Responses

200

A list of ledger accounts

ledger_account_response[]

ledger_account_response

id

identifier · pattern: ^\d+$

A unique record identifier

administration_id

administration_id · pattern: ^\d+$

A unique record identifier

name

string

account_type

string · enum

Enum values:

non_current_assets

current_assets

equity

non_current_liabilities

current_liabilities

revenue

direct_costs

expenses

account_id

string | null

parent_id

identifier_nullable · pattern: ^\d+$

A unique record identifier

active

boolean

created_at

timestamp · date-time

updated_at

timestamp · date-time

allowed_document_types

string[]

Enum values:

sales_invoice

purchase_invoice

general_journal_document

financial_mutation

payment

taxonomy_item_response

financial_account_id

identifier_nullable · pattern: ^\d+$

A unique record identifier

Creates a new ledger account

POST

https://moneybird.com/api/v2

/{administration_id}/ledger_accounts{format}

By providing the parent_id, it is possible to create a tree of ledger accounts. Make sure the account_types of the parent and child equal.

Creates a new ledger account › path Parameters

administration_id

administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

format

string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

Creates a new ledger account › Request Body

rgs_code

string · required

Existing RGS version 3.5 code, e.g. 'WMfoBelMfo'

object

Creates a new ledger account › Responses

Ledger account created

ledger_account_response

id

identifier · pattern: ^\d+$

A unique record identifier

administration_id

administration_id · pattern: ^\d+$

A unique record identifier

name

string

account_type

string · enum

Enum values:

non_current_assets

current_assets

equity

non_current_liabilities

current_liabilities

revenue

direct_costs

expenses

account_id

string | null

parent_id

identifier_nullable · pattern: ^\d+$

A unique record identifier

active

boolean

created_at

timestamp · date-time

updated_at

timestamp · date-time

allowed_document_types

string[]

Enum values:

sales_invoice

purchase_invoice

general_journal_document

financial_mutation

payment

taxonomy_item_response

financial_account_id

identifier_nullable · pattern: ^\d+$

A unique record identifier