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
Returns all information about a contact by the given customer id
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
customer_id
string | integer · pattern:^\d+$
· requiredA unique record identifier
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
A contact
id
string | integer · pattern:^\d+$
A unique record identifier
administration_id
string | integer · pattern:^\d+$
A unique record identifier of an administration
company_name
firstname
string | nulllastname
string | nulladdress1
string | nulladdress2
string | nullzipcode
string | nullcity
string | nullcountry
stringphone
string | nulldelivery_method
string | null · enumEnum values:EmailPostManualSimplerinvoicingPeppolcustomer_id
stringWill be assigned automatically if empty
tax_number
string | nullchamber_of_commerce
string | nullbank_account
string | nullThe SEPA IBAN of the contact, can be empty if no SEPA IBAN is set
is_trusted
booleanDefault: defaultmax_transfer_amount
number | nullattention
string | nullemail
string | nullemail_ubl
booleansend_invoices_to_attention
string | nullsend_invoices_to_email
string | nullsend_estimates_to_attention
string | nullsend_estimates_to_email
string | nullsepa_active
boolean | nullsepa_iban
string | nullsepa_iban_account_name
string | nullsepa_bic
string | nullsepa_mandate_id
string | nullsepa_mandate_date
string | null · datesepa_sequence_type
string · enumEnum values:RCURFRSTOOFFFNALcredit_card_number
string | nullcredit_card_reference
string | nullcredit_card_type
string | null · enumEnum values:mastercardvisatax_number_validated_at
string | null · date-timetax_number_valid
boolean | nullinvoice_workflow_id
string | integer | null · pattern:^\d+$
A unique record identifier
estimate_workflow_id
string | integer | null · pattern:^\d+$
A unique record identifier
si_identifier
string | nullsi_identifier_type
string | nullmoneybird_payments_mandate
booleanWhether the contact has a valid Moneybird Payments mandate
created_at
string · date-timeupdated_at
string · date-timeversion
integersales_invoices_url
string · uri · pattern:^https:\/\/moneybird…
notes
object[]custom_fields
object[]contact_people
object[]archived
booleanevents
object[]
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 | |
estimate_workflow_id | Integer | Filters contacts by a single Estimate workflow | |
invoice_workflow_id | Integer | Filters contacts by a single Invoice workflow | |
contact_type | String | The contact type. Possible values all , company , private_individual | |
delivery_method | String | The delivery method for invoices. Possible values. Possible values all , email , post , manual , peppol , simplerinvoicing | |
trusted_type | String | Whether the contact is trusted. Possible values all , trusted , not_trusted | |
- | - | - | - |
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
query Parameters
filter
stringinclude_archived
boolean | stringper_page
integer | string · min: 1 · max: 100 · pattern:^\d+$
Responses
A list of contacts
id
string | integer · pattern:^\d+$
A unique record identifier
administration_id
string | integer · pattern:^\d+$
A unique record identifier of an administration
company_name
firstname
string | nulllastname
string | nulladdress1
string | nulladdress2
string | nullzipcode
string | nullcity
string | nullcountry
stringphone
string | nulldelivery_method
string | null · enumEnum values:EmailPostManualSimplerinvoicingPeppolcustomer_id
stringWill be assigned automatically if empty
tax_number
string | nullchamber_of_commerce
string | nullbank_account
string | nullThe SEPA IBAN of the contact, can be empty if no SEPA IBAN is set
is_trusted
booleanDefault: defaultmax_transfer_amount
number | nullattention
string | nullemail
string | nullemail_ubl
booleansend_invoices_to_attention
string | nullsend_invoices_to_email
string | nullsend_estimates_to_attention
string | nullsend_estimates_to_email
string | nullsepa_active
boolean | nullsepa_iban
string | nullsepa_iban_account_name
string | nullsepa_bic
string | nullsepa_mandate_id
string | nullsepa_mandate_date
string | null · datesepa_sequence_type
string · enumEnum values:RCURFRSTOOFFFNALcredit_card_number
string | nullcredit_card_reference
string | nullcredit_card_type
string | null · enumEnum values:mastercardvisatax_number_validated_at
string | null · date-timetax_number_valid
boolean | nullinvoice_workflow_id
string | integer | null · pattern:^\d+$
A unique record identifier
estimate_workflow_id
string | integer | null · pattern:^\d+$
A unique record identifier
si_identifier
string | nullsi_identifier_type
string | nullmoneybird_payments_mandate
booleanWhether the contact has a valid Moneybird Payments mandate
created_at
string · date-timeupdated_at
string · date-timeversion
integersales_invoices_url
string · uri · pattern:^https:\/\/moneybird…
notes
object[]custom_fields
object[]contact_people
object[]archived
booleanevents
object[]
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.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
query Parameters
filter
stringinclude_archived
boolean | string
Responses
IDs and versions of records
id
integer | stringversion
integer | string
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.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
A list of contacts
id
string | integer · pattern:^\d+$
A unique record identifier
administration_id
string | integer · pattern:^\d+$
A unique record identifier of an administration
company_name
firstname
string | nulllastname
string | nulladdress1
string | nulladdress2
string | nullzipcode
string | nullcity
string | nullcountry
stringphone
string | nulldelivery_method
string | null · enumEnum values:EmailPostManualSimplerinvoicingPeppolcustomer_id
stringWill be assigned automatically if empty
tax_number
string | nullchamber_of_commerce
string | nullbank_account
string | nullThe SEPA IBAN of the contact, can be empty if no SEPA IBAN is set
is_trusted
booleanDefault: defaultmax_transfer_amount
number | nullattention
string | nullemail
string | nullemail_ubl
booleansend_invoices_to_attention
string | nullsend_invoices_to_email
string | nullsend_estimates_to_attention
string | nullsend_estimates_to_email
string | nullsepa_active
boolean | nullsepa_iban
string | nullsepa_iban_account_name
string | nullsepa_bic
string | nullsepa_mandate_id
string | nullsepa_mandate_date
string | null · datesepa_sequence_type
string · enumEnum values:RCURFRSTOOFFFNALcredit_card_number
string | nullcredit_card_reference
string | nullcredit_card_type
string | null · enumEnum values:mastercardvisatax_number_validated_at
string | null · date-timetax_number_valid
boolean | nullinvoice_workflow_id
string | integer | null · pattern:^\d+$
A unique record identifier
estimate_workflow_id
string | integer | null · pattern:^\d+$
A unique record identifier
si_identifier
string | nullsi_identifier_type
string | nullmoneybird_payments_mandate
booleanWhether the contact has a valid Moneybird Payments mandate
created_at
string · date-timeupdated_at
string · date-timeversion
integersales_invoices_url
string · uri · pattern:^https:\/\/moneybird…
notes
object[]custom_fields
object[]contact_people
object[]archived
booleanevents
object[]
Get contact person
Returns all information about a contact person.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
contact_id
string | integer · pattern:^\d+$
· requiredA unique record identifier
id
string | integer · pattern:^\d+$
· requiredA unique record identifier
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
A contact person
id
string | integer | null · pattern:^\d+$
A unique record identifier
contact_id
string | integer | null · pattern:^\d+$
A unique record identifier
administration_id
string | integer · pattern:^\d+$
A unique record identifier of an administration
firstname
string | nulllastname
string | nullphone
string | nullemail
string | nulldepartment
string | nullcreated_at
string | null · date-timeupdated_at
string | null · date-timeversion
integer
Delete a contact person
Deletes a contact person.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
contact_id
string | integer · pattern:^\d+$
· requiredA unique record identifier
id
string | integer · pattern:^\d+$
· requiredA unique record identifier
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
Contact person deleted
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.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
contact_id
string | integer · pattern:^\d+$
· requiredA unique record identifier
id
string | integer · pattern:^\d+$
· requiredA unique record identifier
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
Contact person updated
id
string | integer | null · pattern:^\d+$
A unique record identifier
contact_id
string | integer | null · pattern:^\d+$
A unique record identifier
administration_id
string | integer · pattern:^\d+$
A unique record identifier of an administration
firstname
string | nulllastname
string | nullphone
string | nullemail
string | nulldepartment
string | nullcreated_at
string | null · date-timeupdated_at
string | null · date-timeversion
integer
Create a new contact person
Creating a new contact person in the administration requires at least a contact_person
hash including firstname
and lastname
.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
contact_id
string | integer · pattern:^\d+$
· requiredA unique record identifier
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
Contact person created
id
string | integer | null · pattern:^\d+$
A unique record identifier
contact_id
string | integer | null · pattern:^\d+$
A unique record identifier
administration_id
string | integer · pattern:^\d+$
A unique record identifier of an administration
firstname
string | nulllastname
string | nullphone
string | nullemail
string | nulldepartment
string | nullcreated_at
string | null · date-timeupdated_at
string | null · date-timeversion
integer
Request an URL for setting up a Moneybird Payments mandate
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.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
contact_id
string | integer · pattern:^\d+$
· requiredA unique record identifier
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
A URL for setting up a Moneybird Payments mandate
url
string
Get Moneybird Payments mandate
Returns information about the stored Moneybird Payments mandate. Only available when Moneybird Payments is enabled for the administration.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
contact_id
string | integer · pattern:^\d+$
· requiredA unique record identifier
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
A Moneybird Payments mandate
type
string | nullsepa_mandate
booleanbank
string | nulliban
string | nullbic
string | nulliban_account_name
string | nullcard_expiry_month
string | nullcard_expiry_year
string | nullcard_final_digits
string | nullcreated_at
string · date-time
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.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
contact_id
string | integer · pattern:^\d+$
· requiredA unique record identifier
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
Moneybird Payments mandate requested
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.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
contact_id
string | integer · pattern:^\d+$
· requiredA unique record identifier
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
Contact deleted
Destroys note from entity
Deletes a note from the contact.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
contact_id
string | integer · pattern:^\d+$
· requiredA unique record identifier
id
string | integer · pattern:^\d+$
· requiredA unique record identifier
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
Note deleted
Adds note to entity
Adds a note to the contact.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
contact_id
string | integer · pattern:^\d+$
· requiredA unique record identifier
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
Note created
id
string | integer · pattern:^\d+$
A unique record identifier
administration_id
string | integer · pattern:^\d+$
A unique record identifier of an administration
entity_id
string | integer | null · pattern:^\d+$
A unique record identifier
entity_type
stringuser_id
string | integer · pattern:^\d+$
A unique record identifier
assignee_id
string | integer | null · pattern:^\d+$
A unique record identifier
todo
boolean | string | nullDefault: falsenote
string | nullcompleted_at
string | null · date-timecompleted_by_id
string | integer | null · pattern:^\d+$
A unique record identifier
todo_type
string | null · enumEnum values:sales_invoice_duepurchase_invoice_duegeneral_document_remindergeneral_document_duenew_document_awaiting_processingnew_financial_mutation_awaiting_processingfinancial_mutations_not_updatedsales_invoice_payment_not_linked_to_financial_mutationdata
object | nullcreated_at
string · date-timeupdated_at
string · date-time
Get additional charges
Get the additional charges of the given contact.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
id
string | integer · pattern:^\d+$
· requiredA unique record identifier
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
query Parameters
include_billed
boolean | stringIf true, includes the additional charges that have already been billed. Default is false.
Responses
A list of additional charges
id
string | integer · pattern:^\d+$
A unique record identifier
administration_id
string | integer · pattern:^\d+$
A unique record identifier of an administration
contact_id
string | integer | null · pattern:^\d+$
A unique record identifier
subscription_id
string | integer | null · pattern:^\d+$
A unique record identifier
product_id
string | integer · pattern:^\d+$
A unique record identifier
detail_id
string | integer | null · pattern:^\d+$
A unique record identifier
amount
string | nullprice
stringperiod
string · pattern:^[0-9]{6}..[0-9]{6}$
description
string
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.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
id
string | integer · pattern:^\d+$
· requiredA unique record identifier
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
Subscription additional charge created
id
string | integer · pattern:^\d+$
A unique record identifier
administration_id
string | integer · pattern:^\d+$
A unique record identifier of an administration
contact_id
string | integer | null · pattern:^\d+$
A unique record identifier
subscription_id
string | integer | null · pattern:^\d+$
A unique record identifier
product_id
string | integer · pattern:^\d+$
A unique record identifier
detail_id
string | integer | null · pattern:^\d+$
A unique record identifier
amount
string | nullprice
stringperiod
string · pattern:^[0-9]{6}..[0-9]{6}$
description
string
Archive a contact
Archives a contact.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
id
string | integer · pattern:^\d+$
· requiredA unique record identifier
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
Contact archived
Get contact
Returns all information about a contact.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
id
string | integer · pattern:^\d+$
· requiredA unique record identifier
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
query Parameters
include_archived
boolean | string
Responses
A contact
id
string | integer · pattern:^\d+$
A unique record identifier
administration_id
string | integer · pattern:^\d+$
A unique record identifier of an administration
company_name
firstname
string | nulllastname
string | nulladdress1
string | nulladdress2
string | nullzipcode
string | nullcity
string | nullcountry
stringphone
string | nulldelivery_method
string | null · enumEnum values:EmailPostManualSimplerinvoicingPeppolcustomer_id
stringWill be assigned automatically if empty
tax_number
string | nullchamber_of_commerce
string | nullbank_account
string | nullThe SEPA IBAN of the contact, can be empty if no SEPA IBAN is set
is_trusted
booleanDefault: defaultmax_transfer_amount
number | nullattention
string | nullemail
string | nullemail_ubl
booleansend_invoices_to_attention
string | nullsend_invoices_to_email
string | nullsend_estimates_to_attention
string | nullsend_estimates_to_email
string | nullsepa_active
boolean | nullsepa_iban
string | nullsepa_iban_account_name
string | nullsepa_bic
string | nullsepa_mandate_id
string | nullsepa_mandate_date
string | null · datesepa_sequence_type
string · enumEnum values:RCURFRSTOOFFFNALcredit_card_number
string | nullcredit_card_reference
string | nullcredit_card_type
string | null · enumEnum values:mastercardvisatax_number_validated_at
string | null · date-timetax_number_valid
boolean | nullinvoice_workflow_id
string | integer | null · pattern:^\d+$
A unique record identifier
estimate_workflow_id
string | integer | null · pattern:^\d+$
A unique record identifier
si_identifier
string | nullsi_identifier_type
string | nullmoneybird_payments_mandate
booleanWhether the contact has a valid Moneybird Payments mandate
created_at
string · date-timeupdated_at
string · date-timeversion
integersales_invoices_url
string · uri · pattern:^https:\/\/moneybird…
notes
object[]custom_fields
object[]contact_people
object[]archived
booleanevents
object[]
Delete a contact
Deletes a contact.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
id
string | integer · pattern:^\d+$
· requiredA unique record identifier
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
Contact deleted
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.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
id
string | integer · pattern:^\d+$
· requiredA unique record identifier
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
Contact updated
id
string | integer · pattern:^\d+$
A unique record identifier
administration_id
string | integer · pattern:^\d+$
A unique record identifier of an administration
company_name
firstname
string | nulllastname
string | nulladdress1
string | nulladdress2
string | nullzipcode
string | nullcity
string | nullcountry
stringphone
string | nulldelivery_method
string | null · enumEnum values:EmailPostManualSimplerinvoicingPeppolcustomer_id
stringWill be assigned automatically if empty
tax_number
string | nullchamber_of_commerce
string | nullbank_account
string | nullThe SEPA IBAN of the contact, can be empty if no SEPA IBAN is set
is_trusted
booleanDefault: defaultmax_transfer_amount
number | nullattention
string | nullemail
string | nullemail_ubl
booleansend_invoices_to_attention
string | nullsend_invoices_to_email
string | nullsend_estimates_to_attention
string | nullsend_estimates_to_email
string | nullsepa_active
boolean | nullsepa_iban
string | nullsepa_iban_account_name
string | nullsepa_bic
string | nullsepa_mandate_id
string | nullsepa_mandate_date
string | null · datesepa_sequence_type
string · enumEnum values:RCURFRSTOOFFFNALcredit_card_number
string | nullcredit_card_reference
string | nullcredit_card_type
string | null · enumEnum values:mastercardvisatax_number_validated_at
string | null · date-timetax_number_valid
boolean | nullinvoice_workflow_id
string | integer | null · pattern:^\d+$
A unique record identifier
estimate_workflow_id
string | integer | null · pattern:^\d+$
A unique record identifier
si_identifier
string | nullsi_identifier_type
string | nullmoneybird_payments_mandate
booleanWhether the contact has a valid Moneybird Payments mandate
created_at
string · date-timeupdated_at
string · date-timeversion
integersales_invoices_url
string · uri · pattern:^https:\/\/moneybird…
notes
object[]custom_fields
object[]contact_people
object[]archived
booleanevents
object[]
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
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
query Parameters
per_page
integer | string · min: 1 · max: 100 · pattern:^\d+$
page
integer | stringquery
stringinclude_archived
boolean | stringtodo
stringcontact_field
stringcontact_value
string
Responses
A list of contacts
id
string | integer · pattern:^\d+$
A unique record identifier
administration_id
string | integer · pattern:^\d+$
A unique record identifier of an administration
company_name
firstname
string | nulllastname
string | nulladdress1
string | nulladdress2
string | nullzipcode
string | nullcity
string | nullcountry
stringphone
string | nulldelivery_method
string | null · enumEnum values:EmailPostManualSimplerinvoicingPeppolcustomer_id
stringWill be assigned automatically if empty
tax_number
string | nullchamber_of_commerce
string | nullbank_account
string | nullThe SEPA IBAN of the contact, can be empty if no SEPA IBAN is set
is_trusted
booleanDefault: defaultmax_transfer_amount
number | nullattention
string | nullemail
string | nullemail_ubl
booleansend_invoices_to_attention
string | nullsend_invoices_to_email
string | nullsend_estimates_to_attention
string | nullsend_estimates_to_email
string | nullsepa_active
boolean | nullsepa_iban
string | nullsepa_iban_account_name
string | nullsepa_bic
string | nullsepa_mandate_id
string | nullsepa_mandate_date
string | null · datesepa_sequence_type
string · enumEnum values:RCURFRSTOOFFFNALcredit_card_number
string | nullcredit_card_reference
string | nullcredit_card_type
string | null · enumEnum values:mastercardvisatax_number_validated_at
string | null · date-timetax_number_valid
boolean | nullinvoice_workflow_id
string | integer | null · pattern:^\d+$
A unique record identifier
estimate_workflow_id
string | integer | null · pattern:^\d+$
A unique record identifier
si_identifier
string | nullsi_identifier_type
string | nullmoneybird_payments_mandate
booleanWhether the contact has a valid Moneybird Payments mandate
created_at
string · date-timeupdated_at
string · date-timeversion
integersales_invoices_url
string · uri · pattern:^https:\/\/moneybird…
notes
object[]custom_fields
object[]contact_people
object[]archived
booleanevents
object[]
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.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
Contact created
id
string | integer · pattern:^\d+$
A unique record identifier
administration_id
string | integer · pattern:^\d+$
A unique record identifier of an administration
company_name
firstname
string | nulllastname
string | nulladdress1
string | nulladdress2
string | nullzipcode
string | nullcity
string | nullcountry
stringphone
string | nulldelivery_method
string | null · enumEnum values:EmailPostManualSimplerinvoicingPeppolcustomer_id
stringWill be assigned automatically if empty
tax_number
string | nullchamber_of_commerce
string | nullbank_account
string | nullThe SEPA IBAN of the contact, can be empty if no SEPA IBAN is set
is_trusted
booleanDefault: defaultmax_transfer_amount
number | nullattention
string | nullemail
string | nullemail_ubl
booleansend_invoices_to_attention
string | nullsend_invoices_to_email
string | nullsend_estimates_to_attention
string | nullsend_estimates_to_email
string | nullsepa_active
boolean | nullsepa_iban
string | nullsepa_iban_account_name
string | nullsepa_bic
string | nullsepa_mandate_id
string | nullsepa_mandate_date
string | null · datesepa_sequence_type
string · enumEnum values:RCURFRSTOOFFFNALcredit_card_number
string | nullcredit_card_reference
string | nullcredit_card_type
string | null · enumEnum values:mastercardvisatax_number_validated_at
string | null · date-timetax_number_valid
boolean | nullinvoice_workflow_id
string | integer | null · pattern:^\d+$
A unique record identifier
estimate_workflow_id
string | integer | null · pattern:^\d+$
A unique record identifier
si_identifier
string | nullsi_identifier_type
string | nullmoneybird_payments_mandate
booleanWhether the contact has a valid Moneybird Payments mandate
created_at
string · date-timeupdated_at
string · date-timeversion
integersales_invoices_url
string · uri · pattern:^https:\/\/moneybird…
notes
object[]custom_fields
object[]contact_people
object[]archived
booleanevents
object[]