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_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
invoice_idUnique invoice identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Get an invoice by invoice_id › Responses
A sales invoice
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
contact_id^\d+$A unique record identifier
contact_person_id^\d+$A unique record identifier
invoice_idrecurring_sales_invoice_id^\d+$A unique record identifier
subscription_id^\d+$A unique record identifier
workflow_id^\d+$A unique record identifier
document_style_id^\d+$A unique record identifier
identity_id^\d+$A unique record identifier
draft_idstateinvoice_datedue_datepayment_conditionspayment_referenceshort_payment_referencereferencelanguagecurrencydiscountoriginal_sales_invoice_id^\d+$A unique record identifier
pausedpaid_atsent_atcreated_atupdated_atpublic_view_codepublic_view_code_expires_atversiontotal_paidtotal_unpaidtotal_unpaid_baseprices_are_incl_taxtotal_price_excl_taxtotal_price_excl_tax_basetotal_price_incl_taxtotal_price_incl_tax_basetotal_discountmarked_dubious_onmarked_uncollectible_onreminder_countnext_reminderoriginal_estimate_id^\d+$A unique record identifier
urlpayment_urlGet an invoice by reference
Get a sales invoice by the reference field of the sales invoice.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
referenceformat^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Get an invoice by reference › Responses
A sales invoice
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
contact_id^\d+$A unique record identifier
contact_person_id^\d+$A unique record identifier
invoice_idrecurring_sales_invoice_id^\d+$A unique record identifier
subscription_id^\d+$A unique record identifier
workflow_id^\d+$A unique record identifier
document_style_id^\d+$A unique record identifier
identity_id^\d+$A unique record identifier
draft_idstateinvoice_datedue_datepayment_conditionspayment_referenceshort_payment_referencereferencelanguagecurrencydiscountoriginal_sales_invoice_id^\d+$A unique record identifier
pausedpaid_atsent_atcreated_atupdated_atpublic_view_codepublic_view_code_expires_atversiontotal_paidtotal_unpaidtotal_unpaid_baseprices_are_incl_taxtotal_price_excl_taxtotal_price_excl_tax_basetotal_price_incl_taxtotal_price_incl_tax_basetotal_discountmarked_dubious_onmarked_uncollectible_onreminder_countnext_reminderoriginal_estimate_id^\d+$A unique record identifier
urlpayment_urlSends 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_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
Sends a reminder › 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_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
filterList all ids and versions › Responses
IDs and versions of records
idversionFetch 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_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 sales invoices with given ids › Responses
A list of sales invoices
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
contact_id^\d+$A unique record identifier
contact_person_id^\d+$A unique record identifier
invoice_idrecurring_sales_invoice_id^\d+$A unique record identifier
subscription_id^\d+$A unique record identifier
workflow_id^\d+$A unique record identifier
document_style_id^\d+$A unique record identifier
identity_id^\d+$A unique record identifier
draft_idstateinvoice_datedue_datepayment_conditionspayment_referenceshort_payment_referencereferencelanguagecurrencydiscountoriginal_sales_invoice_id^\d+$A unique record identifier
pausedpaid_atsent_atcreated_atupdated_atpublic_view_codepublic_view_code_expires_atversiontotal_paidtotal_unpaidtotal_unpaid_baseprices_are_incl_taxtotal_price_excl_taxtotal_price_excl_tax_basetotal_price_incl_taxtotal_price_incl_tax_basetotal_discountmarked_dubious_onmarked_uncollectible_onreminder_countnext_reminderoriginal_estimate_id^\d+$A unique record identifier
urlpayment_urlAdd attachment to sales invoice
Add an attachment to a sales invoice.
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 sales invoice › 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_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
query Parameters
mediaIn case you want to hide sender address and logo you can set this to 'stationery'.
Download sales invoice packing slip PDF by id › 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_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
query Parameters
mediaIn case you want to hide sender address and logo you can set this to 'stationery'.
Download sales invoice PDF by id › Responses
Found
Download sales invoice UBL by id
Download the sales invoice as UBL.
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
Download sales invoice UBL by id › Responses
A sales invoice
Duplicate to credit invoice
Duplicate a sales invoice to a new credit invoice.
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
Duplicate to credit invoice › Responses
Sales invoice updated
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
contact_id^\d+$A unique record identifier
contact_person_id^\d+$A unique record identifier
invoice_idrecurring_sales_invoice_id^\d+$A unique record identifier
subscription_id^\d+$A unique record identifier
workflow_id^\d+$A unique record identifier
document_style_id^\d+$A unique record identifier
identity_id^\d+$A unique record identifier
draft_idstateinvoice_datedue_datepayment_conditionspayment_referenceshort_payment_referencereferencelanguagecurrencydiscountoriginal_sales_invoice_id^\d+$A unique record identifier
pausedpaid_atsent_atcreated_atupdated_atpublic_view_codepublic_view_code_expires_atversiontotal_paidtotal_unpaidtotal_unpaid_baseprices_are_incl_taxtotal_price_excl_taxtotal_price_excl_tax_basetotal_price_incl_taxtotal_price_incl_tax_basetotal_discountmarked_dubious_onmarked_uncollectible_onreminder_countnext_reminderoriginal_estimate_id^\d+$A unique record identifier
urlpayment_urlMark as dubious
This endpoint marks a sales invoice as dubious.
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
Mark as dubious › Responses
Sales invoice updated
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
contact_id^\d+$A unique record identifier
contact_person_id^\d+$A unique record identifier
invoice_idrecurring_sales_invoice_id^\d+$A unique record identifier
subscription_id^\d+$A unique record identifier
workflow_id^\d+$A unique record identifier
document_style_id^\d+$A unique record identifier
identity_id^\d+$A unique record identifier
draft_idstateinvoice_datedue_datepayment_conditionspayment_referenceshort_payment_referencereferencelanguagecurrencydiscountoriginal_sales_invoice_id^\d+$A unique record identifier
pausedpaid_atsent_atcreated_atupdated_atpublic_view_codepublic_view_code_expires_atversiontotal_paidtotal_unpaidtotal_unpaid_baseprices_are_incl_taxtotal_price_excl_taxtotal_price_excl_tax_basetotal_price_incl_taxtotal_price_incl_tax_basetotal_discountmarked_dubious_onmarked_uncollectible_onreminder_countnext_reminderoriginal_estimate_id^\d+$A unique record identifier
urlpayment_urlMark as uncollectible
This endpoint marks a sales invoice as uncollectible.
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
Mark as uncollectible › Request Body
uncollectible_datebook_methodCan be revenue.
Mark as uncollectible › Responses
Sales invoice updated
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
contact_id^\d+$A unique record identifier
contact_person_id^\d+$A unique record identifier
invoice_idrecurring_sales_invoice_id^\d+$A unique record identifier
subscription_id^\d+$A unique record identifier
workflow_id^\d+$A unique record identifier
document_style_id^\d+$A unique record identifier
identity_id^\d+$A unique record identifier
draft_idstateinvoice_datedue_datepayment_conditionspayment_referenceshort_payment_referencereferencelanguagecurrencydiscountoriginal_sales_invoice_id^\d+$A unique record identifier
pausedpaid_atsent_atcreated_atupdated_atpublic_view_codepublic_view_code_expires_atversiontotal_paidtotal_unpaidtotal_unpaid_baseprices_are_incl_taxtotal_price_excl_taxtotal_price_excl_tax_basetotal_price_incl_taxtotal_price_incl_tax_basetotal_discountmarked_dubious_onmarked_uncollectible_onreminder_countnext_reminderoriginal_estimate_id^\d+$A unique record identifier
urlpayment_urlPause 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_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
Pause sales invoice › Responses
Sales invoice paused
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
contact_id^\d+$A unique record identifier
contact_person_id^\d+$A unique record identifier
invoice_idrecurring_sales_invoice_id^\d+$A unique record identifier
subscription_id^\d+$A unique record identifier
workflow_id^\d+$A unique record identifier
document_style_id^\d+$A unique record identifier
identity_id^\d+$A unique record identifier
draft_idstateinvoice_datedue_datepayment_conditionspayment_referenceshort_payment_referencereferencelanguagecurrencydiscountoriginal_sales_invoice_id^\d+$A unique record identifier
pausedpaid_atsent_atcreated_atupdated_atpublic_view_codepublic_view_code_expires_atversiontotal_paidtotal_unpaidtotal_unpaid_baseprices_are_incl_taxtotal_price_excl_taxtotal_price_excl_tax_basetotal_price_incl_taxtotal_price_incl_tax_basetotal_discountmarked_dubious_onmarked_uncollectible_onreminder_countnext_reminderoriginal_estimate_id^\d+$A unique record identifier
urlpayment_urlRegister a payment
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 › Responses
Sales invoice updated
Register a payment for a creditinvoice
Register a payment for a creditinvoice. Requires that the invoice is a credit invoice.
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 creditinvoice › Responses
Sales invoice updated
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
contact_id^\d+$A unique record identifier
contact_person_id^\d+$A unique record identifier
invoice_idrecurring_sales_invoice_id^\d+$A unique record identifier
subscription_id^\d+$A unique record identifier
workflow_id^\d+$A unique record identifier
document_style_id^\d+$A unique record identifier
identity_id^\d+$A unique record identifier
draft_idstateinvoice_datedue_datepayment_conditionspayment_referenceshort_payment_referencereferencelanguagecurrencydiscountoriginal_sales_invoice_id^\d+$A unique record identifier
pausedpaid_atsent_atcreated_atupdated_atpublic_view_codepublic_view_code_expires_atversiontotal_paidtotal_unpaidtotal_unpaid_baseprices_are_incl_taxtotal_price_excl_taxtotal_price_excl_tax_basetotal_price_incl_taxtotal_price_incl_tax_basetotal_discountmarked_dubious_onmarked_uncollectible_onreminder_countnext_reminderoriginal_estimate_id^\d+$A unique record identifier
urlpayment_urlResume sales invoice
This endpoint resumes the sales invoice. The automatic workflow steps will execute again after resuming.
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
Resume sales invoice › Responses
Sales invoice resumed
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
contact_id^\d+$A unique record identifier
contact_person_id^\d+$A unique record identifier
invoice_idrecurring_sales_invoice_id^\d+$A unique record identifier
subscription_id^\d+$A unique record identifier
workflow_id^\d+$A unique record identifier
document_style_id^\d+$A unique record identifier
identity_id^\d+$A unique record identifier
draft_idstateinvoice_datedue_datepayment_conditionspayment_referenceshort_payment_referencereferencelanguagecurrencydiscountoriginal_sales_invoice_id^\d+$A unique record identifier
pausedpaid_atsent_atcreated_atupdated_atpublic_view_codepublic_view_code_expires_atversiontotal_paidtotal_unpaidtotal_unpaid_baseprices_are_incl_taxtotal_price_excl_taxtotal_price_excl_tax_basetotal_price_incl_taxtotal_price_incl_tax_basetotal_discountmarked_dubious_onmarked_uncollectible_onreminder_countnext_reminderoriginal_estimate_id^\d+$A unique record identifier
urlpayment_urlSends 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_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
Sends an invoice › Responses
Sales invoice updated
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
contact_id^\d+$A unique record identifier
contact_person_id^\d+$A unique record identifier
invoice_idrecurring_sales_invoice_id^\d+$A unique record identifier
subscription_id^\d+$A unique record identifier
workflow_id^\d+$A unique record identifier
document_style_id^\d+$A unique record identifier
identity_id^\d+$A unique record identifier
draft_idstateinvoice_datedue_datepayment_conditionspayment_referenceshort_payment_referencereferencelanguagecurrencydiscountoriginal_sales_invoice_id^\d+$A unique record identifier
pausedpaid_atsent_atcreated_atupdated_atpublic_view_codepublic_view_code_expires_atversiontotal_paidtotal_unpaidtotal_unpaid_baseprices_are_incl_taxtotal_price_excl_taxtotal_price_excl_tax_basetotal_price_incl_taxtotal_price_incl_tax_basetotal_discountmarked_dubious_onmarked_uncollectible_onreminder_countnext_reminderoriginal_estimate_id^\d+$A unique record identifier
urlpayment_urlGet 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_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 an invoice by id › Responses
A sales invoice
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
contact_id^\d+$A unique record identifier
contact_person_id^\d+$A unique record identifier
invoice_idrecurring_sales_invoice_id^\d+$A unique record identifier
subscription_id^\d+$A unique record identifier
workflow_id^\d+$A unique record identifier
document_style_id^\d+$A unique record identifier
identity_id^\d+$A unique record identifier
draft_idstateinvoice_datedue_datepayment_conditionspayment_referenceshort_payment_referencereferencelanguagecurrencydiscountoriginal_sales_invoice_id^\d+$A unique record identifier
pausedpaid_atsent_atcreated_atupdated_atpublic_view_codepublic_view_code_expires_atversiontotal_paidtotal_unpaidtotal_unpaid_baseprices_are_incl_taxtotal_price_excl_taxtotal_price_excl_tax_basetotal_price_incl_taxtotal_price_incl_tax_basetotal_discountmarked_dubious_onmarked_uncollectible_onreminder_countnext_reminderoriginal_estimate_id^\d+$A unique record identifier
urlpayment_urlDelete 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_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 sales invoice › 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_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 sales invoice › Responses
Sales invoice updated
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
contact_id^\d+$A unique record identifier
contact_person_id^\d+$A unique record identifier
invoice_idrecurring_sales_invoice_id^\d+$A unique record identifier
subscription_id^\d+$A unique record identifier
workflow_id^\d+$A unique record identifier
document_style_id^\d+$A unique record identifier
identity_id^\d+$A unique record identifier
draft_idstateinvoice_datedue_datepayment_conditionspayment_referenceshort_payment_referencereferencelanguagecurrencydiscountoriginal_sales_invoice_id^\d+$A unique record identifier
pausedpaid_atsent_atcreated_atupdated_atpublic_view_codepublic_view_code_expires_atversiontotal_paidtotal_unpaidtotal_unpaid_baseprices_are_incl_taxtotal_price_excl_taxtotal_price_excl_tax_basetotal_price_incl_taxtotal_price_incl_tax_basetotal_discountmarked_dubious_onmarked_uncollectible_onreminder_countnext_reminderoriginal_estimate_id^\d+$A unique record identifier
urlpayment_urlDownload 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
sales_invoice_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
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
sales_invoice_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
Delete an attachment › Responses
Attachment deleted
Destroys note from entity
Deletes a note from the sales invoice.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
sales_invoice_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 sales invoice.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
sales_invoice_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_atDelete a payment
Delete a payment from a sales invoice.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
sales_invoice_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
Delete a payment › Responses
Payment deleted
Create a payment
Registers a payment for a sales invoice.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
sales_invoice_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_atList 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_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
filterpageper_page^\d+$List all invoices › Responses
A list of sales invoices
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
contact_id^\d+$A unique record identifier
contact_person_id^\d+$A unique record identifier
invoice_idrecurring_sales_invoice_id^\d+$A unique record identifier
subscription_id^\d+$A unique record identifier
workflow_id^\d+$A unique record identifier
document_style_id^\d+$A unique record identifier
identity_id^\d+$A unique record identifier
draft_idstateinvoice_datedue_datepayment_conditionspayment_referenceshort_payment_referencereferencelanguagecurrencydiscountoriginal_sales_invoice_id^\d+$A unique record identifier
pausedpaid_atsent_atcreated_atupdated_atpublic_view_codepublic_view_code_expires_atversiontotal_paidtotal_unpaidtotal_unpaid_baseprices_are_incl_taxtotal_price_excl_taxtotal_price_excl_tax_basetotal_price_incl_taxtotal_price_incl_tax_basetotal_discountmarked_dubious_onmarked_uncollectible_onreminder_countnext_reminderoriginal_estimate_id^\d+$A unique record identifier
urlpayment_urlCreate a sales invoice
Create a sales invoice with the parameters defined in the request body.
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 sales invoice › Responses
Sales invoice created
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
contact_id^\d+$A unique record identifier
contact_person_id^\d+$A unique record identifier
invoice_idrecurring_sales_invoice_id^\d+$A unique record identifier
subscription_id^\d+$A unique record identifier
workflow_id^\d+$A unique record identifier
document_style_id^\d+$A unique record identifier
identity_id^\d+$A unique record identifier
draft_idstateinvoice_datedue_datepayment_conditionspayment_referenceshort_payment_referencereferencelanguagecurrencydiscountoriginal_sales_invoice_id^\d+$A unique record identifier
pausedpaid_atsent_atcreated_atupdated_atpublic_view_codepublic_view_code_expires_atversiontotal_paidtotal_unpaidtotal_unpaid_baseprices_are_incl_taxtotal_price_excl_taxtotal_price_excl_tax_basetotal_price_incl_taxtotal_price_incl_tax_basetotal_discountmarked_dubious_onmarked_uncollectible_onreminder_countnext_reminderoriginal_estimate_id^\d+$A unique record identifier
urlpayment_url