Moneybird API

Administrations

Endpointhttps://moneybird.com/api/v2

Administrations are the top level entities in Moneybird. Use the following endpoints to get information about the administrations you have access to.

List all administrations

GET

https://moneybird.com/api/v2

/administrations{format}

Lists all administrations the current user has access to.

List all administrations › path Parameters

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 administrations › Responses

200

A list of administrations

object[]

id

string | integer · pattern: ^\d+$

A unique record identifier

name

string

language

string · enum

The ISO 639-1 language code used in the administration

Enum values:

nl-be

currency

string

The ISO 4217 currency code

country

string

The ISO 3166-1 alpha-2 code the administration country

time_zone

string

The time zone of the administration

access

string · enum

The type of acess the user has to this administration

Enum values:

accountant_company

user

suspended

boolean

period_locked_until

string | null · date

GET/administrations{format}

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

shell

Example Responses

[
  {
    "id": "176406812960185135",
    "name": "Administratie",
    "language": "nl",
    "currency": "EUR",
    "country": "NL",
    "time_zone": "Europe/Amsterdam",
    "access": "accountant_company",
    "suspended": false,
    "period_locked_until": null
  },
  {
    "id": 123,
    "name": "Parkietje B.V.",
    "language": "nl",
    "currency": "EUR",
    "country": "NL",
    "time_zone": "Europe/Amsterdam",
    "access": "user",
    "suspended": false,
    "period_locked_until": null
  }
]

json

application/json

Assets

List all administrations

GET

https://moneybird.com/api/v2

/administrations{format}

Lists all administrations the current user has access to.

List all administrations › path Parameters

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 administrations › Responses

200

A list of administrations

object[]

id

string | integer · pattern: ^\d+$

A unique record identifier

name

string

language

string · enum

The ISO 639-1 language code used in the administration

Enum values:

nl-be

currency

string

The ISO 4217 currency code

country

string

The ISO 3166-1 alpha-2 code the administration country

time_zone

string

The time zone of the administration

access

string · enum

The type of acess the user has to this administration

Enum values:

accountant_company

user

suspended

boolean

period_locked_until

string | null · date

[ { "id": "176406812960185135", "name": "Administratie", "language": "nl", "currency": "EUR", "country": "NL", "time_zone": "Europe/Amsterdam", "access": "accountant_company", "suspended": false, "period_locked_until": null }, { "id": 123, "name": "Parkietje B.V.", "language": "nl", "currency": "EUR", "country": "NL", "time_zone": "Europe/Amsterdam", "access": "user", "suspended": false, "period_locked_until": null } ]