Invoiceable Docs

Appearance

Overview ​

LineItemData is a data structure used within the Invoicing API.

Definition ​

typescript
export type LineItemData = {
        description: string;
        quantity: number;
        unit_price: number;
        tax_type: CIUSBusinessTerms.BT118nd151;
        tax_rate: number;
        unit_code: CIUSBusinessTerms.BT130 | string;
        price_base_quantity: number;
        gross_price: number | null;
        seller_item_identifier: string | null;
        buyer_item_identifier: string | null;
        standard_id: string | null;
        standard_id_scheme: string | null;
        classification_id: string | null;
        classification_id_scheme: string | null;
        order_line_reference: string | null;
        buyer_accounting_reference: string | null;
        origin_country_code: string | null;
        period_start: any | null;
        period_end: any | null;
        attributes: ItemAttributeData | null;
        product_characteristics: Array<ProductCharacteristicData> | null;
        allowances_charges: Array<AllowanceChargeData> | null;
    };

Properties ​

Required Fields ​

description ​

  • Type: string
  • Description: No description available. [BT-154]

quantity ​

  • Type: number
  • Description: The quantity of items. [BT-129]

unit_price ​

  • Type: number
  • Description: The net price for one unit of the item (in Cents!). [BT-146]

tax_type ​

  • Type: [BT118nd151](/docs/api/enums#bt118nd151)
  • Description: The VAT category code. [BT-118 / BT-151]

tax_rate ​

  • Type: number
  • Description: The VAT rate in basis points (e.g. 1900 for 19%).

unit_code ​

  • Type: [BT130 | string](/docs/api/enums#bt130 | string)
  • Description: The unit of measure code.

price_base_quantity ​

  • Type: number
  • Description: The number of item units to which the price applies (usually 1). [BT-149]

Optional Fields ​

gross_price ​

  • Type: number | null
  • Description: No description available. [BT-148]

seller_item_identifier ​

  • Type: string | null
  • Description: An identifier, assigned by the seller, for the item. [BT-155]

buyer_item_identifier ​

  • Type: string | null
  • Description: An identifier, assigned by the buyer, for the item. [BT-156]

standard_id ​

  • Type: string | null
  • Description: No description available.

standard_id_scheme ​

  • Type: string | null
  • Description: No description available.

classification_id ​

  • Type: string | null
  • Description: No description available.

classification_id_scheme ​

  • Type: string | null
  • Description: No description available.

order_line_reference ​

  • Type: string | null
  • Description: No description available.

buyer_accounting_reference ​

  • Type: string | null
  • Description: No description available.

origin_country_code ​

  • Type: string | null
  • Description: The code of the country from which the item originates. [BT-159]

period_start ​

  • Type: any | null
  • Description: No description available.

period_end ​

  • Type: any | null
  • Description: No description available.

attributes ​

  • Type: [ItemAttributeData](/docs/api/types/item-attribute-data) | null
  • Description: No description available.

product_characteristics ​

  • Type: Array<[ProductCharacteristicData](/docs/api/types/product-characteristic-data)> | null
  • Description: No description available.

allowances_charges ​

  • Type: Array<[AllowanceChargeData](/docs/api/types/allowance-charge-data)> | null
  • Description: Allowances (discounts) and charges on document level.

Usage ​

This type is used in the following structures: