Moneybird API

Financial mutations

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

Financial mutations are the transactions on your financial accounts.

List all ids and versions

GET

https://moneybird.com/api/v2

/{administration_id}/financial_mutations/synchronization{format}

Returns all financial mutations in the administration. The list contains the id and the version of the financial mutation. Check if the version of the financial mutation is newer than the version you have stored locally, use the POST variant for fetching financial mutations with the given ids. The filter argument allows you to filter the list of financial mutations. Filters are a combination of keys and values, separated by a comma: period:this_year,state:all. The available options for filtering are:

Filter	Type	Default	Description
period	`String`	`this_year`	This can either be the description of a period (`this_month`, `prev_month`, `next_month`, `this_quarter`, `prev_quarter`, `next_quarter`, `this_year`, `prev_year`, `next_year`) or a custom period (`201301..201302`, `20130101..20130131`)
state	`String`		Can be `all`, `unprocessed` or `processed`
mutation_type	`String`		Can be `all`, `debit` or `credit`
financial_account_id	`String`

List all ids and versions › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

List all ids and versions › query Parameters

filterstring

List all ids and versions › Responses

IDs and versions of records

idinteger | string
versioninteger | string

Fetch financial mutations with given ids

POST

https://moneybird.com/api/v2

/{administration_id}/financial_mutations/synchronization{format}

Given a list of financial mutation ids, returns the financial mutation information belonging to the financial mutation. Returns a maximum of 100 financial mutations, even if more ids are provided.

Fetch financial mutations with given ids › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Fetch financial mutations with given ids › Request Body

ids(integer | string)[] · required

Fetch financial mutations with given ids › Responses

A financial mutation

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

Links a financial mutation to a booking

PATCH

https://moneybird.com/api/v2

/{administration_id}/financial_mutations/{id}/link_booking{format}

Linking a booking to a financial mutations allows you to process financial mutations. Financial mutations can be linked to invoices, documents, ledger accounts and payment batches.

Links a financial mutation to a booking › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
idstring | integer · pattern: ^\d+$ · required
A unique record identifier
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Links a financial mutation to a booking › Request Body

booking_typestring · required
Can be SalesInvoice, Document, LedgerAccount, PaymentTransactionBatch, PurchaseTransaction, NewPurchaseInvoice, NewReceipt, PaymentTransaction, PurchaseTransactionBatch, ExternalSalesInvoice, Payment or VatDocument.

booking_idstring | integer · pattern: ^\d+$
A unique record identifier
price_base
Both a decimal and a string '10,95' are accepted.
price
Both a decimal and a string '10,95' are accepted.
descriptionstring
payment_batch_identifierstring
project_idstring | integer · pattern: ^\d+$
Should be a valid project id.
mark_open_sepa_transaction_as_paidboolean | string

Links a financial mutation to a booking › Responses

Status code

integer

Unlinks a booking from a financial mutation

DELETE

https://moneybird.com/api/v2

/{administration_id}/financial_mutations/{id}/unlink_booking{format}

Unlinks a booking from a financial mutation.

Unlinks a booking from a financial mutation › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
idstring | integer · pattern: ^\d+$ · required
A unique record identifier
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Unlinks a booking from a financial mutation › Request Body

booking_typestring · enum · required
Can be Payment or LedgerAccountBooking.
Enum values:
Payment
LedgerAccountBooking
booking_idstring | integer · pattern: ^\d+$ · required
A unique record identifier

Unlinks a booking from a financial mutation › Responses

A financial mutation

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

Get a financial mutation by id

GET

https://moneybird.com/api/v2

/{administration_id}/financial_mutations/{id}{format}

Returns a single financial mutation in the administration.

Get a financial mutation by id › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
idstring | integer · pattern: ^\d+$ · required
A unique record identifier
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Get a financial mutation by id › Responses

A financial mutation

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

List all financial mutations

GET

https://moneybird.com/api/v2

/{administration_id}/financial_mutations{format}

Returns a list of financial mutations in the administration. Limited to 100 financial mutations. If you need more financial mutations, use the synchronize API.

The filter argument allows you to filter on the list of financial mutations. Filters are a combination of keys and values, separated by a comma: key:value,key2:value2. The most common filter method will be period: period:this_month. Filtering works the same as in the web application, for more advanced examples, change the filtering in the web application and learn from the resulting URI.

List all financial mutations › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

List all financial mutations › query Parameters

filterstring

List all financial mutations › Responses

A list of financial mutations

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 accounts Financial statements