API documentation
User
Tenant
Feature
Entitlement
User & permissions
Settings
- Settings
- Media
- Webhook
- Notification
Payment
- Payment Method
- Transaction
- SEPA XML
- Open Banking
- Bank Account Transaction
Customer
- Customer
- Customer Address
- Customer Email
- Customer Settings
- Customer Otp
Billing
- Invoice
- Invoice Position Item
- Billing Run
Dunning
- Dunning Document
- Dunning Rule
Subscription
- Subscription
- Subscription Item
- Subscription Measurement
- Billing Group
Offers
- Offer
- Offer Recipient
- Offer Template
Catalogue
- Unit
- Measurement
- Product
- Product Family
- Price Plan
- Coupon
Checkout
- Checkout Link
- Cart
Accounting
Get an invoice position item
Get an invoice position item.
Required permissions:invoice:readAuthorizations
Value for the Authorization header parameter.
Path Parameters
InvoicePositionItem identifier
Response
The creation date of the invoice position item.
The quantity that can be credited.
The description of the invoice position item.
The discount amount of the invoice position item.
The fixed applied discount amount of the invoice position item.
The discount percentage of the invoice position item. You can either define an amount or a percentage.
The gross amount of the invoice position item, after discount.
If the position can be credited.
If the whole position is credited.
The description of the invoice position item.
The net amount of the invoice position item, before discount.
The parent invoice position item. Positions can be defined in a tree, with a maximum depth of two.
The creation date of the invoice position item.
The quantity that can be credited.
The description of the invoice position item.
The discount amount of the invoice position item.
The fixed applied discount amount of the invoice position item.
The discount percentage of the invoice position item. You can either define an amount or a percentage.
The gross amount of the invoice position item, after discount.
If the position can be credited.
If the whole position is credited.
The description of the invoice position item.
The net amount of the invoice position item, before discount.
The parent invoice position item. Positions can be defined in a tree, with a maximum depth of two.
The creation date of the invoice position item.
The quantity that can be credited.
The description of the invoice position item.
The discount amount of the invoice position item.
The fixed applied discount amount of the invoice position item.
The discount percentage of the invoice position item. You can either define an amount or a percentage.
The gross amount of the invoice position item, after discount.
If the position can be credited.
If the whole position is credited.
The description of the invoice position item.
The net amount of the invoice position item, before discount.
The parent invoice position item. Positions can be defined in a tree, with a maximum depth of two.
The creation date of the invoice position item.
The quantity that can be credited.
The description of the invoice position item.
The discount amount of the invoice position item.
The fixed applied discount amount of the invoice position item.
The discount percentage of the invoice position item. You can either define an amount or a percentage.
The gross amount of the invoice position item, after discount.
If the position can be credited.
If the whole position is credited.
The description of the invoice position item.
The net amount of the invoice position item, before discount.
The parent invoice position item. Positions can be defined in a tree, with a maximum depth of two.
The creation date of the invoice position item.
The quantity that can be credited.
The description of the invoice position item.
The discount amount of the invoice position item.
The fixed applied discount amount of the invoice position item.
The discount percentage of the invoice position item. You can either define an amount or a percentage.
The gross amount of the invoice position item, after discount.
The invoice position item group. Positions can be grouped together with a headline, which is shown on the invoice.
If the position can be credited.
If the whole position is credited.
The description of the invoice position item.
The net amount of the invoice position item, before discount.
The parent invoice position item. Positions can be defined in a tree, with a maximum depth of two.
The position of the invoice position item in the invoice. If 0, the item will be added at the end of the invoice.
The quantity of the invoice position item.
The service date from of the invoice position item.
The service date to of the invoice position item.
The tax of the invoice position item, calculated based on the tax group.
The tax amount of the invoice position item, after discount.
The tax group of the invoice position item. Based on the customer and tax group, the correct tax rate will be calculated.
The type of the invoice position item.
product, discount, setup, dunning_fee, invoice The unit of the invoice position item.
The unit price of the invoice position item.
The position of the invoice position item in the invoice. If 0, the item will be added at the end of the invoice.
The type of the product.
product: recurring billed productcharge: one-time billingplan: plan specific product, which cannot be used as a normal product. Will be filtered out in any product lists.
product, charge, plan 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
The description of the product based on the current tenant language.
The unique identifier of the product.
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.
always, only_if_charged The name of the product based on the current tenant language. This will be displayed on customer communication.
The quantity of the invoice position item.
The service date from of the invoice position item.
The service date to of the invoice position item.
The description of the item which will be used in the invoice. The description is translated based on the customer's locale.
Further information defines additional information for the item which will be displayed in the invoice.
The name of the item which will be used in the invoice. The name is translated based on the customer's locale.
The status of the item.
Possible values:
active: The item is active and will be billed.canceled: The item is canceled and will be billed until the end of the contract.pending: The item is pending and will be billed after the contract start.terminated: The item is terminated and will not be billed.
active, canceled, pending, terminated The tax of the invoice position item, calculated based on the tax group.
The tax amount of the invoice position item, after discount.
The tax group of the invoice position item. Based on the customer and tax group, the correct tax rate will be calculated.
The name of the tax group which will be displayed only in the UI
255Defines if reverse charge will be applicated or not
REVERSE_CHARGE_DEACTIVATED, REVERSE_CHARGE, REVERSE_CHARGE_INTRA_EU_SUPPLY standard, reduced The type of the invoice position item.
product, discount, setup, dunning_fee, invoice The unit price of the invoice position item.
The position of the invoice position item in the invoice. If 0, the item will be added at the end of the invoice.
The type of the product.
product: recurring billed productcharge: one-time billingplan: plan specific product, which cannot be used as a normal product. Will be filtered out in any product lists.
product, charge, plan 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
The description of the product based on the current tenant language.
The unique identifier of the product.
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.
always, only_if_charged The name of the product based on the current tenant language. This will be displayed on customer communication.
The quantity of the invoice position item.
The service date from of the invoice position item.
The service date to of the invoice position item.
The description of the item which will be used in the invoice. The description is translated based on the customer's locale.
Further information defines additional information for the item which will be displayed in the invoice.
The name of the item which will be used in the invoice. The name is translated based on the customer's locale.
The status of the item.
Possible values:
active: The item is active and will be billed.canceled: The item is canceled and will be billed until the end of the contract.pending: The item is pending and will be billed after the contract start.terminated: The item is terminated and will not be billed.
active, canceled, pending, terminated The tax of the invoice position item, calculated based on the tax group.
The tax amount of the invoice position item, after discount.
The tax group of the invoice position item. Based on the customer and tax group, the correct tax rate will be calculated.
The name of the tax group which will be displayed only in the UI
255Defines if reverse charge will be applicated or not
REVERSE_CHARGE_DEACTIVATED, REVERSE_CHARGE, REVERSE_CHARGE_INTRA_EU_SUPPLY standard, reduced The type of the invoice position item.
product, discount, setup, dunning_fee, invoice The unit price of the invoice position item.
The position of the invoice position item in the invoice. If 0, the item will be added at the end of the invoice.
The type of the product.
product: recurring billed productcharge: one-time billingplan: plan specific product, which cannot be used as a normal product. Will be filtered out in any product lists.
product, charge, plan 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
The description of the product based on the current tenant language.
The unique identifier of the product.
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.
always, only_if_charged The name of the product based on the current tenant language. This will be displayed on customer communication.
The quantity of the invoice position item.
The service date from of the invoice position item.
The service date to of the invoice position item.
The description of the item which will be used in the invoice. The description is translated based on the customer's locale.
Further information defines additional information for the item which will be displayed in the invoice.
The name of the item which will be used in the invoice. The name is translated based on the customer's locale.
The status of the item.
Possible values:
active: The item is active and will be billed.canceled: The item is canceled and will be billed until the end of the contract.pending: The item is pending and will be billed after the contract start.terminated: The item is terminated and will not be billed.
active, canceled, pending, terminated The tax amount of the invoice position item, after discount.
The tax group of the invoice position item. Based on the customer and tax group, the correct tax rate will be calculated.
The name of the tax group which will be displayed only in the UI
255Defines if reverse charge will be applicated or not
REVERSE_CHARGE_DEACTIVATED, REVERSE_CHARGE, REVERSE_CHARGE_INTRA_EU_SUPPLY standard, reduced The type of the invoice position item.
product, discount, setup, dunning_fee, invoice The unit price of the invoice position item.
The position of the invoice position item in the invoice. If 0, the item will be added at the end of the invoice.
The type of the product.
product: recurring billed productcharge: one-time billingplan: plan specific product, which cannot be used as a normal product. Will be filtered out in any product lists.
product, charge, plan 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
The description of the product based on the current tenant language.
The unique identifier of the product.
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.
always, only_if_charged The name of the product based on the current tenant language. This will be displayed on customer communication.
The quantity of the invoice position item.
The service date from of the invoice position item.
The service date to of the invoice position item.
The description of the item which will be used in the invoice. The description is translated based on the customer's locale.
Further information defines additional information for the item which will be displayed in the invoice.
The name of the item which will be used in the invoice. The name is translated based on the customer's locale.
The status of the item.
Possible values:
active: The item is active and will be billed.canceled: The item is canceled and will be billed until the end of the contract.pending: The item is pending and will be billed after the contract start.terminated: The item is terminated and will not be billed.
active, canceled, pending, terminated The tax amount of the invoice position item, after discount.
The tax group of the invoice position item. Based on the customer and tax group, the correct tax rate will be calculated.
The name of the tax group which will be displayed only in the UI
255Defines if reverse charge will be applicated or not
REVERSE_CHARGE_DEACTIVATED, REVERSE_CHARGE, REVERSE_CHARGE_INTRA_EU_SUPPLY standard, reduced The type of the invoice position item.
product, discount, setup, dunning_fee, invoice The unit price of the invoice position item.
Was this page helpful?