Zum Hauptinhalt springen
GET
cURL

Autorisierungen

Authorization
string
header
erforderlich

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Pfadparameter

id
string
erforderlich

InvoicePositionItem identifier

Antwort

InvoicePositionItem resource

id
object
position
integer | null
read-only

The position of the invoice position item in the invoice. If 0, the item will be added at the end of the invoice.

quantity
number | null

The quantity of the invoice position item.

Beispiel:

1

unit
object | null

The unit of the invoice position item.

unitPrice
object

The unit price of the invoice position item.

netAmount
object
read-only

The net amount of the invoice position item, before discount.

grossAmount
object
read-only

The gross amount of the invoice position item, after discount.

taxAmount
object
read-only

The tax amount of the invoice position item, after discount.

discountAmount
object

The discount amount of the invoice position item.

discountPercentage
string | null

The discount percentage of the invoice position item. You can either define an amount or a percentage.

Beispiel:

10

name
string

The description of the invoice position item.

Beispiel:

"My subscription product"

description
string | null

The description of the invoice position item.

Beispiel:

"* my subscription product"

taxGroup
object

The tax group of the invoice position item. Based on the customer and tax group, the correct tax rate will be calculated.

tax
object | null

The tax of the invoice position item, calculated based on the tax group.

type
enum<string> | null

The type of the invoice position item.

Verfügbare Optionen:
product,
discount,
setup,
dunning_fee,
invoice,
null
Beispiel:

"product"

parent
any | null

The parent invoice position item. Positions can be defined in a tree, with a maximum depth of two.

group
object | null

The invoice position item group. Positions can be grouped together with a headline, which is shown on the invoice.

createdAt
string<date-time>
read-only

The creation date of the invoice position item.

Beispiel:

"2020-01-01T00:00:00+00:00"

product
object | null
subscriptionItem
object | null
serviceDateFrom
string<date-time> | null
read-only

The service date from of the invoice position item.

Beispiel:

"2020-01-01T00:00:00+00:00"

serviceDateTo
string<date-time> | null
read-only

The service date to of the invoice position item.

Beispiel:

"2020-01-01T00:00:00+00:00"

isCreditable
boolean
read-only

If the position can be credited.

Beispiel:

true

isFullyCredited
boolean
read-only

If the whole position is credited.

Beispiel:

true

creditableQuantity
number | null
read-only

The quantity that can be credited.

Beispiel:

1