Moneybird logo
Moneybird API

Identities

Endpoint:https://moneybird.com/api/v2

Identities are the different profiles or trade names under which you can send documents from your administration.


Retrieve the default identity

GET
https://moneybird.com/api/v2
/{administration_id}/identities/default{format}

Returns the default identity of this administration.

Retrieve the default identitypath Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

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

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

    Default: .json

Retrieve the default identity Responses

A list of identities

  • idstring | integer · pattern: ^\d+$

    A unique record identifier

  • administration_idstring | integer · pattern: ^\d+$

    A unique record identifier of an administration

  • company_namestring | null
  • citystring | null
  • countrystring | null
  • zipcodestring | null
  • address1string | null
  • address2string | null
  • emailstring | null
  • phonestring | null
  • bank_account_namestring | null
  • bank_account_numberstring | null
  • bank_account_bicstring | null
  • custom_fieldsobject[]
  • updated_atstring · date-time
  • created_atstring · date-time
  • chamber_of_commercestring | null
  • tax_numberstring | null

Updates the default identity

PATCH
https://moneybird.com/api/v2
/{administration_id}/identities/default{format}

Updates the default identity.

Updates the default identitypath Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

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

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

    Default: .json

Updates the default identity Request Body

  • identityobject

Updates the default identity Responses

A list of identities

  • idstring | integer · pattern: ^\d+$

    A unique record identifier

  • administration_idstring | integer · pattern: ^\d+$

    A unique record identifier of an administration

  • company_namestring | null
  • citystring | null
  • countrystring | null
  • zipcodestring | null
  • address1string | null
  • address2string | null
  • emailstring | null
  • phonestring | null
  • bank_account_namestring | null
  • bank_account_numberstring | null
  • bank_account_bicstring | null
  • custom_fieldsobject[]
  • updated_atstring · date-time
  • created_atstring · date-time
  • chamber_of_commercestring | null
  • tax_numberstring | null

Retrieve identity by given id

GET
https://moneybird.com/api/v2
/{administration_id}/identities/{id}{format}

Returns the identity with the given id.

Retrieve identity by given idpath Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • idstring | integer · pattern: ^\d+$ · required

    A unique record identifier

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

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

    Default: .json

Retrieve identity by given id Responses

A identity

  • idstring | integer · pattern: ^\d+$

    A unique record identifier

  • administration_idstring | integer · pattern: ^\d+$

    A unique record identifier of an administration

  • company_namestring | null
  • citystring | null
  • countrystring | null
  • zipcodestring | null
  • address1string | null
  • address2string | null
  • emailstring | null
  • phonestring | null
  • bank_account_namestring | null
  • bank_account_numberstring | null
  • bank_account_bicstring | null
  • custom_fieldsobject[]
  • updated_atstring · date-time
  • created_atstring · date-time
  • chamber_of_commercestring | null
  • tax_numberstring | null

Deletes an identity

DELETE
https://moneybird.com/api/v2
/{administration_id}/identities/{id}{format}

Deletes an identity. Always returns a 204 status code even if the identity could not be deleted.

Deletes an identitypath Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • idstring | integer · pattern: ^\d+$ · required

    A unique record identifier

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

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

    Default: .json

Deletes an identity Responses

Identity deleted

No data returned

Updates an identity

PATCH
https://moneybird.com/api/v2
/{administration_id}/identities/{id}{format}

Updates an identity.

Updates an identitypath Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • idstring | integer · pattern: ^\d+$ · required

    A unique record identifier

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

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

    Default: .json

Updates an identity Request Body

  • identityobject

Updates an identity Responses

Identity updated

  • idstring | integer · pattern: ^\d+$

    A unique record identifier

  • administration_idstring | integer · pattern: ^\d+$

    A unique record identifier of an administration

  • company_namestring | null
  • citystring | null
  • countrystring | null
  • zipcodestring | null
  • address1string | null
  • address2string | null
  • emailstring | null
  • phonestring | null
  • bank_account_namestring | null
  • bank_account_numberstring | null
  • bank_account_bicstring | null
  • custom_fieldsobject[]
  • updated_atstring · date-time
  • created_atstring · date-time
  • chamber_of_commercestring | null
  • tax_numberstring | null

Retrieve identities

GET
https://moneybird.com/api/v2
/{administration_id}/identities{format}

An administration can have multiple identities, for example to cover multiple tradenames or offices. This does not include the default identity.

Retrieve identitiespath Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

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

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

    Default: .json

Retrieve identities Responses

A list of identities

  • idstring | integer · pattern: ^\d+$

    A unique record identifier

  • administration_idstring | integer · pattern: ^\d+$

    A unique record identifier of an administration

  • company_namestring | null
  • citystring | null
  • countrystring | null
  • zipcodestring | null
  • address1string | null
  • address2string | null
  • emailstring | null
  • phonestring | null
  • bank_account_namestring | null
  • bank_account_numberstring | null
  • bank_account_bicstring | null
  • custom_fieldsobject[]
  • updated_atstring · date-time
  • created_atstring · date-time
  • chamber_of_commercestring | null
  • tax_numberstring | null

Creates an identity

POST
https://moneybird.com/api/v2
/{administration_id}/identities{format}

Most fields for an identity are required. You can provide zero or more custom fields, for each provided custom field value the id and value are required.

Creates an identitypath Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

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

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

    Default: .json

Creates an identity Request Body

  • identityobject

Creates an identity Responses

Identity created

  • idstring | integer · pattern: ^\d+$

    A unique record identifier

  • administration_idstring | integer · pattern: ^\d+$

    A unique record identifier of an administration

  • company_namestring | null
  • citystring | null
  • countrystring | null
  • zipcodestring | null
  • address1string | null
  • address2string | null
  • emailstring | null
  • phonestring | null
  • bank_account_namestring | null
  • bank_account_numberstring | null
  • bank_account_bicstring | null
  • custom_fieldsobject[]
  • updated_atstring · date-time
  • created_atstring · date-time
  • chamber_of_commercestring | null
  • tax_numberstring | null