Invoices

Get invoice

get

/invoices/

This api is used to fetch generated invoices from WorkorderApp. The result can be filtered by using the advanced filter. As described in the introduction section.

Parameter	Description
inv_id	Unique invoice ID number of the invoice
inv_worksheet_id	Worksheet ID that is used to generate this invoice
inv_quo_id	Quotation ID that is used to generate this invoice
inv_inv_id	Parent invoice ID. Used when creating a credit invoice.
inv_type	Invoice type, can be DEBIT, CREDIT, CONCEPT_DEBIT or CONCEPT_CREDIT
inv_currency_code	ISO 4217 currency code
inv_currency_symbol	Currency symbol shown in the UI
inv_description	Description of the invoice
inv_invoice_debtor_nr	Debtor number of the assigned relation
inv_invoice_debtor_name	Debtor name of the assigned relation
inv_invoice_debtor_email	Debtor e-mail of the assigned relation
inv_number_numeric	Invoice number numeric value
inv_number_formatted	Pretty formatted invoice number
inv_status	Invoice status, can be OPEN, PAYED, OVERDUE, REMINDER_1, REMINDER_2, REMINDER_3 or ...
inv_reference	Reference, example purchase order number workorder number
inv_date	Invoice date
inv_due_date	Invoice due date
inv_due_days	Amount of due days. This days are added to the inv_date to calculate the inv_due_date.
inv_terms	Terms shown in the footer of the PDF.
inv_header	Header shown on top of the PDF.
inv_amount	Total amount including VAT.
inv_amount_excl	Total amount excluding VAT.
inv_balance	Total amounts of the transactions registered to this invoice.
inv_user_create	User who created this invoice
inv_user_mutate	User who mutated this invoice
inv_user_send	User who marked this invoice as send.
inv_timestamp_create	Timestamp of creation
inv_timestamp_mutate	Timestamp of mutating
inv_timestamp_payed	Timestamp when the invoice was marked as payed (inv_amount equal to inv_balance)
inv_timestamp_send	Timestamp of marking the invoice as send.
iln_lines	Array of invoice lines.
invoice_debtor	Invoice debtor.
pdf	Temporary PDF url.
ubl	Temporary ubl 2.0 url.

Invoice line parameters

Parameter	Description
iln_id	Line ID
iln_inv_id	Invoice Id
iln_order	Position of the line
iln_material_code	Material code
iln_material_hourtype	Hourtype code
iln_description	Line description
iln_amount	Line amount
iln_price	Item price
iln_vat_percentage	Vat percentage
iln_discount	Discount percentage
iln_total	Total price excluding vat and discount
iln_total_discount	Calculated discount amount
iln_total_vat	Calculated vat amount
iln_total_excl	Total price excluding vat and including discount
iln_total_incl	Total price including vat and including discount

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

tokenstringOptionalExample: {{client_token}}

software_tokenstringOptionalExample: {{software_token}}

keystringOptionalExample: inv_invoice_debtor_nr

valuestringOptionalExample: eq

operatorintegerOptionalExample: 24

Responses

200

Response_200

No content

get/invoices/

GET /invoices/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Response_200

No content

Update invoice

put

/invoices/

This api is used to fetch update invoices. Any of the parameters can be added as a URL parameter with the new value.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

tokenstringOptionalExample: {{client_token}}

software_tokenstringOptionalExample: {{software_token}}

inv_idintegerOptional

Invoice id is required

Example: 1

inv_external_referencestringOptionalExample: 2018-000192

inv_referencestringOptionalExample: REFF

Responses

200

Response_200

No content

put/invoices/

PUT /invoices/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Response_200

No content