PUT
/
invoices
/
{id}

Authorizations

Authorization
string
headerrequired

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

Response

200 - application/json
id
string

The unique identifier of the invoice.

customer
object

The customer of the invoice.

paymentMethod
object

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

referencedInvoice
object

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

type
enum<string>

The type of the invoice.

Available options:
TYPE_INVOICE,
TYPE_CREDIT,
TYPE_REFUND,
TYPE_REMINDER,
TYPE_CANCEL,
TYPE_DUNNING
currencyCode
string

The currency code of the invoice. If multiple currency codes will be used in the positions, they will be converted to that base currency.

number
string | null

The document id of the invoice. This will be generated, when the invoice will be finalized.

status
enum<string>
Available options:
STATUS_DRAFT,
STATUS_PAID,
STATUS_CANCELLED,
STATUS_REFUNDED,
STATUS_REMINDED,
STATUS_UNPAID,
STATUS_NEW,
STATUS_FINALIZING
creationDate
string
finalizationDate
string | null
dueDate
string | null
lastReminderDate
string | null
lastSentAt
string | null
dunningLevel
integer
dunningStatus
enum<string>
default: none
Available options:
reminder,
dunning,
none
payDate
string | null
invoiceAddress
object

The invoice address of the invoice.

internalNote
string | null

The notice of the invoice.

title
string | null
introduction
string | null
closing
string | null
netAmount
object

The net amount of the invoice.

grossAmount
object
taxAmount
object
discountAmount
object | null

The total net discount amount of the invoice.

file
object
positions
object[]

The positions of the invoice.

applicatedExchangeRates
object[]

The applicated exchange rates of the invoice, fetched from the european central bank.

eInvoiceType
enum<string> | null

The einvoice generated xml file format.

leitwegId
string | null

The leitwegid used for einvoice. This is only set, when the eInvoiceType is not null.

serviceDateFrom
string | null

The earliest service date of all positions.

serviceDateTo
string | null

The latest service date of all positions.

unpaidAmount
object
usageBreakdownUrl
string | null

Public url to view the detailed usage breakdown of this invoice.

cancellationDocument
object | null

The referenced cancellation document.

dunningDisabled
boolean

Dunning is disabled for this invoice.

sourceType
enum<string>

Where the invoice was created from.

Possible values:

  • cart: The invoice was created from a cart.
  • subscription: The invoice was created from a subscription billing run.
  • manual: The invoice was created by a user.
Available options:
manual,
subscription,
cart

Was this page helpful?

Get invoiceDelete invoice