Get an invoice position item

Get an invoice position item.

^{Required permissions: invoice:read}

GET /invoice-position-items/{id}

cURL

cURL

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

200

{
  "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": {
    "internalDescription": "19%",
    "reverseChargeType": "REVERSE_CHARGE",
    "type": "standard",
    "id": "00000000-0000-0000-0000-000000000000"
  },
  "tax": {
    "code": "19",
    "rate": 19,
    "id": "00000000-0000-0000-0000-000000000000",
    "description": "19%"
  },
  "type": "product",
  "parent": "<unknown>",
  "group": {
    "id": "ad8a3b9e-5b0a-4e1a-9c1a-0b9b2b8b0b0b",
    "ranking": 1,
    "name": "Subscription #12345"
  },
  "createdAt": "2020-01-01T00:00:00+00:00",
  "product": {
    "type": "product",
    "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
    "name": "Basic",
    "description": "For small teams.",
    "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
}

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

200

application/json

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.

Show child attributes

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.

Show child attributes

tax · object | null

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

Show child attributes

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.

Show child attributes

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

Show child attributes

subscriptionItem · object | null

Show child attributes

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