Identities

Show examples in: cURL Ruby

Retrieve the default identity

Returns the default identity of this administration.

Example: returns the default identity

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/identities/default.json

Response

Status: 200 OK
{
  "id": "171195703361537146",
  "administration_id": 123,
  "company_name": "Parkietje B.V.",
  "city": "Enschede",
  "country": "NL",
  "zipcode": "7523XD",
  "address1": "Brouwerijstraat 26",
  "address2": null,
  "email": "info@moneybird.com",
  "phone": "0612345678",
  "bank_account_name": null,
  "bank_account_number": "NL51RABO0330707736",
  "bank_account_bic": null,
  "custom_fields": [

  ],
  "updated_at": "2016-10-26T12:29:27.752Z",
  "created_at": "2016-10-26T12:29:27.078Z"
}

Updates the default identity

Parameters

Parameter Type Description
identity[company_name] String
identity[country] String

ISO two-character country code, e.g. NL or DE.

identity[city] String
identity[zipcode] String
identity[address1] String
identity[address2] String
identity[email] String

Should be a valid email addresses.

identity[phone] String
identity[bank_account_name] String
identity[bank_account_number] String
identity[bank_account_bic] String
identity[chamber_of_commerce] String
identity[tax_number] String
identity[custom_fields_attributes][*][id] Integer

Should be a valid custom field id.

identity[custom_fields_attributes][*][value] String

Example: updates the default identity

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPATCH \
  -d '{"identity":{"company_name":"Second B.V."}}' \
  https://moneybird.com/api/v2/123/identities/default.json

Response

Status: 200 OK
{
  "id": "171195703361537146",
  "administration_id": 123,
  "company_name": "Second B.V.",
  "city": "Enschede",
  "country": "NL",
  "zipcode": "7523XD",
  "address1": "Brouwerijstraat 26",
  "address2": null,
  "email": "info@moneybird.com",
  "phone": "0612345678",
  "bank_account_name": null,
  "bank_account_number": "NL51RABO0330707736",
  "bank_account_bic": null,
  "custom_fields": [

  ],
  "updated_at": "2016-10-26T12:36:44.814Z",
  "created_at": "2016-10-26T12:29:27.078Z"
}

Retrieve identities

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

Example: returns all identities of an administration

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/identities.json

Response

Status: 200 OK
[
  {
    "id": "171196166748242947",
    "administration_id": 123,
    "company_name": "Parkietje B.V.",
    "city": "Den Haag",
    "country": "NL",
    "zipcode": "4321XY",
    "address1": "Brouwersplein 62",
    "address2": null,
    "email": "service@example.com",
    "phone": "1234-5678900",
    "bank_account_name": "Foobar B.V.",
    "bank_account_number": "NL80TEST0252789466",
    "bank_account_bic": null,
    "custom_fields": [

    ],
    "updated_at": "2016-10-26T12:36:48.987Z",
    "created_at": "2016-10-26T12:36:48.987Z"
  }
]

Retrieve identity by given id

Example: returns a single identity

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/identities/171196171306402819.json

Response

Status: 200 OK
{
  "id": "171196171306402819",
  "administration_id": 123,
  "company_name": "Parkietje B.V.",
  "city": "Den Haag",
  "country": "NL",
  "zipcode": "4321XY",
  "address1": "Brouwersplein 62",
  "address2": null,
  "email": "service@example.com",
  "phone": "1234-5678900",
  "bank_account_name": "Foobar B.V.",
  "bank_account_number": "NL80TEST0252789466",
  "bank_account_bic": null,
  "custom_fields": [

  ],
  "updated_at": "2016-10-26T12:36:53.335Z",
  "created_at": "2016-10-26T12:36:53.335Z"
}

Example: returns 404 when identity does not exist

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/identities/34123123.json

Response

Status: 404 Not Found
{
  "error": "record not found",
  "symbolic": {
    "id": "not_found"
  }
}

Creates an identity

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.

Parameters

Parameter Type Description
identity[company_name] String

Required

identity[country] String

Required

ISO two-character country code, e.g. NL or DE.

identity[city] String

Required

identity[zipcode] String

Required

identity[address1] String

Required

identity[address2] String
identity[email] String

Should be a valid email addresses.

identity[phone] String
identity[bank_account_name] String
identity[bank_account_number] String
identity[bank_account_bic] String
identity[custom_fields_attributes][*][id] Integer

Should be a valid custom field id.

identity[custom_fields_attributes][*][value] String

Example: creates an identity

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPOST \
  -d '{"identity":{"company_name":"Foobar B.V.","address1":"Straat 1","zipcode":"Zipcode","city":"Enschede","country":"NL","email":"foobar@example.com"}}' \
  https://moneybird.com/api/v2/123/identities.json

Response

Status: 201 Created
{
  "id": "171196183625073673",
  "administration_id": 123,
  "company_name": "Foobar B.V.",
  "city": "Enschede",
  "country": "NL",
  "zipcode": "Zipcode",
  "address1": "Straat 1",
  "address2": null,
  "email": "foobar@example.com",
  "phone": null,
  "bank_account_name": null,
  "bank_account_number": null,
  "bank_account_bic": null,
  "custom_fields": [

  ],
  "updated_at": "2016-10-26T12:37:05.083Z",
  "created_at": "2016-10-26T12:37:05.083Z"
}

Example: creates an identity with custom fields

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPOST \
  -d '{"identity":{"company_name":"Foobar B.V.","address1":"Straat 1","zipcode":"Zipcode","city":"Enschede","country":"NL","email":"foobar@example.com","custom_fields_attributes":{"0":{"id":171196189152117767,"value":"my custom value"}}}}' \
  https://moneybird.com/api/v2/123/identities.json

Response

Status: 201 Created
{
  "id": "171196189185672201",
  "administration_id": 123,
  "company_name": "Foobar B.V.",
  "city": "Enschede",
  "country": "NL",
  "zipcode": "Zipcode",
  "address1": "Straat 1",
  "address2": null,
  "email": "foobar@example.com",
  "phone": null,
  "bank_account_name": null,
  "bank_account_number": null,
  "bank_account_bic": null,
  "custom_fields": [
    {
      "id": "171196189152117767",
      "name": "custom_field_6647",
      "value": "my custom value"
    }
  ],
  "updated_at": "2016-10-26T12:37:10.385Z",
  "created_at": "2016-10-26T12:37:10.385Z"
}

Updates an identity

Parameters

Parameter Type Description
identity[company_name] String
identity[country] String

ISO two-character country code, e.g. NL or DE.

identity[city] String
identity[zipcode] String
identity[address1] String
identity[address2] String
identity[email] String

Should be a valid email addresses.

identity[phone] String
identity[bank_account_name] String
identity[bank_account_number] String
identity[bank_account_bic] String
identity[custom_fields_attributes][*][id] Integer

Should be a valid custom field id.

identity[custom_fields_attributes][*][value] String

Example: updates a identity

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPATCH \
  -d '{"identity":{"company_name":"Second B.V."}}' \
  https://moneybird.com/api/v2/123/identities/171196193748026371.json

Response

Status: 200 OK
{
  "id": "171196193748026371",
  "administration_id": 123,
  "company_name": "Second B.V.",
  "city": "Den Haag",
  "country": "NL",
  "zipcode": "4321XY",
  "address1": "Brouwersplein 62",
  "address2": null,
  "email": "service@example.com",
  "phone": "1234-5678900",
  "bank_account_name": "Foobar B.V.",
  "bank_account_number": "NL80TEST0252789466",
  "bank_account_bic": null,
  "custom_fields": [

  ],
  "updated_at": "2016-10-26T12:37:14.802Z",
  "created_at": "2016-10-26T12:37:14.737Z"
}

Deletes an identity

Example: deletes the identity

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XDELETE \
  https://moneybird.com/api/v2/123/identities/171196198486541315.json

Response

Status: 204 No Content

Example: cannot delete the default identity

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XDELETE \
  https://moneybird.com/api/v2/123/identities/171195703361537146.json

Response

Status: 404 Not Found
{
  "error": "record not found",
  "symbolic": {
    "id": "not_found"
  }
}

Top