Get an invoice position item

GET

invoice-position-items

{id}

curl -X GET \
 /invoice-position-items/{id} \
 --header "Authorization: Bearer <token>"

{
  "id": {},
  "position": 123,
  "quantity": 1,
  "unit": {
    "id": {},
    "name": "Stück"
  },
  "unitPrice": {},
  "netAmount": {},
  "grossAmount": {},
  "taxAmount": {},
  "discountAmount": {},
  "discountPercentage": 10,
  "name": "My subscription product",
  "description": "* my subscription product",
  "taxGroup": {
    "id": "00000000-0000-0000-0000-000000000000",
    "internalDescription": "19%",
    "reverseChargeType": "REVERSE_CHARGE",
    "type": "standard"
  },
  "tax": {
    "id": "00000000-0000-0000-0000-000000000000",
    "description": "19%",
    "code": "19",
    "rate": 19
  },
  "type": "product",
  "parent": {},
  "group": {
    "id": "ad8a3b9e-5b0a-4e1a-9c1a-0b9b2b8b0b0b",
    "ranking": 1,
    "name": "Subscription #12345"
  },
  "createdAt": "2020-01-01T00:00:00+00:00",
  "product": {
    "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
    "name": "Basic",
    "description": "For small teams.",
    "type": "product",
    "invoiceVisibility": "always",
    "customFields": {
      "field1": "value1",
      "field2": "value2"
    }
  },
  "subscriptionItem": {
    "id": "01F9ZQZJZJQZJZJZJZJZJZJZJZ",
    "name": "Fitness M",
    "description": "Everything included",
    "furtherInformation": "Additional agreements: The contract includes a free drink flatrate.",
    "status": "active",
    "subscriptionId": "<string>"
  },
  "serviceDateFrom": "2020-01-01T00:00:00+00:00",
  "serviceDateTo": "2020-01-01T00:00:00+00:00",
  "isCreditable": true,
  "isFullyCredited": true,
  "creditableQuantity": 1
}

Authorizations

Authorization

string

header

required

Value for the Authorization header parameter.

Path Parameters

string

required

InvoicePositionItem identifier

Response

200

application/json

InvoicePositionItem resource

object

position

integer | null

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

quantity

object

The quantity of the invoice position item.

unit

object | null

The unit of the invoice position item.

unitPrice

object

The unit price of the invoice position item.

netAmount

object

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

grossAmount

object

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

taxAmount

object

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.

Example:

10

discountFixed

object

The fixed applied discount amount of the invoice position item.

name

string

The description of the invoice position item.

Example:

"My subscription product"

description

string | null

The description of the invoice position item.

Example:

"* 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.

Available options:

product,

discount,

setup,

dunning_fee,

invoice

Example:

"product"

parent

object | null

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

parent.id

object

parent.position

integer | null

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

parent.quantity

object

The quantity of the invoice position item.

parent.unit

object | null

The unit of the invoice position item.

parent.unitPrice

object

The unit price of the invoice position item.

parent.netAmount

object

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

parent.grossAmount

object

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

parent.taxAmount

object

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

parent.discountAmount

object

The discount amount of the invoice position item.

parent.discountPercentage

string | null

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

Example:

10

parent.discountFixed

object

The fixed applied discount amount of the invoice position item.

parent.name

string

The description of the invoice position item.

Example:

"My subscription product"

parent.description

string | null

The description of the invoice position item.

Example:

"* my subscription product"

parent.taxGroup

object

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

parent.tax

object | null

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

parent.type

enum<string> | null

The type of the invoice position item.

Available options:

product,

discount,

setup,

dunning_fee,

invoice

Example:

"product"

parent.parent

object | null

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

parent.parent.id

object

parent.parent.position

integer | null

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

parent.parent.quantity

object

The quantity of the invoice position item.

parent.parent.unit

object | null

The unit of the invoice position item.

parent.parent.unitPrice

object

The unit price of the invoice position item.

parent.parent.netAmount

object

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

parent.parent.grossAmount

object

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

parent.parent.taxAmount

object

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

parent.parent.discountAmount

object

The discount amount of the invoice position item.

parent.parent.discountPercentage

string | null

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

Example:

10

parent.parent.discountFixed

object

The fixed applied discount amount of the invoice position item.

parent.parent.name

string

The description of the invoice position item.

Example:

"My subscription product"

parent.parent.description

string | null

The description of the invoice position item.

Example:

"* my subscription product"

parent.parent.taxGroup

object

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

parent.parent.tax

object | null

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

parent.parent.type

enum<string> | null

The type of the invoice position item.

Available options:

product,

discount,

setup,

dunning_fee,

invoice

Example:

"product"

parent

object

parent.parent.group

object | null

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

parent.parent.createdAt

string

The creation date of the invoice position item.

Example:

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

parent.parent.product

object | null

parent.parent.product.type

enum<string>

required

The type of the product.

product: recurring billed product
charge: one-time billing
plan: plan specific product, which cannot be used as a normal product. Will be filtered out in any product lists.

Available options:

product,

charge,

plan

parent.parent.product.id

string

The unique identifier of the product.

Example:

"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b"

parent.parent.product.name

string

The name of the product based on the current tenant language. This will be displayed on customer communication.

Example:

"Basic"

parent.parent.product.description

string | null

The description of the product based on the current tenant language.

Example:

"For small teams."

parent.parent.product.invoiceVisibility

enum<string>

Defines when the product should be displayed in the invoice.

always: The product is always displayed in the invoice.
only_if_charged: The product is only displayed in the invoice if it is charged.

Available options:

always,

only_if_charged

parent.parent.product.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

Example:

{ "field1": "value1", "field2": "value2" }

parent.parent.subscriptionItem

object | null

parent.parent.serviceDateFrom

string | null

The service date from of the invoice position item.

Example:

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

parent.parent.serviceDateTo

string | null

The service date to of the invoice position item.

Example:

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

parent.parent.isCreditable

boolean

If the position can be credited.

Example:

true

parent.parent.isFullyCredited

boolean

If the whole position is credited.

Example:

true

parent.parent.creditableQuantity

object

The quantity that can be credited.

parent.group

object | null

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

parent.createdAt

string

The creation date of the invoice position item.

Example:

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

parent.product

object | null

parent.product.type

enum<string>

required

The type of the product.

product: recurring billed product
charge: one-time billing
plan: plan specific product, which cannot be used as a normal product. Will be filtered out in any product lists.

Available options:

product,

charge,

plan

parent.product.id

string

The unique identifier of the product.

Example:

"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b"

parent.product.name

string

The name of the product based on the current tenant language. This will be displayed on customer communication.

Example:

"Basic"

parent.product.description

string | null

The description of the product based on the current tenant language.

Example:

"For small teams."

parent.product.invoiceVisibility

enum<string>

Defines when the product should be displayed in the invoice.

always: The product is always displayed in the invoice.
only_if_charged: The product is only displayed in the invoice if it is charged.

Available options:

always,

only_if_charged

parent.product.customFields

object | null

Example:

{ "field1": "value1", "field2": "value2" }

parent.subscriptionItem

object | null

parent.serviceDateFrom

string | null

The service date from of the invoice position item.

Example:

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

parent.serviceDateTo

string | null

The service date to of the invoice position item.

Example:

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

parent.isCreditable

boolean

If the position can be credited.

Example:

true

parent.isFullyCredited

boolean

If the whole position is credited.

Example:

true

parent.creditableQuantity

object

The quantity that can be credited.

group

object | null

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

createdAt

string

The creation date of the invoice position item.

Example:

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

product

object | null

product.type

enum<string>

required

The type of the product.

product: recurring billed product
charge: one-time billing
plan: plan specific product, which cannot be used as a normal product. Will be filtered out in any product lists.

Available options:

product,

charge,

plan

product.id

string

The unique identifier of the product.

Example:

"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b"

product.name

string

The name of the product based on the current tenant language. This will be displayed on customer communication.

Example:

"Basic"

product.description

string | null

The description of the product based on the current tenant language.

Example:

"For small teams."

product.invoiceVisibility

enum<string>

Defines when the product should be displayed in the invoice.

always: The product is always displayed in the invoice.
only_if_charged: The product is only displayed in the invoice if it is charged.

Available options:

always,

only_if_charged

product.customFields

object | null

Example:

{ "field1": "value1", "field2": "value2" }

subscriptionItem

object | null

serviceDateFrom

string | null

The service date from of the invoice position item.

Example:

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

serviceDateTo

string | null

The service date to of the invoice position item.

Example:

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

isCreditable

boolean

If the position can be credited.

Example:

true

isFullyCredited

boolean

If the whole position is credited.

Example:

true

creditableQuantity

object

The quantity that can be credited.

Add comment Update an invoice position item

curl -X GET \
 /invoice-position-items/{id} \
 --header "Authorization: Bearer <token>"

{
  "id": {},
  "position": 123,
  "quantity": 1,
  "unit": {
    "id": {},
    "name": "Stück"
  },
  "unitPrice": {},
  "netAmount": {},
  "grossAmount": {},
  "taxAmount": {},
  "discountAmount": {},
  "discountPercentage": 10,
  "name": "My subscription product",
  "description": "* my subscription product",
  "taxGroup": {
    "id": "00000000-0000-0000-0000-000000000000",
    "internalDescription": "19%",
    "reverseChargeType": "REVERSE_CHARGE",
    "type": "standard"
  },
  "tax": {
    "id": "00000000-0000-0000-0000-000000000000",
    "description": "19%",
    "code": "19",
    "rate": 19
  },
  "type": "product",
  "parent": {},
  "group": {
    "id": "ad8a3b9e-5b0a-4e1a-9c1a-0b9b2b8b0b0b",
    "ranking": 1,
    "name": "Subscription #12345"
  },
  "createdAt": "2020-01-01T00:00:00+00:00",
  "product": {
    "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
    "name": "Basic",
    "description": "For small teams.",
    "type": "product",
    "invoiceVisibility": "always",
    "customFields": {
      "field1": "value1",
      "field2": "value2"
    }
  },
  "subscriptionItem": {
    "id": "01F9ZQZJZJQZJZJZJZJZJZJZJZ",
    "name": "Fitness M",
    "description": "Everything included",
    "furtherInformation": "Additional agreements: The contract includes a free drink flatrate.",
    "status": "active",
    "subscriptionId": "<string>"
  },
  "serviceDateFrom": "2020-01-01T00:00:00+00:00",
  "serviceDateTo": "2020-01-01T00:00:00+00:00",
  "isCreditable": true,
  "isFullyCredited": true,
  "creditableQuantity": 1
}

API documentation

User

Tenant

Feature

Entitlement

User & permissions

Settings

Payment

Analytics

Customer

Billing

Dunning

Subscription

Offers

Catalogue

Checkout

Accounting

Taxes

Get an invoice position item

Authorizations

Path Parameters

Response