Identities

Retrieve the default identity

GET /identities/default(.:format)

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": "416087461234476933",
  "administration_id": 123,
  "company_name": "Parkietje B.V.",
  "city": "Enschede",
  "country": "NL",
  "zipcode": "7523XD",
  "address1": "Brouwerijstraat 26",
  "address2": null,
  "email": "info@dev.null.moneybird.net",
  "phone": "0612345678",
  "bank_account_name": null,
  "bank_account_number": "NL50TEST0166567191",
  "bank_account_bic": null,
  "custom_fields": [

  ],
  "updated_at": "2024-03-21T14:39:07.256Z",
  "created_at": "2024-03-21T14:39:06.875Z",
  "chamber_of_commerce": "08155914",
  "tax_number": "NL817575546B01"
}

Updates the default identity

PATCH /identities/default(.:format)

Parameters

Parameter	Type	Description
`identity[company_name]`	`String`
`identity[legal_entity_type]`	`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[tax_number_absence_reason]`	`String`	Can be `below_tax_threshold` or `industry_exemption`.
`identity[custom_fields_attributes][id]`	`Integer`	Required
`identity[custom_fields_attributes][value]`	`String`	Required
`identity[administration_attributes][adyen_processed_funds]`	`Boolean`
`identity[administration_attributes][company_activities_description]`	`String`
`identity[administration_attributes][company_website_url]`	`String`
`identity[administration_attributes][company_website_absent]`	`String`
`identity[administration_attributes][legal_entity_type]`	`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": "416087461234476933",
  "administration_id": 123,
  "company_name": "Second B.V.",
  "city": "Enschede",
  "country": "NL",
  "zipcode": "7523XD",
  "address1": "Brouwerijstraat 26",
  "address2": null,
  "email": "info@dev.null.moneybird.net",
  "phone": "0612345678",
  "bank_account_name": null,
  "bank_account_number": "NL50TEST0166567191",
  "bank_account_bic": null,
  "custom_fields": [

  ],
  "updated_at": "2024-03-21T14:41:04.730Z",
  "created_at": "2024-03-21T14:39:06.875Z",
  "chamber_of_commerce": "08155914",
  "tax_number": "NL817575546B01"
}

Retrieve identities

GET /identities(.:format)

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": "416087584877315481",
    "administration_id": 123,
    "company_name": "Parkietje B.V.",
    "city": "Den Haag",
    "country": "NL",
    "zipcode": "4321XY",
    "address1": "Brouwersplein 62",
    "address2": null,
    "email": "info@dev.null.moneybird.net",
    "phone": "1234-5678900",
    "bank_account_name": "Foobar B.V.",
    "bank_account_number": "NL80TEST0252789466",
    "bank_account_bic": null,
    "custom_fields": [

    ],
    "updated_at": "2024-03-21T14:41:04.793Z",
    "created_at": "2024-03-21T14:41:04.793Z",
    "chamber_of_commerce": "08155914",
    "tax_number": "NL817575546B01"
  }
]

Retrieve identity by given id

GET /identities/:id(.:format)

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/416087584989513119.json?
    
    

Response

        
          
          Status: 200 OK

{
  "id": "416087584989513119",
  "administration_id": 123,
  "company_name": "Parkietje B.V.",
  "city": "Den Haag",
  "country": "NL",
  "zipcode": "4321XY",
  "address1": "Brouwersplein 62",
  "address2": null,
  "email": "info@dev.null.moneybird.net",
  "phone": "1234-5678900",
  "bank_account_name": "Foobar B.V.",
  "bank_account_number": "NL80TEST0252789466",
  "bank_account_bic": null,
  "custom_fields": [

  ],
  "updated_at": "2024-03-21T14:41:04.900Z",
  "created_at": "2024-03-21T14:41:04.900Z",
  "chamber_of_commerce": "08155914",
  "tax_number": "NL817575546B01"
}

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

POST /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.

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`	Required Should be a valid email addresses.
`identity[phone]`	`String`
`identity[bank_account_name]`	`String`
`identity[bank_account_number]`	`String`	Required
`identity[bank_account_bic]`	`String`
`identity[custom_fields_attributes][id]`	`Integer`	Required
`identity[custom_fields_attributes][value]`	`String`	Required

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": "416087585293600179",
  "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": "2024-03-21T14:41:05.190Z",
  "created_at": "2024-03-21T14:41:05.190Z",
  "chamber_of_commerce": "08155914",
  "tax_number": "NL817575546B01"
}

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":416087585374340538,"value":"my custom value"}}}}' \
  https://moneybird.com/api/v2/123/identities.json
    
    

Response

        
          
          Status: 201 Created

{
  "id": "416087585448789438",
  "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": "416087585374340538",
      "name": "custom_field_419e19c1e6db7f94cdbf",
      "value": "my custom value"
    }
  ],
  "updated_at": "2024-03-21T14:41:05.338Z",
  "created_at": "2024-03-21T14:41:05.338Z",
  "chamber_of_commerce": "08155914",
  "tax_number": "NL817575546B01"
}

Updates an identity

PATCH /identities/:id(.:format)

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`	Required
`identity[custom_fields_attributes][value]`	`String`	Required

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/416087585515898305.json
    
    

Response

        
          
          Status: 200 OK

{
  "id": "416087585515898305",
  "administration_id": 123,
  "company_name": "Second B.V.",
  "city": "Den Haag",
  "country": "NL",
  "zipcode": "4321XY",
  "address1": "Brouwersplein 62",
  "address2": null,
  "email": "info@dev.null.moneybird.net",
  "phone": "1234-5678900",
  "bank_account_name": "Foobar B.V.",
  "bank_account_number": "NL80TEST0252789466",
  "bank_account_bic": null,
  "custom_fields": [

  ],
  "updated_at": "2024-03-21T14:41:05.469Z",
  "created_at": "2024-03-21T14:41:05.401Z",
  "chamber_of_commerce": "08155914",
  "tax_number": "NL817575546B01"
}

Deletes an identity

DELETE /identities/:id(.:format)

Example: deletes the identity

Request

    curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XDELETE \
  -d '{}' \
  https://moneybird.com/api/v2/123/identities/416087585644873161.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 \
  -d '{}' \
  https://moneybird.com/api/v2/123/identities/416087461234476933.json
    
    

Response

        
          
          Status: 404 Not Found

{
  "error": "record not found",
  "symbolic": {
    "id": "not_found"
  }
}