Financial mutations are the transactions on your financial accounts.
List all ids and versions
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 |
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
query Parameters
filterstring
Responses
IDs and versions of records
idinteger | stringversioninteger | string
Fetch financial mutations with given ids
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.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
A financial mutation
idstring | integer · pattern:^\d+$A unique record identifier
administration_idstring | integer · pattern:^\d+$A unique record identifier of an administration
amountstringcodestring | nulldatestring · datemessagestring | nullcontra_account_namestring | nullcontra_account_numberstringstatestring · enumEnum values:unprocessedprocessedDefault: unprocessedamount_openstringsepa_fieldsobject | nullbatch_referencestring | nullfinancial_account_idstring | integer · pattern:^\d+$A unique record identifier
currencystringISO 4217 currency code
original_amountstring | nullcreated_atstring · date-timeupdated_atstring · date-timeversionintegerfinancial_statement_idstring | integer · pattern:^\d+$A unique record identifier
processed_atstring | null · date-timeaccount_servicer_transaction_idstring | nullpaymentsobject[]ledger_account_bookingsobject[]
Links a financial mutation to a booking
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.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
idstring | integer · pattern:^\d+$· requiredA unique record identifier
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Request Body
booking_typestring · requiredCan be
SalesInvoice,Document,LedgerAccount,PaymentTransactionBatch,PurchaseTransaction,NewPurchaseInvoice,NewReceipt,PaymentTransaction,PurchaseTransactionBatch,ExternalSalesInvoice,PaymentorVatDocument.
booking_idstring | integer · pattern:^\d+$A unique record identifier
price_baseBoth a decimal and a string '10,95' are accepted.
priceBoth a decimal and a string '10,95' are accepted.
descriptionstringpayment_batch_identifierstringproject_idstring | integer · pattern:^\d+$Should be a valid project id.
mark_open_sepa_transaction_as_paidboolean | string
Responses
Status code
Unlinks a booking from a financial mutation
Unlinks a booking from a financial mutation.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
idstring | integer · pattern:^\d+$· requiredA unique record identifier
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Request Body
booking_typestring · enum · requiredCan be
PaymentorLedgerAccountBooking.Enum values:PaymentLedgerAccountBookingbooking_idstring | integer · pattern:^\d+$· requiredA unique record identifier
Responses
A financial mutation
idstring | integer · pattern:^\d+$A unique record identifier
administration_idstring | integer · pattern:^\d+$A unique record identifier of an administration
amountstringcodestring | nulldatestring · datemessagestring | nullcontra_account_namestring | nullcontra_account_numberstringstatestring · enumEnum values:unprocessedprocessedDefault: unprocessedamount_openstringsepa_fieldsobject | nullbatch_referencestring | nullfinancial_account_idstring | integer · pattern:^\d+$A unique record identifier
currencystringISO 4217 currency code
original_amountstring | nullcreated_atstring · date-timeupdated_atstring · date-timeversionintegerfinancial_statement_idstring | integer · pattern:^\d+$A unique record identifier
processed_atstring | null · date-timeaccount_servicer_transaction_idstring | nullpaymentsobject[]ledger_account_bookingsobject[]
Get a financial mutation by id
Returns a single financial mutation in the administration.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
idstring | integer · pattern:^\d+$· requiredA unique record identifier
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
A financial mutation
idstring | integer · pattern:^\d+$A unique record identifier
administration_idstring | integer · pattern:^\d+$A unique record identifier of an administration
amountstringcodestring | nulldatestring · datemessagestring | nullcontra_account_namestring | nullcontra_account_numberstringstatestring · enumEnum values:unprocessedprocessedDefault: unprocessedamount_openstringsepa_fieldsobject | nullbatch_referencestring | nullfinancial_account_idstring | integer · pattern:^\d+$A unique record identifier
currencystringISO 4217 currency code
original_amountstring | nullcreated_atstring · date-timeupdated_atstring · date-timeversionintegerfinancial_statement_idstring | integer · pattern:^\d+$A unique record identifier
processed_atstring | null · date-timeaccount_servicer_transaction_idstring | nullpaymentsobject[]ledger_account_bookingsobject[]
List all financial mutations
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.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
query Parameters
filterstring
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
amountstringcodestring | nulldatestring · datemessagestring | nullcontra_account_namestring | nullcontra_account_numberstringstatestring · enumEnum values:unprocessedprocessedDefault: unprocessedamount_openstringsepa_fieldsobject | nullbatch_referencestring | nullfinancial_account_idstring | integer · pattern:^\d+$A unique record identifier
currencystringISO 4217 currency code
original_amountstring | nullcreated_atstring · date-timeupdated_atstring · date-timeversionintegerfinancial_statement_idstring | integer · pattern:^\d+$A unique record identifier
processed_atstring | null · date-timeaccount_servicer_transaction_idstring | nullpaymentsobject[]ledger_account_bookingsobject[]