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_name
  • attention
  • firstname
  • lastname
  • address1
  • address2
  • zipcode
  • city
  • country
  • email
  • phone
  • customer_id
  • tax_number
  • chamber_of_commerce
  • bank_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": "407012459837130694",
    "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": "2023-12-12T10:35:51.120Z",
    "updated_at": "2023-12-12T10:35:51.120Z",
    "version": 1702377351,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/ed73c4c42b1a85c2e3397a1161bdeb8d5eaedee53cb46e08740cbf7b37a01f4c/all",
    "notes": [

    ],
    "custom_fields": [

    ],
    "contact_people": [

    ],
    "archived": false,
    "events": [
      {
        "administration_id": 123,
        "user_id": 17023773225870,
        "action": "contact_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {
        },
        "created_at": "2023-12-12T10:35:51.124Z",
        "updated_at": "2023-12-12T10:35:51.124Z"
      }
    ]
  },
  {
    "id": "407012459766876089",
    "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": "2023-12-12T10:35:51.053Z",
    "updated_at": "2023-12-12T10:35:51.084Z",
    "version": 1702377351,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/913a6d706943b2abf4f1d77bed045fe06a3dfa69e3f564de7296f7a5ad8cb2d5/all",
    "notes": [

    ],
    "custom_fields": [

    ],
    "contact_people": [
      {
        "id": "407012459775264699",
        "contact_id": "407012459766876089",
        "administration_id": 123,
        "firstname": "John",
        "lastname": "Appleseed",
        "phone": null,
        "email": null,
        "department": null,
        "created_at": "2023-12-12T10:35:51.059Z",
        "updated_at": "2023-12-12T10:35:51.059Z",
        "version": 1702377351
      },
      {
        "id": "407012459848665033",
        "contact_id": "407012459766876089",
        "administration_id": 123,
        "firstname": "Jan",
        "lastname": "Janssen",
        "phone": "123-456-2346",
        "email": "janjanssen@dev.null.moneybird.net",
        "department": "Sales",
        "created_at": "2023-12-12T10:35:51.131Z",
        "updated_at": "2023-12-12T10:35:51.131Z",
        "version": 1702377351
      },
      {
        "id": "407012459851810763",
        "contact_id": "407012459766876089",
        "administration_id": 123,
        "firstname": "Foo",
        "lastname": "Bar",
        "phone": "123-456-2346",
        "email": "janjanssen@dev.null.moneybird.net",
        "department": "Sales",
        "created_at": "2023-12-12T10:35:51.134Z",
        "updated_at": "2023-12-12T10:35:51.134Z",
        "version": 1702377351
      }
    ],
    "archived": false,
    "events": [
      {
        "administration_id": 123,
        "user_id": 17023773225870,
        "action": "contact_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {
        },
        "created_at": "2023-12-12T10:35:51.075Z",
        "updated_at": "2023-12-12T10:35:51.075Z"
      }
    ]
  },
  {
    "id": "407012459810916288",
    "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": "2023-12-12T10:35:51.095Z",
    "updated_at": "2023-12-12T10:35:51.095Z",
    "version": 1702377351,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/5966967d89dab78b24cc6b4d610868da4031b30a09fec97b7e9053966075b781/all",
    "notes": [

    ],
    "custom_fields": [

    ],
    "contact_people": [
      {
        "id": "407012459816159170",
        "contact_id": "407012459810916288",
        "administration_id": 123,
        "firstname": "John",
        "lastname": "Doe",
        "phone": null,
        "email": null,
        "department": null,
        "created_at": "2023-12-12T10:35:51.100Z",
        "updated_at": "2023-12-12T10:35:51.100Z",
        "version": 1702377351
      }
    ],
    "archived": false,
    "events": [
      {
        "administration_id": 123,
        "user_id": 17023773225870,
        "action": "contact_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {
        },
        "created_at": "2023-12-12T10:35:51.107Z",
        "updated_at": "2023-12-12T10:35:51.107Z"
      }
    ]
  }
]
      

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": "407012462778386382",
    "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": "2023-12-12T10:35:53.926Z",
    "updated_at": "2023-12-12T10:35:54.096Z",
    "version": 1702377354,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/d07a1d9987f1baca798c2860983b1d2d00a3595cac90348b3f3e59328aa18d78/all",
    "notes": [

    ],
    "custom_fields": [

    ],
    "contact_people": [
      {
        "id": "407012462782580688",
        "contact_id": "407012462778386382",
        "administration_id": 123,
        "firstname": "John",
        "lastname": "Appleseed",
        "phone": null,
        "email": null,
        "department": null,
        "created_at": "2023-12-12T10:35:53.930Z",
        "updated_at": "2023-12-12T10:35:53.930Z",
        "version": 1702377353
      },
      {
        "id": "407012463202011102",
        "contact_id": "407012462778386382",
        "administration_id": 123,
        "firstname": "Jan",
        "lastname": "Janssen",
        "phone": "123-456-2346",
        "email": "janjanssen@dev.null.moneybird.net",
        "department": "Sales",
        "created_at": "2023-12-12T10:35:54.328Z",
        "updated_at": "2023-12-12T10:35:54.328Z",
        "version": 1702377354
      },
      {
        "id": "407012463205156832",
        "contact_id": "407012462778386382",
        "administration_id": 123,
        "firstname": "Foo",
        "lastname": "Bar",
        "phone": "123-456-2346",
        "email": "janjanssen@dev.null.moneybird.net",
        "department": "Sales",
        "created_at": "2023-12-12T10:35:54.333Z",
        "updated_at": "2023-12-12T10:35:54.333Z",
        "version": 1702377354
      }
    ],
    "archived": false,
    "events": [
      {
        "administration_id": 123,
        "user_id": 17023773225870,
        "action": "contact_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {
        },
        "created_at": "2023-12-12T10:35:54.069Z",
        "updated_at": "2023-12-12T10:35:54.069Z"
      }
    ]
  }
]
      

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

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

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": "407012468284458010",
    "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": "2023-12-12T10:35:59.177Z",
    "updated_at": "2023-12-12T10:35:59.177Z",
    "version": 1702377359,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/eb140b47316365cf5ee3b889f803252dceeaf836c2444cf5a59d742134010ead/all",
    "notes": [

    ],
    "custom_fields": [

    ],
    "contact_people": [

    ],
    "archived": false,
    "events": [
      {
        "administration_id": 123,
        "user_id": 17023773225870,
        "action": "contact_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {
        },
        "created_at": "2023-12-12T10:35:59.180Z",
        "updated_at": "2023-12-12T10:35:59.180Z"
      }
    ]
  }
]
      

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": "407012468379878434",
    "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": "2023-12-12T10:35:59.268Z",
    "updated_at": "2023-12-12T10:35:59.288Z",
    "version": 1702377359,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/712e5d793d18d415d507e77e6c91265b41045c7ed6495936988a2ee06b50e0fb/all",
    "notes": [

    ],
    "custom_fields": [

    ],
    "contact_people": [
      {
        "id": "407012468384072740",
        "contact_id": "407012468379878434",
        "administration_id": 123,
        "firstname": "John",
        "lastname": "Appleseed",
        "phone": null,
        "email": null,
        "department": null,
        "created_at": "2023-12-12T10:35:59.272Z",
        "updated_at": "2023-12-12T10:35:59.272Z",
        "version": 1702377359
      },
      {
        "id": "407012468437550130",
        "contact_id": "407012468379878434",
        "administration_id": 123,
        "firstname": "Jan",
        "lastname": "Janssen",
        "phone": "123-456-2346",
        "email": "janjanssen@dev.null.moneybird.net",
        "department": "Sales",
        "created_at": "2023-12-12T10:35:59.323Z",
        "updated_at": "2023-12-12T10:35:59.323Z",
        "version": 1702377359
      },
      {
        "id": "407012468439647284",
        "contact_id": "407012468379878434",
        "administration_id": 123,
        "firstname": "Foo",
        "lastname": "Bar",
        "phone": "123-456-2346",
        "email": "janjanssen@dev.null.moneybird.net",
        "department": "Sales",
        "created_at": "2023-12-12T10:35:59.325Z",
        "updated_at": "2023-12-12T10:35:59.325Z",
        "version": 1702377359
      }
    ],
    "archived": false,
    "events": [
      {
        "administration_id": 123,
        "user_id": 17023773225870,
        "action": "contact_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {
        },
        "created_at": "2023-12-12T10:35:59.280Z",
        "updated_at": "2023-12-12T10:35:59.280Z"
      }
    ]
  }
]
      

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%3A2023-12-11+10%3A35%3A59+UTC
    

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "407012468830766186",
    "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": "2023-12-12T10:35:59.698Z",
    "updated_at": "2023-12-12T10:35:59.698Z",
    "version": 1702377359,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/f3abb5ad1dfedde440ed9417e00cae67dd5c11f260a0e480630abcd5aeeca17c/all",
    "notes": [

    ],
    "custom_fields": [

    ],
    "contact_people": [

    ],
    "archived": false,
    "events": [
      {
        "administration_id": 123,
        "user_id": 17023773225870,
        "action": "contact_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {
        },
        "created_at": "2023-12-12T10:35:59.701Z",
        "updated_at": "2023-12-12T10:35:59.701Z"
      }
    ]
  },
  {
    "id": "407012468780434525",
    "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": "2023-12-12T10:35:59.650Z",
    "updated_at": "2023-12-12T10:35:59.670Z",
    "version": 1702377359,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/e4c033b50442ff582494c7be65ddb96fa5f0c1a9adc9462f642eba7bcefb6906/all",
    "notes": [

    ],
    "custom_fields": [

    ],
    "contact_people": [
      {
        "id": "407012468784628831",
        "contact_id": "407012468780434525",
        "administration_id": 123,
        "firstname": "John",
        "lastname": "Appleseed",
        "phone": null,
        "email": null,
        "department": null,
        "created_at": "2023-12-12T10:35:59.654Z",
        "updated_at": "2023-12-12T10:35:59.654Z",
        "version": 1702377359
      }
    ],
    "archived": false,
    "events": [
      {
        "administration_id": 123,
        "user_id": 17023773225870,
        "action": "contact_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {
        },
        "created_at": "2023-12-12T10:35:59.663Z",
        "updated_at": "2023-12-12T10:35:59.663Z"
      }
    ]
  },
  {
    "id": "407012468809794660",
    "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": "2023-12-12T10:35:59.677Z",
    "updated_at": "2023-12-12T10:35:59.677Z",
    "version": 1702377359,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/350ebc7cd1de3b6db5372149ce2bba69eb4697fad3e2dcc5b5391d0ca39f37d7/all",
    "notes": [

    ],
    "custom_fields": [

    ],
    "contact_people": [
      {
        "id": "407012468813988966",
        "contact_id": "407012468809794660",
        "administration_id": 123,
        "firstname": "John",
        "lastname": "Doe",
        "phone": null,
        "email": null,
        "department": null,
        "created_at": "2023-12-12T10:35:59.682Z",
        "updated_at": "2023-12-12T10:35:59.682Z",
        "version": 1702377359
      }
    ],
    "archived": false,
    "events": [
      {
        "administration_id": 123,
        "user_id": 17023773225870,
        "action": "contact_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {
        },
        "created_at": "2023-12-12T10:35:59.688Z",
        "updated_at": "2023-12-12T10:35:59.688Z"
      }
    ]
  }
]
      

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%3A2023-12-12+10%3A36%3A04+UTC
    

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "407012469039432831",
    "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": "2023-12-12T10:35:59.897Z",
    "updated_at": "2023-12-12T10:37:04.955Z",
    "version": 1702377424,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/f1a437b90cfd09271c9c4114becb2a454efdb2c559de3b07e6756c385b1770e0/all",
    "notes": [

    ],
    "custom_fields": [

    ],
    "contact_people": [
      {
        "id": "407012469043627137",
        "contact_id": "407012469039432831",
        "administration_id": 123,
        "firstname": "John",
        "lastname": "Appleseed",
        "phone": null,
        "email": null,
        "department": null,
        "created_at": "2023-12-12T10:35:59.902Z",
        "updated_at": "2023-12-12T10:35:59.902Z",
        "version": 1702377359
      }
    ],
    "archived": false,
    "events": [
      {
        "administration_id": 123,
        "user_id": 17023773225870,
        "action": "contact_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {
        },
        "created_at": "2023-12-12T10:35:59.910Z",
        "updated_at": "2023-12-12T10:35:59.910Z"
      }
    ]
  }
]
      

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": "407012469281653921",
    "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": "c05bba90335f3a3392c43ed48e2cc4bcdb29eecec263adcb81d371d7667a1360",
    "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": "2023-12-12T10:36:00.128Z",
    "updated_at": "2023-12-12T10:36:00.132Z",
    "version": 1702377360,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/1202f5a93db0e40c719859e0ebd1e13702cc5fff48dc6edd8f460893df035057/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": "407012470116320492",
    "version": 1702377360
  },
  {
    "id": "407012470148826355",
    "version": 1702377360
  }
]
      

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": "407012470308209927",
    "version": 1702377361
  }
]
      

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":[407012470450816280,407012470488565025]}' \
  https://moneybird.com/api/v2/123/contacts/synchronization.json
    

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "407012470450816280",
    "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": "2023-12-12T10:36:01.243Z",
    "updated_at": "2023-12-12T10:36:01.243Z",
    "version": 1702377361,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/6596ada2503c816ea17e575b40aa1eccba90ae24c7af7d1606c02cd76c29a587/all",
    "notes": [

    ],
    "custom_fields": [

    ],
    "contact_people": [
      {
        "id": "407012470456059162",
        "contact_id": "407012470450816280",
        "administration_id": 123,
        "firstname": "John",
        "lastname": "Appleseed",
        "phone": null,
        "email": null,
        "department": null,
        "created_at": "2023-12-12T10:36:01.248Z",
        "updated_at": "2023-12-12T10:36:01.248Z",
        "version": 1702377361
      }
    ],
    "archived": false,
    "events": [
      {
        "administration_id": 123,
        "user_id": 17023773225870,
        "action": "contact_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {
        },
        "created_at": "2023-12-12T10:36:01.254Z",
        "updated_at": "2023-12-12T10:36:01.254Z"
      }
    ]
  },
  {
    "id": "407012470488565025",
    "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": "2023-12-12T10:36:01.279Z",
    "updated_at": "2023-12-12T10:36:01.279Z",
    "version": 1702377361,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/261fb6f4a10544237ca65f157d41e439d76d73b8399eb844656f1c267475b9f7/all",
    "notes": [

    ],
    "custom_fields": [

    ],
    "contact_people": [
      {
        "id": "407012470493807907",
        "contact_id": "407012470488565025",
        "administration_id": 123,
        "firstname": "Mark",
        "lastname": "van Vliet",
        "phone": null,
        "email": null,
        "department": null,
        "created_at": "2023-12-12T10:36:01.285Z",
        "updated_at": "2023-12-12T10:36:01.285Z",
        "version": 1702377361
      }
    ],
    "archived": false,
    "events": [
      {
        "administration_id": 123,
        "user_id": 17023773225870,
        "action": "contact_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {
        },
        "created_at": "2023-12-12T10:36:01.292Z",
        "updated_at": "2023-12-12T10:36:01.292Z"
      }
    ]
  }
]
      

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

Response

        
          
          Status: 200 OK
        
      
{
  "id": "407012469372880037",
  "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": "2023-12-12T10:36:00.215Z",
  "updated_at": "2023-12-12T10:36:00.246Z",
  "version": 1702377360,
  "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/23100b5288651bdd5071de7084052db3c83c14a57f34ce501277da548a3ac3ef/all",
  "notes": [

  ],
  "custom_fields": [

  ],
  "contact_people": [
    {
      "id": "407012469378122919",
      "contact_id": "407012469372880037",
      "administration_id": 123,
      "firstname": "John",
      "lastname": "Appleseed",
      "phone": null,
      "email": null,
      "department": null,
      "created_at": "2023-12-12T10:36:00.220Z",
      "updated_at": "2023-12-12T10:36:00.220Z",
      "version": 1702377360
    }
  ],
  "archived": false,
  "events": [
    {
      "administration_id": 123,
      "user_id": 17023773225870,
      "action": "contact_created",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
      },
      "created_at": "2023-12-12T10:36:00.238Z",
      "updated_at": "2023-12-12T10:36:00.238Z"
    }
  ]
}
      

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

Response

        
          
          Status: 200 OK
        
      
{
  "id": "407012469534360755",
  "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": "2023-12-12T10:36:00.369Z",
  "updated_at": "2023-12-12T10:36:00.418Z",
  "version": 1702377360,
  "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/f9c32497f9970ce211c979075d2a76ea7c476d6382b03a4df9fa49d0fa05e611/all",
  "notes": [

  ],
  "custom_fields": [

  ],
  "contact_people": [
    {
      "id": "407012469539603637",
      "contact_id": "407012469534360755",
      "administration_id": 123,
      "firstname": "John",
      "lastname": "Appleseed",
      "phone": null,
      "email": null,
      "department": null,
      "created_at": "2023-12-12T10:36:00.374Z",
      "updated_at": "2023-12-12T10:36:00.374Z",
      "version": 1702377360
    }
  ],
  "archived": false,
  "events": [
    {
      "administration_id": 123,
      "user_id": 17023773225870,
      "action": "contact_created",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
      },
      "created_at": "2023-12-12T10:36:00.383Z",
      "updated_at": "2023-12-12T10:36:00.383Z"
    }
  ]
}
      

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": "407012469826913488",
  "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": "2023-12-12T10:36:00.648Z",
  "updated_at": "2023-12-12T10:36:00.671Z",
  "version": 1702377360,
  "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/846e9da72e46656f0ce6d7f0536aa4e19fb37ff19808ff28f23aa18f8fe8ddad/all",
  "notes": [

  ],
  "custom_fields": [

  ],
  "contact_people": [
    {
      "id": "407012469832156370",
      "contact_id": "407012469826913488",
      "administration_id": 123,
      "firstname": "John",
      "lastname": "Appleseed",
      "phone": null,
      "email": null,
      "department": null,
      "created_at": "2023-12-12T10:36:00.654Z",
      "updated_at": "2023-12-12T10:36:00.654Z",
      "version": 1702377360
    }
  ],
  "archived": false,
  "events": [
    {
      "administration_id": 123,
      "user_id": 17023773225870,
      "action": "contact_created",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
      },
      "created_at": "2023-12-12T10:36:00.663Z",
      "updated_at": "2023-12-12T10:36:00.663Z"
    }
  ]
}
      

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 company_name, firstname or lastname.

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 Email, Simplerinvoicing or Manual.

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 company_name, firstname or lastname.

contact[lastname] String

A contact requires a non-blank company_name, firstname or lastname.

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 true, all other SEPA fields are required.

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 RCUR, FRST, OOFF or FNAL.

contact[si_identifier_type] String

Can be 0002, 0007, 0009, 0037, 0060, 0088, 0096, 0097, 0106, 0130, 0135, 0142, 0151, 0183, 0184, 0190, 0191, 0192, 0193, 0195, 0196, 0198, 0199, 0200, 0201, 0202, 0204, 0208, 0209, 9901, 9902, 9904, 9905, 9906, 9907, 9908, 9909, 9910, 9912, 9913, 9914, 9915, 9917, 9918, 9919, 9920, 9921, 9922, 9923, 9924, 9925, 9926, 9927, 9928, 9929, 9930, 9931, 9932, 9933, 9934, 9935, 9936, 9937, 9938, 9939, 9940, 9941, 9942, 9943, 9944, 9945, 9946, 9947, 9948, 9949, 9950, 9951, 9952, 9953, 9954, 9955, 9956, 9957 or 9958.

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": "407012470696183093",
  "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": "2023-12-12T10:36:01.477Z",
  "updated_at": "2023-12-12T10:36:01.477Z",
  "version": 1702377361,
  "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/ce15f0dd41d32488aab2515bd4300ab8ad36301f31fb464f9abcc590059ec8c5/all",
  "notes": [

  ],
  "custom_fields": [

  ],
  "contact_people": [

  ],
  "archived": false,
  "events": [
    {
      "administration_id": 123,
      "user_id": 17023773225870,
      "action": "contact_created",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
      },
      "created_at": "2023-12-12T10:36:01.481Z",
      "updated_at": "2023-12-12T10:36:01.481Z"
    }
  ]
}
      

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":407012470822012231,"value":"Field value"}}}}' \
  https://moneybird.com/api/v2/123/contacts.json
    

Response

        
          
          Status: 201 Created
        
      
{
  "id": "407012470862906697",
  "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": "2023-12-12T10:36:01.636Z",
  "updated_at": "2023-12-12T10:36:01.636Z",
  "version": 1702377361,
  "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/c78c4ac37772ec5ca678d07ec08cdb000b0c2ae4b0414958c2e03ae653272b4e/all",
  "notes": [

  ],
  "custom_fields": [
    {
      "id": "407012470822012231",
      "name": "Number",
      "value": "Field value"
    }
  ],
  "contact_people": [

  ],
  "archived": false,
  "events": [
    {
      "administration_id": 123,
      "user_id": 17023773225870,
      "action": "contact_created",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
      },
      "created_at": "2023-12-12T10:36:01.640Z",
      "updated_at": "2023-12-12T10:36:01.640Z"
    }
  ]
}
      

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": "407012471420749188",
  "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.039Z",
  "updated_at": "2017-06-30T23:30:00.039Z",
  "version": 1498865400,
  "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/c5f403ee0e3880fcf2a2cbaf5fef797546456067f7c123767f2d14d3a2795f1d/all",
  "notes": [

  ],
  "custom_fields": [

  ],
  "contact_people": [

  ],
  "archived": false,
  "events": [
    {
      "administration_id": 123,
      "user_id": 17023773225870,
      "action": "contact_created",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
      },
      "created_at": "2017-06-30T23:30:00.043Z",
      "updated_at": "2017-06-30T23:30:00.043Z"
    }
  ]
}
      

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": "407012471729030563",
  "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": "2023-12-12T10:36:02.462Z",
  "updated_at": "2023-12-12T10:36:02.462Z",
  "version": 1702377362,
  "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/22b50603b8f98f1281bf57b5144bc3ee1c1603e9340cf3c37942a4d43729bf02/all",
  "notes": [

  ],
  "custom_fields": [

  ],
  "contact_people": [

  ],
  "archived": false,
  "events": [
    {
      "administration_id": 123,
      "user_id": 17023773225870,
      "action": "contact_created",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
      },
      "created_at": "2023-12-12T10:36:02.466Z",
      "updated_at": "2023-12-12T10:36:02.466Z"
    }
  ]
}
      

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 company_name, firstname or lastname.

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 Email, Simplerinvoicing or Manual.

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 company_name, firstname or lastname.

contact[lastname] String

A contact requires a non-blank company_name, firstname or lastname.

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 true, all other SEPA fields are required.

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 RCUR, FRST, OOFF or FNAL.

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 0002, 0007, 0009, 0037, 0060, 0088, 0096, 0097, 0106, 0130, 0135, 0142, 0151, 0183, 0184, 0190, 0191, 0192, 0193, 0195, 0196, 0198, 0199, 0200, 0201, 0202, 0204, 0208, 0209, 9901, 9902, 9904, 9905, 9906, 9907, 9908, 9909, 9910, 9912, 9913, 9914, 9915, 9917, 9918, 9919, 9920, 9921, 9922, 9923, 9924, 9925, 9926, 9927, 9928, 9929, 9930, 9931, 9932, 9933, 9934, 9935, 9936, 9937, 9938, 9939, 9940, 9941, 9942, 9943, 9944, 9945, 9946, 9947, 9948, 9949, 9950, 9951, 9952, 9953, 9954, 9955, 9956, 9957 or 9958.

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

Response

        
          
          Status: 200 OK
        
      
{
  "id": "407012471781459367",
  "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": "2023-12-12T10:36:02.512Z",
  "updated_at": "2023-12-12T10:36:02.588Z",
  "version": 1702377362,
  "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/6d72533ad8f1b4c1c341afa48d3821fe1a9ee560d005e33d4dc79052c69d5c50/all",
  "notes": [

  ],
  "custom_fields": [

  ],
  "contact_people": [
    {
      "id": "407012471786702249",
      "contact_id": "407012471781459367",
      "administration_id": 123,
      "firstname": "John",
      "lastname": "Appleseed",
      "phone": null,
      "email": null,
      "department": null,
      "created_at": "2023-12-12T10:36:02.517Z",
      "updated_at": "2023-12-12T10:36:02.517Z",
      "version": 1702377362
    },
    {
      "id": "407012471875831222",
      "contact_id": "407012471781459367",
      "administration_id": 123,
      "firstname": null,
      "lastname": "Appleseed",
      "phone": null,
      "email": null,
      "department": null,
      "created_at": "2023-12-12T10:36:02.602Z",
      "updated_at": "2023-12-12T10:36:02.602Z",
      "version": 1702377362
    }
  ],
  "archived": false,
  "events": [
    {
      "administration_id": 123,
      "user_id": 17023773225870,
      "action": "contact_created",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
      },
      "created_at": "2023-12-12T10:36:02.526Z",
      "updated_at": "2023-12-12T10:36:02.526Z"
    },
    {
      "administration_id": 123,
      "user_id": 17023773225870,
      "action": "contact_changed",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
        "changes": {
          "company_name": [
            "Foobar Holding B.V.",
            "Test B.V."
          ]
        }
      },
      "created_at": "2023-12-12T10:36:02.591Z",
      "updated_at": "2023-12-12T10:36:02.591Z"
    }
  ]
}
      

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

Response

        
          
          Status: 200 OK
        
      
{
  "id": "407012471959717313",
  "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": "2023-12-12T10:36:02.683Z",
  "updated_at": "2023-12-12T10:36:02.728Z",
  "version": 1702377362,
  "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/24d7c99015367b4985702d1bea7e57127759cd01bd01e1cd0127f87e03da17d4/all",
  "notes": [

  ],
  "custom_fields": [

  ],
  "contact_people": [
    {
      "id": "407012471963911619",
      "contact_id": "407012471959717313",
      "administration_id": 123,
      "firstname": "John",
      "lastname": "Doe",
      "phone": null,
      "email": null,
      "department": null,
      "created_at": "2023-12-12T10:36:02.687Z",
      "updated_at": "2023-12-12T10:36:02.687Z",
      "version": 1702377362
    }
  ],
  "archived": false,
  "events": [
    {
      "administration_id": 123,
      "user_id": 17023773225870,
      "action": "contact_created",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
      },
      "created_at": "2023-12-12T10:36:02.692Z",
      "updated_at": "2023-12-12T10:36:02.692Z"
    },
    {
      "administration_id": 123,
      "user_id": 17023773225870,
      "action": "contact_changed",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
        "changes": {
          "company_name": [
            "Foobar Holding B.V.",
            "Test B.V."
          ]
        }
      },
      "created_at": "2023-12-12T10:36:02.731Z",
      "updated_at": "2023-12-12T10:36:02.731Z"
    }
  ]
}
      

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

Response

        
          
          Status: 200 OK
        
      
{
  "id": "407012472099177937",
  "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": "2023-12-12T10:36:02.816Z",
  "updated_at": "2023-12-12T10:36:02.865Z",
  "version": 1702377362,
  "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/665f1ac8f355939ddfc486ef444893ea88ab2659ef2f6488a8556f9eb5c899cd/all",
  "notes": [

  ],
  "custom_fields": [

  ],
  "contact_people": [
    {
      "id": "407012472104420819",
      "contact_id": "407012472099177937",
      "administration_id": 123,
      "firstname": "John",
      "lastname": "Doe",
      "phone": null,
      "email": null,
      "department": null,
      "created_at": "2023-12-12T10:36:02.821Z",
      "updated_at": "2023-12-12T10:36:02.821Z",
      "version": 1702377362
    }
  ],
  "archived": false,
  "events": [
    {
      "administration_id": 123,
      "user_id": 17023773225870,
      "action": "contact_created",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
      },
      "created_at": "2023-12-12T10:36:02.827Z",
      "updated_at": "2023-12-12T10:36:02.827Z"
    },
    {
      "administration_id": 123,
      "user_id": 17023773225870,
      "action": "contact_changed",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
        "changes": {
          "sepa_sequence_type": [
            "RCUR",
            "FNAL"
          ]
        }
      },
      "created_at": "2023-12-12T10:36:02.868Z",
      "updated_at": "2023-12-12T10:36:02.868Z"
    }
  ]
}
      

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/407012472210327002.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/407012472450450934.json
    

Response

        
          
          Status: 200 OK
        
      
{
  "id": "407012472450450934",
  "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": "2023-12-12T10:36:03.150Z",
  "updated_at": "2023-12-12T10:36:03.230Z",
  "version": 1702377363,
  "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/5aa1776b8d8a686ce1a6c7d0f5ca4cdcce6f16e1245a4b246860fd1fae3e29e2/all",
  "notes": [

  ],
  "custom_fields": [

  ],
  "contact_people": [
    {
      "id": "407012472454645240",
      "contact_id": "407012472450450934",
      "administration_id": 123,
      "firstname": "John",
      "lastname": "Appleseed",
      "phone": null,
      "email": null,
      "department": null,
      "created_at": "2023-12-12T10:36:03.155Z",
      "updated_at": "2023-12-12T10:36:03.155Z",
      "version": 1702377363
    },
    {
      "id": "407012472545871365",
      "contact_id": "407012472450450934",
      "administration_id": 123,
      "firstname": null,
      "lastname": "Appleseed",
      "phone": null,
      "email": null,
      "department": null,
      "created_at": "2023-12-12T10:36:03.241Z",
      "updated_at": "2023-12-12T10:36:03.241Z",
      "version": 1702377363
    }
  ],
  "archived": false,
  "events": [
    {
      "administration_id": 123,
      "user_id": 17023773225870,
      "action": "contact_created",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
      },
      "created_at": "2023-12-12T10:36:03.164Z",
      "updated_at": "2023-12-12T10:36:03.164Z"
    },
    {
      "administration_id": 123,
      "user_id": 17023773225870,
      "action": "contact_changed",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
        "changes": {
          "si_identifier": [
            "",
            "1234567"
          ]
        }
      },
      "created_at": "2023-12-12T10:36:03.232Z",
      "updated_at": "2023-12-12T10:36:03.232Z"
    }
  ]
}
      

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

Response

        
          
          Status: 200 OK
        
      
{
  "id": "407012472820598314",
  "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": "ca08600e2145fd02ec5708ee4438890b6d09e6f62b6721f6f56818b08de36a0c",
  "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": "2023-12-12T10:36:03.503Z",
  "updated_at": "2023-12-12T10:36:03.546Z",
  "version": 1702377363,
  "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/ba19f5a7ff25a0f7c33b2369491f2a94bc1198858f8d028f188ee5f2d5e21b56/all",
  "notes": [

  ],
  "custom_fields": [

  ],
  "contact_people": [
    {
      "id": "407012472884561454",
      "contact_id": "407012472820598314",
      "administration_id": 123,
      "firstname": "Money",
      "lastname": "Bird",
      "phone": null,
      "email": null,
      "department": null,
      "created_at": "2023-12-12T10:36:03.564Z",
      "updated_at": "2023-12-12T10:36:03.564Z",
      "version": 1702377363
    }
  ],
  "archived": false,
  "events": [
    {
      "administration_id": 123,
      "user_id": 17023773225870,
      "action": "contact_changed",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
        "changes": {
          "firstname": [
            null,
            "Money"
          ],
          "lastname": [
            null,
            "Bird"
          ]
        }
      },
      "created_at": "2023-12-12T10:36:03.555Z",
      "updated_at": "2023-12-12T10:36:03.555Z"
    }
  ]
}
      

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/407012472939087410.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/407012473145656899.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/407012474323207873/contact_people/407012474328450755.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/407012474455328465/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":407012474654557931,"amount":"5 x","price":100.0,"period":"20210601..20210630","description":"Transaction Costs"}' \
  https://moneybird.com/api/v2/123/contacts/407012474585351903/additional_charges
    

Response

        
          
          Status: 201 Created
        
      
{
  "id": "407012474708035309",
  "administration_id": 123,
  "contact_id": "407012474585351903",
  "subscription_id": null,
  "product_id": "407012474654557931",
  "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/407012474748929776/additional_charges?
    

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "407012474800310013",
    "administration_id": 123,
    "contact_id": "407012474748929776",
    "subscription_id": null,
    "product_id": "407012474798212860",
    "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/407012475379124041/additional_charges.json?include_billed=true
    

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "407012475434698582",
    "administration_id": 123,
    "contact_id": "407012475379124041",
    "subscription_id": null,
    "product_id": "407012475432601429",
    "detail_id": null,
    "amount": "1 x",
    "price": "100.0",
    "period": "202106..202106",
    "description": "Transaction Costs"
  },
  {
    "id": "407012475563673451",
    "administration_id": 123,
    "contact_id": "407012475379124041",
    "subscription_id": null,
    "product_id": "407012475438892887",
    "detail_id": "407012475558430570",
    "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 true the note is a to-do.

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":407012475692648314,"todo":true}}' \
  https://moneybird.com/api/v2/123/contacts/407012475642316654/notes.json
    

Response

        
          
          Status: 201 Created
        
      
{
  "id": "407012475735639932",
  "administration_id": 123,
  "entity_id": "407012475642316654",
  "entity_type": "Contact",
  "user_id": 17023773225870,
  "assignee_id": "407012475692648314",
  "todo": true,
  "note": "Text of the note",
  "completed_at": null,
  "completed_by_id": null,
  "todo_type": null,
  "data": {
  },
  "created_at": "2023-12-12T10:36:06.283Z",
  "updated_at": "2023-12-12T10:36:06.283Z"
}
      

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/407012475820574593/notes/407012475870906253.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/407012475998832532/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/407012476172896163/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/407012476306065330/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/407012476421408704/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/407012476536752078/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/407012476683552733/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/407012476815673324/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/407012476943599610/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/407012477076767754/moneybird_payments_mandate.json
    

Response