Receipts are proofs of payment for expenses.
List ids and versions of receipts
Returns all documents in the administration. The list contains the document id and the version of the document.
Check if the version of the document is newer than the version you have stored locally, use the POST
variant for fetching documents with the given ids.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
query Parameters
filterString terms, example: key1:value1,key2:value2.
List ids and versions of receipts › Responses
IDs and versions of records
idversionFetch receipts with given ids
Given a list of document ids, returns the document information belonging to the documents. Returns a maximum of 100 documents, even if more ids are provided.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Fetch receipts with given ids › Responses
A list of receipts
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
contact_id^\d+$A unique record identifier
referencedatedue_dateentry_numberstatecurrencyrevenue_invoiceprices_are_incl_taxoriginpaid_attax_numbertotal_price_excl_taxtotal_price_excl_tax_basetotal_price_incl_taxtotal_price_incl_tax_basecreated_atupdated_atversionDownload attachment
Download the attachment. The response will be a redirect to a temporarily available URL
where the attachment can be downloaded. Use the Location header in the response
to download the attachment.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
attachment_id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Download attachment › Responses
Found
Delete an attachment
Deletes an attachment of an attachable.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
attachment_id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Delete an attachment › Responses
Attachment deleted
Add attachment to receipt
Add an attachment to a receipt.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Add attachment to receipt › Responses
Status code
Delete a payment
Deletes a payment from a receipt.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
payment_id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Delete a payment › Responses
Payment deleted
Create a payment
Registers a payment for a receipt.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Create a payment › Responses
Payment created
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
invoice_typeinvoice_id^\d+$A unique record identifier
financial_account_id^\d+$A unique record identifier
user_id^\d+$A unique record identifier
payment_transaction_id^\d+$A unique record identifier
transaction_identifierpayment_datecredit_invoice_id^\d+$A unique record identifier
financial_mutation_id^\d+$A unique record identifier
ledger_account_id^\d+$A unique record identifier
linked_payment_id^\d+$A unique record identifier
manual_payment_actioncreated_atupdated_atRegister a payment for a receipt
This endpoint is deprecated and should no longer be used. It has been replaced by Create a payment.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Register a payment for a receipt › Responses
Status code
Get a receipt
Returns a receipt by id.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Get a receipt › Responses
A receipt
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
contact_id^\d+$A unique record identifier
referencedatedue_dateentry_numberstatecurrencyrevenue_invoiceprices_are_incl_taxoriginpaid_attax_numbertotal_price_excl_taxtotal_price_excl_tax_basetotal_price_incl_taxtotal_price_incl_tax_basecreated_atupdated_atversionDelete a receipts
Deletes a receipt.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Delete a receipts › Responses
Status code
Update a receipt
Updates a receipt.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Update a receipt › Responses
Receipt updated
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
contact_id^\d+$A unique record identifier
referencedatedue_dateentry_numberstatecurrencyrevenue_invoiceprices_are_incl_taxoriginpaid_attax_numbertotal_price_excl_taxtotal_price_excl_tax_basetotal_price_incl_taxtotal_price_incl_tax_basecreated_atupdated_atversionDestroys note from entity
Deletes a note from the receipt.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
receipt_id^\d+$ · requiredA unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Destroys note from entity › Responses
Note deleted
Adds note to entity
Adds a note to the receipt.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
receipt_id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Adds note to entity › Responses
Note created
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
entity_id^\d+$A unique record identifier
entity_typeuser_id^\d+$A unique record identifier
assignee_id^\d+$A unique record identifier
todonotecompleted_atcompleted_by_id^\d+$A unique record identifier
todo_typedatacreated_atupdated_atList receipts
Returns a paginated list of documents of this type in the administration.
The filter argument allows you to filter on the list of documents. 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_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
query Parameters
filterString terms, example: key1:value1,key2:value2.
new_filterString terms, example: key1:value1,key2:value2.
pageper_page^\d+$exclude_new_general_journal_documentsList receipts › Responses
A list of receipts
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
contact_id^\d+$A unique record identifier
referencedatedue_dateentry_numberstatecurrencyrevenue_invoiceprices_are_incl_taxoriginpaid_attax_numbertotal_price_excl_taxtotal_price_excl_tax_basetotal_price_incl_taxtotal_price_incl_tax_basecreated_atupdated_atversionCreate a new receipt
Creates a new receipt.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Create a new receipt › Responses
Receipt created
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
contact_id^\d+$A unique record identifier
referencedatedue_dateentry_numberstatecurrencyrevenue_invoiceprices_are_incl_taxoriginpaid_attax_numbertotal_price_excl_taxtotal_price_excl_tax_basetotal_price_incl_taxtotal_price_incl_tax_basecreated_atupdated_atversion