PUT
/
invoice-position-items
/
{id}

Authorizations

Authorization
string
headerrequired

Value for the Authorization header parameter.

Path Parameters

id
string
required

InvoicePositionItem identifier

Body

name
string
required

The name of the position item.

Required string length: 1 - 255
unitId
string
required

The unit ID of the position item.

unitPrice
string
default: 0.00required

The unit price as net amount. It is only allowed to use dots as seperator.

taxGroupId
string | null
required

The tax group ID of the position item.

id
string

The ID of the position item.

position
integer | null

The position of the position item. If not set, it will be set automatically. The position is used to sort the position items in the invoice.

description
string | null

The description of the position item.

Required string length: 1 - 10000
quantity
number
default: 1

The quantity of the position item. This can be positive or negative.

currencyCode
string | null

The currency code of the position item. If not set, the currency code of the invoice will be used.

serviceDateFrom
string | null

The service date from of the position item. If not set, it is null and will not be printed.

serviceDateTo
string | null

The service date to of the position item. If not set, it is null and will not be printed.

discountAmount
string
default: 0.00

The discount amount as net amount needs to be null or a positive money value. This will be subtracted from the unit price amount of the position item (unit price).

discountPercentage
number

The discount percentage needs to be null or a positive value. This will be subtracted from the unit price amount of the position item (unit price).

Required range: 0 < x < 100
unitPriceInterval
string | null

The unit price interval of the position item. If not set, it is null and will not be printed.

subscriptionItem
string | null

The subscription item of the position item.

product
string | null

The product of the position item. This is used to have access to statistics also on manual created invoices.

children
object[]

The children of the position item.

group
object

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.

paymentProviderFeeCents
object

The total amount of fees for each payment provider, which charges fees.

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 an invoice position itemDelete an invoice position item