Moneybird API

Schemas

administration_id

string | integer · pattern: ^\d+$

A unique record identifier of an administration

administration_response

idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
namestring
languagestring · enum
The ISO 639-1 language code used in the administration
Enum values:
nl
nl-be
en
currencystring
The ISO 4217 currency code
countrystring
The ISO 3166-1 alpha-2 code the administration country
time_zonestring
The time zone of the administration
accessstring · enum
The type of acess the user has to this administration
Enum values:
accountant_company
user
suspendedboolean
period_locked_untilstring | null · date

asset_response

idstring | integer | null · pattern: ^\d+$
A unique record identifier
ledger_account_idstring | integer | null · pattern: ^\d+$
A unique record identifier
namestring
purchase_datestring · date
purchase_value
current_value
value_change_planobject | null
disposal
value_changesobject[]
sourcesobject[]

attachment_response

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
attachable_idstring | integer · pattern: ^\d+$
A unique record identifier
attachable_typestring · enum
Enum values:
SalesInvoice
RecurringSalesInvoice
Document
FinancialStatement
Workflow
Estimate
ExternalSalesInvoice
filenamestring
content_typestring
sizeinteger
rotationinteger | null
created_atstring | null · date-time
updated_atstring | null · date-time

balance_sheet_ledger_account

ledger_account_idstring
valuestring
childrenobject[]

base_contact_response

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

base_user_response

idstring | integer · pattern: ^\d+$
A unique record identifier
namestring
created_atstring · date-time
updated_atstring · date-time

contact_person_response

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

contact_report_item

contact_idstring | integer | null · pattern: ^\d+$ · required
A unique record identifier
amountstring · required

contact_response

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[]

currency

string

ISO 4217 currency code

custom_field_response

idstring | integer | null · pattern: ^\d+$
A unique record identifier
administration_id
namestring
sourcestring | null · enum
Enum values:
sales_invoice
estimate
contact
identity

custom_field_value_response

idstring | integer · pattern: ^\d+$
A unique record identifier
namestring
valuestring

custom_fields_attributes

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = array

Properties for Variant 1:

idinteger | string · required
valuestring · required

detail_response

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
tax_rate_idstring | integer · pattern: ^\d+$
A unique record identifier
ledger_account_idstring | integer · pattern: ^\d+$
A unique record identifier
project_idstring | integer | null · pattern: ^\d+$
A unique record identifier
product_idstring | integer | null · pattern: ^\d+$
A unique record identifier
amountstring | null
amount_decimalstring | null
descriptionstring
pricestring · pattern: ^-?\d+\.\d{1,2}$
Example: 123.45
periodstring | null · pattern: ^\d{6,8}..\d{6,8}$
row_orderinteger
total_price_excl_tax_with_discount
total_price_excl_tax_with_discount_base
tax_report_reference(string | null)[]
mandatory_tax_textstring | null
created_atstring | null · date-time
updated_atstring | null · date-time
is_optionalboolean
is_selectedboolean

details_attributes

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = array

Properties for Variant 1:

idinteger | string
descriptionstring
periodstring
String with a date range: 20140101..20141231, presets are also allowed: this_month, prev_month, next_month, etc.
price
Both a decimal and a string '10,95' are accepted.
amountinteger | string
tax_rate_idinteger | string
Should be a valid tax rate id.
ledger_account_idinteger | string
Should be a valid ledger account id.
project_idinteger | string
Should be a valid project id.
product_idinteger | string
Should be a valid product id.
row_orderinteger | string
is_optionalboolean | string
is_selectedboolean | string
_destroyboolean | string
automated_tax_enabledboolean | string

disposal_response

datestring · date
reasonstring · enum
Enum values:
out_of_use
sold
private_withdrawal
divested
externally_bookedboolean
asset_idstring | integer · pattern: ^\d+$
A unique record identifier

document_style_response

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
namestring
identity_idstring | integer · pattern: ^\d+$
A unique record identifier
defaultboolean
logo_hashstring | null
logo_container_full_widthboolean | null
Default: false
logo_display_widthinteger | null
Default: 50
logo_positionstring · enum
Enum values:
left
center
right
background_hashstring | null
paper_sizestring · enum
Enum values:
A4
letter
address_positionstring · enum
Enum values:
left
right
font_sizeinteger
font_familystring
print_on_stationeryboolean | null
Default: false
custom_cssstring | null
invoice_sender_addressobject[]
invoice_metadata_leftobject[]
invoice_metadata_rightobject[]
estimate_sender_addressobject[]
estimate_metadata_leftobject[]
estimate_metadata_rightobject[]
created_atstring | null · date-time
updated_atstring | null · date-time

download_response

idstring | integer · pattern: ^\d+$
A unique record identifier
user_idstring | integer | null · pattern: ^\d+$
The user who created the download
download_typestring
The type of download (e.g., export_contacts, export_sales_invoices, auditfile)
filenamestring
content_typestring
failedboolean
downloadedboolean
created_atstring · date-time
updated_atstring · date-time

estimate_response

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
contact_idstring | integer · pattern: ^\d+$
A unique record identifier
contact
contact_person_idstring | integer | null · pattern: ^\d+$
A unique record identifier
contact_person
estimate_idstring | null
estimate_sequence_idstring | null
workflow_idstring | integer · pattern: ^\d+$
A unique record identifier
document_style_idstring | integer · pattern: ^\d+$
A unique record identifier
identity_idstring | integer · pattern: ^\d+$
A unique record identifier
draft_idinteger | null
statestring · enum
Enum values:
draft
open
late
accepted
rejected
billed
archived
estimate_datestring | null · date
due_datestring · date
referencestring | null
languagestring | null
currencystring
exchange_rate
discount
original_estimate_idstring | integer | null · pattern: ^\d+$
A unique record identifier
show_taxboolean
Default: true
sign_onlineboolean
Default: true
sent_atstring | null · date
accepted_atstring | null · date
rejected_atstring | null · date
archived_atstring | null · date
created_atstring | null · date-time
updated_atstring | null · date-time
public_view_codestring | null · pattern: ^\d+$
public_view_code_expires_atstring | null · date-time
versioninteger
pre_textstring | null
post_textstring | null
detailsobject[]
prices_are_incl_taxboolean
Default: false
total_price_excl_tax
total_price_excl_tax_base
total_price_incl_tax
total_price_incl_tax_base
total_discount
urlstring
custom_fieldsobject[]
notesobject[]
attachmentsobject[]
eventsobject[]
tax_totalsobject[]

event_response

administration_id
user_idstring | integer · pattern: ^\d+$
A unique record identifier
actionstring
link_entity_idstring | integer | null · pattern: ^\d+$
A unique record identifier
link_entity_typestring | null
dataobject
created_atstring · date-time
updated_atstring · date-time

extended_user_response

idstring | integer · pattern: ^\d+$
A unique record identifier
namestring
created_atstring · date-time
updated_atstring · date-time
emailstring
email_validatedboolean
languagestring
time_zonestring
user_typestring · enum
Enum values:
end_user
api_user
system_user
deleted_end_user
deleted_api_user
permissionsstring[]
Enum values:
sales_invoices
documents
estimates
bank
settings
ownership
time_entries

external_sales_invoice_response

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
contact
datestring · date
statestring · enum
Enum values:
new
open
late
paid
uncollectible
pending_payment
due_datestring | null · date
referencestring | null
entry_numberinteger
originstring | null · enum
Enum values:
upload
endpoint
si
email
si_local
si_peppol
api
moneybird_bv
sourcestring | null
source_urlstring | null
currencystring
ISO 4217 currency code
paid_atstring | null · date
created_atstring · date-time
updated_atstring · date-time
versioninteger
detailsobject[]
paymentsobject[]
total_paidstring
total_unpaidstring
total_unpaid_basestring
prices_are_incl_taxboolean
total_price_excl_taxstring
total_price_excl_tax_basestring
total_price_incl_taxstring
total_price_incl_tax_basestring
marked_dubious_onstring | null · date
marked_uncollectible_onstring | null · date
notesobject[]
attachmentsobject[]
eventsobject[]
tax_totalsobject[]

financial_account_response

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
typestring
namestring
identifierstring
currencystring
ISO 4217 currency code
providerstring | null
activeboolean
Default: true
created_atstring · date-time
updated_atstring · date-time

financial_mutation_response

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
amountstring
codestring | null
datestring · date
messagestring | null
contra_account_namestring | null
contra_account_numberstring
statestring · enum
Enum values:
unprocessed
processed
Default: unprocessed
amount_openstring
sepa_fieldsobject | null
batch_referencestring | null
financial_account_idstring | integer · pattern: ^\d+$
A unique record identifier
currencystring
ISO 4217 currency code
original_amountstring | null
created_atstring · date-time
updated_atstring · date-time
versioninteger
financial_statement_idstring | integer · pattern: ^\d+$
A unique record identifier
processed_atstring | null · date-time
account_servicer_transaction_idstring | null
paymentsobject[]
ledger_account_bookingsobject[]

financial_statement_response

idstring | integer · pattern: ^\d+$
A unique record identifier
financial_account_idstring | integer · pattern: ^\d+$
A unique record identifier
referencestring
official_datestring | null · date
official_balancestring | null
importer_servicestring | null
financial_mutationsobject[]

general_document_response

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
contact
referencestring | null
datestring · date
due_datestring | null · date
entry_numberinteger | null
statestring · enum
Enum values:
new
open
late
paid
saved
pending_payment
exchange_ratestring | null
created_atstring · date-time
updated_atstring · date-time
versioninteger
notesobject[]
attachmentsobject[]
eventsobject[]

general_journal_document_entry_response

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
ledger_account_idstring | integer · pattern: ^\d+$
A unique record identifier
project_idstring | integer | null · pattern: ^\d+$
A unique record identifier
contact_idstring | integer | null · pattern: ^\d+$
A unique record identifier
debitstring
creditstring
row_orderinteger | null
created_atstring · date-time
updated_atstring · date-time
descriptionstring | null

general_journal_document_response

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
referencestring | null
datestring · date
journal_typestring | null · enum
Enum values:
fiscal_year_ending
created_atstring · date-time
updated_atstring · date-time
versioninteger
general_journal_document_entriesobject[]
notesobject[]
attachmentsobject[]
eventsobject[]

goal_response

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
kindstring

identifier

string | integer · pattern: ^\d+$

A unique record identifier

identifier_nullable

string | integer | null · pattern: ^\d+$

A unique record identifier

identity_response

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
company_namestring | null
citystring | null
countrystring | null
zipcodestring | null
address1string | null
address2string | null
emailstring | null
phonestring | null
bank_account_namestring | null
bank_account_numberstring | null
bank_account_bicstring | null
custom_fieldsobject[]
updated_atstring · date-time
created_atstring · date-time
chamber_of_commercestring | null
tax_numberstring | null

ledger_account_booking_response

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
financial_mutation_idstring | integer · pattern: ^\d+$
A unique record identifier
ledger_account_idstring | integer · pattern: ^\d+$
A unique record identifier
project_idstring | integer | null · pattern: ^\d+$
A unique record identifier
descriptionstring | null
pricestring
created_atstring · date-time
updated_atstring · date-time

ledger_account_data

string

ledger_account_response

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
namestring
account_typestring · enum
Enum values:
non_current_assets
current_assets
equity
non_current_liabilities
current_liabilities
revenue
direct_costs
expenses
account_idstring | null
parent_idstring | integer | null · pattern: ^\d+$
A unique record identifier
created_atstring · date-time
updated_atstring · date-time
allowed_document_typesstring[]
Enum values:
sales_invoice
purchase_invoice
general_journal_document
financial_mutation
payment
taxonomy_itemobject
financial_account_idstring | integer | null · pattern: ^\d+$
A unique record identifier

minimal_contact_response

idstring | integer · pattern: ^\d+$
A unique record identifier
firstnamestring | null
lastnamestring | null
company_namestring | null

minimal_time_entry_response

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
project_idstring | integer | null · pattern: ^\d+$
A unique record identifier
user_idstring | integer · pattern: ^\d+$
A unique record identifier
started_atstring · date-time
ended_atstring · date-time
descriptionstring | null
paused_durationstring
billableboolean
created_atstring · date-time
updated_atstring · date-time

non_symbolic_error

errorobject

note_response

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

number

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = string
	type = number
	type = null

Properties for Variant 1:

string · pattern: ^-?[0-9]+[,\.]?[0-9]…

payment_response

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
invoice_typestring · enum
Enum values:
SalesInvoice
Document
ExternalSalesInvoice
VatDocument
invoice_idstring | integer · pattern: ^\d+$
A unique record identifier
financial_account_idstring | integer | null · pattern: ^\d+$
A unique record identifier
user_idstring | integer · pattern: ^\d+$
A unique record identifier
payment_transaction_idstring | integer | null · pattern: ^\d+$
A unique record identifier
transaction_identifierstring | null
price
price_base
payment_datestring · date
credit_invoice_idstring | integer | null · pattern: ^\d+$
A unique record identifier
financial_mutation_idstring | integer | null · pattern: ^\d+$
A unique record identifier
ledger_account_idstring | integer | null · pattern: ^\d+$
A unique record identifier
linked_payment_idstring | integer | null · pattern: ^\d+$
A unique record identifier
manual_payment_actionstring | null
created_atstring · date-time
updated_atstring · date-time

period_response

string · pattern: ^\d{6,8}..\d{6,8}$

product_response

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
descriptionstring | null
titlestring | null
identifierstring | null
pricestring
currencystring
frequencyinteger | null
frequency_typestring | null · enum
Enum values:
day
week
month
quarter
year
tax_rate_idstring | integer | null · pattern: ^\d+$
A unique record identifier
ledger_account_idstring | integer · pattern: ^\d+$
A unique record identifier
created_atstring · date-time
updated_atstring · date-time

project_report_item

project_idstring | integer | null · pattern: ^\d+$ · required
A unique record identifier
amountstring · required

project_response

idstring | integer · pattern: ^\d+$
A unique record identifier
namestring
statestring · enum
Enum values:
active
archived
budgetinteger | null

purchase_invoice_response

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
contact
referencestring | null
datestring · date
due_datestring | null · date
entry_numberinteger | null
statestring · enum
Enum values:
new
open
late
paid
saved
pending_payment
currencystring
ISO 4217 currency code
exchange_ratestring | null
revenue_invoiceboolean | null
prices_are_incl_taxboolean | null
originstring | null · enum
Enum values:
upload
endpoint
si
email
si_local
si_peppol
api
moneybird_bv
paid_atstring | null · date
tax_numberstring | null
total_price_excl_taxstring | null
total_price_excl_tax_basestring | null
total_price_incl_taxstring | null
total_price_incl_tax_basestring | null
created_atstring · date-time
updated_atstring · date-time
versioninteger
detailsobject[]
paymentsobject[]
notesobject[]
attachmentsobject[]
eventsobject[]

purchase_transaction_batch_response

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
financial_account_idstring | integer · pattern: ^\d+$
A unique record identifier
statestring · enum
Enum values:
exported
cancelled
open
identifierstring
created_atstring · date-time
updated_atstring · date-time

purchase_transaction_response

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
financial_account_idstring | integer · pattern: ^\d+$
A unique record identifier
payment_instrument_idstring | integer | null · pattern: ^\d+$
A unique record identifier
statestring · enum
Enum values:
open
cancelled
paid
pending_payment
error
awaiting_authorization
preparing
sepa_ibanstring
sepa_iban_account_namestring
sepa_bicstring
source_sepa_ibanstring | null
source_sepa_iban_account_namestring | null
datestring | null · date
descriptionstring
end_to_end_idstring
contactobject
amountstring
created_atstring · date-time
updated_atstring · date-time
payable_typestring | null
payable_idstring | integer | null · pattern: ^\d+$
A unique record identifier
payment_methodstring | null

receipt_response

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
contact
referencestring | null
datestring · date
due_datestring | null · date
entry_numberinteger | null
statestring · enum
Enum values:
new
open
late
paid
saved
pending_payment
currencystring | null
exchange_rate
revenue_invoiceboolean | null
prices_are_incl_taxboolean | null
originstring | null · enum
Enum values:
upload
endpoint
si
email
si_local
si_peppol
api
moneybird_bv
paid_atstring | null · date
tax_numberstring | null
total_price_excl_taxstring | null
total_price_excl_tax_basestring | null
total_price_incl_taxstring | null
total_price_incl_tax_basestring | null
created_atstring · date-time
updated_atstring · date-time
versioninteger
detailsobject[]
paymentsobject[]
notesobject[]
attachmentsobject[]
eventsobject[]

recurring_contract_response

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

recurring_sales_invoice_response

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
contact_idstring | integer · pattern: ^\d+$
A unique record identifier
contactobject
contact_person_idstring | integer | null · pattern: ^\d+$
A unique record identifier
contact_person
workflow_idstring | integer · pattern: ^\d+$
A unique record identifier
start_datestring · date
invoice_datestring · date
last_datestring | null · date
activeboolean | null
payment_conditionsstring | null
referencestring | null
languagestring
currencystring
discountstring | null
first_due_intervalinteger
auto_sendboolean | null
sending_scheduled_atstring | null · date-time
sending_scheduled_user_idstring | integer | null · pattern: ^\d+$
A unique record identifier
frequency_typestring · enum
Enum values:
day
week
month
quarter
year
frequencyinteger
created_atstring | null · date-time
updated_atstring | null · date-time
versioninteger
prices_are_incl_taxboolean
total_price_excl_taxstring
total_price_excl_tax_basestring
total_price_incl_taxstring
total_price_incl_tax_basestring
detailsobject[]
custom_fieldsobject[]
notesobject[]
attachmentsobject[]
eventsobject[]
subscription

sales_invoice_response

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
contact_idstring | integer · pattern: ^\d+$
A unique record identifier
contactobject
contact_person_idstring | integer | null · pattern: ^\d+$
A unique record identifier
contact_person
invoice_idstring | null
recurring_sales_invoice_idstring | integer | null · pattern: ^\d+$
A unique record identifier
subscription_idstring | integer | null · pattern: ^\d+$
A unique record identifier
workflow_idstring | integer · pattern: ^\d+$
A unique record identifier
document_style_idstring | integer · pattern: ^\d+$
A unique record identifier
identity_idstring | integer · pattern: ^\d+$
A unique record identifier
draft_idinteger | null
statestring · enum
Enum values:
draft
scheduled
open
pending_payment
reminded
late
paid
uncollectible
invoice_datestring | null · date
due_datestring · date
payment_conditionsstring | null
payment_referencestring | null
short_payment_referencestring | null
referencestring | null
languagestring | null
currencystring
discountstring | null
original_sales_invoice_idstring | integer | null · pattern: ^\d+$
A unique record identifier
pausedboolean
paid_atstring | null · date
sent_atstring | null · date
created_atstring · date-time
updated_atstring · date-time
public_view_codestring | null
public_view_code_expires_atstring | null · date-time
versioninteger
detailsobject[]
paymentsobject[]
total_paidstring
total_unpaidstring
total_unpaid_basestring
prices_are_incl_taxboolean
total_price_excl_taxstring
total_price_excl_tax_basestring
total_price_incl_taxstring
total_price_incl_tax_basestring
total_discountstring
marked_dubious_onstring | null · date
marked_uncollectible_onstring | null · date
reminder_countinteger | null
next_reminderstring | null · date
original_estimate_idstring | integer | null · pattern: ^\d+$
A unique record identifier
urlstring
payment_urlstring
custom_fieldsobject[]
notesobject[]
attachmentsobject[]
eventsobject[]
tax_totalsobject[]
time_entriesobject[]

simple_contact_response

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
company_namestring | null
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
tax_numberstring | null
chamber_of_commercestring | null
bank_accountstring | null
is_trustedboolean
max_transfer_amountstring | 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 | null
created_atstring | null · date-time
updated_atstring | null · date-time
versioninteger
sales_invoices_urlstring
notesobject[]
custom_fieldsobject[]
contact_peopleobject[]
archivedboolean

source_response

idstring | integer · pattern: ^\d+$
A unique record identifier
asset_idstring | integer · pattern: ^\d+$
A unique record identifier
detail_idstring | integer · pattern: ^\d+$
A unique record identifier

subgoal_response

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
kindstring

subscription_additional_charge_response

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

subscription_product_response

start_datestring · date
end_datestring | null · date
product_idstring | integer · pattern: ^\d+$
A unique record identifier
productobject
amountstring
discountstring | null

subscription_response

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
start_datestring · date
end_datestring | null · date
frequencyinteger | null
frequency_typestring | null · enum
Enum values:
day
week
month
quarter
year
referencestring | null
cancelled_atstring | null · date-time
product_idstring | integer · pattern: ^\d+$
A unique record identifier
productobject
contact_idstring | integer · pattern: ^\d+$
A unique record identifier
contactobject
contact_person_idstring | integer | null · pattern: ^\d+$
A unique record identifier
contact_person
subscription_productsobject[]
recurring_sales_invoice_idstring | integer | null · pattern: ^\d+$
A unique record identifier

subscription_template_response

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
workflow_idstring | integer · pattern: ^\d+$
A unique record identifier
document_style_idstring | integer · pattern: ^\d+$
A unique record identifier
mergeableboolean
contact_can_updateboolean
productsobject[]

symbolic_error

errorstring
symbolicobject

tax_rate_response

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
namestring
percentage
tax_rate_typestring · enum
Enum values:
sales_invoice
purchase_invoice
general_journal_document
show_taxboolean | null
activeboolean | null
countrystring | null
created_atstring | null · date-time
updated_atstring | null · date-time

tax_subtotal_response

tax_rate_idstring | integer · pattern: ^\d+$
A unique record identifier
taxable_amount
taxable_amount_base
tax_amount
tax_amount_base

taxonomy_item_response

taxonomy_versionstring
codestring
namestring
name_englishstring | null
referencestring | null

time_entry_response

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
project_idstring | integer | null · pattern: ^\d+$
A unique record identifier
sales_invoice_idstring | integer | null · pattern: ^\d+$
A unique record identifier
user_idstring | integer · pattern: ^\d+$
A unique record identifier
started_atstring · date-time
ended_at
descriptionstring
paused_durationinteger
billableboolean | null
created_atstring · date-time
updated_atstring · date-time
contact
userobject
project
sales_invoice
eventsobject[]
notesobject[]

timestamp

string · date-time

typeless_document_response

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
contact
referencestring | null
datestring · date
statestring · enum
Enum values:
new
open
late
paid
saved
pending_payment
originstring | null · enum
Enum values:
upload
endpoint
si
email
si_local
si_peppol
api
moneybird_bv
created_atstring · date-time
updated_atstring · date-time
versioninteger
attachmentsobject[]
eventsobject[]

user_response

idstring | integer · pattern: ^\d+$
A unique record identifier
namestring
created_atstring · date-time
updated_atstring · date-time

value_change_response

typestring · enum
Enum values:
divestment
full_depreciation
manual
arbitrary
linear
datestring · date
amount
descriptionnull | string
externally_bookedboolean
asset_idstring | integer · pattern: ^\d+$
A unique record identifier

verification_response

emailsstring[]
bank_account_numbersstring[]
chamber_of_commerce_numberstring
tax_numberstring

verifications_response

emailsstring[]
bank_account_numbersstring[]
chamber_of_commerce_numberstring
tax_numberstring

version

integer

webhook_response

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
urlstring
enabled_eventsstring[]
last_http_statusinteger | string | null
HTTP status code of the request last received back from the webhook
last_http_bodystring | null
Body of the request last received back from the webhook
tokenstring

workflow_response

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
typestring
namestring
defaultboolean
currencystring
languagestring
activeboolean
prices_are_incl_taxboolean
created_atstring · date-time
updated_atstring · date-time