Moneybird API

Schemas

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

administration_response

id

string | integer · pattern: ^\d+$

A unique record identifier

name

string

language

string · enum

The ISO 639-1 language code used in the administration

Enum values:

nl-be

currency

string

The ISO 4217 currency code

country

string

The ISO 3166-1 alpha-2 code the administration country

time_zone

string

The time zone of the administration

access

string · enum

The type of acess the user has to this administration

Enum values:

accountant_company

user

suspended

boolean

period_locked_until

string | null · date

asset_response

id

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

A unique record identifier

ledger_account_id

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

A unique record identifier

name

string

purchase_date

string · date

value_change_plan

object | null

object[]

attachment_response

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

attachable_id

string | integer · pattern: ^\d+$

A unique record identifier

attachable_type

string · enum

Enum values:

SalesInvoice

RecurringSalesInvoice

Document

FinancialStatement

Workflow

Estimate

ExternalSalesInvoice

filename

string

content_type

string

size

integer

rotation

integer | null

created_at

string | null · date-time

updated_at

string | null · date-time

balance_sheet_ledger_account

object[]

A list of ledger accounts with their value and child accounts

ledger_account_id

string

value

string

object[]

base_contact_response

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

company_name

firstname

string | null

lastname

string | null

address1

string | null

address2

string | null

zipcode

string | null

city

string | null

country

string

phone

string | null

delivery_method

string | null · enum

Enum values:

Post

Manual

Simplerinvoicing

Peppol

customer_id

string

Will be assigned automatically if empty

tax_number

string | null

chamber_of_commerce

string | null

bank_account

string | null

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

is_trusted

boolean

Default: default

max_transfer_amount

number | null

attention

string | null

email

string | null

email_ubl

boolean

send_invoices_to_attention

string | null

send_invoices_to_email

string | null

send_estimates_to_attention

string | null

send_estimates_to_email

string | null

sepa_active

boolean | null

sepa_iban

string | null

sepa_iban_account_name

string | null

sepa_bic

string | null

sepa_mandate_id

string | null

sepa_mandate_date

string | null · date

sepa_sequence_type

string · enum

Enum values:

RCUR

FRST

OOFF

FNAL

credit_card_number

string | null

credit_card_reference

string | null

credit_card_type

string | null · enum

Enum values:

mastercard

visa

tax_number_validated_at

string | null · date-time

tax_number_valid

boolean | null

invoice_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 | null

si_identifier_type

string | null

moneybird_payments_mandate

boolean

Whether the contact has a valid Moneybird Payments mandate

created_at

string · date-time

updated_at

string · date-time

version

integer

sales_invoices_url

string · uri · pattern: ^https:\/\/moneybird…

object[]

archived

boolean

base_user_response

id

string | integer · pattern: ^\d+$

A unique record identifier

name

string

created_at

string · date-time

updated_at

string · date-time

contact_person_response

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

firstname

string | null

lastname

string | null

phone

string | null

email

string | null

department

string | null

created_at

string | null · date-time

updated_at

string | null · date-time

version

integer

contact_report_item

Contact report data item

contact_id

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

A unique record identifier

amount

string · required

contact_response

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

company_name

firstname

string | null

lastname

string | null

address1

string | null

address2

string | null

zipcode

string | null

city

string | null

country

string

phone

string | null

delivery_method

string | null · enum

Enum values:

Post

Manual

Simplerinvoicing

Peppol

customer_id

string

Will be assigned automatically if empty

tax_number

string | null

chamber_of_commerce

string | null

bank_account

string | null

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

is_trusted

boolean

Default: default

max_transfer_amount

number | null

attention

string | null

email

string | null

email_ubl

boolean

send_invoices_to_attention

string | null

send_invoices_to_email

string | null

send_estimates_to_attention

string | null

send_estimates_to_email

string | null

sepa_active

boolean | null

sepa_iban

string | null

sepa_iban_account_name

string | null

sepa_bic

string | null

sepa_mandate_id

string | null

sepa_mandate_date

string | null · date

sepa_sequence_type

string · enum

Enum values:

RCUR

FRST

OOFF

FNAL

credit_card_number

string | null

credit_card_reference

string | null

credit_card_type

string | null · enum

Enum values:

mastercard

visa

tax_number_validated_at

string | null · date-time

tax_number_valid

boolean | null

invoice_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 | null

si_identifier_type

string | null

moneybird_payments_mandate

boolean

Whether the contact has a valid Moneybird Payments mandate

created_at

string · date-time

updated_at

string · date-time

version

integer

sales_invoices_url

string · uri · pattern: ^https:\/\/moneybird…

object[]

archived

boolean

object[]

creditors_report_item

Creditors report data item

contact_id

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

A unique record identifier

amount

string · required

currency

string

ISO 4217 currency code

custom_field_response

id

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

A unique record identifier

name

string

source

string | null · enum

Enum values:

sales_invoice

estimate

contact

identity

custom_field_value_response

id

string | integer · pattern: ^\d+$

A unique record identifier

name

string

value

string

custom_fields_attributes

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = array

Properties for Variant 1:

id

integer | string · required

value

string · required

debtors_report_item

Debtors report data item

contact_id

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

A unique record identifier

amount

string · required

detail_response

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

tax_rate_id

string | integer · pattern: ^\d+$

A unique record identifier

ledger_account_id

string | integer · pattern: ^\d+$

A unique record identifier

project_id

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

A unique record identifier

product_id

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

A unique record identifier

amount

string | null

amount_decimal

string | null

description

string

price

string · pattern: ^-?\d+\.\d{1,2}$

period

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

row_order

integer

tax_report_reference

(string | null)[]

mandatory_tax_text

string | null

created_at

string | null · date-time

updated_at

string | null · date-time

is_optional

boolean

is_selected

boolean

details_attributes

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = array

Properties for Variant 1:

id

integer | string

description

string

period

string

String with a date range: 20140101..20141231, presets are also allowed: this_month, prev_month, next_month, etc.

Both a decimal and a string '10,95' are accepted.

amount

integer | string

tax_rate_id

integer | string

Should be a valid tax rate id.

ledger_account_id

integer | string

Should be a valid ledger account id.

project_id

integer | string

Should be a valid project id.

product_id

integer | string

Should be a valid product id.

row_order

integer | string

is_optional

boolean | string

is_selected

boolean | string

_destroy

boolean | string

automated_tax_enabled

boolean | string

disposal_response

date

string · date

reason

string · enum

Enum values:

out_of_use

sold

private_withdrawal

divested

externally_booked

boolean

asset_id

string | integer · pattern: ^\d+$

A unique record identifier

document_style_response

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

name

string

identity_id

string | integer · pattern: ^\d+$

A unique record identifier

default

boolean

logo_hash

string | null

logo_container_full_width

boolean | null

Default: false

logo_display_width

integer | null

Default: 50

logo_position

string · enum

Enum values:

left

center

right

background_hash

string | null

paper_size

string · enum

Enum values:

letter

address_position

string · enum

Enum values:

left

right

font_size

integer

font_family

string

print_on_stationery

boolean | null

Default: false

custom_css

string | null

object[]

created_at

string | null · date-time

updated_at

string | null · date-time

download_response

id

string | integer · pattern: ^\d+$

A unique record identifier

user_id

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

The user who created the download

download_type

string

The type of download (e.g., export_contacts, export_sales_invoices, auditfile)

filename

string

content_type

string

failed

boolean

downloaded

boolean

created_at

string · date-time

updated_at

string · date-time

estimate_response

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

contact_id

string | integer · pattern: ^\d+$

A unique record identifier

contact_person_id

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

A unique record identifier

estimate_id

string | null

estimate_sequence_id

string | null

workflow_id

string | integer · pattern: ^\d+$

A unique record identifier

document_style_id

string | integer · pattern: ^\d+$

A unique record identifier

identity_id

string | integer · pattern: ^\d+$

A unique record identifier

draft_id

integer | null

state

string · enum

Enum values:

draft

open

late

accepted

rejected

billed

archived

estimate_date

string | null · date

due_date

string · date

reference

string | null

language

string | null

currency

string

original_estimate_id

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

A unique record identifier

show_tax

boolean

Default: true

sign_online

boolean

Default: true

sent_at

string | null · date

accepted_at

string | null · date

rejected_at

string | null · date

archived_at

string | null · date

created_at

string | null · date-time

updated_at

string | null · date-time

public_view_code

string | null · pattern: ^\d+$

public_view_code_expires_at

string | null · date-time

version

integer

pre_text

string | null

post_text

string | null

object[]

prices_are_incl_tax

boolean

Default: false

url

string

object[]

event_response

user_id

string | integer · pattern: ^\d+$

A unique record identifier

action

string

link_entity_id

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

A unique record identifier

link_entity_type

string | null

object

created_at

string · date-time

updated_at

string · date-time

extended_user_response

id

string | integer · pattern: ^\d+$

A unique record identifier

name

string

created_at

string · date-time

updated_at

string · date-time

email

string

email_validated

boolean

language

string

time_zone

string

user_type

string · enum

Enum values:

end_user

api_user

system_user

deleted_end_user

deleted_api_user

permissions

string[]

Enum values:

sales_invoices

documents

estimates

bank

settings

ownership

time_entries

external_sales_invoice_response

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

contact_id

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

A unique record identifier

date

string · date

state

string · enum

Enum values:

new

open

late

paid

uncollectible

pending_payment

due_date

string | null · date

reference

string | null

entry_number

integer

origin

string | null · enum

Enum values:

upload

endpoint

si_local

si_peppol

api

moneybird_bv

source

string | null

source_url

string | null

currency

string

ISO 4217 currency code

paid_at

string | null · date

created_at

string · date-time

updated_at

string · date-time

version

integer

object[]

total_paid

string

total_unpaid

string

total_unpaid_base

string

prices_are_incl_tax

boolean

total_price_excl_tax

string

total_price_excl_tax_base

string

total_price_incl_tax

string

total_price_incl_tax_base

string

marked_dubious_on

string | null · date

marked_uncollectible_on

string | null · date

object[]

financial_account_response

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

type

string

name

string

identifier

string

currency

string

ISO 4217 currency code

provider

string | null

active

boolean

Default: true

created_at

string · date-time

updated_at

string · date-time

financial_mutation_response

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

amount

string

code

string | null

date

string · date

message

string | null

contra_account_name

string | null

contra_account_number

string

state

string · enum

Enum values:

unprocessed

processed

Default: unprocessed

amount_open

string

sepa_fields

object | null

batch_reference

string | null

financial_account_id

string | integer · pattern: ^\d+$

A unique record identifier

currency

string

ISO 4217 currency code

original_amount

string | null

created_at

string · date-time

updated_at

string · date-time

version

integer

financial_statement_id

string | integer · pattern: ^\d+$

A unique record identifier

processed_at

string | null · date-time

account_servicer_transaction_id

string | null

object[]

financial_statement_response

id

string | integer · pattern: ^\d+$

A unique record identifier

financial_account_id

string | integer · pattern: ^\d+$

A unique record identifier

reference

string

official_date

string | null · date

official_balance

string | null

importer_service

string | null

object[]

general_document_response

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

contact_id

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

A unique record identifier

reference

string | null

date

string · date

due_date

string | null · date

entry_number

integer | null

state

string · enum

Enum values:

new

open

late

paid

saved

pending_payment

exchange_rate

string | null

created_at

string · date-time

updated_at

string · date-time

version

integer

object[]

general_journal_document_entry_response

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

ledger_account_id

string | integer · pattern: ^\d+$

A unique record identifier

project_id

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

A unique record identifier

contact_id

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

A unique record identifier

debit

string

credit

string

row_order

integer | null

created_at

string · date-time

updated_at

string · date-time

description

string | null

general_journal_document_response

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

reference

string | null

date

string · date

journal_type

string | null · enum

Enum values:

fiscal_year_ending

created_at

string · date-time

updated_at

string · date-time

version

integer

object[]

goal_response

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

kind

string

identifier

string | integer · pattern: ^\d+$

A unique record identifier

identifier_nullable

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

A unique record identifier

identity_response

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

company_name

string | null

city

string | null

country

string | null

zipcode

string | null

address1

string | null

address2

string | null

email

string | null

phone

string | null

bank_account_name

string | null

bank_account_number

string | null

bank_account_bic

string | null

object[]

updated_at

string · date-time

created_at

string · date-time

chamber_of_commerce

string | null

tax_number

string | null

ledger_account_booking_response

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

financial_mutation_id

string | integer · pattern: ^\d+$

A unique record identifier

ledger_account_id

string | integer · pattern: ^\d+$

A unique record identifier

project_id

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

A unique record identifier

description

string | null

price

string

created_at

string · date-time

updated_at

string · date-time

ledger_account_data

Data grouped by ledger account

string

ledger_account_response

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

name

string

account_type

string · enum

Enum values:

non_current_assets

current_assets

equity

non_current_liabilities

current_liabilities

revenue

direct_costs

expenses

account_id

string | null

parent_id

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

A unique record identifier

created_at

string · date-time

updated_at

string · date-time

allowed_document_types

string[]

Enum values:

sales_invoice

purchase_invoice

general_journal_document

financial_mutation

payment

object

financial_account_id

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

A unique record identifier

minimal_contact_response

id

string | integer · pattern: ^\d+$

A unique record identifier

firstname

string | null

lastname

string | null

company_name

string | null

minimal_time_entry_response

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

contact_id

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

A unique record identifier

project_id

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

A unique record identifier

user_id

string | integer · pattern: ^\d+$

A unique record identifier

started_at

string · date-time

ended_at

string · date-time

description

string | null

paused_duration

string

billable

boolean

created_at

string · date-time

updated_at

string · date-time

non_symbolic_error

object

note_response

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

entity_id

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

A unique record identifier

entity_type

string

user_id

string | integer · pattern: ^\d+$

A unique record identifier

assignee_id

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

A unique record identifier

todo

boolean | string | null

Default: false

note

string | null

completed_at

string | null · date-time

completed_by_id

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

A unique record identifier

todo_type

string | 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

data

object | null

created_at

string · date-time

updated_at

string · 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

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

invoice_type

string · enum

Enum values:

SalesInvoice

Document

ExternalSalesInvoice

VatDocument

invoice_id

string | integer · pattern: ^\d+$

A unique record identifier

financial_account_id

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

A unique record identifier

user_id

string | integer · pattern: ^\d+$

A unique record identifier

payment_transaction_id

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

A unique record identifier

transaction_identifier

string | null

payment_date

string · date

credit_invoice_id

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

A unique record identifier

financial_mutation_id

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

A unique record identifier

ledger_account_id

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

A unique record identifier

linked_payment_id

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

A unique record identifier

manual_payment_action

string | null

created_at

string · date-time

updated_at

string · date-time

period_response

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

product_response

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

description

string | null

title

string | null

identifier

string | null

price

string

currency

string

frequency

integer | null

frequency_type

string | null · enum

Enum values:

day

week

month

quarter

year

tax_rate_id

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

A unique record identifier

ledger_account_id

string | integer · pattern: ^\d+$

A unique record identifier

created_at

string · date-time

updated_at

string · date-time

project_report_item

Project report data item

project_id

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

A unique record identifier

amount

string · required

project_response

id

string | integer · pattern: ^\d+$

A unique record identifier

name

string

state

string · enum

Enum values:

active

archived

budget

integer | null

purchase_invoice_response

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

contact_id

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

A unique record identifier

reference

string | null

date

string · date

due_date

string | null · date

entry_number

integer | null

state

string · enum

Enum values:

new

open

late

paid

saved

pending_payment

currency

string

ISO 4217 currency code

exchange_rate

string | null

revenue_invoice

boolean | null

prices_are_incl_tax

boolean | null

origin

string | null · enum

Enum values:

upload

endpoint

si_local

si_peppol

api

moneybird_bv

paid_at

string | null · date

tax_number

string | null

total_price_excl_tax

string | null

total_price_excl_tax_base

string | null

total_price_incl_tax

string | null

total_price_incl_tax_base

string | null

created_at

string · date-time

updated_at

string · date-time

version

integer

object[]

purchase_transaction_batch_response

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

financial_account_id

string | integer · pattern: ^\d+$

A unique record identifier

state

string · enum

Enum values:

exported

cancelled

open

identifier

string

created_at

string · date-time

updated_at

string · date-time

purchase_transaction_response

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

financial_account_id

string | integer · pattern: ^\d+$

A unique record identifier

payment_instrument_id

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

A unique record identifier

state

string · enum

Enum values:

open

cancelled

paid

pending_payment

error

awaiting_authorization

preparing

sepa_iban

string

sepa_iban_account_name

string

sepa_bic

string

source_sepa_iban

string | null

source_sepa_iban_account_name

string | null

date

string | null · date

description

string

end_to_end_id

string

object

amount

string

created_at

string · date-time

updated_at

string · date-time

payable_type

string | null

payable_id

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

A unique record identifier

payment_method

string | null

receipt_response

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

contact_id

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

A unique record identifier

reference

string | null

date

string · date

due_date

string | null · date

entry_number

integer | null

state

string · enum

Enum values:

new

open

late

paid

saved

pending_payment

currency

string | null

revenue_invoice

boolean | null

prices_are_incl_tax

boolean | null

origin

string | null · enum

Enum values:

upload

endpoint

si_local

si_peppol

api

moneybird_bv

paid_at

string | null · date

tax_number

string | null

total_price_excl_tax

string | null

total_price_excl_tax_base

string | null

total_price_incl_tax

string | null

total_price_incl_tax_base

string | null

created_at

string · date-time

updated_at

string · date-time

version

integer

object[]

recurring_contract_response

type

string | null

sepa_mandate

boolean

bank

string | null

iban

string | null

bic

string | null

iban_account_name

string | null

card_expiry_month

string | null

card_expiry_year

string | null

card_final_digits

string | null

created_at

string · date-time

recurring_sales_invoice_response

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

contact_id

string | integer · pattern: ^\d+$

A unique record identifier

object

contact_person_id

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

A unique record identifier

workflow_id

string | integer · pattern: ^\d+$

A unique record identifier

start_date

string · date

invoice_date

string · date

last_date

string | null · date

active

boolean | null

payment_conditions

string | null

reference

string | null

language

string

currency

string

discount

string | null

first_due_interval

integer

auto_send

boolean | null

sending_scheduled_at

string | null · date-time

sending_scheduled_user_id

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

A unique record identifier

frequency_type

string · enum

Enum values:

day

week

month

quarter

year

frequency

integer

created_at

string | null · date-time

updated_at

string | null · date-time

version

integer

prices_are_incl_tax

boolean

total_price_excl_tax

string

total_price_excl_tax_base

string

total_price_incl_tax

string

total_price_incl_tax_base

string

object[]

sales_invoice_response

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

contact_id

string | integer · pattern: ^\d+$

A unique record identifier

object

contact_person_id

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

A unique record identifier

invoice_id

string | null

recurring_sales_invoice_id

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

A unique record identifier

subscription_id

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

A unique record identifier

workflow_id

string | integer · pattern: ^\d+$

A unique record identifier

document_style_id

string | integer · pattern: ^\d+$

A unique record identifier

identity_id

string | integer · pattern: ^\d+$

A unique record identifier

draft_id

integer | null

state

string · enum

Enum values:

draft

scheduled

open

pending_payment

reminded

late

paid

uncollectible

invoice_date

string | null · date

due_date

string · date

payment_conditions

string | null

payment_reference

string | null

short_payment_reference

string | null

reference

string | null

language

string | null

currency

string

discount

string | null

original_sales_invoice_id

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

A unique record identifier

paused

boolean

paid_at

string | null · date

sent_at

string | null · date

created_at

string · date-time

updated_at

string · date-time

public_view_code

string | null

public_view_code_expires_at

string | null · date-time

version

integer

object[]

total_paid

string

total_unpaid

string

total_unpaid_base

string

prices_are_incl_tax

boolean

total_price_excl_tax

string

total_price_excl_tax_base

string

total_price_incl_tax

string

total_price_incl_tax_base

string

total_discount

string

marked_dubious_on

string | null · date

marked_uncollectible_on

string | null · date

reminder_count

integer | null

next_reminder

string | null · date

original_estimate_id

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

A unique record identifier

url

string

payment_url

string

object[]

simple_contact_response

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

company_name

string | null

firstname

string | null

lastname

string | null

address1

string | null

address2

string | null

zipcode

string | null

city

string | null

country

string

phone

string | null

delivery_method

string | null · enum

Enum values:

Post

Manual

Simplerinvoicing

Peppol

customer_id

string

tax_number

string | null

chamber_of_commerce

string | null

bank_account

string | null

is_trusted

boolean

max_transfer_amount

string | null

attention

string | null

email

string | null

email_ubl

boolean

send_invoices_to_attention

string | null

send_invoices_to_email

string | null

send_estimates_to_attention

string | null

send_estimates_to_email

string | null

sepa_active

boolean | null

sepa_iban

string | null

sepa_iban_account_name

string | null

sepa_bic

string | null

sepa_mandate_id

string | null

sepa_mandate_date

string | null · date

sepa_sequence_type

string · enum

Enum values:

RCUR

FRST

OOFF

FNAL

credit_card_number

string | null

credit_card_reference

string | null

credit_card_type

string | null · enum

Enum values:

mastercard

visa

tax_number_validated_at

string | null · date-time

tax_number_valid

boolean | null

invoice_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 | null

si_identifier_type

string | null

moneybird_payments_mandate

boolean | null

created_at

string | null · date-time

updated_at

string | null · date-time

version

integer

sales_invoices_url

string

object[]

archived

boolean

source_response

id

string | integer · pattern: ^\d+$

A unique record identifier

asset_id

string | integer · pattern: ^\d+$

A unique record identifier

detail_id

string | integer · pattern: ^\d+$

A unique record identifier

subgoal_response

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

kind

string

subscription_additional_charge_response

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

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 | null

price

string

period

string · pattern: ^[0-9]{6}..[0-9]{6}$

description

string

subscription_product_response

start_date

string · date

end_date

string | null · date

product_id

string | integer · pattern: ^\d+$

A unique record identifier

object

amount

string

discount

string | null

subscription_response

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

start_date

string · date

end_date

string | null · date

frequency

integer | null

frequency_type

string | null · enum

Enum values:

day

week

month

quarter

year

reference

string | null

cancelled_at

string | null · date-time

product_id

string | integer · pattern: ^\d+$

A unique record identifier

object

contact_id

string | integer · pattern: ^\d+$

A unique record identifier

object

contact_person_id

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

A unique record identifier

object[]

recurring_sales_invoice_id

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

A unique record identifier

subscription_template_response

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

workflow_id

string | integer · pattern: ^\d+$

A unique record identifier

document_style_id

string | integer · pattern: ^\d+$

A unique record identifier

mergeable

boolean

contact_can_update

boolean

object[]

symbolic_error

error

string

object

tax_rate_response

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

name

string

tax_rate_type

string · enum

Enum values:

sales_invoice

purchase_invoice

general_journal_document

show_tax

boolean | null

active

boolean | null

country

string | null

created_at

string | null · date-time

updated_at

string | null · date-time

tax_subtotal_response

tax_rate_id

string | integer · pattern: ^\d+$

A unique record identifier

taxonomy_item_response

taxonomy_version

string

code

string

name

string

name_english

string | null

reference

string | null

time_entry_response

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

contact_id

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

A unique record identifier

project_id

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

A unique record identifier

sales_invoice_id

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

A unique record identifier

user_id

string | integer · pattern: ^\d+$

A unique record identifier

started_at

string · date-time

description

string

paused_duration

integer

billable

boolean | null

created_at

string · date-time

updated_at

string · date-time

object

object[]

timestamp

string · date-time

typeless_document_response

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

contact_id

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

A unique record identifier

reference

string | null

date

string · date

state

string · enum

Enum values:

new

open

late

paid

saved

pending_payment

origin

string | null · enum

Enum values:

upload

endpoint

si_local

si_peppol

api

moneybird_bv

created_at

string · date-time

updated_at

string · date-time

version

integer

object[]

user_response

id

string | integer · pattern: ^\d+$

A unique record identifier

name

string

created_at

string · date-time

updated_at

string · date-time

value_change_response

type

string · enum

Enum values:

divestment

full_depreciation

manual

arbitrary

linear

date

string · date

description

null | string

externally_booked

boolean

asset_id

string | integer · pattern: ^\d+$

A unique record identifier

verification_response

emails

string[]

bank_account_numbers

string[]

chamber_of_commerce_number

string

tax_number

string

verifications_response

emails

string[]

bank_account_numbers

string[]

chamber_of_commerce_number

string

tax_number

string

version

integer

webhook_response

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

url

string

enabled_events

string[]

last_http_status

integer | string | null

HTTP status code of the request last received back from the webhook

last_http_body

string | null

Body of the request last received back from the webhook

token

string

workflow_response

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

type

string

name

string

default

boolean

currency

string

language

string

active

boolean

prices_are_incl_tax

boolean

created_at

string · date-time

updated_at

string · date-time