Create an incoming invoice

Creates an incoming invoice or a prepayment invoice on an existing purchase order. Set invoice_number to post the invoice to your accounting integration.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Create an incoming invoice or a prepayment invoice.

integer
required

Database ID of the purchase order the invoice belongs to.

integer
enum
required

Invoice type. Set on creation and cannot be changed afterwards. Credit invoices cannot be created through the API.

  • 10 - Incoming invoice
  • 20 - Prepayment
  • 30 - Credit invoice
Allowed:
products
array of objects
required

Invoice lines. Every line of a new invoice names a line of the purchase order.

products*
string | null
Defaults to null

Invoice number. Generated automatically when omitted.

string | null
Defaults to null

Vendor invoice number. Filling this posts the invoice to the accounting integration, if one is connected.

integer | null
Defaults to null

Invoice date as UNIX timestamp.

integer | null
Defaults to null

Payment due date as UNIX timestamp.

integer | null
Defaults to null

Database ID of the vendor. Defaults to the vendor of the purchase order.

string | null
Defaults to null

Taxable additional fees, in the account default currency. Allocated across the purchase order lines. Not allowed on prepayment invoices. Send this field, fees_taxable_sum_cur, or both. With both, fees_taxable_sum_cur multiplied by the invoice exchange rate must equal this field to five decimal places; otherwise the request is refused with 422.

string | null
Defaults to null

Taxable additional fees, in the invoice currency. Allocated across the purchase order lines. Not allowed on prepayment invoices.

string | null
Defaults to null

Non-taxable additional fees, in the account default currency. Allocated across the purchase order lines. Not allowed on prepayment invoices. Send this field, fees_sum_cur, or both. With both, fees_sum_cur multiplied by the invoice exchange rate must equal this field to five decimal places; otherwise the request is refused with 422.

string | null
Defaults to null

Non-taxable additional fees, in the invoice currency. Allocated across the purchase order lines. Not allowed on prepayment invoices.

string | null
Defaults to null

Tax percentage. Applies only to an invoice without lines. An invoice with lines always uses the VAT rate of its purchase order, and a value sent here is ignored.

string | null
Defaults to null

On a prepayment invoice, the prepayment amount; on an incoming invoice, the prepayment applied from the purchase order's pool. In the account default currency. Required when type is 20 (Prepayment), unless prepayment_sum_cur is sent. Send this field, prepayment_sum_cur, or both. With both, prepayment_sum_cur multiplied by the invoice exchange rate must equal this field to five decimal places; otherwise the request is refused with 422.

string | null
Defaults to null

On a prepayment invoice, the prepayment amount. On an incoming invoice, the prepayment applied from the purchase order's pool. Required when type is 20 (Prepayment), unless prepayment_sum_base is sent.

integer | null
Defaults to null

Date when the invoice was created as UNIX timestamp. Defaults to today.

custom_values
array of objects
Defaults to null

Custom field values for the invoice.

custom_values
files
array of objects
Defaults to null

Files attached to the invoice.

files
Responses

401

Unauthorized

429

Too many requests

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json