Sales invoices are the invoices you send to your customers for products or services you have delivered.
Get an invoice by invoice_id
Get a sales invoice by the invoice_id field of the sales invoice.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
invoice_idstring · requiredUnique invoice 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 sales invoice
idstring | integer · pattern:^\d+$A unique record identifier
administration_idstring | integer · pattern:^\d+$A unique record identifier of an administration
contact_idstring | integer · pattern:^\d+$A unique record identifier
contactobjectcontact_person_idstring | integer | null · pattern:^\d+$A unique record identifier
contact_personinvoice_idstring | nullrecurring_sales_invoice_idstring | integer | null · pattern:^\d+$A unique record identifier
subscription_idstring | integer | null · pattern:^\d+$A unique record identifier
workflow_idstring | integer · pattern:^\d+$A unique record identifier
document_style_idstring | integer · pattern:^\d+$A unique record identifier
identity_idstring | integer · pattern:^\d+$A unique record identifier
draft_idinteger | nullstatestring · enumEnum values:draftscheduledopenpending_paymentremindedlatepaiduncollectibleinvoice_datestring | null · datedue_datestring · datepayment_conditionsstring | nullpayment_referencestring | nullshort_payment_referencestring | nullreferencestring | nulllanguagestring | nullcurrencystringdiscountstring | nulloriginal_sales_invoice_idstring | integer | null · pattern:^\d+$A unique record identifier
pausedbooleanpaid_atstring | null · datesent_atstring | null · datecreated_atstring · date-timeupdated_atstring · date-timepublic_view_codestring | nullpublic_view_code_expires_atstring | null · date-timeversionintegerdetailsobject[]paymentsobject[]total_paidstringtotal_unpaidstringtotal_unpaid_basestringprices_are_incl_taxbooleantotal_price_excl_taxstringtotal_price_excl_tax_basestringtotal_price_incl_taxstringtotal_price_incl_tax_basestringtotal_discountstringmarked_dubious_onstring | null · datemarked_uncollectible_onstring | null · datereminder_countinteger | nullnext_reminderstring | null · dateoriginal_estimate_idstring | integer | null · pattern:^\d+$A unique record identifier
urlstringpayment_urlstringcustom_fieldsobject[]notesobject[]attachmentsobject[]eventsobject[]tax_totalsobject[]time_entriesobject[]
Get an invoice by reference
Get a sales invoice by the reference field of the sales invoice.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
referencestring · requiredformatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
A sales invoice
idstring | integer · pattern:^\d+$A unique record identifier
administration_idstring | integer · pattern:^\d+$A unique record identifier of an administration
contact_idstring | integer · pattern:^\d+$A unique record identifier
contactobjectcontact_person_idstring | integer | null · pattern:^\d+$A unique record identifier
contact_personinvoice_idstring | nullrecurring_sales_invoice_idstring | integer | null · pattern:^\d+$A unique record identifier
subscription_idstring | integer | null · pattern:^\d+$A unique record identifier
workflow_idstring | integer · pattern:^\d+$A unique record identifier
document_style_idstring | integer · pattern:^\d+$A unique record identifier
identity_idstring | integer · pattern:^\d+$A unique record identifier
draft_idinteger | nullstatestring · enumEnum values:draftscheduledopenpending_paymentremindedlatepaiduncollectibleinvoice_datestring | null · datedue_datestring · datepayment_conditionsstring | nullpayment_referencestring | nullshort_payment_referencestring | nullreferencestring | nulllanguagestring | nullcurrencystringdiscountstring | nulloriginal_sales_invoice_idstring | integer | null · pattern:^\d+$A unique record identifier
pausedbooleanpaid_atstring | null · datesent_atstring | null · datecreated_atstring · date-timeupdated_atstring · date-timepublic_view_codestring | nullpublic_view_code_expires_atstring | null · date-timeversionintegerdetailsobject[]paymentsobject[]total_paidstringtotal_unpaidstringtotal_unpaid_basestringprices_are_incl_taxbooleantotal_price_excl_taxstringtotal_price_excl_tax_basestringtotal_price_incl_taxstringtotal_price_incl_tax_basestringtotal_discountstringmarked_dubious_onstring | null · datemarked_uncollectible_onstring | null · datereminder_countinteger | nullnext_reminderstring | null · dateoriginal_estimate_idstring | integer | null · pattern:^\d+$A unique record identifier
urlstringpayment_urlstringcustom_fieldsobject[]notesobject[]attachmentsobject[]eventsobject[]tax_totalsobject[]time_entriesobject[]
Sends a reminder
This endpoint sends a reminder to a contact. A reminder can contain multiple sales invoices. Reminders are grouped by workflow, identity and document style, so a contact with sales invoices with different workflows, will receive multiple reminders. Only by grouping reminders like this, we can assure the right content and layout of a reminder.
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
Status code
List all ids and versions
Returns all sales invoices in the administration. The list contains the invoice id and the version of the invoice.
Check if the version of the invoice is newer than the version you have stored locally, use the POST
variant for fetching invoices 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
filterstring
Responses
IDs and versions of records
idinteger | stringversioninteger | string
Fetch sales invoices with given ids
Given a list of sales invoice ids, returns the sales invoice information belonging to the invoices. Returns a maximum of 100 invoice, 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 sales invoices
idstring | integer · pattern:^\d+$A unique record identifier
administration_idstring | integer · pattern:^\d+$A unique record identifier of an administration
contact_idstring | integer · pattern:^\d+$A unique record identifier
contactobjectcontact_person_idstring | integer | null · pattern:^\d+$A unique record identifier
contact_personinvoice_idstring | nullrecurring_sales_invoice_idstring | integer | null · pattern:^\d+$A unique record identifier
subscription_idstring | integer | null · pattern:^\d+$A unique record identifier
workflow_idstring | integer · pattern:^\d+$A unique record identifier
document_style_idstring | integer · pattern:^\d+$A unique record identifier
identity_idstring | integer · pattern:^\d+$A unique record identifier
draft_idinteger | nullstatestring · enumEnum values:draftscheduledopenpending_paymentremindedlatepaiduncollectibleinvoice_datestring | null · datedue_datestring · datepayment_conditionsstring | nullpayment_referencestring | nullshort_payment_referencestring | nullreferencestring | nulllanguagestring | nullcurrencystringdiscountstring | nulloriginal_sales_invoice_idstring | integer | null · pattern:^\d+$A unique record identifier
pausedbooleanpaid_atstring | null · datesent_atstring | null · datecreated_atstring · date-timeupdated_atstring · date-timepublic_view_codestring | nullpublic_view_code_expires_atstring | null · date-timeversionintegerdetailsobject[]paymentsobject[]total_paidstringtotal_unpaidstringtotal_unpaid_basestringprices_are_incl_taxbooleantotal_price_excl_taxstringtotal_price_excl_tax_basestringtotal_price_incl_taxstringtotal_price_incl_tax_basestringtotal_discountstringmarked_dubious_onstring | null · datemarked_uncollectible_onstring | null · datereminder_countinteger | nullnext_reminderstring | null · dateoriginal_estimate_idstring | integer | null · pattern:^\d+$A unique record identifier
urlstringpayment_urlstringcustom_fieldsobject[]notesobject[]attachmentsobject[]eventsobject[]tax_totalsobject[]time_entriesobject[]
Add attachment to sales invoice
Add an attachment to a sales invoice.
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
Download sales invoice packing slip PDF by id
Redirects to the download URL of the sales invoice as packing slip PDF. The link is valid for 30 seconds.
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
query Parameters
mediastringIn case you want to hide sender address and logo you can set this to 'stationery'.
Responses
Found
Download sales invoice PDF by id
Redirects to the download URL of the sales invoice as PDF. The link is valid for 30 seconds.
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
query Parameters
mediastringIn case you want to hide sender address and logo you can set this to 'stationery'.
Responses
Found
Download sales invoice UBL by id
Download the sales invoice as UBL.
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 sales invoice
Duplicate to credit invoice
Duplicate a sales invoice to a new credit invoice.
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
Sales invoice updated
idstring | integer · pattern:^\d+$A unique record identifier
administration_idstring | integer · pattern:^\d+$A unique record identifier of an administration
contact_idstring | integer · pattern:^\d+$A unique record identifier
contactobjectcontact_person_idstring | integer | null · pattern:^\d+$A unique record identifier
contact_personinvoice_idstring | nullrecurring_sales_invoice_idstring | integer | null · pattern:^\d+$A unique record identifier
subscription_idstring | integer | null · pattern:^\d+$A unique record identifier
workflow_idstring | integer · pattern:^\d+$A unique record identifier
document_style_idstring | integer · pattern:^\d+$A unique record identifier
identity_idstring | integer · pattern:^\d+$A unique record identifier
draft_idinteger | nullstatestring · enumEnum values:draftscheduledopenpending_paymentremindedlatepaiduncollectibleinvoice_datestring | null · datedue_datestring · datepayment_conditionsstring | nullpayment_referencestring | nullshort_payment_referencestring | nullreferencestring | nulllanguagestring | nullcurrencystringdiscountstring | nulloriginal_sales_invoice_idstring | integer | null · pattern:^\d+$A unique record identifier
pausedbooleanpaid_atstring | null · datesent_atstring | null · datecreated_atstring · date-timeupdated_atstring · date-timepublic_view_codestring | nullpublic_view_code_expires_atstring | null · date-timeversionintegerdetailsobject[]paymentsobject[]total_paidstringtotal_unpaidstringtotal_unpaid_basestringprices_are_incl_taxbooleantotal_price_excl_taxstringtotal_price_excl_tax_basestringtotal_price_incl_taxstringtotal_price_incl_tax_basestringtotal_discountstringmarked_dubious_onstring | null · datemarked_uncollectible_onstring | null · datereminder_countinteger | nullnext_reminderstring | null · dateoriginal_estimate_idstring | integer | null · pattern:^\d+$A unique record identifier
urlstringpayment_urlstringcustom_fieldsobject[]notesobject[]attachmentsobject[]eventsobject[]tax_totalsobject[]time_entriesobject[]
Mark as dubious
This endpoint marks a sales invoice as dubious.
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
Sales invoice updated
idstring | integer · pattern:^\d+$A unique record identifier
administration_idstring | integer · pattern:^\d+$A unique record identifier of an administration
contact_idstring | integer · pattern:^\d+$A unique record identifier
contactobjectcontact_person_idstring | integer | null · pattern:^\d+$A unique record identifier
contact_personinvoice_idstring | nullrecurring_sales_invoice_idstring | integer | null · pattern:^\d+$A unique record identifier
subscription_idstring | integer | null · pattern:^\d+$A unique record identifier
workflow_idstring | integer · pattern:^\d+$A unique record identifier
document_style_idstring | integer · pattern:^\d+$A unique record identifier
identity_idstring | integer · pattern:^\d+$A unique record identifier
draft_idinteger | nullstatestring · enumEnum values:draftscheduledopenpending_paymentremindedlatepaiduncollectibleinvoice_datestring | null · datedue_datestring · datepayment_conditionsstring | nullpayment_referencestring | nullshort_payment_referencestring | nullreferencestring | nulllanguagestring | nullcurrencystringdiscountstring | nulloriginal_sales_invoice_idstring | integer | null · pattern:^\d+$A unique record identifier
pausedbooleanpaid_atstring | null · datesent_atstring | null · datecreated_atstring · date-timeupdated_atstring · date-timepublic_view_codestring | nullpublic_view_code_expires_atstring | null · date-timeversionintegerdetailsobject[]paymentsobject[]total_paidstringtotal_unpaidstringtotal_unpaid_basestringprices_are_incl_taxbooleantotal_price_excl_taxstringtotal_price_excl_tax_basestringtotal_price_incl_taxstringtotal_price_incl_tax_basestringtotal_discountstringmarked_dubious_onstring | null · datemarked_uncollectible_onstring | null · datereminder_countinteger | nullnext_reminderstring | null · dateoriginal_estimate_idstring | integer | null · pattern:^\d+$A unique record identifier
urlstringpayment_urlstringcustom_fieldsobject[]notesobject[]attachmentsobject[]eventsobject[]tax_totalsobject[]time_entriesobject[]
Mark as uncollectible
This endpoint marks a sales invoice as uncollectible.
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
Sales invoice updated
idstring | integer · pattern:^\d+$A unique record identifier
administration_idstring | integer · pattern:^\d+$A unique record identifier of an administration
contact_idstring | integer · pattern:^\d+$A unique record identifier
contactobjectcontact_person_idstring | integer | null · pattern:^\d+$A unique record identifier
contact_personinvoice_idstring | nullrecurring_sales_invoice_idstring | integer | null · pattern:^\d+$A unique record identifier
subscription_idstring | integer | null · pattern:^\d+$A unique record identifier
workflow_idstring | integer · pattern:^\d+$A unique record identifier
document_style_idstring | integer · pattern:^\d+$A unique record identifier
identity_idstring | integer · pattern:^\d+$A unique record identifier
draft_idinteger | nullstatestring · enumEnum values:draftscheduledopenpending_paymentremindedlatepaiduncollectibleinvoice_datestring | null · datedue_datestring · datepayment_conditionsstring | nullpayment_referencestring | nullshort_payment_referencestring | nullreferencestring | nulllanguagestring | nullcurrencystringdiscountstring | nulloriginal_sales_invoice_idstring | integer | null · pattern:^\d+$A unique record identifier
pausedbooleanpaid_atstring | null · datesent_atstring | null · datecreated_atstring · date-timeupdated_atstring · date-timepublic_view_codestring | nullpublic_view_code_expires_atstring | null · date-timeversionintegerdetailsobject[]paymentsobject[]total_paidstringtotal_unpaidstringtotal_unpaid_basestringprices_are_incl_taxbooleantotal_price_excl_taxstringtotal_price_excl_tax_basestringtotal_price_incl_taxstringtotal_price_incl_tax_basestringtotal_discountstringmarked_dubious_onstring | null · datemarked_uncollectible_onstring | null · datereminder_countinteger | nullnext_reminderstring | null · dateoriginal_estimate_idstring | integer | null · pattern:^\d+$A unique record identifier
urlstringpayment_urlstringcustom_fieldsobject[]notesobject[]attachmentsobject[]eventsobject[]tax_totalsobject[]time_entriesobject[]
Pause sales invoice
This endpoint pauses a sales invoice. The automatic workflow steps will not be executed while the sales invoice is paused.
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
Sales invoice paused
idstring | integer · pattern:^\d+$A unique record identifier
administration_idstring | integer · pattern:^\d+$A unique record identifier of an administration
contact_idstring | integer · pattern:^\d+$A unique record identifier
contactobjectcontact_person_idstring | integer | null · pattern:^\d+$A unique record identifier
contact_personinvoice_idstring | nullrecurring_sales_invoice_idstring | integer | null · pattern:^\d+$A unique record identifier
subscription_idstring | integer | null · pattern:^\d+$A unique record identifier
workflow_idstring | integer · pattern:^\d+$A unique record identifier
document_style_idstring | integer · pattern:^\d+$A unique record identifier
identity_idstring | integer · pattern:^\d+$A unique record identifier
draft_idinteger | nullstatestring · enumEnum values:draftscheduledopenpending_paymentremindedlatepaiduncollectibleinvoice_datestring | null · datedue_datestring · datepayment_conditionsstring | nullpayment_referencestring | nullshort_payment_referencestring | nullreferencestring | nulllanguagestring | nullcurrencystringdiscountstring | nulloriginal_sales_invoice_idstring | integer | null · pattern:^\d+$A unique record identifier
pausedbooleanpaid_atstring | null · datesent_atstring | null · datecreated_atstring · date-timeupdated_atstring · date-timepublic_view_codestring | nullpublic_view_code_expires_atstring | null · date-timeversionintegerdetailsobject[]paymentsobject[]total_paidstringtotal_unpaidstringtotal_unpaid_basestringprices_are_incl_taxbooleantotal_price_excl_taxstringtotal_price_excl_tax_basestringtotal_price_incl_taxstringtotal_price_incl_tax_basestringtotal_discountstringmarked_dubious_onstring | null · datemarked_uncollectible_onstring | null · datereminder_countinteger | nullnext_reminderstring | null · dateoriginal_estimate_idstring | integer | null · pattern:^\d+$A unique record identifier
urlstringpayment_urlstringcustom_fieldsobject[]notesobject[]attachmentsobject[]eventsobject[]tax_totalsobject[]time_entriesobject[]
Register a payment
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
Register a payment for a creditinvoice
Register a payment for a creditinvoice. Requires that the invoice is a credit invoice.
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
Sales invoice updated
idstring | integer · pattern:^\d+$A unique record identifier
administration_idstring | integer · pattern:^\d+$A unique record identifier of an administration
contact_idstring | integer · pattern:^\d+$A unique record identifier
contactobjectcontact_person_idstring | integer | null · pattern:^\d+$A unique record identifier
contact_personinvoice_idstring | nullrecurring_sales_invoice_idstring | integer | null · pattern:^\d+$A unique record identifier
subscription_idstring | integer | null · pattern:^\d+$A unique record identifier
workflow_idstring | integer · pattern:^\d+$A unique record identifier
document_style_idstring | integer · pattern:^\d+$A unique record identifier
identity_idstring | integer · pattern:^\d+$A unique record identifier
draft_idinteger | nullstatestring · enumEnum values:draftscheduledopenpending_paymentremindedlatepaiduncollectibleinvoice_datestring | null · datedue_datestring · datepayment_conditionsstring | nullpayment_referencestring | nullshort_payment_referencestring | nullreferencestring | nulllanguagestring | nullcurrencystringdiscountstring | nulloriginal_sales_invoice_idstring | integer | null · pattern:^\d+$A unique record identifier
pausedbooleanpaid_atstring | null · datesent_atstring | null · datecreated_atstring · date-timeupdated_atstring · date-timepublic_view_codestring | nullpublic_view_code_expires_atstring | null · date-timeversionintegerdetailsobject[]paymentsobject[]total_paidstringtotal_unpaidstringtotal_unpaid_basestringprices_are_incl_taxbooleantotal_price_excl_taxstringtotal_price_excl_tax_basestringtotal_price_incl_taxstringtotal_price_incl_tax_basestringtotal_discountstringmarked_dubious_onstring | null · datemarked_uncollectible_onstring | null · datereminder_countinteger | nullnext_reminderstring | null · dateoriginal_estimate_idstring | integer | null · pattern:^\d+$A unique record identifier
urlstringpayment_urlstringcustom_fieldsobject[]notesobject[]attachmentsobject[]eventsobject[]tax_totalsobject[]time_entriesobject[]
Resume sales invoice
This endpoint resumes the sales invoice. The automatic workflow steps will execute again after resuming.
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
Sales invoice resumed
idstring | integer · pattern:^\d+$A unique record identifier
administration_idstring | integer · pattern:^\d+$A unique record identifier of an administration
contact_idstring | integer · pattern:^\d+$A unique record identifier
contactobjectcontact_person_idstring | integer | null · pattern:^\d+$A unique record identifier
contact_personinvoice_idstring | nullrecurring_sales_invoice_idstring | integer | null · pattern:^\d+$A unique record identifier
subscription_idstring | integer | null · pattern:^\d+$A unique record identifier
workflow_idstring | integer · pattern:^\d+$A unique record identifier
document_style_idstring | integer · pattern:^\d+$A unique record identifier
identity_idstring | integer · pattern:^\d+$A unique record identifier
draft_idinteger | nullstatestring · enumEnum values:draftscheduledopenpending_paymentremindedlatepaiduncollectibleinvoice_datestring | null · datedue_datestring · datepayment_conditionsstring | nullpayment_referencestring | nullshort_payment_referencestring | nullreferencestring | nulllanguagestring | nullcurrencystringdiscountstring | nulloriginal_sales_invoice_idstring | integer | null · pattern:^\d+$A unique record identifier
pausedbooleanpaid_atstring | null · datesent_atstring | null · datecreated_atstring · date-timeupdated_atstring · date-timepublic_view_codestring | nullpublic_view_code_expires_atstring | null · date-timeversionintegerdetailsobject[]paymentsobject[]total_paidstringtotal_unpaidstringtotal_unpaid_basestringprices_are_incl_taxbooleantotal_price_excl_taxstringtotal_price_excl_tax_basestringtotal_price_incl_taxstringtotal_price_incl_tax_basestringtotal_discountstringmarked_dubious_onstring | null · datemarked_uncollectible_onstring | null · datereminder_countinteger | nullnext_reminderstring | null · dateoriginal_estimate_idstring | integer | null · pattern:^\d+$A unique record identifier
urlstringpayment_urlstringcustom_fieldsobject[]notesobject[]attachmentsobject[]eventsobject[]tax_totalsobject[]time_entriesobject[]
Sends an invoice
This endpoint provides two options: sending the invoice and scheduling sending in the future. When sending now, you can provide a send method, email address and message. If you don't provide any arguments, the defaults from the contact and workflow will be used.
When scheduling sending, set the boolean sending_scheduled to true and provide an invoice_date.
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
Sales invoice updated
idstring | integer · pattern:^\d+$A unique record identifier
administration_idstring | integer · pattern:^\d+$A unique record identifier of an administration
contact_idstring | integer · pattern:^\d+$A unique record identifier
contactobjectcontact_person_idstring | integer | null · pattern:^\d+$A unique record identifier
contact_personinvoice_idstring | nullrecurring_sales_invoice_idstring | integer | null · pattern:^\d+$A unique record identifier
subscription_idstring | integer | null · pattern:^\d+$A unique record identifier
workflow_idstring | integer · pattern:^\d+$A unique record identifier
document_style_idstring | integer · pattern:^\d+$A unique record identifier
identity_idstring | integer · pattern:^\d+$A unique record identifier
draft_idinteger | nullstatestring · enumEnum values:draftscheduledopenpending_paymentremindedlatepaiduncollectibleinvoice_datestring | null · datedue_datestring · datepayment_conditionsstring | nullpayment_referencestring | nullshort_payment_referencestring | nullreferencestring | nulllanguagestring | nullcurrencystringdiscountstring | nulloriginal_sales_invoice_idstring | integer | null · pattern:^\d+$A unique record identifier
pausedbooleanpaid_atstring | null · datesent_atstring | null · datecreated_atstring · date-timeupdated_atstring · date-timepublic_view_codestring | nullpublic_view_code_expires_atstring | null · date-timeversionintegerdetailsobject[]paymentsobject[]total_paidstringtotal_unpaidstringtotal_unpaid_basestringprices_are_incl_taxbooleantotal_price_excl_taxstringtotal_price_excl_tax_basestringtotal_price_incl_taxstringtotal_price_incl_tax_basestringtotal_discountstringmarked_dubious_onstring | null · datemarked_uncollectible_onstring | null · datereminder_countinteger | nullnext_reminderstring | null · dateoriginal_estimate_idstring | integer | null · pattern:^\d+$A unique record identifier
urlstringpayment_urlstringcustom_fieldsobject[]notesobject[]attachmentsobject[]eventsobject[]tax_totalsobject[]time_entriesobject[]
Get an invoice by id
Returns a sales invoices in the administration.
Note that the link in the url attribute will only work if viewing invoices online has been enabled and the invoice is not a draft.
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 sales invoice
idstring | integer · pattern:^\d+$A unique record identifier
administration_idstring | integer · pattern:^\d+$A unique record identifier of an administration
contact_idstring | integer · pattern:^\d+$A unique record identifier
contactobjectcontact_person_idstring | integer | null · pattern:^\d+$A unique record identifier
contact_personinvoice_idstring | nullrecurring_sales_invoice_idstring | integer | null · pattern:^\d+$A unique record identifier
subscription_idstring | integer | null · pattern:^\d+$A unique record identifier
workflow_idstring | integer · pattern:^\d+$A unique record identifier
document_style_idstring | integer · pattern:^\d+$A unique record identifier
identity_idstring | integer · pattern:^\d+$A unique record identifier
draft_idinteger | nullstatestring · enumEnum values:draftscheduledopenpending_paymentremindedlatepaiduncollectibleinvoice_datestring | null · datedue_datestring · datepayment_conditionsstring | nullpayment_referencestring | nullshort_payment_referencestring | nullreferencestring | nulllanguagestring | nullcurrencystringdiscountstring | nulloriginal_sales_invoice_idstring | integer | null · pattern:^\d+$A unique record identifier
pausedbooleanpaid_atstring | null · datesent_atstring | null · datecreated_atstring · date-timeupdated_atstring · date-timepublic_view_codestring | nullpublic_view_code_expires_atstring | null · date-timeversionintegerdetailsobject[]paymentsobject[]total_paidstringtotal_unpaidstringtotal_unpaid_basestringprices_are_incl_taxbooleantotal_price_excl_taxstringtotal_price_excl_tax_basestringtotal_price_incl_taxstringtotal_price_incl_tax_basestringtotal_discountstringmarked_dubious_onstring | null · datemarked_uncollectible_onstring | null · datereminder_countinteger | nullnext_reminderstring | null · dateoriginal_estimate_idstring | integer | null · pattern:^\d+$A unique record identifier
urlstringpayment_urlstringcustom_fieldsobject[]notesobject[]attachmentsobject[]eventsobject[]tax_totalsobject[]time_entriesobject[]
Delete a sales invoice
Delete a sales invoice. Requires that the sales invoice has no pending payments and is not in a locked bookkeeping period.
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
Sales invoice deleted
Update a sales invoice
When updating a sales invoice, provide only the attributes you want to update. The other attributes will not be changed.
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
Sales invoice updated
idstring | integer · pattern:^\d+$A unique record identifier
administration_idstring | integer · pattern:^\d+$A unique record identifier of an administration
contact_idstring | integer · pattern:^\d+$A unique record identifier
contactobjectcontact_person_idstring | integer | null · pattern:^\d+$A unique record identifier
contact_personinvoice_idstring | nullrecurring_sales_invoice_idstring | integer | null · pattern:^\d+$A unique record identifier
subscription_idstring | integer | null · pattern:^\d+$A unique record identifier
workflow_idstring | integer · pattern:^\d+$A unique record identifier
document_style_idstring | integer · pattern:^\d+$A unique record identifier
identity_idstring | integer · pattern:^\d+$A unique record identifier
draft_idinteger | nullstatestring · enumEnum values:draftscheduledopenpending_paymentremindedlatepaiduncollectibleinvoice_datestring | null · datedue_datestring · datepayment_conditionsstring | nullpayment_referencestring | nullshort_payment_referencestring | nullreferencestring | nulllanguagestring | nullcurrencystringdiscountstring | nulloriginal_sales_invoice_idstring | integer | null · pattern:^\d+$A unique record identifier
pausedbooleanpaid_atstring | null · datesent_atstring | null · datecreated_atstring · date-timeupdated_atstring · date-timepublic_view_codestring | nullpublic_view_code_expires_atstring | null · date-timeversionintegerdetailsobject[]paymentsobject[]total_paidstringtotal_unpaidstringtotal_unpaid_basestringprices_are_incl_taxbooleantotal_price_excl_taxstringtotal_price_excl_tax_basestringtotal_price_incl_taxstringtotal_price_incl_tax_basestringtotal_discountstringmarked_dubious_onstring | null · datemarked_uncollectible_onstring | null · datereminder_countinteger | nullnext_reminderstring | null · dateoriginal_estimate_idstring | integer | null · pattern:^\d+$A unique record identifier
urlstringpayment_urlstringcustom_fieldsobject[]notesobject[]attachmentsobject[]eventsobject[]tax_totalsobject[]time_entriesobject[]
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
sales_invoice_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
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
sales_invoice_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
Attachment deleted
Destroys note from entity
Deletes a note from the sales invoice.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
sales_invoice_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 sales invoice.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
sales_invoice_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
Delete a payment
Delete a payment from a sales invoice.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
sales_invoice_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
Payment deleted
Create a payment
Registers a payment for a sales invoice.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
sales_invoice_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
List all invoices
Returns a paginated list of all sales invoices in the administration.
The filter argument allows you to filter the list of invoices. 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 |
|---|---|---|---|
| state | String | all | all, draft, open, scheduled, pending_payment, late, reminded, paid or uncollectible |
| 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) |
| reference | String | Select invoices with a certain reference | |
| contact_id | Integer | Select invoices belonging to a certain contact | |
| recurring_sales_invoice_id | Integer | Select invoices created by a certain recurring invoice | |
| workflow_id | Integer | Select invoices that use a certain workflow | |
| created_after | String | Select invoices created after the given time (exclusive). ISO 8601 formatted string. The time to compare with is in UTC timezone | |
| updated_after | String | Select invoices updated after the given time (exclusive). ISO 8601 formatted string. The time to compare with is in UTC timezone |
You can filter by multiple states at the same time as well. To do this, separate the state values by a pipe: state:draft|scheduled. This also holds for the reference.
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
filterstringpageinteger | stringper_pageinteger | string · min: 1 · max: 100 · pattern:^\d+$
Responses
A list of sales invoices
idstring | integer · pattern:^\d+$A unique record identifier
administration_idstring | integer · pattern:^\d+$A unique record identifier of an administration
contact_idstring | integer · pattern:^\d+$A unique record identifier
contactobjectcontact_person_idstring | integer | null · pattern:^\d+$A unique record identifier
contact_personinvoice_idstring | nullrecurring_sales_invoice_idstring | integer | null · pattern:^\d+$A unique record identifier
subscription_idstring | integer | null · pattern:^\d+$A unique record identifier
workflow_idstring | integer · pattern:^\d+$A unique record identifier
document_style_idstring | integer · pattern:^\d+$A unique record identifier
identity_idstring | integer · pattern:^\d+$A unique record identifier
draft_idinteger | nullstatestring · enumEnum values:draftscheduledopenpending_paymentremindedlatepaiduncollectibleinvoice_datestring | null · datedue_datestring · datepayment_conditionsstring | nullpayment_referencestring | nullshort_payment_referencestring | nullreferencestring | nulllanguagestring | nullcurrencystringdiscountstring | nulloriginal_sales_invoice_idstring | integer | null · pattern:^\d+$A unique record identifier
pausedbooleanpaid_atstring | null · datesent_atstring | null · datecreated_atstring · date-timeupdated_atstring · date-timepublic_view_codestring | nullpublic_view_code_expires_atstring | null · date-timeversionintegerdetailsobject[]paymentsobject[]total_paidstringtotal_unpaidstringtotal_unpaid_basestringprices_are_incl_taxbooleantotal_price_excl_taxstringtotal_price_excl_tax_basestringtotal_price_incl_taxstringtotal_price_incl_tax_basestringtotal_discountstringmarked_dubious_onstring | null · datemarked_uncollectible_onstring | null · datereminder_countinteger | nullnext_reminderstring | null · dateoriginal_estimate_idstring | integer | null · pattern:^\d+$A unique record identifier
urlstringpayment_urlstringcustom_fieldsobject[]notesobject[]attachmentsobject[]eventsobject[]tax_totalsobject[]time_entriesobject[]
Create a sales invoice
Create a sales invoice with the parameters defined in the request body.
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
Sales invoice created
idstring | integer · pattern:^\d+$A unique record identifier
administration_idstring | integer · pattern:^\d+$A unique record identifier of an administration
contact_idstring | integer · pattern:^\d+$A unique record identifier
contactobjectcontact_person_idstring | integer | null · pattern:^\d+$A unique record identifier
contact_personinvoice_idstring | nullrecurring_sales_invoice_idstring | integer | null · pattern:^\d+$A unique record identifier
subscription_idstring | integer | null · pattern:^\d+$A unique record identifier
workflow_idstring | integer · pattern:^\d+$A unique record identifier
document_style_idstring | integer · pattern:^\d+$A unique record identifier
identity_idstring | integer · pattern:^\d+$A unique record identifier
draft_idinteger | nullstatestring · enumEnum values:draftscheduledopenpending_paymentremindedlatepaiduncollectibleinvoice_datestring | null · datedue_datestring · datepayment_conditionsstring | nullpayment_referencestring | nullshort_payment_referencestring | nullreferencestring | nulllanguagestring | nullcurrencystringdiscountstring | nulloriginal_sales_invoice_idstring | integer | null · pattern:^\d+$A unique record identifier
pausedbooleanpaid_atstring | null · datesent_atstring | null · datecreated_atstring · date-timeupdated_atstring · date-timepublic_view_codestring | nullpublic_view_code_expires_atstring | null · date-timeversionintegerdetailsobject[]paymentsobject[]total_paidstringtotal_unpaidstringtotal_unpaid_basestringprices_are_incl_taxbooleantotal_price_excl_taxstringtotal_price_excl_tax_basestringtotal_price_incl_taxstringtotal_price_incl_tax_basestringtotal_discountstringmarked_dubious_onstring | null · datemarked_uncollectible_onstring | null · datereminder_countinteger | nullnext_reminderstring | null · dateoriginal_estimate_idstring | integer | null · pattern:^\d+$A unique record identifier
urlstringpayment_urlstringcustom_fieldsobject[]notesobject[]attachmentsobject[]eventsobject[]tax_totalsobject[]time_entriesobject[]