Contacts
List all contacts
Returns a paginated list of contacts in the administration.
Searching for contacts can be done by providing the query parameter with search terms. The API searches for matches in the following contact fields:
company_nameattentionfirstnamelastnameaddress1address2zipcodecitycountryemailphonecustomer_idtax_numberchamber_of_commercebank_account
Parameters
| Parameter | Type | Description |
|---|---|---|
page |
Integer |
|
per_page |
Integer |
|
query |
String |
|
include_archived |
Boolean |
|
todo |
String |
Example: return a list of contacts
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/contacts.json?
Response
Status: 200 OK
[
{
"id": "416087480804050054",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": "",
"lastname": "",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "3",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:39:25.539Z",
"updated_at": "2024-03-21T14:39:25.539Z",
"version": 1711031965,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/894f1a90c4163e13c0b9ec8655e8f6c719d531e01e1da7e59fb0714bbed332cd/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false,
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "contact_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:39:25.544Z",
"updated_at": "2024-03-21T14:39:25.544Z"
}
]
},
{
"id": "416087480727503993",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": null,
"lastname": "Appleseed",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234 AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "1",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:39:25.466Z",
"updated_at": "2024-03-21T14:39:25.495Z",
"version": 1711031965,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/1804974a329a3d3991599682a00cfc943bf718854e5ffce4c1d5e9e89ecc9475/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
{
"id": "416087480734844027",
"contact_id": "416087480727503993",
"administration_id": 123,
"firstname": "John",
"lastname": "Appleseed",
"phone": null,
"email": null,
"department": null,
"created_at": "2024-03-21T14:39:25.474Z",
"updated_at": "2024-03-21T14:39:25.474Z",
"version": 1711031965
},
{
"id": "416087480816632969",
"contact_id": "416087480727503993",
"administration_id": 123,
"firstname": "Jan",
"lastname": "Janssen",
"phone": "123-456-2346",
"email": "janjanssen@dev.null.moneybird.net",
"department": "Sales",
"created_at": "2024-03-21T14:39:25.550Z",
"updated_at": "2024-03-21T14:39:25.550Z",
"version": 1711031965
},
{
"id": "416087480820827275",
"contact_id": "416087480727503993",
"administration_id": 123,
"firstname": "Foo",
"lastname": "Bar",
"phone": "123-456-2346",
"email": "janjanssen@dev.null.moneybird.net",
"department": "Sales",
"created_at": "2024-03-21T14:39:25.554Z",
"updated_at": "2024-03-21T14:39:25.554Z",
"version": 1711031965
}
],
"archived": false,
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "contact_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:39:25.484Z",
"updated_at": "2024-03-21T14:39:25.484Z"
}
]
},
{
"id": "416087480773641344",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": null,
"lastname": null,
"address1": "1 Infinite Loop",
"address2": "",
"zipcode": "123456",
"city": "Redmond",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "2",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "NL50TEST0166567191",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": true,
"sepa_iban": "NL50TEST0166567191",
"sepa_iban_account_name": "Foobar Holding B.V.",
"sepa_bic": "RABONL2U",
"sepa_mandate_id": "MAN12313",
"sepa_mandate_date": "2014-01-01",
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:39:25.510Z",
"updated_at": "2024-03-21T14:39:25.510Z",
"version": 1711031965,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/148acbb3ba17337074d87ed6a94166f49c902f386f65a3b6e10ee01a35a04c4d/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
{
"id": "416087480780981378",
"contact_id": "416087480773641344",
"administration_id": 123,
"firstname": "John",
"lastname": "Doe",
"phone": null,
"email": null,
"department": null,
"created_at": "2024-03-21T14:39:25.518Z",
"updated_at": "2024-03-21T14:39:25.518Z",
"version": 1711031965
}
],
"archived": false,
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "contact_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:39:25.525Z",
"updated_at": "2024-03-21T14:39:25.525Z"
}
]
}
]
Example: allows filtering by name
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/contacts.json?query=appleseed
Response
Status: 200 OK
[
{
"id": "416087484232893582",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": null,
"lastname": "Appleseed",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234 AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "1",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:39:28.808Z",
"updated_at": "2024-03-21T14:39:28.913Z",
"version": 1711031968,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/2828d495b25c8e4773dd0ead41f7c04a2d6350379aacd7271fa27b273fad26f0/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
{
"id": "416087484240233616",
"contact_id": "416087484232893582",
"administration_id": 123,
"firstname": "John",
"lastname": "Appleseed",
"phone": null,
"email": null,
"department": null,
"created_at": "2024-03-21T14:39:28.816Z",
"updated_at": "2024-03-21T14:39:28.816Z",
"version": 1711031968
},
{
"id": "416087484497134750",
"contact_id": "416087484232893582",
"administration_id": 123,
"firstname": "Jan",
"lastname": "Janssen",
"phone": "123-456-2346",
"email": "janjanssen@dev.null.moneybird.net",
"department": "Sales",
"created_at": "2024-03-21T14:39:29.061Z",
"updated_at": "2024-03-21T14:39:29.061Z",
"version": 1711031969
},
{
"id": "416087484502377632",
"contact_id": "416087484232893582",
"administration_id": 123,
"firstname": "Foo",
"lastname": "Bar",
"phone": "123-456-2346",
"email": "janjanssen@dev.null.moneybird.net",
"department": "Sales",
"created_at": "2024-03-21T14:39:29.065Z",
"updated_at": "2024-03-21T14:39:29.065Z",
"version": 1711031969
}
],
"archived": false,
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "contact_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:39:28.903Z",
"updated_at": "2024-03-21T14:39:28.903Z"
}
]
}
]
Example: allows filtering by name in combination with pagination
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/contacts.json?page=2&per_page=1&query=appleseed
Response
Status: 200 OK
[
]
Example: returns empty list when no matches with filter
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/contacts.json?query=sdfadsfdsafdsafadsgasdfadsfdsf
Response
Status: 200 OK
[
]
Example: returns paginated contacts on page 1
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/contacts.json?per_page=1
Response
Status: 200 OK
[
{
"id": "416087491625354458",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": "",
"lastname": "",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "3",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:39:35.860Z",
"updated_at": "2024-03-21T14:39:35.860Z",
"version": 1711031975,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/090c9f586cb681df56acebadeebd0799029960fd5a15a6192c65da184beb8168/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false,
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "contact_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:39:35.866Z",
"updated_at": "2024-03-21T14:39:35.866Z"
}
]
}
]
Example: returns paginated contacts on page 2
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/contacts.json?page=2&per_page=1
Response
Status: 200 OK
[
{
"id": "416087491771106530",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": null,
"lastname": "Appleseed",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234 AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "1",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:39:35.999Z",
"updated_at": "2024-03-21T14:39:36.025Z",
"version": 1711031976,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/b999061d4b0968d383283520509964ff49d2c7f7a5693efc7aea0491ec7317a6/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
{
"id": "416087491778446564",
"contact_id": "416087491771106530",
"administration_id": 123,
"firstname": "John",
"lastname": "Appleseed",
"phone": null,
"email": null,
"department": null,
"created_at": "2024-03-21T14:39:36.007Z",
"updated_at": "2024-03-21T14:39:36.007Z",
"version": 1711031976
},
{
"id": "416087491846604018",
"contact_id": "416087491771106530",
"administration_id": 123,
"firstname": "Jan",
"lastname": "Janssen",
"phone": "123-456-2346",
"email": "janjanssen@dev.null.moneybird.net",
"department": "Sales",
"created_at": "2024-03-21T14:39:36.071Z",
"updated_at": "2024-03-21T14:39:36.071Z",
"version": 1711031976
},
{
"id": "416087491849749748",
"contact_id": "416087491771106530",
"administration_id": 123,
"firstname": "Foo",
"lastname": "Bar",
"phone": "123-456-2346",
"email": "janjanssen@dev.null.moneybird.net",
"department": "Sales",
"created_at": "2024-03-21T14:39:36.074Z",
"updated_at": "2024-03-21T14:39:36.074Z",
"version": 1711031976
}
],
"archived": false,
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "contact_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:39:36.016Z",
"updated_at": "2024-03-21T14:39:36.016Z"
}
]
}
]
Example: returns an error when too many contacts are requested
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/contacts.json?per_page=101
Response
Status: 400 Bad Request
{
"error": "Per Page is too big",
"symbolic": {
"per_page": "max"
}
}
Filter contacts
Returns a paginated list of all contacts in the administration.
The filter argument allows you to filter the list of contacts. Filters are a combination of keys and values,
separated by a comma: first_name:henk,last_name:jansen. The available options for filtering are:
| Filter | Type | Default | Description |
| created_after | String |
 | Select contacts created after the given time (exclusive). ISO 8601 formatted string. The time to compare with is in UTC timezone |
| updated_after | String |
 | Select contacts updated after the given time (exclusive). ISO 8601 formatted string. The time to compare with is in UTC timezone |
| first_name | String |
 | Select contacts with the given first name. Case-insensitive |
| last_name | String |
 | Select contacts with the given last name. Case-insensitive |
Parameters
| Parameter | Type | Description |
|---|---|---|
filter |
String |
|
include_archived |
Grape::api::boolean |
Example: returns all contacts created after given datetime
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/contacts/filter.json?filter=created_after%3A2024-03-20+14%3A39%3A36+UTC
Response
Status: 200 OK
[
{
"id": "416087492513498410",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": "",
"lastname": "",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "3",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:39:36.708Z",
"updated_at": "2024-03-21T14:39:36.708Z",
"version": 1711031976,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/3d32a2da5555bd2c3d36b5d7c9a38bac79f81eab1c30ba2603ac5151c62186ed/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false,
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "contact_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:39:36.713Z",
"updated_at": "2024-03-21T14:39:36.713Z"
}
]
},
{
"id": "416087492431709469",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": null,
"lastname": "Appleseed",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234 AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "1",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:39:36.630Z",
"updated_at": "2024-03-21T14:39:36.666Z",
"version": 1711031976,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/52e9a1be12a3362755e448910fbc17818dec650513576ff81fe8af66c8f3f45a/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
{
"id": "416087492439049503",
"contact_id": "416087492431709469",
"administration_id": 123,
"firstname": "John",
"lastname": "Appleseed",
"phone": null,
"email": null,
"department": null,
"created_at": "2024-03-21T14:39:36.637Z",
"updated_at": "2024-03-21T14:39:36.637Z",
"version": 1711031976
}
],
"archived": false,
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "contact_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:39:36.654Z",
"updated_at": "2024-03-21T14:39:36.654Z"
}
]
},
{
"id": "416087492485186852",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": null,
"lastname": null,
"address1": "1 Infinite Loop",
"address2": "",
"zipcode": "123456",
"city": "Redmond",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "2",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "NL50TEST0166567191",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": true,
"sepa_iban": "NL50TEST0166567191",
"sepa_iban_account_name": "Foobar Holding B.V.",
"sepa_bic": "RABONL2U",
"sepa_mandate_id": "MAN12313",
"sepa_mandate_date": "2014-01-01",
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:39:36.680Z",
"updated_at": "2024-03-21T14:39:36.680Z",
"version": 1711031976,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/c7aa5dd0e1700c91e4bf0fe45a8084e11e0c0e010d56304a5796b341e3740108/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
{
"id": "416087492491478310",
"contact_id": "416087492485186852",
"administration_id": 123,
"firstname": "John",
"lastname": "Doe",
"phone": null,
"email": null,
"department": null,
"created_at": "2024-03-21T14:39:36.687Z",
"updated_at": "2024-03-21T14:39:36.687Z",
"version": 1711031976
}
],
"archived": false,
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "contact_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:39:36.694Z",
"updated_at": "2024-03-21T14:39:36.694Z"
}
]
}
]
Example: returns only contacts updated after given datetime
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/contacts/filter.json?filter=updated_after%3A2024-03-21+14%3A39%3A42+UTC
Response
Status: 200 OK
[
{
"id": "416087492860577087",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": null,
"lastname": "foo",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234 AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "1",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:39:37.039Z",
"updated_at": "2024-03-21T14:40:42.139Z",
"version": 1711032042,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/bc9c6d3a80eb8c9c3fde490319ea95c77af0019cb4bd0ee640144938b75d9139/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
{
"id": "416087492868965697",
"contact_id": "416087492860577087",
"administration_id": 123,
"firstname": "John",
"lastname": "Appleseed",
"phone": null,
"email": null,
"department": null,
"created_at": "2024-03-21T14:39:37.047Z",
"updated_at": "2024-03-21T14:39:37.047Z",
"version": 1711031977
}
],
"archived": false,
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "contact_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:39:37.058Z",
"updated_at": "2024-03-21T14:39:37.058Z"
}
]
}
]
Example: allows filtering by firstname
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/contacts/filter.json?filter=first_name%3Apiet
Response
Status: 200 OK
[
{
"id": "416087493138449761",
"administration_id": 123,
"company_name": "Relation 1",
"firstname": "Piet",
"lastname": null,
"address1": null,
"address2": null,
"zipcode": null,
"city": null,
"country": "NL",
"phone": null,
"delivery_method": "Email",
"customer_id": "7fe4028e937ba6277cdfc46e19f4abd0cd8653098415a689da798dc7322794a9",
"tax_number": null,
"chamber_of_commerce": null,
"bank_account": null,
"attention": null,
"email": null,
"email_ubl": false,
"send_invoices_to_attention": null,
"send_invoices_to_email": null,
"send_estimates_to_attention": null,
"send_estimates_to_email": null,
"sepa_active": false,
"sepa_iban": null,
"sepa_iban_account_name": null,
"sepa_bic": null,
"sepa_mandate_id": null,
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": null,
"credit_card_reference": null,
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": null,
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:39:37.304Z",
"updated_at": "2024-03-21T14:39:37.309Z",
"version": 1711031977,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/82fc695b6fe0bb737bc8e4d3fa9ea9d58aeca2e388e9edda3de965eb78501c5d/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false,
"events": [
]
}
]
List all ids and versions
Returns all contacts in the administration. The list contains the contact id and the version of the contact.
Check if the version of the contact is newer than the version you have stored locally, use the POST
variant for fetching contacts with the given ids.
Parameters
| Parameter | Type | Description |
|---|---|---|
filter |
String |
|
include_archived |
Grape::api::boolean |
Example: return a list of id's and version id's
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/contacts/synchronization.json?
Response
Status: 200 OK
[
{
"id": "416087494165005740",
"version": 1711031978
},
{
"id": "416087494207997363",
"version": 1711031978
}
]
Example: retrieves the id's for synchronization with a filter
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/contacts/synchronization.json?filter=first_name%3Ahenk
Response
Status: 200 OK
[
{
"id": "416087494384158151",
"version": 1711031978
}
]
Fetch contacts with given ids
Given a list of contact ids, returns the contact information belonging to the contacts. Returns a maximum of 100 contacts, even if more ids are provided.
Parameters
| Parameter | Type | Description |
|---|---|---|
ids |
Array[integer] |
Required |
Example: return a list of given ids
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPOST \
-d '{"ids":[416087494540395992,416087494597019105]}' \
https://moneybird.com/api/v2/123/contacts/synchronization.json
Response
Status: 200 OK
[
{
"id": "416087494540395992",
"administration_id": 123,
"company_name": "Bar Foo",
"firstname": null,
"lastname": null,
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "3",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:39:38.640Z",
"updated_at": "2024-03-21T14:39:38.640Z",
"version": 1711031978,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/5b83ada0f58895309c5b6d9354dbb06410e6d9403a9894128d832f58b3aaac83/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
{
"id": "416087494551930330",
"contact_id": "416087494540395992",
"administration_id": 123,
"firstname": "John",
"lastname": "Appleseed",
"phone": null,
"email": null,
"department": null,
"created_at": "2024-03-21T14:39:38.652Z",
"updated_at": "2024-03-21T14:39:38.652Z",
"version": 1711031978
}
],
"archived": false,
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "contact_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:39:38.658Z",
"updated_at": "2024-03-21T14:39:38.658Z"
}
]
},
{
"id": "416087494597019105",
"administration_id": 123,
"company_name": "Foo Bar",
"firstname": null,
"lastname": null,
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "5",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:39:38.695Z",
"updated_at": "2024-03-21T14:39:38.695Z",
"version": 1711031978,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/22a3fe86c037ba7ad8f33227026bd5570c4256a90e6e4969daf87e4eb4659df6/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
{
"id": "416087494604359139",
"contact_id": "416087494597019105",
"administration_id": 123,
"firstname": "Mark",
"lastname": "van Vliet",
"phone": null,
"email": null,
"department": null,
"created_at": "2024-03-21T14:39:38.702Z",
"updated_at": "2024-03-21T14:39:38.702Z",
"version": 1711031978
}
],
"archived": false,
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "contact_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:39:38.708Z",
"updated_at": "2024-03-21T14:39:38.708Z"
}
]
}
]
Get contact
Returns all information about a contact.
Parameters
| Parameter | Type | Description |
|---|---|---|
include_archived |
Boolean |
Example: return a contact
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/contacts/416087493243307365.json?
Response
Status: 200 OK
{
"id": "416087493243307365",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": null,
"lastname": "Appleseed",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234 AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "1",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:39:37.403Z",
"updated_at": "2024-03-21T14:39:37.431Z",
"version": 1711031977,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/204ce52ecbc524deaa06c63375af80079458ab24d69b00b77c92956d826dd760/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
{
"id": "416087493249598823",
"contact_id": "416087493243307365",
"administration_id": 123,
"firstname": "John",
"lastname": "Appleseed",
"phone": null,
"email": null,
"department": null,
"created_at": "2024-03-21T14:39:37.410Z",
"updated_at": "2024-03-21T14:39:37.410Z",
"version": 1711031977
}
],
"archived": false,
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "contact_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:39:37.421Z",
"updated_at": "2024-03-21T14:39:37.421Z"
}
]
}
Example: returns sepa_iban as bank_account
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/contacts/416087493421565299.json?
Response
Status: 200 OK
{
"id": "416087493421565299",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": null,
"lastname": "Appleseed",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234 AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "1",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "NL50TEST0166567191",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "NL50TEST0166567191",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:39:37.573Z",
"updated_at": "2024-03-21T14:39:37.632Z",
"version": 1711031977,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/de35d2170aadb4cd61b9cc428dffc4579f388ffcc54b9dc2b64e0faa626ca3dc/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
{
"id": "416087493428905333",
"contact_id": "416087493421565299",
"administration_id": 123,
"firstname": "John",
"lastname": "Appleseed",
"phone": null,
"email": null,
"department": null,
"created_at": "2024-03-21T14:39:37.581Z",
"updated_at": "2024-03-21T14:39:37.581Z",
"version": 1711031977
}
],
"archived": false,
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "contact_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:39:37.591Z",
"updated_at": "2024-03-21T14:39:37.591Z"
}
]
}
Example: returns 404 when contact does not exist
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/contacts/34123123.json?
Response
Status: 404 Not Found
{
"error": "record not found",
"symbolic": {
"id": "not_found"
}
}
Get contact by customer id
Returns all information about a contact by the given customer id
Parameters
| Parameter | Type | Description |
|---|---|---|
customer_id |
String |
Required Should be unique for the administration. |
Example: return a contact
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/contacts/customer_id/1.json?
Response
Status: 200 OK
{
"id": "416087493700486544",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": null,
"lastname": "Appleseed",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234 AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "1",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:39:37.839Z",
"updated_at": "2024-03-21T14:39:37.864Z",
"version": 1711031977,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/e412b0971058b7eefe8ea59498cf1b13a8a7b37c0e863ae63ca8d1a4f6c31df7/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
{
"id": "416087493705729426",
"contact_id": "416087493700486544",
"administration_id": 123,
"firstname": "John",
"lastname": "Appleseed",
"phone": null,
"email": null,
"department": null,
"created_at": "2024-03-21T14:39:37.846Z",
"updated_at": "2024-03-21T14:39:37.846Z",
"version": 1711031977
}
],
"archived": false,
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "contact_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:39:37.855Z",
"updated_at": "2024-03-21T14:39:37.855Z"
}
]
}
Example: returns 404 when contact does not exist
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/contacts/customer_id/34123123.json?
Response
Status: 404 Not Found
{
"error": "record not found",
"symbolic": {
"customer_id": "not_found"
}
}
Create a new contact
Creating a new contact in the administration requires at least a company_name or a firstname and lastname.
When filling a custom field, both id and value are required. See the custom field example for more information.
Parameters
| Parameter | Type | Description |
|---|---|---|
contact[company_name] |
String |
A contact requires a non-blank |
contact[address1] |
String |
|
contact[address2] |
String |
|
contact[zipcode] |
String |
|
contact[city] |
String |
|
contact[country] |
String |
ISO two-character country code, e.g. NL or DE. |
contact[phone] |
String |
|
contact[delivery_method] |
String |
Can be |
contact[customer_id] |
String |
Will be assigned automatically if empty. Should be unique for the administration. |
contact[tax_number] |
String |
|
contact[firstname] |
String |
A contact requires a non-blank |
contact[lastname] |
String |
A contact requires a non-blank |
contact[chamber_of_commerce] |
String |
|
contact[bank_account] |
String |
|
contact[send_invoices_to_attention] |
String |
|
contact[send_invoices_to_email] |
String |
Should be one or more valid email addresses, separated by a comma. |
contact[send_estimates_to_attention] |
String |
|
contact[send_estimates_to_email] |
String |
Should be one or more valid email addresses, separated by a comma. |
contact[sepa_active] |
Boolean |
When |
contact[sepa_iban] |
String |
Should be a valid IBAN. |
contact[sepa_iban_account_name] |
String |
|
contact[sepa_bic] |
String |
Should be a valid BIC. |
contact[sepa_mandate_id] |
String |
|
contact[sepa_mandate_date] |
String |
Should be a date in the past. |
contact[sepa_sequence_type] |
String |
Can be |
contact[si_identifier_type] |
String |
Can be |
contact[si_identifier] |
String |
|
contact[invoice_workflow_id] |
Integer |
Should be a valid invoice workflow id. |
contact[estimate_workflow_id] |
Integer |
Should be a valid estimate workflow id. |
contact[email_ubl] |
Boolean |
|
contact[direct_debit] |
Boolean |
|
contact[custom_fields_attributes][id] |
Integer |
Required |
contact[custom_fields_attributes][value] |
String |
Required |
contact[contact_person][firstname] |
String |
Required |
contact[contact_person][lastname] |
String |
Required |
type |
String |
|
from_checkout |
Boolean |
Example: create a new contact
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPOST \
-d '{"contact":{"company_name":"Test B.V."}}' \
https://moneybird.com/api/v2/123/contacts.json
Response
Status: 201 Created
{
"id": "416087494846580213",
"administration_id": 123,
"company_name": "Test B.V.",
"firstname": "",
"lastname": "",
"address1": "",
"address2": "",
"zipcode": "",
"city": "",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "3",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "",
"send_estimates_to_attention": "",
"send_estimates_to_email": "",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:39:38.932Z",
"updated_at": "2024-03-21T14:39:38.932Z",
"version": 1711031978,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/ee97d4f434c89726477867798e3bc25ecd26211947fb2125e58e73835265d05a/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false,
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "contact_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:39:38.937Z",
"updated_at": "2024-03-21T14:39:38.937Z"
}
]
}
Example: adding values for custom fields
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPOST \
-d '{"contact":{"company_name":"Test B.V.","custom_fields_attributes":{"0":{"id":416087494984992263,"value":"Field value"}}}}' \
https://moneybird.com/api/v2/123/contacts.json
Response
Status: 201 Created
{
"id": "416087495033226761",
"administration_id": 123,
"company_name": "Test B.V.",
"firstname": "",
"lastname": "",
"address1": "",
"address2": "",
"zipcode": "",
"city": "",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "3",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "",
"send_estimates_to_attention": "",
"send_estimates_to_email": "",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:39:39.111Z",
"updated_at": "2024-03-21T14:39:39.111Z",
"version": 1711031979,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/74869382bcfa9771d1c87e946f383c1a36b29c5e8d9ae5d51dbd242419767a09/all",
"notes": [
],
"custom_fields": [
{
"id": "416087494984992263",
"name": "Number",
"value": "Field value"
}
],
"contact_people": [
],
"archived": false,
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "contact_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:39:39.115Z",
"updated_at": "2024-03-21T14:39:39.115Z"
}
]
}
Example: returns an error when custom field cannot be found
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPOST \
-d '{"contact":{"custom_fields_attributes":{"0":{"id":1234,"value":"Field value"}}}}' \
https://moneybird.com/api/v2/123/contacts.json
Response
Status: 404 Not Found
{
"error": "Custom field with id 1234 not found for administration",
"symbolic": {
"custom_fields_attributes": "not_found"
}
}
Example: returns an error when fields are not provided
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPOST \
-d '{}' \
https://moneybird.com/api/v2/123/contacts.json
Response
Status: 400 Bad Request
{
"error": "Contact is required",
"symbolic": {
"contact": "required"
}
}
Example: returns an error when record is invalid
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPOST \
-d '{"contact":{"company_name":"","firstname":"","lastname":""}}' \
https://moneybird.com/api/v2/123/contacts.json
Response
Status: 422 Unprocessable Entity
{
"error": {
"firstname": [
"is required"
],
"lastname": [
"is required"
],
"company_name": [
"is required"
]
}
}
Example: create a new contact with mandate_date in timezone gap
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPOST \
-d '{"contact":{"company_name":"Test B.V.","sepa_active":true,"sepa_iban":"NL91ABNA0417164300","sepa_iban_account_name":"Foo Bar","sepa_mandate_date":"2017-6-30","sepa_mandate_id":"NL123214"}}' \
https://moneybird.com/api/v2/123/contacts.json
Response
Status: 201 Created
{
"id": "416087495817561668",
"administration_id": 123,
"company_name": "Test B.V.",
"firstname": "",
"lastname": "",
"address1": "",
"address2": "",
"zipcode": "",
"city": "",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "3",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "NL91ABNA0417164300",
"attention": "",
"email": "",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "",
"send_estimates_to_attention": "",
"send_estimates_to_email": "",
"sepa_active": true,
"sepa_iban": "NL91ABNA0417164300",
"sepa_iban_account_name": "Foo Bar",
"sepa_bic": "ABNANL2A",
"sepa_mandate_id": "NL123214",
"sepa_mandate_date": "2017-06-30",
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2017-06-30T23:30:00.056Z",
"updated_at": "2017-06-30T23:30:00.056Z",
"version": 1498865400,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/a8699782a5e615b3771bfef3843b2b2f2f1e031f5d4451eab4705c3a9f23c6c3/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false,
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "contact_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2017-06-30T23:30:00.062Z",
"updated_at": "2017-06-30T23:30:00.062Z"
}
]
}
Example: create a new contact with mandate_date without timezone gap
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPOST \
-d '{"contact":{"company_name":"Test B.V.","sepa_active":true,"sepa_iban":"NL91ABNA0417164300","sepa_iban_account_name":"Foo Bar","sepa_mandate_date":"2017-6-30","sepa_mandate_id":"NL123214"}}' \
https://moneybird.com/api/v2/123/contacts.json
Response
Status: 422 Unprocessable Entity
{
"error": {
"sepa_mandate_date": [
"cannot be today or in the future"
]
}
}
Example: create a new contact with given SI identifier
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPOST \
-d '{"contact":{"company_name":"Test B.V.","si_identifier":"1234567","si_identifier_type":"NL:KVK"}}' \
https://moneybird.com/api/v2/123/contacts.json
Response
Status: 201 Created
{
"id": "416087496181417571",
"administration_id": 123,
"company_name": "Test B.V.",
"firstname": "",
"lastname": "",
"address1": "",
"address2": "",
"zipcode": "",
"city": "",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "3",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "",
"send_estimates_to_attention": "",
"send_estimates_to_email": "",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "1234567",
"si_identifier_type": "NL:KVK",
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:39:40.206Z",
"updated_at": "2024-03-21T14:39:40.206Z",
"version": 1711031980,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/46f4f8c05359a952130308465b964e126f5ee05d37a674e3065b80a9b408c7a9/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false,
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "contact_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:39:40.211Z",
"updated_at": "2024-03-21T14:39:40.211Z"
}
]
}
Update a contact
When updating a contact, you only need to provide the information you want to change. Attributes you don’t provide in the request will not be updated. Optional attributes can be removed by setting them to an empty string value.
Parameters
| Parameter | Type | Description |
|---|---|---|
contact[company_name] |
String |
A contact requires a non-blank |
contact[address1] |
String |
|
contact[address2] |
String |
|
contact[zipcode] |
String |
|
contact[city] |
String |
|
contact[country] |
String |
ISO two-character country code, e.g. NL or DE. |
contact[phone] |
String |
|
contact[delivery_method] |
String |
Can be |
contact[email_ubl] |
Boolean |
|
contact[customer_id] |
String |
Will be assigned automatically if empty. Should be unique for the administration. |
contact[tax_number] |
String |
|
contact[firstname] |
String |
A contact requires a non-blank |
contact[lastname] |
String |
A contact requires a non-blank |
contact[chamber_of_commerce] |
String |
|
contact[bank_account] |
String |
|
contact[send_invoices_to_attention] |
String |
|
contact[send_invoices_to_email] |
String |
Should be one or more valid email addresses, separated by a comma. |
contact[send_estimates_to_attention] |
String |
|
contact[send_estimates_to_email] |
String |
Should be one or more valid email addresses, separated by a comma. |
contact[sepa_active] |
Boolean |
When |
contact[sepa_iban] |
String |
Should be a valid IBAN. |
contact[sepa_iban_account_name] |
String |
|
contact[sepa_bic] |
String |
Should be a valid BIC. |
contact[sepa_mandate_id] |
String |
|
contact[sepa_mandate_date] |
String |
Should be a date in the past. |
contact[sepa_sequence_type] |
String |
Can be |
contact[invoice_workflow_id] |
Integer |
Should be a valid invoice workflow id. |
contact[estimate_workflow_id] |
Integer |
Should be a valid estimate workflow id. |
contact[si_identifier_type] |
String |
Can be |
contact[si_identifier] |
String |
|
contact[direct_debit] |
Boolean |
|
contact[custom_fields_attributes][id] |
Integer |
Required |
contact[custom_fields_attributes][value] |
String |
Required |
Example: update a contact
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPATCH \
-d '{"contact":{"company_name":"Test B.V."}}' \
https://moneybird.com/api/v2/123/contacts/416087496247477863.json
Response
Status: 200 OK
{
"id": "416087496247477863",
"administration_id": 123,
"company_name": "Test B.V.",
"firstname": null,
"lastname": "Appleseed",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234 AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "1",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:39:40.268Z",
"updated_at": "2024-03-21T14:39:40.372Z",
"version": 1711031980,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/b94fcede2928cce4092628c7f70b440fc63ac80c69c80db716b677d855c71e59/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
{
"id": "416087496253769321",
"contact_id": "416087496247477863",
"administration_id": 123,
"firstname": "John",
"lastname": "Appleseed",
"phone": null,
"email": null,
"department": null,
"created_at": "2024-03-21T14:39:40.275Z",
"updated_at": "2024-03-21T14:39:40.275Z",
"version": 1711031980
},
{
"id": "416087496384841334",
"contact_id": "416087496247477863",
"administration_id": 123,
"firstname": null,
"lastname": "Appleseed",
"phone": null,
"email": null,
"department": null,
"created_at": "2024-03-21T14:39:40.400Z",
"updated_at": "2024-03-21T14:39:40.400Z",
"version": 1711031980
}
],
"archived": false,
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "contact_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:39:40.283Z",
"updated_at": "2024-03-21T14:39:40.283Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "contact_changed",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"changes": {
"company_name": [
"Foobar Holding B.V.",
"Test B.V."
]
}
},
"created_at": "2024-03-21T14:39:40.376Z",
"updated_at": "2024-03-21T14:39:40.376Z"
}
]
}
Example: update a contact that has SEPA activated
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPATCH \
-d '{"contact":{"company_name":"Test B.V."}}' \
https://moneybird.com/api/v2/123/contacts/416087496500184705.json
Response
Status: 200 OK
{
"id": "416087496500184705",
"administration_id": 123,
"company_name": "Test B.V.",
"firstname": null,
"lastname": null,
"address1": "1 Infinite Loop",
"address2": "",
"zipcode": "123456",
"city": "Redmond",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "2",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "NL50TEST0166567191",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": true,
"sepa_iban": "NL50TEST0166567191",
"sepa_iban_account_name": "Foobar Holding B.V.",
"sepa_bic": "RABONL2U",
"sepa_mandate_id": "MAN12313",
"sepa_mandate_date": "2014-01-01",
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:39:40.509Z",
"updated_at": "2024-03-21T14:39:40.566Z",
"version": 1711031980,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/f6dcf7deb8ce1670d6e2817a602068b09c5d36a55a599df6aebd66aa07dec4d8/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
{
"id": "416087496506476163",
"contact_id": "416087496500184705",
"administration_id": 123,
"firstname": "John",
"lastname": "Doe",
"phone": null,
"email": null,
"department": null,
"created_at": "2024-03-21T14:39:40.516Z",
"updated_at": "2024-03-21T14:39:40.516Z",
"version": 1711031980
}
],
"archived": false,
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "contact_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:39:40.523Z",
"updated_at": "2024-03-21T14:39:40.523Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "contact_changed",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"changes": {
"company_name": [
"Foobar Holding B.V.",
"Test B.V."
]
}
},
"created_at": "2024-03-21T14:39:40.571Z",
"updated_at": "2024-03-21T14:39:40.571Z"
}
]
}
Example: update the SEPA sequence type
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPATCH \
-d '{"contact":{"sepa_sequence_type":"FNAL"}}' \
https://moneybird.com/api/v2/123/contacts/416087496672151185.json
Response
Status: 200 OK
{
"id": "416087496672151185",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": null,
"lastname": null,
"address1": "1 Infinite Loop",
"address2": "",
"zipcode": "123456",
"city": "Redmond",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "2",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "NL50TEST0166567191",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": true,
"sepa_iban": "NL50TEST0166567191",
"sepa_iban_account_name": "Foobar Holding B.V.",
"sepa_bic": "RABONL2U",
"sepa_mandate_id": "MAN12313",
"sepa_mandate_date": "2014-01-01",
"sepa_sequence_type": "FNAL",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:39:40.674Z",
"updated_at": "2024-03-21T14:39:40.736Z",
"version": 1711031980,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/2c4bc026ea601e39baf34f251bd78831c5b72fed0895b3e33fd1c29d9604350b/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
{
"id": "416087496679491219",
"contact_id": "416087496672151185",
"administration_id": 123,
"firstname": "John",
"lastname": "Doe",
"phone": null,
"email": null,
"department": null,
"created_at": "2024-03-21T14:39:40.681Z",
"updated_at": "2024-03-21T14:39:40.681Z",
"version": 1711031980
}
],
"archived": false,
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "contact_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:39:40.689Z",
"updated_at": "2024-03-21T14:39:40.689Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "contact_changed",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"changes": {
"sepa_sequence_type": [
"RCUR",
"FNAL"
]
}
},
"created_at": "2024-03-21T14:39:40.740Z",
"updated_at": "2024-03-21T14:39:40.740Z"
}
]
}
Example: returns an error when record is invalid
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPATCH \
-d '{"contact":{"company_name":"","firstname":"","lastname":""}}' \
https://moneybird.com/api/v2/123/contacts/416087496837826202.json
Response
Status: 422 Unprocessable Entity
{
"error": {
"firstname": [
"is required"
],
"lastname": [
"is required"
],
"company_name": [
"is required"
]
}
}
Example: returns a 404 status when the contact is not found
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPATCH \
-d '{"contact":{"company_name":"Test B.V."}}' \
https://moneybird.com/api/v2/123/contacts/1564321.json
Response
Status: 404 Not Found
{
"error": "record not found",
"symbolic": {
"id": "not_found"
}
}
Example: updates a contact with given SI identifier
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPATCH \
-d '{"contact":{"si_identifier":"1234567","si_identifier_type":"NL:KVK"}}' \
https://moneybird.com/api/v2/123/contacts/416087497139816118.json
Response
Status: 200 OK
{
"id": "416087497139816118",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": null,
"lastname": "Appleseed",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234 AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "1",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "1234567",
"si_identifier_type": "NL:KVK",
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:39:41.120Z",
"updated_at": "2024-03-21T14:39:41.245Z",
"version": 1711031981,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/5ece96278775f005f20406fff8f1b792df4a4c3ffb7869ac2acffc4115b688bb/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
{
"id": "416087497147156152",
"contact_id": "416087497139816118",
"administration_id": 123,
"firstname": "John",
"lastname": "Appleseed",
"phone": null,
"email": null,
"department": null,
"created_at": "2024-03-21T14:39:41.127Z",
"updated_at": "2024-03-21T14:39:41.127Z",
"version": 1711031981
},
{
"id": "416087497287665349",
"contact_id": "416087497139816118",
"administration_id": 123,
"firstname": null,
"lastname": "Appleseed",
"phone": null,
"email": null,
"department": null,
"created_at": "2024-03-21T14:39:41.261Z",
"updated_at": "2024-03-21T14:39:41.261Z",
"version": 1711031981
}
],
"archived": false,
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "contact_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:39:41.137Z",
"updated_at": "2024-03-21T14:39:41.137Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "contact_changed",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"changes": {
"si_identifier": [
"",
"1234567"
]
}
},
"created_at": "2024-03-21T14:39:41.248Z",
"updated_at": "2024-03-21T14:39:41.248Z"
}
]
}
Example: creates a contact person when company name, firstname and lastname exist together
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPATCH \
-d '{"contact":{"firstname":"Money","lastname":"Bird"}}' \
https://moneybird.com/api/v2/123/contacts/416087497577072362.json
Response
Status: 200 OK
{
"id": "416087497577072362",
"administration_id": 123,
"company_name": "Moneybird B.V.",
"firstname": "Money",
"lastname": "Bird",
"address1": null,
"address2": null,
"zipcode": null,
"city": null,
"country": "NL",
"phone": null,
"delivery_method": "Email",
"customer_id": "0d501d4778e54489ec8c8bd0c8c9f85e7cc715518da50bcb3cc57d0622763776",
"tax_number": null,
"chamber_of_commerce": null,
"bank_account": null,
"attention": null,
"email": null,
"email_ubl": false,
"send_invoices_to_attention": null,
"send_invoices_to_email": null,
"send_estimates_to_attention": null,
"send_estimates_to_email": null,
"sepa_active": false,
"sepa_iban": null,
"sepa_iban_account_name": null,
"sepa_bic": null,
"sepa_mandate_id": null,
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": null,
"credit_card_reference": null,
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": null,
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:39:41.537Z",
"updated_at": "2024-03-21T14:39:41.577Z",
"version": 1711031981,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/3bdb32b14018f856b6bcbaa09ecdab2edca041486f71b088e45fddf9f7e1b5f1/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
{
"id": "416087497632646894",
"contact_id": "416087497577072362",
"administration_id": 123,
"firstname": "Money",
"lastname": "Bird",
"phone": null,
"email": null,
"department": null,
"created_at": "2024-03-21T14:39:41.590Z",
"updated_at": "2024-03-21T14:39:41.590Z",
"version": 1711031981
}
],
"archived": false,
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "contact_changed",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"changes": {
"firstname": [
null,
"Money"
],
"lastname": [
null,
"Bird"
]
}
},
"created_at": "2024-03-21T14:39:41.580Z",
"updated_at": "2024-03-21T14:39:41.580Z"
}
]
}
Delete a contact
Example: delete a contact
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XDELETE \
-d '{}' \
https://moneybird.com/api/v2/123/contacts/416087497700804338.json
Response
Example: archives the contact when deleting was not possible
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XDELETE \
-d '{}' \
https://moneybird.com/api/v2/123/contacts/416087497923102467.json
Response
Example: returns a 404 status when the contact is not found
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XDELETE \
-d '{}' \
https://moneybird.com/api/v2/123/contacts/1564321.json
Response
Status: 404 Not Found
{
"error": "record not found",
"symbolic": {
"id": "not_found"
}
}
Example: delete a contact
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XDELETE \
-d '{}' \
https://moneybird.com/api/v2/123/contacts/416087499272619905/contact_people/416087499278911363.json
Response
Example: returns a 404 status when the contact is not found
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XDELETE \
-d '{}' \
https://moneybird.com/api/v2/123/contacts/416087499415226257/contact_people/1564321.json
Response
Status: 404 Not Found
{
"error": "record not found",
"symbolic": {
"id": "not_found"
}
}
Create an additional charge to be invoiced at start of next period
At the end of the current period, the additional charges for a contact are merged where possible and an invoice will be created for them. The invoice will be scheduled for sending at the first day of the next month.
Example: creates a usage charge
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPOST \
-d '{"product_id":416087499636475819,"amount":"5 x","price":100.0,"period":"20210601..20210630","description":"Transaction Costs"}' \
https://moneybird.com/api/v2/123/contacts/416087499546298271/additional_charges
Response
Status: 201 Created
{
"id": "416087499692050349",
"administration_id": 123,
"contact_id": "416087499546298271",
"subscription_id": null,
"product_id": "416087499636475819",
"detail_id": null,
"amount": "5 x",
"price": "100.0",
"period": "202106..202106",
"description": "Transaction Costs"
}
Get additional charges
Get the additional charges of the given contact.
Parameters
| Parameter | Type | Description |
|---|---|---|
include_billed |
Boolean |
If true, includes the additional charges that have already been billed. Default is false. |
Example: views additional charges of a contact
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/contacts/416087499738187696/additional_charges?
Response
Status: 200 OK
[
{
"id": "416087499802150845",
"administration_id": 123,
"contact_id": "416087499738187696",
"subscription_id": null,
"product_id": "416087499799005116",
"detail_id": null,
"amount": "1 x",
"price": "100.0",
"period": "202106..202106",
"description": "Transaction Costs"
}
]
Example: does return billed additional charges if include_billed is true
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/contacts/416087500591727625/additional_charges.json?include_billed=true
Response
Status: 200 OK
[
{
"id": "416087500653593622",
"administration_id": 123,
"contact_id": "416087500591727625",
"subscription_id": null,
"product_id": "416087500650447893",
"detail_id": null,
"amount": "1 x",
"price": "100.0",
"period": "202106..202106",
"description": "Transaction Costs"
},
{
"id": "416087500807734315",
"administration_id": 123,
"contact_id": "416087500591727625",
"subscription_id": null,
"product_id": "416087500659885079",
"detail_id": "416087500801442858",
"amount": "1 x",
"price": "100.0",
"period": "202106..202106",
"description": "Transaction Costs"
}
]
Adds note to entity
Parameters
| Parameter | Type | Description |
|---|---|---|
note[note] |
String |
Required. Text for the note or to-do. |
note[todo] |
Boolean |
If |
note[assignee_id] |
Integer |
Assign to-do to user. Should be a valid user id. If assignee_id is provided the note will be a to-do. |
Example: create a note
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPOST \
-d '{"note":{"note":"Text of the note","assignee_id":416087500959777850,"todo":true}}' \
https://moneybird.com/api/v2/123/contacts/416087500896863278/notes.json
Response
Status: 201 Created
{
"id": "416087501017449532",
"administration_id": 123,
"entity_id": "416087500896863278",
"entity_type": "Contact",
"user_id": 17110319469471,
"assignee_id": "416087500959777850",
"todo": true,
"note": "Text of the note",
"completed_at": null,
"completed_by_id": null,
"todo_type": null,
"data": {
},
"created_at": "2024-03-21T14:39:44.817Z",
"updated_at": "2024-03-21T14:39:44.817Z"
}
Destroys note from entity
Example: destroy a note
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XDELETE \
-d '{}' \
https://moneybird.com/api/v2/123/contacts/416087501082461249/notes/416087501150618701.json
Response
Get contact person
Returns all information about a contact person.
Create a new contact person
Creating a new contact person in the administration requires at least a contact_person hash including firstname and lastname.
Parameters
| Parameter | Type | Description |
|---|---|---|
contact_person[firstname] |
String |
|
contact_person[lastname] |
String |
|
contact_person[phone] |
String |
|
contact_person[email] |
String |
Should be a valid email addresses. |
contact_person[department] |
String |
Update a contact person
When updating a contact, you only need to provide the information you want to change. Attributes you don’t provide in the request will not be updated.
Parameters
| Parameter | Type | Description |
|---|---|---|
contact_person[firstname] |
String |
|
contact_person[lastname] |
String |
|
contact_person[phone] |
String |
|
contact_person[email] |
String |
Should be a valid email addresses. |
contact_person[department] |
String |
Delete a contact person
Get Moneybird Payments mandate
Returns information about the stored Moneybird Payments mandate. Only available when Moneybird Payments is enabled for the administration.
Parameters
| Parameter | Type | Description |
|---|---|---|
contact_id |
Integer |
Required Should be a valid contact ID. |
Example: returns information about the stored Moneybird Payments mandate
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/contacts/416087501279593556/moneybird_payments_mandate.json?
Response
Status: 200 OK
{
"type": "idealtestissuer5",
"sepa_mandate": true,
"bank": "Test Issuer 5",
"iban": "NL81TEST0536169128",
"bic": "TESTNL05",
"iban_account_name": "E. Klaassen",
"created_at": "2022-04-07T13:31:09.000Z"
}
Example: returns limited information if mandate exists, but only limited information is available
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/contacts/416087501448414307/moneybird_payments_mandate.json?
Response
Status: 200 OK
{
"type": "mccorporatecredit",
"sepa_mandate": false,
"bank": null,
"iban": null,
"bic": null,
"iban_account_name": null,
"created_at": "2022-04-11T09:17:56.000Z"
}
Example: does return not found when there is no Moneybird Payments mandate found
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/contacts/416087501597312114/moneybird_payments_mandate.json?
Response
Example: does not allow access if Moneybird Payments is disabled for the administration
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/contacts/416087501725238400/moneybird_payments_mandate.json?
Response
Request a new Moneybird Payments mandate
Sends a request for a Moneybird Payments mandate to a contact via e-mail. Your contact will receive an email containing a link to authorise direct debit payments through Moneybird Payments. Your contact is required to make a 15 cent payment. Only available when Moneybird Payments is enabled for the administration.
Parameters
| Parameter | Type | Description |
|---|---|---|
mandate_request[email_message] |
String |
|
mandate_request[identity_id] |
Integer |
Should be a valid identity id. |
Example: requests a new Moneybird Payments mandate
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPOST \
-d '{}' \
https://moneybird.com/api/v2/123/contacts/416087501851067534/moneybird_payments_mandate.json
Response
Example: allows for a custom message within the request e-mail
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPOST \
-d '{"mandate_request":{"email_message":"We use direct debit for our services, for which we require your authorisation. You can authorise us for direct debit through the button below. This requires you to make a one-time payment of 15 cents. This way we can verify your bank account."}}' \
https://moneybird.com/api/v2/123/contacts/416087502009402525/moneybird_payments_mandate.json
Response
Example: does not allow access if Moneybird Payments is disabled for the administration
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPOST \
-d '{}' \
https://moneybird.com/api/v2/123/contacts/416087502162494636/moneybird_payments_mandate.json
Response
Delete a stored Moneybird Payments mandate
Deletes the stored Moneybird Payments mandate for the contact. Only available when Moneybird Payments is enabled for the administration.
Parameters
| Parameter | Type | Description |
|---|---|---|
contact_id |
Integer |
Required Should be a valid contact id. |
Example: destroys the stored Moneybird Payments mandate
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XDELETE \
-d '{}' \
https://moneybird.com/api/v2/123/contacts/416087502340752570/moneybird_payments_mandate.json
Response
Example: does not allow access if Moneybird Payments is disabled for the administration
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XDELETE \
-d '{}' \
https://moneybird.com/api/v2/123/contacts/416087502511670474/moneybird_payments_mandate.json