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_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
filterstringString terms, example: key1:value1,key2:value2.
Responses
IDs and versions of records
idinteger | stringversioninteger | string
Fetch 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_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 list of receipts
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
contactreferencestring | nulldatestring · datedue_datestring | null · dateentry_numberinteger | nullstatestring · enumEnum values:newopenlatepaidsavedpending_paymentcurrencystring | nullexchange_raterevenue_invoiceboolean | nullprices_are_incl_taxboolean | nulloriginstring | null · enumEnum values:uploadendpointsiemailsi_localsi_peppolapimoneybird_bvpaid_atstring | null · datetax_numberstring | nulltotal_price_excl_taxstring | nulltotal_price_excl_tax_basestring | nulltotal_price_incl_taxstring | nulltotal_price_incl_tax_basestring | nullcreated_atstring · date-timeupdated_atstring · date-timeversionintegerdetailsobject[]paymentsobject[]notesobject[]attachmentsobject[]eventsobject[]
Download 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_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
attachment_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
Found
Delete an attachment
Deletes an attachment of an attachable.
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
attachment_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
Attachment deleted
Add attachment to receipt
Add an attachment to a receipt.
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
Status code
Delete a payment
Deletes a payment from a receipt.
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
payment_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
Payment deleted
Create a payment
Registers a payment for a receipt.
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
Payment created
idstring | integer · pattern:^\d+$A unique record identifier
administration_idstring | integer · pattern:^\d+$A unique record identifier of an administration
invoice_typestring · enumEnum values:SalesInvoiceDocumentExternalSalesInvoiceVatDocumentinvoice_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 | nullpriceprice_basepayment_datestring · datecredit_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 | nullcreated_atstring · date-timeupdated_atstring · date-time
Register 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_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
Status code
Get a receipt
Returns a receipt by id.
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 receipt
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
contactreferencestring | nulldatestring · datedue_datestring | null · dateentry_numberinteger | nullstatestring · enumEnum values:newopenlatepaidsavedpending_paymentcurrencystring | nullexchange_raterevenue_invoiceboolean | nullprices_are_incl_taxboolean | nulloriginstring | null · enumEnum values:uploadendpointsiemailsi_localsi_peppolapimoneybird_bvpaid_atstring | null · datetax_numberstring | nulltotal_price_excl_taxstring | nulltotal_price_excl_tax_basestring | nulltotal_price_incl_taxstring | nulltotal_price_incl_tax_basestring | nullcreated_atstring · date-timeupdated_atstring · date-timeversionintegerdetailsobject[]paymentsobject[]notesobject[]attachmentsobject[]eventsobject[]
Delete a receipts
Deletes a receipt.
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
Status code
Update a receipt
Updates a receipt.
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
Receipt updated
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
contactreferencestring | nulldatestring · datedue_datestring | null · dateentry_numberinteger | nullstatestring · enumEnum values:newopenlatepaidsavedpending_paymentcurrencystring | nullexchange_raterevenue_invoiceboolean | nullprices_are_incl_taxboolean | nulloriginstring | null · enumEnum values:uploadendpointsiemailsi_localsi_peppolapimoneybird_bvpaid_atstring | null · datetax_numberstring | nulltotal_price_excl_taxstring | nulltotal_price_excl_tax_basestring | nulltotal_price_incl_taxstring | nulltotal_price_incl_tax_basestring | nullcreated_atstring · date-timeupdated_atstring · date-timeversionintegerdetailsobject[]paymentsobject[]notesobject[]attachmentsobject[]eventsobject[]
Destroys note from entity
Deletes a note from the receipt.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
receipt_idstring | integer · pattern:^\d+$· requiredA unique record identifier
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
Note deleted
Adds note to entity
Adds a note to the receipt.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
receipt_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
Note created
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_typestringuser_idstring | integer · pattern:^\d+$A unique record identifier
assignee_idstring | integer | null · pattern:^\d+$A unique record identifier
todoboolean | string | nullDefault: falsenotestring | nullcompleted_atstring | null · date-timecompleted_by_idstring | integer | null · pattern:^\d+$A unique record identifier
todo_typestring | null · enumEnum values:sales_invoice_duepurchase_invoice_duegeneral_document_remindergeneral_document_duenew_document_awaiting_processingnew_financial_mutation_awaiting_processingfinancial_mutations_not_updatedsales_invoice_payment_not_linked_to_financial_mutationdataobject | nullcreated_atstring · date-timeupdated_atstring · date-time
List 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_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
filterstringString terms, example:
key1:value1,key2:value2.new_filterstringString terms, example:
key1:value1,key2:value2.pageinteger | stringper_pageinteger | string · min: 1 · max: 100 · pattern:^\d+$exclude_new_general_journal_documentsboolean | string
Responses
A list of receipts
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
contactreferencestring | nulldatestring · datedue_datestring | null · dateentry_numberinteger | nullstatestring · enumEnum values:newopenlatepaidsavedpending_paymentcurrencystring | nullexchange_raterevenue_invoiceboolean | nullprices_are_incl_taxboolean | nulloriginstring | null · enumEnum values:uploadendpointsiemailsi_localsi_peppolapimoneybird_bvpaid_atstring | null · datetax_numberstring | nulltotal_price_excl_taxstring | nulltotal_price_excl_tax_basestring | nulltotal_price_incl_taxstring | nulltotal_price_incl_tax_basestring | nullcreated_atstring · date-timeupdated_atstring · date-timeversionintegerdetailsobject[]paymentsobject[]notesobject[]attachmentsobject[]eventsobject[]
Create a new receipt
Creates a new receipt.
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
Receipt created
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
contactreferencestring | nulldatestring · datedue_datestring | null · dateentry_numberinteger | nullstatestring · enumEnum values:newopenlatepaidsavedpending_paymentcurrencystring | nullexchange_raterevenue_invoiceboolean | nullprices_are_incl_taxboolean | nulloriginstring | null · enumEnum values:uploadendpointsiemailsi_localsi_peppolapimoneybird_bvpaid_atstring | null · datetax_numberstring | nulltotal_price_excl_taxstring | nulltotal_price_excl_tax_basestring | nulltotal_price_incl_taxstring | nulltotal_price_incl_tax_basestring | nullcreated_atstring · date-timeupdated_atstring · date-timeversionintegerdetailsobject[]paymentsobject[]notesobject[]attachmentsobject[]eventsobject[]