PUT
/
invoices
/
{id}

Authorizations

Authorization
string
header
required

Value for the Authorization header parameter.

Path Parameters

id
string
required

Invoice identifier

Body

customerId
string | null
required

The customer ID of the invoice.

customerAddressId
string | null

The customer address ID which should be used for this invoice. If not provided, we will use the default invoice or address, or if not defined, the default address.

paymentMethodId
string | null

The customer's payment method ID which should be used for this invoice. If not provided, we will use the default payment method.

currencyCode
string | null

The currency code of the invoice. All position item currencies will be converted to this currency. If not provided, the default currency of the customer will be used.

internalNote
string | null

The internal note of the invoice.

Required string length: 1 - 255
dueDate
string | null

If not provided, we use the tenant default setting for the due date.

positions
object[]

The positions of the invoice. Can be empty and filled later.

title
string | null

The title of the invoice. If none is provided, we use the title from the default invoice template.

Maximum length: 255
introduction
string | null

The introduction of the invoice. If none is provided, we use the introduction from the default invoice template.

Maximum length: 5000
closing
string | null

The closing of the invoice. If none is provided, we use the closing from the default invoice template.

Maximum length: 5000
customFields
object | null

Custom fields for the entity. The keys are the field names and the values are the field values. They need to be configured under "/custom-fields" in the API documentation. The input is validated against the configuration. For more details see Custom Fields Guide

Response

200
application/json
id
string

The unique identifier of the invoice.

customer
object

The customer of the invoice.

paymentMethod
object | null

The payment method which should be used to fullfill the payment of the invoice.

referencedInvoice
object | null

The referenced invoice of the invoice. This could be in case of a reminder, refund etc.