Moneybird logo
Moneybird API

Contacts

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

Contacts are the entities in Moneybird that represent your customers, suppliers or other business relations. Use the following endpoints to get information about contacts, create new contacts or update existing contacts.


Get contact by customer id

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

Returns all information about a contact by the given customer id

Get contact by customer idpath Parameters

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

    The unique identifier of the administration

    A unique record identifier of an administration

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

    A unique record identifier

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

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

    Default: .json

Get contact by customer id Responses

A contact

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

    A unique record identifier

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

    A unique record identifier of an administration

  • company_name
  • firstnamestring | null
  • lastnamestring | null
  • address1string | null
  • address2string | null
  • zipcodestring | null
  • citystring | null
  • countrystring
  • phonestring | null
  • delivery_methodstring | null · enum
    Enum values:
    Email
    Post
    Manual
    Simplerinvoicing
    Peppol
  • customer_idstring

    Will be assigned automatically if empty

  • tax_numberstring | null
  • chamber_of_commercestring | null
  • bank_accountstring | null

    The SEPA IBAN of the contact, can be empty if no SEPA IBAN is set

  • is_trustedboolean
    Default: default
  • max_transfer_amountnumber | null
  • attentionstring | null
  • emailstring | null
  • email_ublboolean
  • send_invoices_to_attentionstring | null
  • send_invoices_to_emailstring | null
  • send_estimates_to_attentionstring | null
  • send_estimates_to_emailstring | null
  • sepa_activeboolean | null
  • sepa_ibanstring | null
  • sepa_iban_account_namestring | null
  • sepa_bicstring | null
  • sepa_mandate_idstring | null
  • sepa_mandate_datestring | null · date
  • sepa_sequence_typestring · enum
    Enum values:
    RCUR
    FRST
    OOFF
    FNAL
  • credit_card_numberstring | null
  • credit_card_referencestring | null
  • credit_card_typestring | null · enum
    Enum values:
    mastercard
    visa
  • tax_number_validated_atstring | null · date-time
  • tax_number_validboolean | null
  • invoice_workflow_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • estimate_workflow_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • si_identifierstring | null
  • si_identifier_typestring | null
  • moneybird_payments_mandateboolean

    Whether the contact has a valid Moneybird Payments mandate

  • created_atstring · date-time
  • updated_atstring · date-time
  • versioninteger
  • sales_invoices_urlstring · uri · pattern: ^https:\/\/moneybird…
  • notesobject[]
  • custom_fieldsobject[]
  • contact_peopleobject[]
  • archivedboolean
  • eventsobject[]

Filter contacts

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

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:

FilterTypeDefaultDescription
created_afterStringSelect contacts created after the given time (exclusive). ISO 8601 formatted string. The time to compare with is in UTC timezone
updated_afterStringSelect contacts updated after the given time (exclusive). ISO 8601 formatted string. The time to compare with is in UTC timezone
first_nameStringSelect contacts with the given first name. Case-insensitive
last_nameStringSelect contacts with the given last name. Case-insensitive
estimate_workflow_idIntegerFilters contacts by a single Estimate workflow
invoice_workflow_idIntegerFilters contacts by a single Invoice workflow
contact_typeStringThe contact type. Possible values all, company, private_individual
delivery_methodStringThe delivery method for invoices. Possible values. Possible values all, email, post, manual, peppol, simplerinvoicing
trusted_typeStringWhether the contact is trusted. Possible values all, trusted, not_trusted
----

Filter contactspath Parameters

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

    The unique identifier of the administration

    A unique record identifier of an administration

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

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

    Default: .json

Filter contactsquery Parameters

  • filterstring
  • include_archivedboolean | string
  • per_pageinteger | string · min: 1 · max: 100 · pattern: ^\d+$

Filter contacts Responses

A list of contacts

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

    A unique record identifier

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

    A unique record identifier of an administration

  • company_name
  • firstnamestring | null
  • lastnamestring | null
  • address1string | null
  • address2string | null
  • zipcodestring | null
  • citystring | null
  • countrystring
  • phonestring | null
  • delivery_methodstring | null · enum
    Enum values:
    Email
    Post
    Manual
    Simplerinvoicing
    Peppol
  • customer_idstring

    Will be assigned automatically if empty

  • tax_numberstring | null
  • chamber_of_commercestring | null
  • bank_accountstring | null

    The SEPA IBAN of the contact, can be empty if no SEPA IBAN is set

  • is_trustedboolean
    Default: default
  • max_transfer_amountnumber | null
  • attentionstring | null
  • emailstring | null
  • email_ublboolean
  • send_invoices_to_attentionstring | null
  • send_invoices_to_emailstring | null
  • send_estimates_to_attentionstring | null
  • send_estimates_to_emailstring | null
  • sepa_activeboolean | null
  • sepa_ibanstring | null
  • sepa_iban_account_namestring | null
  • sepa_bicstring | null
  • sepa_mandate_idstring | null
  • sepa_mandate_datestring | null · date
  • sepa_sequence_typestring · enum
    Enum values:
    RCUR
    FRST
    OOFF
    FNAL
  • credit_card_numberstring | null
  • credit_card_referencestring | null
  • credit_card_typestring | null · enum
    Enum values:
    mastercard
    visa
  • tax_number_validated_atstring | null · date-time
  • tax_number_validboolean | null
  • invoice_workflow_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • estimate_workflow_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • si_identifierstring | null
  • si_identifier_typestring | null
  • moneybird_payments_mandateboolean

    Whether the contact has a valid Moneybird Payments mandate

  • created_atstring · date-time
  • updated_atstring · date-time
  • versioninteger
  • sales_invoices_urlstring · uri · pattern: ^https:\/\/moneybird…
  • notesobject[]
  • custom_fieldsobject[]
  • contact_peopleobject[]
  • archivedboolean
  • eventsobject[]

List all ids and versions

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

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.

List all ids and versionspath Parameters

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

    The unique identifier of the administration

    A unique record identifier of an administration

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

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

    Default: .json

List all ids and versionsquery Parameters

  • filterstring
  • include_archivedboolean | string

List all ids and versions Responses

IDs and versions of records

  • idinteger | string
  • versioninteger | string

Fetch contacts with given ids

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

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.

Fetch contacts with given idspath Parameters

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

    The unique identifier of the administration

    A unique record identifier of an administration

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

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

    Default: .json

Fetch contacts with given ids Request Body

  • ids(integer | string)[] · required

Fetch contacts with given ids Responses

A list of contacts

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

    A unique record identifier

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

    A unique record identifier of an administration

  • company_name
  • firstnamestring | null
  • lastnamestring | null
  • address1string | null
  • address2string | null
  • zipcodestring | null
  • citystring | null
  • countrystring
  • phonestring | null
  • delivery_methodstring | null · enum
    Enum values:
    Email
    Post
    Manual
    Simplerinvoicing
    Peppol
  • customer_idstring

    Will be assigned automatically if empty

  • tax_numberstring | null
  • chamber_of_commercestring | null
  • bank_accountstring | null

    The SEPA IBAN of the contact, can be empty if no SEPA IBAN is set

  • is_trustedboolean
    Default: default
  • max_transfer_amountnumber | null
  • attentionstring | null
  • emailstring | null
  • email_ublboolean
  • send_invoices_to_attentionstring | null
  • send_invoices_to_emailstring | null
  • send_estimates_to_attentionstring | null
  • send_estimates_to_emailstring | null
  • sepa_activeboolean | null
  • sepa_ibanstring | null
  • sepa_iban_account_namestring | null
  • sepa_bicstring | null
  • sepa_mandate_idstring | null
  • sepa_mandate_datestring | null · date
  • sepa_sequence_typestring · enum
    Enum values:
    RCUR
    FRST
    OOFF
    FNAL
  • credit_card_numberstring | null
  • credit_card_referencestring | null
  • credit_card_typestring | null · enum
    Enum values:
    mastercard
    visa
  • tax_number_validated_atstring | null · date-time
  • tax_number_validboolean | null
  • invoice_workflow_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • estimate_workflow_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • si_identifierstring | null
  • si_identifier_typestring | null
  • moneybird_payments_mandateboolean

    Whether the contact has a valid Moneybird Payments mandate

  • created_atstring · date-time
  • updated_atstring · date-time
  • versioninteger
  • sales_invoices_urlstring · uri · pattern: ^https:\/\/moneybird…
  • notesobject[]
  • custom_fieldsobject[]
  • contact_peopleobject[]
  • archivedboolean
  • eventsobject[]

Get contact person

GET
https://moneybird.com/api/v2
/{administration_id}/contacts/{contact_id}/contact_people/{id}{format}

Returns all information about a contact person.

Get contact personpath Parameters

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

    The unique identifier of the administration

    A unique record identifier of an administration

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

    A unique record identifier

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

    A unique record identifier

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

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

    Default: .json

Get contact person Responses

A contact person

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

    A unique record identifier

  • contact_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

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

    A unique record identifier of an administration

  • firstnamestring | null
  • lastnamestring | null
  • phonestring | null
  • emailstring | null
  • departmentstring | null
  • created_atstring | null · date-time
  • updated_atstring | null · date-time
  • versioninteger

Delete a contact person

DELETE
https://moneybird.com/api/v2
/{administration_id}/contacts/{contact_id}/contact_people/{id}{format}

Deletes a contact person.

Delete a contact personpath Parameters

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

    The unique identifier of the administration

    A unique record identifier of an administration

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

    A unique record identifier

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

    A unique record identifier

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

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

    Default: .json

Delete a contact person Responses

Contact person deleted

No data returned

Update a contact person

PATCH
https://moneybird.com/api/v2
/{administration_id}/contacts/{contact_id}/contact_people/{id}{format}

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.

Update a contact personpath Parameters

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

    The unique identifier of the administration

    A unique record identifier of an administration

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

    A unique record identifier

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

    A unique record identifier

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

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

    Default: .json

Update a contact person Request Body

  • contact_personobject

Update a contact person Responses

Contact person updated

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

    A unique record identifier

  • contact_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

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

    A unique record identifier of an administration

  • firstnamestring | null
  • lastnamestring | null
  • phonestring | null
  • emailstring | null
  • departmentstring | null
  • created_atstring | null · date-time
  • updated_atstring | null · date-time
  • versioninteger

Create a new contact person

POST
https://moneybird.com/api/v2
/{administration_id}/contacts/{contact_id}/contact_people{format}

Creating a new contact person in the administration requires at least a contact_person hash including firstname and lastname.

Create a new contact personpath Parameters

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

    The unique identifier of the administration

    A unique record identifier of an administration

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

    A unique record identifier

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

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

    Default: .json

Create a new contact person Request Body

  • contact_personobject

Create a new contact person Responses

Contact person created

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

    A unique record identifier

  • contact_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

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

    A unique record identifier of an administration

  • firstnamestring | null
  • lastnamestring | null
  • phonestring | null
  • emailstring | null
  • departmentstring | null
  • created_atstring | null · date-time
  • updated_atstring | null · date-time
  • versioninteger

Request an URL for setting up a Moneybird Payments mandate

POST
https://moneybird.com/api/v2
/{administration_id}/contacts/{contact_id}/moneybird_payments_mandate/url{format}

Obtains an URL for setting up a Moneybird Payments mandate. You must provide this URL to your contact to set-up the mandate. Your contact is required to make a 15 cent payment. Every generated URL using this endpoint is valid for 14 days after creation. Only available when Moneybird Payments is enabled for the administration.

Request an URL for setting up a Moneybird Payments mandatepath Parameters

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

    The unique identifier of the administration

    A unique record identifier of an administration

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

    A unique record identifier

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

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

    Default: .json

Request an URL for setting up a Moneybird Payments mandate Request Body

  • mandate_requestobject

Request an URL for setting up a Moneybird Payments mandate Responses

A URL for setting up a Moneybird Payments mandate

  • urlstring

Get Moneybird Payments mandate

GET
https://moneybird.com/api/v2
/{administration_id}/contacts/{contact_id}/moneybird_payments_mandate{format}

Returns information about the stored Moneybird Payments mandate. Only available when Moneybird Payments is enabled for the administration.

Get Moneybird Payments mandatepath Parameters

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

    The unique identifier of the administration

    A unique record identifier of an administration

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

    A unique record identifier

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

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

    Default: .json

Get Moneybird Payments mandate Responses

A Moneybird Payments mandate

  • typestring | null
  • sepa_mandateboolean
  • bankstring | null
  • ibanstring | null
  • bicstring | null
  • iban_account_namestring | null
  • card_expiry_monthstring | null
  • card_expiry_yearstring | null
  • card_final_digitsstring | null
  • created_atstring · date-time

Request a new Moneybird Payments mandate

POST
https://moneybird.com/api/v2
/{administration_id}/contacts/{contact_id}/moneybird_payments_mandate{format}

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.

Request a new Moneybird Payments mandatepath Parameters

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

    The unique identifier of the administration

    A unique record identifier of an administration

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

    A unique record identifier

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

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

    Default: .json

Request a new Moneybird Payments mandate Request Body

  • mandate_requestobject

Request a new Moneybird Payments mandate Responses

Moneybird Payments mandate requested

No data returned

Delete a stored Moneybird Payments mandate

DELETE
https://moneybird.com/api/v2
/{administration_id}/contacts/{contact_id}/moneybird_payments_mandate{format}

Deletes the stored Moneybird Payments mandate for the contact. Only available when Moneybird Payments is enabled for the administration.

Delete a stored Moneybird Payments mandatepath Parameters

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

    The unique identifier of the administration

    A unique record identifier of an administration

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

    A unique record identifier

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

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

    Default: .json

Delete a stored Moneybird Payments mandate Responses

Contact deleted

No data returned

Destroys note from entity

DELETE
https://moneybird.com/api/v2
/{administration_id}/contacts/{contact_id}/notes/{id}{format}

Deletes a note from the contact.

Destroys note from entitypath Parameters

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

    The unique identifier of the administration

    A unique record identifier of an administration

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

    A unique record identifier

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

    A unique record identifier

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

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

    Default: .json

Destroys note from entity Responses

Note deleted

No data returned

Adds note to entity

POST
https://moneybird.com/api/v2
/{administration_id}/contacts/{contact_id}/notes{format}

Adds a note to the contact.

Adds note to entitypath Parameters

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

    The unique identifier of the administration

    A unique record identifier of an administration

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

    A unique record identifier

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

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

    Default: .json

Adds note to entity Request Body

  • noteobject

Adds note to entity Responses

Note created

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

    A unique record identifier

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

    A unique record identifier of an administration

  • entity_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • entity_typestring
  • user_idstring | integer · pattern: ^\d+$

    A unique record identifier

  • assignee_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • todoboolean | string | null
    Default: false
  • notestring | null
  • completed_atstring | null · date-time
  • completed_by_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • todo_typestring | null · enum
    Enum values:
    sales_invoice_due
    purchase_invoice_due
    general_document_reminder
    general_document_due
    new_document_awaiting_processing
    new_financial_mutation_awaiting_processing
    financial_mutations_not_updated
    sales_invoice_payment_not_linked_to_financial_mutation
  • dataobject | null
  • created_atstring · date-time
  • updated_atstring · date-time

Get additional charges

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

Get the additional charges of the given contact.

Get additional chargespath Parameters

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

    The unique identifier of the administration

    A unique record identifier of an administration

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

    A unique record identifier

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

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

    Default: .json

Get additional chargesquery Parameters

  • include_billedboolean | string

    If true, includes the additional charges that have already been billed. Default is false.

Get additional charges Responses

A list of additional charges

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

    A unique record identifier

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

    A unique record identifier of an administration

  • contact_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • subscription_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

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

    A unique record identifier

  • detail_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • amountstring | null
  • pricestring
  • periodstring · pattern: ^[0-9]{6}..[0-9]{6}$
  • descriptionstring

Create an additional charge to be invoiced at start of next period

POST
https://moneybird.com/api/v2
/{administration_id}/contacts/{id}/additional_charges{format}

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.

Create an additional charge to be invoiced at start of next periodpath Parameters

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

    The unique identifier of the administration

    A unique record identifier of an administration

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

    A unique record identifier

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

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

    Default: .json

Create an additional charge to be invoiced at start of next period Request Body

Additional properties are allowed

Create an additional charge to be invoiced at start of next period Responses

Subscription additional charge created

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

    A unique record identifier

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

    A unique record identifier of an administration

  • contact_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • subscription_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

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

    A unique record identifier

  • detail_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • amountstring | null
  • pricestring
  • periodstring · pattern: ^[0-9]{6}..[0-9]{6}$
  • descriptionstring

Archive a contact

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

Archives a contact.

Archive a contactpath Parameters

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

    The unique identifier of the administration

    A unique record identifier of an administration

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

    A unique record identifier

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

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

    Default: .json

Archive a contact Responses

Contact archived

No data returned

Get contact

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

Returns all information about a contact.

Get contactpath Parameters

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

    The unique identifier of the administration

    A unique record identifier of an administration

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

    A unique record identifier

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

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

    Default: .json

Get contactquery Parameters

  • include_archivedboolean | string

Get contact Responses

A contact

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

    A unique record identifier

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

    A unique record identifier of an administration

  • company_name
  • firstnamestring | null
  • lastnamestring | null
  • address1string | null
  • address2string | null
  • zipcodestring | null
  • citystring | null
  • countrystring
  • phonestring | null
  • delivery_methodstring | null · enum
    Enum values:
    Email
    Post
    Manual
    Simplerinvoicing
    Peppol
  • customer_idstring

    Will be assigned automatically if empty

  • tax_numberstring | null
  • chamber_of_commercestring | null
  • bank_accountstring | null

    The SEPA IBAN of the contact, can be empty if no SEPA IBAN is set

  • is_trustedboolean
    Default: default
  • max_transfer_amountnumber | null
  • attentionstring | null
  • emailstring | null
  • email_ublboolean
  • send_invoices_to_attentionstring | null
  • send_invoices_to_emailstring | null
  • send_estimates_to_attentionstring | null
  • send_estimates_to_emailstring | null
  • sepa_activeboolean | null
  • sepa_ibanstring | null
  • sepa_iban_account_namestring | null
  • sepa_bicstring | null
  • sepa_mandate_idstring | null
  • sepa_mandate_datestring | null · date
  • sepa_sequence_typestring · enum
    Enum values:
    RCUR
    FRST
    OOFF
    FNAL
  • credit_card_numberstring | null
  • credit_card_referencestring | null
  • credit_card_typestring | null · enum
    Enum values:
    mastercard
    visa
  • tax_number_validated_atstring | null · date-time
  • tax_number_validboolean | null
  • invoice_workflow_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • estimate_workflow_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • si_identifierstring | null
  • si_identifier_typestring | null
  • moneybird_payments_mandateboolean

    Whether the contact has a valid Moneybird Payments mandate

  • created_atstring · date-time
  • updated_atstring · date-time
  • versioninteger
  • sales_invoices_urlstring · uri · pattern: ^https:\/\/moneybird…
  • notesobject[]
  • custom_fieldsobject[]
  • contact_peopleobject[]
  • archivedboolean
  • eventsobject[]

Delete a contact

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

Deletes a contact.

Delete a contactpath Parameters

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

    The unique identifier of the administration

    A unique record identifier of an administration

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

    A unique record identifier

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

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

    Default: .json

Delete a contact Responses

Contact deleted

No data returned

Update a contact

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

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.

Update a contactpath Parameters

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

    The unique identifier of the administration

    A unique record identifier of an administration

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

    A unique record identifier

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

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

    Default: .json

Update a contact Request Body

  • contactobject · required

Update a contact Responses

Contact updated

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

    A unique record identifier

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

    A unique record identifier of an administration

  • company_name
  • firstnamestring | null
  • lastnamestring | null
  • address1string | null
  • address2string | null
  • zipcodestring | null
  • citystring | null
  • countrystring
  • phonestring | null
  • delivery_methodstring | null · enum
    Enum values:
    Email
    Post
    Manual
    Simplerinvoicing
    Peppol
  • customer_idstring

    Will be assigned automatically if empty

  • tax_numberstring | null
  • chamber_of_commercestring | null
  • bank_accountstring | null

    The SEPA IBAN of the contact, can be empty if no SEPA IBAN is set

  • is_trustedboolean
    Default: default
  • max_transfer_amountnumber | null
  • attentionstring | null
  • emailstring | null
  • email_ublboolean
  • send_invoices_to_attentionstring | null
  • send_invoices_to_emailstring | null
  • send_estimates_to_attentionstring | null
  • send_estimates_to_emailstring | null
  • sepa_activeboolean | null
  • sepa_ibanstring | null
  • sepa_iban_account_namestring | null
  • sepa_bicstring | null
  • sepa_mandate_idstring | null
  • sepa_mandate_datestring | null · date
  • sepa_sequence_typestring · enum
    Enum values:
    RCUR
    FRST
    OOFF
    FNAL
  • credit_card_numberstring | null
  • credit_card_referencestring | null
  • credit_card_typestring | null · enum
    Enum values:
    mastercard
    visa
  • tax_number_validated_atstring | null · date-time
  • tax_number_validboolean | null
  • invoice_workflow_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • estimate_workflow_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • si_identifierstring | null
  • si_identifier_typestring | null
  • moneybird_payments_mandateboolean

    Whether the contact has a valid Moneybird Payments mandate

  • created_atstring · date-time
  • updated_atstring · date-time
  • versioninteger
  • sales_invoices_urlstring · uri · pattern: ^https:\/\/moneybird…
  • notesobject[]
  • custom_fieldsobject[]
  • contact_peopleobject[]
  • archivedboolean
  • eventsobject[]

List all contacts

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

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

List all contactspath Parameters

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

    The unique identifier of the administration

    A unique record identifier of an administration

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

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

    Default: .json

List all contactsquery Parameters

  • per_pageinteger | string · min: 1 · max: 100 · pattern: ^\d+$
  • pageinteger | string
  • querystring
  • include_archivedboolean | string
  • todostring
  • contact_fieldstring
  • contact_valuestring

List all contacts Responses

A list of contacts

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

    A unique record identifier

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

    A unique record identifier of an administration

  • company_name
  • firstnamestring | null
  • lastnamestring | null
  • address1string | null
  • address2string | null
  • zipcodestring | null
  • citystring | null
  • countrystring
  • phonestring | null
  • delivery_methodstring | null · enum
    Enum values:
    Email
    Post
    Manual
    Simplerinvoicing
    Peppol
  • customer_idstring

    Will be assigned automatically if empty

  • tax_numberstring | null
  • chamber_of_commercestring | null
  • bank_accountstring | null

    The SEPA IBAN of the contact, can be empty if no SEPA IBAN is set

  • is_trustedboolean
    Default: default
  • max_transfer_amountnumber | null
  • attentionstring | null
  • emailstring | null
  • email_ublboolean
  • send_invoices_to_attentionstring | null
  • send_invoices_to_emailstring | null
  • send_estimates_to_attentionstring | null
  • send_estimates_to_emailstring | null
  • sepa_activeboolean | null
  • sepa_ibanstring | null
  • sepa_iban_account_namestring | null
  • sepa_bicstring | null
  • sepa_mandate_idstring | null
  • sepa_mandate_datestring | null · date
  • sepa_sequence_typestring · enum
    Enum values:
    RCUR
    FRST
    OOFF
    FNAL
  • credit_card_numberstring | null
  • credit_card_referencestring | null
  • credit_card_typestring | null · enum
    Enum values:
    mastercard
    visa
  • tax_number_validated_atstring | null · date-time
  • tax_number_validboolean | null
  • invoice_workflow_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • estimate_workflow_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • si_identifierstring | null
  • si_identifier_typestring | null
  • moneybird_payments_mandateboolean

    Whether the contact has a valid Moneybird Payments mandate

  • created_atstring · date-time
  • updated_atstring · date-time
  • versioninteger
  • sales_invoices_urlstring · uri · pattern: ^https:\/\/moneybird…
  • notesobject[]
  • custom_fieldsobject[]
  • contact_peopleobject[]
  • archivedboolean
  • eventsobject[]

Create a new contact

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

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.

Create a new contactpath Parameters

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

    The unique identifier of the administration

    A unique record identifier of an administration

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

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

    Default: .json

Create a new contact Request Body

  • contactobject · required

Create a new contact Responses

Contact created

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

    A unique record identifier

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

    A unique record identifier of an administration

  • company_name
  • firstnamestring | null
  • lastnamestring | null
  • address1string | null
  • address2string | null
  • zipcodestring | null
  • citystring | null
  • countrystring
  • phonestring | null
  • delivery_methodstring | null · enum
    Enum values:
    Email
    Post
    Manual
    Simplerinvoicing
    Peppol
  • customer_idstring

    Will be assigned automatically if empty

  • tax_numberstring | null
  • chamber_of_commercestring | null
  • bank_accountstring | null

    The SEPA IBAN of the contact, can be empty if no SEPA IBAN is set

  • is_trustedboolean
    Default: default
  • max_transfer_amountnumber | null
  • attentionstring | null
  • emailstring | null
  • email_ublboolean
  • send_invoices_to_attentionstring | null
  • send_invoices_to_emailstring | null
  • send_estimates_to_attentionstring | null
  • send_estimates_to_emailstring | null
  • sepa_activeboolean | null
  • sepa_ibanstring | null
  • sepa_iban_account_namestring | null
  • sepa_bicstring | null
  • sepa_mandate_idstring | null
  • sepa_mandate_datestring | null · date
  • sepa_sequence_typestring · enum
    Enum values:
    RCUR
    FRST
    OOFF
    FNAL
  • credit_card_numberstring | null
  • credit_card_referencestring | null
  • credit_card_typestring | null · enum
    Enum values:
    mastercard
    visa
  • tax_number_validated_atstring | null · date-time
  • tax_number_validboolean | null
  • invoice_workflow_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • estimate_workflow_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • si_identifierstring | null
  • si_identifier_typestring | null
  • moneybird_payments_mandateboolean

    Whether the contact has a valid Moneybird Payments mandate

  • created_atstring · date-time
  • updated_atstring · date-time
  • versioninteger
  • sales_invoices_urlstring · uri · pattern: ^https:\/\/moneybird…
  • notesobject[]
  • custom_fieldsobject[]
  • contact_peopleobject[]
  • archivedboolean
  • eventsobject[]