--- title: "Show Transaction" method: GET path: "/v2/all-transactions/{procurosTransactionId}" tags: ["All Transactions"] --- # Show Transaction `GET /v2/all-transactions/{procurosTransactionId}` ## Request - Base URL: `https://api.procuros.io` - URL: `https://api.procuros.io/v2/all-transactions/{procurosTransactionId}` - Auth: HTTP bearer Show a single transaction. ## Path parameters - `procurosTransactionId` string, uuid, required ## Response `200` Success - object - `data` Transaction, required - `procurosTransactionId` string, uuid, required: Unique ID assigned to every transaction on the Procuros Network. - `type` 'ORDER' | 'ORDER_RESPONSE' | 'SHIPPING_NOTICE' | 'INVOICE' | 'CREDIT_NOTE' | 'DISPATCH_INSTRUCTION' | 'DISPATCH_INSTRUCTION_RESPONSE' | 'RECEIVAL_NOTICE' | 'REMITTANCE_ADVICE' | 'PRODUCT_CATALOG' | 'INVENTORY_REPORT' | 'SALES_REPORT', required: Type of transaction. - `status` 'PENDING' | 'SUCCESS' | 'FAILED' | 'DROPPED' | 'UNKNOWN', required: Current status of the transaction. - `flow` 'LIVE' | 'TEST', required: Flow (LIVE or TEST) of the transaction. - `createdAt` string, date-time, required - `replacesProcurosTransactionId` string, uuid, nullable: ID of the transaction this one replaces (i.e. this is a newer version of that transaction). - `replacedByProcurosTransactionId` string, uuid, nullable: ID of the transaction that replaced this one (i.e. a newer version exists). - `isLatestVersion` boolean, required: Whether this is the latest version of the transaction. False when a newer version exists (see replacedByProcurosTransactionId). - `content` union, required - Order: A purchase order is a formal request from a buying organization to a supplier to fulfill a contract. - `header` OrderHeader, required - `buyer` Party, required - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `supplier` Party, required - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `shipTo` ShipToParty: A party object where identifiers are optional, used specifically for shipTo fields. - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[] - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `billTo` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `finalRecipient` FinalRecipientParty: A party object where identifiers are optional, used specifically for finalRecipient fields. - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[] - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `technicalRecipient` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `technicalSender` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `orderIdentifier` string, required: Order number assigned to this purchase order by the buyer. - `orderDate` string, date-time, required - `AdditionalOrderIdentifiers` AdditionalOrderIdentifiers: Additional order identifiers for different parties in the transaction. - `supplierOrderIdentifier` string: Supplier order identifier. - `shipToOrderIdentifier` string: Ship-to order identifier. - `shipFromOrderIdentifier` string: Ship-from order identifier. - `billToOrderIdentifier` string: Bill-to order identifier. - `billFromOrderIdentifier` string: Bill-from order identifier. - `finalRecipientOrderIdentifier` string: Final recipient order identifier. - `technicalRecipientOrderIdentifier` string: Technical recipient order identifier. - `type` string: Type of the order as assigned by sender. - `requestedDeliveryDate` string, date-time - `requestedEarliestDeliveryDate` string, date-time - `requestedLatestDeliveryDate` string, date-time - `currency` string: ISO 4217 standard three-letter currency code. - `paymentTerms` PaymentTerm[]: Used for defining payment targets and optional discounts. - `payInNumberOfDays` integer, required - `percentage` number, float, required: Discount in % which is granted if payment is made not later than payInNumberOfDays after invoice date. - `comments` string: Arbitrary human-readable information buyers can send within purchase orders - `deliveryInformation` string: Delivery information for the order. - `purchasingInformation` string: Additional information about purchasing. - `legalInformation` string: Legal notices and information. - `promotionCode` string: Promotion code applied to the entire order. - `contractReference` string: Contract reference for the order. - `version` integer: The document version number. Subsequent updates should increment this number by 1. - `attachments` Attachment[] - `fileName` string: Name of the file. - `url` string, uri: URL to the file. - `mimeType` string: MIME type of the file. - `items` OrderItem[], required - `lineNumber` integer: LineNumber attribute may remain constant for any item through updates to the order, therefor lineNumbers may not be consecutive. - `identifiers` ItemIdentifier[]: Which identifiers are required depends on your trade partner. Most trade partners expect at least one identifier with domain `GS1` or `BUYER`. - `identifier` string: Party identifier within the 'domain' such as EAN/GTIN on GS1 domain, buyer's internal SKU on BUYER domain, etc. - `domain` 'GS1' | 'BUYER' | 'SUPPLIER': Identification system the identifier belongs to. - `isDepositItem` boolean: If true, the item is a deposit item such as bottle deposit (German: Pfandartikel). - `quantity` number, float: Defaults to 1. - `freeQuantity` number, float: The quantity of this item that is free of charge, in addition to (not part of) `quantity`. For example, an order line with `quantity` 10 and `freeQuantity` 2 means 12 units are delivered in total, 2 of which are free of charge. For subitems, this must be the total free quantity of this item. For example, the parent item is a display of chocolate bars and has free quantity set to 2. Each display contains 50 chocolate bars. Therefore, the free quantity of the "Chocolate Bar" subitem is 100 (2x50). - `unitOfMeasure` 'EA' | 'GRM' | 'HUR' | 'KGM' | 'LTR' | 'MLT' | 'MTK' | 'MTR' | 'PCK' | 'SET' | 'CS' | 'CA' | 'DAY' | 'WEE' | 'MON' | 'CT' | 'CQ' | 'CU' | 'BJ' | 'BO' | 'MTQ' | 'PF' | 'BG' | 'RO' | 'TNE' | 'BE' | 'CMT' | 'KMT' | 'PR' | 'TU': Subset of the the UN/CEFACT Unit of Measure Common Codes. - `description` string - `comments` string - `unitPrice` number, float - `pricingUnitOfMeasure` string: The unit of measure used for pricing. This field specifies the unit that the price refers to, which may differ from the quantity unit (e.g., price per carton when quantity is in pieces). - `pricingUnitQuantity` number, float: The quantity of base units contained in the pricing unit of measure. For example, if the price is per carton (pricingUnitOfMeasure: "CT") and each carton contains 100 pieces, this field stores 100. - `recommendedRetailPrice` number, float - `tax` Tax - `amount` number, float, required: Tax value in currency. - `percentage` number, float, required: Tax value in percentage. - `description` string, nullable - `category` string: VAT category for this tax. One of VAT, EXEMPT, ZERO_RATED, VAT_REVERSE_CHARGE, VAT_INTRA_COMMUNITY, VAT_EXPORT or VAT_OUT_OF_SCOPE. - `promotionCode` string: Promotion code applied to this item. - `contractReference` string: Contract reference for this item. - `requestedDeliveryDate` string, date-time - `requestedEarliestDeliveryDate` string, date-time - `requestedLatestDeliveryDate` string, date-time - `deliveryGracePeriodInDays` integer: Delivery grace period in days. - `minimumRemainingShelfLifeInDays` integer: Minimum remaining shelf life in days. - `netWeight` number, float: Net weight of the item in grams. - `grossWeight` number, float: Gross weight of the item in grams. - `originCountryCode` string: ISO 3166-1 alpha-2 country code. - `colorCode` string: Color code of the item. - `colorName` string: Color name of the item. - `size` string: Size of the item. - `dimension` string: Dimension of the item. - `hsCode` string: Harmonized System Code of the item. - `cnCode` string: The 8-digit Combined Nomenclature (CN) code classifying this product for EU customs and trade statistics. Suppliers are responsible for providing a valid code. - `organicControlPointNumber` string: Organic Control Point Number of the supplier - OCPN is a unique identifier that verifies that a producer of organic products is adhering to the standards for organic production. - `fscNumber` string: An FSC number refers to an identification number issued by the Forest Stewardship Council (FSC), an international organization that certifies sustainable forestry practices. - `mscNumber` string: An MSC number refers to an identification number issued by the Marine Stewardship Council (MSC), an international organization that certifies sustainable fishing practices. - `season` string: The season or collection period this item belongs to. Used to group and filter assortment by seasonal release. - `gender` string: The target gender this item is designed for (e.g. Male, Female, Unisex). Used to classify and filter assortment by gender segment. - `brand` string: Brand or manufacturer name of the product (e.g., BOSCH, Kela). - `consumerGroup` string: Gender for which this item is marketed (e.g., Unisex, Damen, Herren). - `assortment` string: Collection which the item belongs to (e.g., ME_GEN, COA_FB, COA_G, COA_OR, MB_EP, MB_EX, MB_LS, VCA_CE, LAN_ARP, JCH_IWF, JCH_IWC, LAC_L). - `category` string: Product category classification (e.g., 1008). - `subCategory` string: Product sub-category classification. - `certificationsRequired` CertificationsRequired: Indicates which certifications are required for the ordered item. - `fairtrade` boolean, nullable: Whether Fairtrade certification is required for this item. - `supplierQa` boolean, nullable: Whether supplier quality assurance certification is required for this item. - `eudr` boolean, nullable: Whether EU Deforestation Regulation (EUDR) certification is required for this item. - `attachments` LineItemAttachment[]: Document attachments for this line item, such as technical datasheets, product labels, or compliance documentation. - `fileName` string: Name of the attachment file. - `url` string, uri: URL to the attachment file. - `mimeType` string: MIME type of the attachment file (e.g., application/pdf). - `type` 'DECLARATION_OF_CONFORMITY' | 'ENERGY_LABEL' | 'EU_DATASHEET' | 'SAFETY_DATASHEET' | 'TECHNICAL_DATASHEET' | 'PRODUCT_LABEL': Type/classification of the line item attachment document. - `modificationGroups` ModificationGroup[] - `basis` number, float, required: The net base amount on which the modifications are applied. For item-level modifications on level 1, this equals the line item subtotal (quantity * unitPrice). For document-level modifications on level 1, this equals the subtotalAmount of the invoice. - `level` integer, required: Determines in which order the modifications group should be applied. Starting at 1 and continuously increasing. There should be no modification groups with the same level. - `modifications` Modification[], required - … - `summary` object: The summary is required if a modificationGroup exists on the order, otherwise the summary is optional. In API v3, the summary will be mandatory in any case. - `subtotalAmount` number, float, required: The sum of all line item subtotal amounts. The line item subtotal already includes all line item modifications. - `grossAmount` number, float, required: The netAmount plus taxes. - `netAmount` number, float, required: The subtotalAmount plus totalCharges and minus totalAllowances. - `dueAmount` number, float, required: The grossAmount minus deposit. Note: deposits are not yet supported, therefore dueAmount will always equal grossAmount for now. - `totalCharges` number, float, required: The total sum of all charges applied on document-level. Does not include charges applied on item-level. - `totalAllowances` number, float, required: The total sum of all allowances applied on invoice level. Does not include allowances applied on item-level. - `tax` object, required - `total` number, float, required - `description` string - `items` object[], required - … - `modificationGroups` ModificationGroup[] - `basis` number, float, required: The net base amount on which the modifications are applied. For item-level modifications on level 1, this equals the line item subtotal (quantity * unitPrice). For document-level modifications on level 1, this equals the subtotalAmount of the invoice. - `level` integer, required: Determines in which order the modifications group should be applied. Starting at 1 and continuously increasing. There should be no modification groups with the same level. - `modifications` Modification[], required - … - OrderResponse - `header` OrderResponseHeader, required - `type` 'ACCEPT' | 'REJECT' | 'CHANGE': Type of the order response. `ACCEPT` means the order was accepted exactly as ordered. `REJECT` means the order was fully rejected. `CHANGE` means part of the order was accepted but either line item quantities or delivery date are changed. **If this field is omitted or set to null, the response is treated identically to `REJECT` — items are prohibited and the order is considered fully rejected. It is strongly recommended to always provide an explicit type.** - `version` integer: If you are sending multiple order responses, this field must be incremented by 1 for each response. - `buyer` Party, required - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `supplier` Party, required - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `shipTo` ShipToParty: A party object where identifiers are optional, used specifically for shipTo fields. - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[] - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `billTo` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `finalRecipient` FinalRecipientParty: A party object where identifiers are optional, used specifically for finalRecipient fields. - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[] - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `technicalRecipient` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `technicalSender` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `orderResponseIdentifier` string, required: Order response number assigned by the supplier to identify this order response. - `orderResponseDate` string, date-time, required - `orderIdentifier` string, required: Order number assigned to this purchase order by the buyer. - `orderDate` string, date-time - `AdditionalOrderIdentifiers` AdditionalOrderIdentifiers: Additional order identifiers for different parties in the transaction. - `supplierOrderIdentifier` string: Supplier order identifier. - `shipToOrderIdentifier` string: Ship-to order identifier. - `shipFromOrderIdentifier` string: Ship-from order identifier. - `billToOrderIdentifier` string: Bill-to order identifier. - `billFromOrderIdentifier` string: Bill-from order identifier. - `finalRecipientOrderIdentifier` string: Final recipient order identifier. - `technicalRecipientOrderIdentifier` string: Technical recipient order identifier. - `confirmedDeliveryDate` string, date-time - `confirmedShipmentDate` string, date-time - `requestedDeliveryDate` string, date-time - `requestedEarliestDeliveryDate` string, date-time - `requestedLatestDeliveryDate` string, date-time - `currency` string: ISO 4217 standard three-letter currency code. - `paymentTerms` PaymentTerm[]: Used for defining payment targets and optional discounts. - `payInNumberOfDays` integer, required - `percentage` number, float, required: Discount in % which is granted if payment is made not later than payInNumberOfDays after invoice date. - `comments` string: Arbitrary human-readable information buyers can send within purchase orders - `deliveryInformation` string: Delivery information for the order. - `purchasingInformation` string: Additional information about purchasing. - `legalInformation` string: Legal notices and information. - `contractReference` string: Contract reference for the order. - `promotionCode` string: Promotion code applied to the entire order. - `items` OrderResponseItemWithSubSubItems[]: Conditional based on the `type` field in the header: Required when type is `CHANGE`; optional when type is `ACCEPT` (omit to confirm all lines as-is, or include to selectively confirm specific items); prohibited when type is `REJECT` or when type is omitted/null (both treated as a full rejection). When the type is `CHANGE`, it must contain ALL order line items, regardless whether or not `orderedQuantity` and `confirmedQuantity` are equal. - `lineNumber` integer - `orderLineNumber` integer: The line number of the order item that this response item refers to. - `identifiers` ItemIdentifier[]: Which identifiers are required depends on your trade partner. Most trade partners expect at least one identifier with domain `GS1` or `BUYER`. - `identifier` string: Party identifier within the 'domain' such as EAN/GTIN on GS1 domain, buyer's internal SKU on BUYER domain, etc. - `domain` 'GS1' | 'BUYER' | 'SUPPLIER': Identification system the identifier belongs to. - `isDepositItem` boolean: If true, the item is a deposit item such as bottle deposit (German: Pfandartikel). - `orderedQuantity` number, float - `confirmedQuantity` number, float - `requestedDeliveryDate` string, date-time - `requestedEarliestDeliveryDate` string, date-time - `requestedLatestDeliveryDate` string, date-time - `confirmedDeliveryDate` string, date-time - `confirmedEarliestDeliveryDate` string, date-time - `confirmedLatestDeliveryDate` string, date-time - `confirmedShipmentDate` string, date-time - `unitOfMeasure` 'EA' | 'GRM' | 'HUR' | 'KGM' | 'LTR' | 'MLT' | 'MTK' | 'MTR' | 'PCK' | 'SET' | 'CS' | 'CA' | 'DAY' | 'WEE' | 'MON' | 'CT' | 'CQ' | 'CU' | 'BJ' | 'BO' | 'MTQ' | 'PF' | 'BG' | 'RO' | 'TNE' | 'BE' | 'CMT' | 'KMT' | 'PR' | 'TU': Subset of the the UN/CEFACT Unit of Measure Common Codes. - `description` string - `comments` string - `unitPrice` number, float - `pricingUnitOfMeasure` string: The unit of measure used for pricing. This field specifies the unit that the price refers to, which may differ from the quantity unit (e.g., price per carton when quantity is in pieces). - `pricingUnitQuantity` number, float: The quantity of base units contained in the pricing unit of measure. For example, if the price is per carton (pricingUnitOfMeasure: "CT") and each carton contains 100 pieces, this field stores 100. - `recommendedRetailPrice` number, float - `tax` Tax - `amount` number, float, required: Tax value in currency. - `percentage` number, float, required: Tax value in percentage. - `description` string, nullable - `category` string: VAT category for this tax. One of VAT, EXEMPT, ZERO_RATED, VAT_REVERSE_CHARGE, VAT_INTRA_COMMUNITY, VAT_EXPORT or VAT_OUT_OF_SCOPE. - `contractReference` string: Contract reference for this item. - `promotionCode` string: Promotion code applied to this item. - `minimumRemainingShelfLifeInDays` integer: Minimum remaining shelf life in days. - `netWeight` number, float: Net weight of the item in grams. - `grossWeight` number, float: Gross weight of the item in grams. - `originCountryCode` string: ISO 3166-1 alpha-2 country code. - `colorCode` string: Color code of the item. - `colorName` string: Color name of the item. - `size` string: Size of the item. - `dimension` string: Dimension of the item. - `hsCode` string: Harmonized System Code of the item. - `cnCode` string: The 8-digit Combined Nomenclature (CN) code classifying this product for EU customs and trade statistics. Suppliers are responsible for providing a valid code. - `organicControlPointNumber` string: Organic Control Point Number of the supplier - OCPN is a unique identifier that verifies that a producer of organic products is adhering to the standards for organic production. - `fscNumber` string: An FSC number refers to an identification number issued by the Forest Stewardship Council (FSC), an international organization that certifies sustainable forestry practices. - `mscNumber` string: An MSC number refers to an identification number issued by the Marine Stewardship Council (MSC), an international organization that certifies sustainable fishing practices. - `season` string: The season or collection period this item belongs to. Used to group and filter assortment by seasonal release. - `gender` string: The target gender this item is designed for (e.g. Male, Female, Unisex). Used to classify and filter assortment by gender segment. - `substituteOf` ItemSubstitution: A reference to the counterpart article in a substitution. - `identifiers` ItemIdentifier[]: Identifiers of the referenced article. Each entry must carry a `domain` and an `identifier`; name the counterpart with the same identifiers used on its own line item. - … - `substitutedBy` ItemSubstitution: A reference to the counterpart article in a substitution. - `identifiers` ItemIdentifier[]: Identifiers of the referenced article. Each entry must carry a `domain` and an `identifier`; name the counterpart with the same identifiers used on its own line item. - … - `modificationGroups` ModificationGroup[] - `basis` number, float, required: The net base amount on which the modifications are applied. For item-level modifications on level 1, this equals the line item subtotal (quantity * unitPrice). For document-level modifications on level 1, this equals the subtotalAmount of the invoice. - `level` integer, required: Determines in which order the modifications group should be applied. Starting at 1 and continuously increasing. There should be no modification groups with the same level. - `modifications` Modification[], required - … - `attachments` LineItemAttachment[]: Document attachments for this line item response, such as technical datasheets, product labels, or compliance documentation. - `fileName` string: Name of the attachment file. - `url` string, uri: URL to the attachment file. - `mimeType` string: MIME type of the attachment file (e.g., application/pdf). - `type` 'DECLARATION_OF_CONFORMITY' | 'ENERGY_LABEL' | 'EU_DATASHEET' | 'SAFETY_DATASHEET' | 'TECHNICAL_DATASHEET' | 'PRODUCT_LABEL': Type/classification of the line item attachment document. - `subItems` OrderResponseItemWithSubItems[]: Sub items of this order response item. Supports two levels of nesting. - `lineNumber` integer - `orderLineNumber` integer: The line number of the order item that this response item refers to. - `identifiers` ItemIdentifier[]: Which identifiers are required depends on your trade partner. Most trade partners expect at least one identifier with domain `GS1` or `BUYER`. - … - `isDepositItem` boolean: If true, the item is a deposit item such as bottle deposit (German: Pfandartikel). - `orderedQuantity` number, float - `confirmedQuantity` number, float - `requestedDeliveryDate` string, date-time - `requestedEarliestDeliveryDate` string, date-time - `requestedLatestDeliveryDate` string, date-time - `confirmedDeliveryDate` string, date-time - `confirmedEarliestDeliveryDate` string, date-time - `confirmedLatestDeliveryDate` string, date-time - `confirmedShipmentDate` string, date-time - `unitOfMeasure` 'EA' | 'GRM' | 'HUR' | 'KGM' | 'LTR' | 'MLT' | 'MTK' | 'MTR' | 'PCK' | 'SET' | 'CS' | 'CA' | 'DAY' | 'WEE' | 'MON' | 'CT' | 'CQ' | 'CU' | 'BJ' | 'BO' | 'MTQ' | 'PF' | 'BG' | 'RO' | 'TNE' | 'BE' | 'CMT' | 'KMT' | 'PR' | 'TU': Subset of the the UN/CEFACT Unit of Measure Common Codes. - `description` string - `comments` string - `unitPrice` number, float - `pricingUnitOfMeasure` string: The unit of measure used for pricing. This field specifies the unit that the price refers to, which may differ from the quantity unit (e.g., price per carton when quantity is in pieces). - `pricingUnitQuantity` number, float: The quantity of base units contained in the pricing unit of measure. For example, if the price is per carton (pricingUnitOfMeasure: "CT") and each carton contains 100 pieces, this field stores 100. - `recommendedRetailPrice` number, float - `tax` Tax - … - `contractReference` string: Contract reference for this item. - `promotionCode` string: Promotion code applied to this item. - `minimumRemainingShelfLifeInDays` integer: Minimum remaining shelf life in days. - `netWeight` number, float: Net weight of the item in grams. - `grossWeight` number, float: Gross weight of the item in grams. - `originCountryCode` string: ISO 3166-1 alpha-2 country code. - `colorCode` string: Color code of the item. - `colorName` string: Color name of the item. - `size` string: Size of the item. - `dimension` string: Dimension of the item. - `hsCode` string: Harmonized System Code of the item. - `cnCode` string: The 8-digit Combined Nomenclature (CN) code classifying this product for EU customs and trade statistics. Suppliers are responsible for providing a valid code. - `organicControlPointNumber` string: Organic Control Point Number of the supplier - OCPN is a unique identifier that verifies that a producer of organic products is adhering to the standards for organic production. - `fscNumber` string: An FSC number refers to an identification number issued by the Forest Stewardship Council (FSC), an international organization that certifies sustainable forestry practices. - `mscNumber` string: An MSC number refers to an identification number issued by the Marine Stewardship Council (MSC), an international organization that certifies sustainable fishing practices. - `season` string: The season or collection period this item belongs to. Used to group and filter assortment by seasonal release. - `gender` string: The target gender this item is designed for (e.g. Male, Female, Unisex). Used to classify and filter assortment by gender segment. - `substituteOf` ItemSubstitution: A reference to the counterpart article in a substitution. - … - `substitutedBy` ItemSubstitution: A reference to the counterpart article in a substitution. - … - `modificationGroups` ModificationGroup[] - … - `attachments` LineItemAttachment[]: Document attachments for this line item response, such as technical datasheets, product labels, or compliance documentation. - … - `subItems` OrderResponseItem[]: Sub items of this sub order response item. - … - `summary` object: The summary is required if a modificationGroup exists on the order response, otherwise the summary is optional. In API v3, the summary will be mandatory in any case. - `subtotalAmount` number, float, required: The sum of all line item subtotal amounts. The line item subtotal already includes all line item modifications. - `grossAmount` number, float, required: The netAmount plus taxes. - `netAmount` number, float, required: The subtotalAmount plus totalCharges and minus totalAllowances. - `dueAmount` number, float, required: The grossAmount minus deposit. Note: deposits are not yet supported, therefore dueAmount will always equal grossAmount for now. - `totalCharges` number, float, required: The total sum of all charges applied on document-level. Does not include charges applied on item-level. - `totalAllowances` number, float, required: The total sum of all allowances applied on invoice level. Does not include allowances applied on item-level. - `tax` object, required - `total` number, float, required - `description` string - `items` object[], required - … - `modificationGroups` ModificationGroup[] - `basis` number, float, required: The net base amount on which the modifications are applied. For item-level modifications on level 1, this equals the line item subtotal (quantity * unitPrice). For document-level modifications on level 1, this equals the subtotalAmount of the invoice. - `level` integer, required: Determines in which order the modifications group should be applied. Starting at 1 and continuously increasing. There should be no modification groups with the same level. - `modifications` Modification[], required - … - ShippingNotice - `header` ShippingNoticeHeader, required - `buyer` Party, required - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `supplier` Party, required - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `shipFrom` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `shipTo` ShipToParty: A party object where identifiers are optional, used specifically for shipTo fields. - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[] - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `billTo` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `finalRecipient` FinalRecipientParty: A party object where identifiers are optional, used specifically for finalRecipient fields. - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[] - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `technicalRecipient` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `technicalSender` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `shippingNoticeIdentifier` string, required - `shippingNoticeDate` string, date-time, required - `orderIdentifier` string, required: Order number assigned to the related purchase order by the buyer. - `orderDate` string, date-time - `AdditionalOrderIdentifiers` AdditionalOrderIdentifiers: Additional order identifiers for different parties in the transaction. - `supplierOrderIdentifier` string: Supplier order identifier. - `shipToOrderIdentifier` string: Ship-to order identifier. - `shipFromOrderIdentifier` string: Ship-from order identifier. - `billToOrderIdentifier` string: Bill-to order identifier. - `billFromOrderIdentifier` string: Bill-from order identifier. - `finalRecipientOrderIdentifier` string: Final recipient order identifier. - `technicalRecipientOrderIdentifier` string: Technical recipient order identifier. - `requestedDeliveryDate` string, date-time - `requestedEarliestDeliveryDate` string, date-time - `requestedLatestDeliveryDate` string, date-time - `expectedDeliveryDate` string, date-time - `requestedDespatchDate` string, date-time - `despatchDate` string, date-time - `carrier` string: Carriers company name. - `trackingNumber` string - `trackingUrl` string - `modeOfTransport` 'ROAD' | 'RAIL' | 'AIR' | 'SEA' | 'MULTIMODAL': Chosen mode of transport for the shipment. - `incoTerms` 'EXW' | 'FCA' | 'CPT' | 'CIP' | 'DAP' | 'DDP' | 'FAS' | 'FOB' | 'CFR' | 'CIF' | 'DAT': International Commercial Terms (INCOTERMS) as published by the International Chamber of Commerce (ICC). - `shippingMethod` string - `status` string - `comments` string: Arbitrary human-readable information buyers can send within purchase orders - `deliveryInformation` string: Information about the delivery process. - `purchasingInformation` string: Additional information about purchasing. - `legalInformation` string: Legal notices and information. - `currency` string: ISO 4217 standard three-letter currency code. - `version` integer: The document version number. Subsequent updates should increment this number by 1. - `transportUnits` ShippingNoticeTransportUnitWithSubTransportUnits[], required: Transport units (e.g. pallets, cartons) contained in the shipment. Can be nested in case of sandwich pallets. - `unitIdentifier` string: Transport unit number. (SSCC or NVE) - `unitType` 'EURO_PALLET' | 'EURO_PALLET_HALF' | 'EURO_PALLET_QUARTER' | 'CARTON' | 'PACKAGE' | 'PALLET' | 'CONTAINER': Transport unit type. Supported values: EURO_PALLET (Euro Pallet 120×80 cm), EURO_PALLET_HALF (1/2 Euro Pallet 80×60 cm), EURO_PALLET_QUARTER (1/4 Euro Pallet 60×40 cm), PALLET (generic/non-Euro pallet), PACKAGE, CARTON, CONTAINER. - `containedTradeUnitCount` integer: Number of contained trade units. (cases, cartons, etc.) - `requestedDeliveryDate` string, date-time - `expectedDeliveryDate` string, date-time - `requestedDespatchDate` string, date-time - `despatchDate` string, date-time - `carrier` TransportUnitCarrier: Carrier information for a transport unit. - `name` string: Carrier name. - `trackingNumber` string: Tracking number. - `trackingUrl` string: Tracking URL. - `transportLabel` TransportLabel: Transport label (ZPL + PDF) for a transport unit. - `zplUrl` string: URL to the raw ZPL of the transport label. - `pdfUrl` string: URL to the rendered PDF of the transport label. - `items` ShippingNoticeItemWithSubSubItems[], required: Line items contained in this transport unit. - `lineNumber` integer, required - `orderLineNumber` integer: Line number used on the order. - `orderIdentifier` string: Order number assigned to the related purchase order by the buyer. - `identifiers` ItemIdentifier[], required: Which identifiers are required depends on your trade partner. Most trade partners expect at least one identifier with domain `GS1` or `BUYER`. - … - `isDepositItem` boolean, required: If true, the item is a deposit item such as bottle deposit (German: Pfandartikel). - `description` string: Item description. - `comments` string - `orderedQuantity` number, required: The quantity ordered by the customer. For subitems, this must be the total quantity of this item. For example, the parent item is a display of chocolate bars and has quantity 2. Each display contains 50 chocolate bars. Therefore, the quantity of the "Chocolate Bar" subitem is 100 (2x50). - `shippedQuantity` number, required: The quantity shipped to the customer. For subitems, this must be the total quantity of this item. For example, the parent item is a display of chocolate bars and has quantity 2. Each display contains 50 chocolate bars. Therefore, the quantity of the "Chocolate Bar" subitem is 100 (2x50). - `openQuantityAction` 'DISCARDED' | 'DELIVERED_LATER': Method used to handle mismatches between "orderedQuantity" and "shippedQuantity". Required if "orderedQuantity" and "shippedQuantity" mismatch, otherwise prohibited. - `batches` Batch[] - … - `serialNumbers` SerialNumber[]: Serial numbers of the individual units of this line item. - … - `unitPrice` number, float - `recommendedRetailPrice` number, float - `tax` Tax - … - `minimumRemainingShelfLifeInDays` integer: Minimum remaining shelf life in days. - `promotionCode` string: Promotion code applied to this item. - `contractReference` string: Contract reference for this item. - `netWeight` number, float: Net weight of the item in grams. - `grossWeight` number, float: Gross weight of the item in grams. - `originCountryCode` string: ISO 3166-1 alpha-2 country code. - `colorCode` string: Color code of the item. - `colorName` string: Color name of the item. - `size` string: Size of the item. - `dimension` string: Dimension of the item. - `hsCode` string: Harmonized System Code of the item. - `cnCode` string: The 8-digit Combined Nomenclature (CN) code classifying this product for EU customs and trade statistics. Suppliers are responsible for providing a valid code. - `organicControlPointNumber` string: Organic Control Point Number of the supplier - OCPN is a unique identifier that verifies that a producer of organic products is adhering to the standards for organic production. - `fscNumber` string: An FSC number refers to an identification number issued by the Forest Stewardship Council (FSC), an international organization that certifies sustainable forestry practices. - `mscNumber` string: An MSC number refers to an identification number issued by the Marine Stewardship Council (MSC), an international organization that certifies sustainable fishing practices. - `certifications` Certifications: Item certifications for various standards and organizations. - … - `substituteOf` ItemSubstitution: A reference to the counterpart article in a substitution. - … - `substitutedBy` ItemSubstitution: A reference to the counterpart article in a substitution. - … - `unitOfMeasure` 'EA' | 'GRM' | 'HUR' | 'KGM' | 'LTR' | 'MLT' | 'MTK' | 'MTR' | 'PCK' | 'SET' | 'CS' | 'CA' | 'DAY' | 'WEE' | 'MON' | 'CT' | 'CQ' | 'CU' | 'BJ' | 'BO' | 'MTQ' | 'PF' | 'BG' | 'RO' | 'TNE' | 'BE' | 'CMT' | 'KMT' | 'PR' | 'TU': Subset of the the UN/CEFACT Unit of Measure Common Codes. - `breeder` object - … - `fattener` object - … - `slaughterer` object - … - `cutter` object - … - `slaughterDate` string, date - `tradeClass` string - `earTag` string - `birthdate` string, date - `gender` 'MALE' | 'FEMALE' - `subItems` ShippingNoticeItemWithSubItems[]: Sub items of this shipping notice item. Supports two levels of nesting. - … - `transportUnits` ShippingNoticeTransportUnit[]: Contained transport units (e.g. sandwich pallet layers). - `unitIdentifier` string: Transport unit number. (SSCC or NVE) - `unitType` 'EURO_PALLET' | 'EURO_PALLET_HALF' | 'EURO_PALLET_QUARTER' | 'CARTON' | 'PACKAGE' | 'PALLET' | 'CONTAINER': Transport unit type. Supported values: EURO_PALLET (Euro Pallet 120×80 cm), EURO_PALLET_HALF (1/2 Euro Pallet 80×60 cm), EURO_PALLET_QUARTER (1/4 Euro Pallet 60×40 cm), PALLET (generic/non-Euro pallet), PACKAGE, CARTON, CONTAINER. - `containedTradeUnitCount` integer: Number of contained trade units. (cases, cartons, etc.) - `requestedDeliveryDate` string, date-time - `expectedDeliveryDate` string, date-time - `requestedDespatchDate` string, date-time - `despatchDate` string, date-time - `carrier` TransportUnitCarrier: Carrier information for a transport unit. - … - `transportLabel` TransportLabel: Transport label (ZPL + PDF) for a transport unit. - … - `items` ShippingNoticeItemWithSubSubItems[], required: Line items contained in this transport unit. - … - Invoice: Invoices describe purchase orders, line items, partners involved, accounting distribution, payment terms, discounts, shipping and special handling, taxes, deposit and prepayment, and remittance information. - `header` InvoiceHeader, required - `buyer` Party, required - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `supplier` Party, required - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `shipTo` ShipToParty: A party object where identifiers are optional, used specifically for shipTo fields. - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[] - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `billTo` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `billFrom` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `finalRecipient` FinalRecipientParty: A party object where identifiers are optional, used specifically for finalRecipient fields. - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[] - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `technicalRecipient` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `technicalSender` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `invoiceIdentifier` string, required: Invoice number/reference. - `invoiceDate` string, date-time, required - `invoiceValueDate` string, date-time - `invoiceDueDate` string, date-time - `shippingNoticeIdentifier` string, nullable: Shared shipping notice number/reference for an invoice covering a single shipping notice. - `shippingNoticeDate` string, date-time, nullable - `orderIdentifier` string, required: Order number assigned to the related purchase order by the buyer. - `orderDate` string, date-time, required - `AdditionalOrderIdentifiers` AdditionalOrderIdentifiers: Additional order identifiers for different parties in the transaction. - `supplierOrderIdentifier` string: Supplier order identifier. - `shipToOrderIdentifier` string: Ship-to order identifier. - `shipFromOrderIdentifier` string: Ship-from order identifier. - `billToOrderIdentifier` string: Bill-to order identifier. - `billFromOrderIdentifier` string: Bill-from order identifier. - `finalRecipientOrderIdentifier` string: Final recipient order identifier. - `technicalRecipientOrderIdentifier` string: Technical recipient order identifier. - `requestedDeliveryDate` string, date-time - `expectedDeliveryDate` string, date-time - `paymentTerms` PaymentTerm[]: Used for defining payment targets and optional discounts. - `payInNumberOfDays` integer, required - `percentage` number, float, required: Discount in % which is granted if payment is made not later than payInNumberOfDays after invoice date. - `comments` string: Arbitrary human-readable information buyers can send within invoices - `deliveryInformation` string: Information about the delivery process. - `purchasingInformation` string: Additional information about purchasing. - `legalInformation` string: Legal notices and information. - `currency` string: ISO 4217 standard three-letter currency code. - `paymentMethod` 'CASH' | 'CREDIT_TRANSFER' | 'BANK_CARD' | 'DIRECT_DEBIT' | 'CREDIT_CARD': How the document is to be paid. - `type` 'PARTIAL_INVOICE' - `promotionCode` string: Promotion code applied to the entire invoice. Does not affect invoice calculations. - `organicControlPointNumber` string: Organic Control Point Number of the supplier - OCPN is a unique identifier that verifies that a producer of organic products is adhering to the standards for organic production. - `contractReference` string: Contract reference for the invoice. - `version` integer: The document version number. Subsequent updates should increment this number by 1. - `items` InvoiceItemWithSubSubItems[], nullable: Can be left out or empty, e.g. when the invoice only has document-level charges. Some receivers can still require at least one line item. - `lineNumber` integer, required - `shippingNoticeIdentifier` string: For invoices covering multiple shipping notices, provide the shipping notice number/reference for this item and omit the header-level shipping notice fields. - `shippingNoticeDate` string, date-time - `shippingNoticeLineNumber` integer: Optional shipping notice line number for this item when the invoice covers multiple shipping notices. - `orderIdentifier` string: Order number assigned to the related purchase order by the buyer. - `orderDate` string, date-time - `orderLineNumber` integer - `requestedDeliveryDate` string, date-time - `expectedDeliveryDate` string, date-time - `identifiers` ItemIdentifier[], required: Which identifiers are required depends on your trade partner. Most trade partners expect at least one identifier with domain `GS1` or `BUYER`. - `identifier` string: Party identifier within the 'domain' such as EAN/GTIN on GS1 domain, buyer's internal SKU on BUYER domain, etc. - `domain` 'GS1' | 'BUYER' | 'SUPPLIER': Identification system the identifier belongs to. - `isDepositItem` boolean, required: If true, the item is a deposit item such as bottle deposit (German: Pfandartikel). - `isInvoicedItem` boolean, required: Determine if this item is the invoiced item. Only invoiced items can have a unitPrice != 0. If an item is not invoiced and no parent item is invoiced either, sub items must exist. - `description` string: Item description. - `comments` string - `quantity` number, float, required: For subitems, this must be the total quantity of this item. For example, the parent item is a display of chocolate bars and has quantity 2. Each display contains 50 chocolate bars. Therefore, the quantity of the "Chocolate Bar" subitem is 100 (2x50). - `freeQuantity` number, float: The quantity of this item that is free of charge, in addition to (not part of) `quantity`. For example, an order line with `quantity` 10 and `freeQuantity` 2 means 12 units are delivered in total, 2 of which are free of charge. For subitems, this must be the total free quantity of this item. For example, the parent item is a display of chocolate bars and has free quantity set to 2. Each display contains 50 chocolate bars. Therefore, the free quantity of the "Chocolate Bar" subitem is 100 (2x50). - `orderedQuantity` number, float: The quantity ordered by the customer. - `unitPrice` number, float, required - `pricingUnitOfMeasure` string: The unit of measure used for pricing. This field specifies the unit that the price refers to, which may differ from the quantity unit (e.g., price per carton when quantity is in pieces). - `pricingUnitQuantity` number, float: The quantity of base units contained in the pricing unit of measure. For example, if the price is per carton (pricingUnitOfMeasure: "CT") and each carton contains 100 pieces, this field stores 100. - `recommendedRetailPrice` number, float - `netWeight` number, float: Net weight of the item in grams. - `grossWeight` number, float: Gross weight of the item in grams. - `originCountryCode` string: ISO 3166-1 alpha-2 country code. - `colorCode` string: Color code of the item. - `colorName` string: Color name of the item. - `size` string: Size of the item. - `dimension` string: Dimension of the item. - `hsCode` string: Harmonized System Code of the item. - `cnCode` string: The 8-digit Combined Nomenclature (CN) code classifying this product for EU customs and trade statistics. Suppliers are responsible for providing a valid code. - `organicControlPointNumber` string: Organic Control Point Number of the supplier - OCPN is a unique identifier that verifies that a producer of organic products is adhering to the standards for organic production. - `fscNumber` string: An FSC number refers to an identification number issued by the Forest Stewardship Council (FSC), an international organization that certifies sustainable forestry practices. - `mscNumber` string: An MSC number refers to an identification number issued by the Marine Stewardship Council (MSC), an international organization that certifies sustainable fishing practices. - `certifications` Certifications: Item certifications for various standards and organizations. - `deBnn` string: DE-BNN (Bundesverband Naturkost Naturwaren) certification number - `eudr` object: EU Deforestation Regulation (EUDR) compliance information - … - `substituteOf` ItemSubstitution: A reference to the counterpart article in a substitution. - `identifiers` ItemIdentifier[]: Identifiers of the referenced article. Each entry must carry a `domain` and an `identifier`; name the counterpart with the same identifiers used on its own line item. - … - `substitutedBy` ItemSubstitution: A reference to the counterpart article in a substitution. - `identifiers` ItemIdentifier[]: Identifiers of the referenced article. Each entry must carry a `domain` and an `identifier`; name the counterpart with the same identifiers used on its own line item. - … - `promotionCode` string: Promotion code applied to this item. Does not affect invoice calculations. - `contractReference` string: Contract reference for this item. - `tax` Tax, required - `amount` number, float, required: Tax value in currency. - `percentage` number, float, required: Tax value in percentage. - `description` string, nullable - `category` string: VAT category for this tax. One of VAT, EXEMPT, ZERO_RATED, VAT_REVERSE_CHARGE, VAT_INTRA_COMMUNITY, VAT_EXPORT or VAT_OUT_OF_SCOPE. - `batches` Batch[] - `batchIdentifier` string - `expirationDate` string, date - `quantity` number, float: How much of the shipping notice line item belongs to this batch. The sum of all batch quantities must be equal to the "shippedQuantity" of the shipping notice line item. - `netWeight` number, float: Net weight of the batch in grams. - `grossWeight` number, float: Gross weight of the batch in grams. - `serialNumbers` SerialNumber[]: Serial numbers of the individual units of this line item. - `identifiers` object, required: Identifiers of the serialized unit. At least one identifier should be provided. - … - `batchIdentifier` string: Identifier of the batch this unit belongs to. References the "batchIdentifier" of an entry in "batches". - `modificationGroups` ModificationGroup[]: If a Modification Group is provided, the Invoice Summary is required. - `basis` number, float, required: The net base amount on which the modifications are applied. For item-level modifications on level 1, this equals the line item subtotal (quantity * unitPrice). For document-level modifications on level 1, this equals the subtotalAmount of the invoice. - `level` integer, required: Determines in which order the modifications group should be applied. Starting at 1 and continuously increasing. There should be no modification groups with the same level. - `modifications` Modification[], required - … - `unitOfMeasure` 'EA' | 'GRM' | 'HUR' | 'KGM' | 'LTR' | 'MLT' | 'MTK' | 'MTR' | 'PCK' | 'SET' | 'CS' | 'CA' | 'DAY' | 'WEE' | 'MON' | 'CT' | 'CQ' | 'CU' | 'BJ' | 'BO' | 'MTQ' | 'PF' | 'BG' | 'RO' | 'TNE' | 'BE' | 'CMT' | 'KMT' | 'PR' | 'TU': Subset of the the UN/CEFACT Unit of Measure Common Codes. - `subItems` InvoiceItemWithSubItems[]: Sub items of this invoice item. Supports two levels of nesting. - `lineNumber` integer, required - `shippingNoticeIdentifier` string: For invoices covering multiple shipping notices, provide the shipping notice number/reference for this item and omit the header-level shipping notice fields. - `shippingNoticeDate` string, date-time - `shippingNoticeLineNumber` integer: Optional shipping notice line number for this item when the invoice covers multiple shipping notices. - `orderIdentifier` string: Order number assigned to the related purchase order by the buyer. - `orderDate` string, date-time - `orderLineNumber` integer - `requestedDeliveryDate` string, date-time - `expectedDeliveryDate` string, date-time - `identifiers` ItemIdentifier[], required: Which identifiers are required depends on your trade partner. Most trade partners expect at least one identifier with domain `GS1` or `BUYER`. - … - `isDepositItem` boolean, required: If true, the item is a deposit item such as bottle deposit (German: Pfandartikel). - `isInvoicedItem` boolean, required: Determine if this item is the invoiced item. Only invoiced items can have a unitPrice != 0. If an item is not invoiced and no parent item is invoiced either, sub items must exist. - `description` string: Item description. - `comments` string - `quantity` number, float, required: For subitems, this must be the total quantity of this item. For example, the parent item is a display of chocolate bars and has quantity 2. Each display contains 50 chocolate bars. Therefore, the quantity of the "Chocolate Bar" subitem is 100 (2x50). - `freeQuantity` number, float: The quantity of this item that is free of charge, in addition to (not part of) `quantity`. For example, an order line with `quantity` 10 and `freeQuantity` 2 means 12 units are delivered in total, 2 of which are free of charge. For subitems, this must be the total free quantity of this item. For example, the parent item is a display of chocolate bars and has free quantity set to 2. Each display contains 50 chocolate bars. Therefore, the free quantity of the "Chocolate Bar" subitem is 100 (2x50). - `orderedQuantity` number, float: The quantity ordered by the customer. - `unitPrice` number, float, required - `pricingUnitOfMeasure` string: The unit of measure used for pricing. This field specifies the unit that the price refers to, which may differ from the quantity unit (e.g., price per carton when quantity is in pieces). - `pricingUnitQuantity` number, float: The quantity of base units contained in the pricing unit of measure. For example, if the price is per carton (pricingUnitOfMeasure: "CT") and each carton contains 100 pieces, this field stores 100. - `recommendedRetailPrice` number, float - `netWeight` number, float: Net weight of the item in grams. - `grossWeight` number, float: Gross weight of the item in grams. - `originCountryCode` string: ISO 3166-1 alpha-2 country code. - `colorCode` string: Color code of the item. - `colorName` string: Color name of the item. - `size` string: Size of the item. - `dimension` string: Dimension of the item. - `hsCode` string: Harmonized System Code of the item. - `cnCode` string: The 8-digit Combined Nomenclature (CN) code classifying this product for EU customs and trade statistics. Suppliers are responsible for providing a valid code. - `organicControlPointNumber` string: Organic Control Point Number of the supplier - OCPN is a unique identifier that verifies that a producer of organic products is adhering to the standards for organic production. - `fscNumber` string: An FSC number refers to an identification number issued by the Forest Stewardship Council (FSC), an international organization that certifies sustainable forestry practices. - `mscNumber` string: An MSC number refers to an identification number issued by the Marine Stewardship Council (MSC), an international organization that certifies sustainable fishing practices. - `certifications` Certifications: Item certifications for various standards and organizations. - … - `substituteOf` ItemSubstitution: A reference to the counterpart article in a substitution. - … - `substitutedBy` ItemSubstitution: A reference to the counterpart article in a substitution. - … - `promotionCode` string: Promotion code applied to this item. Does not affect invoice calculations. - `contractReference` string: Contract reference for this item. - `tax` Tax, required - … - `batches` Batch[] - … - `serialNumbers` SerialNumber[]: Serial numbers of the individual units of this line item. - … - `modificationGroups` ModificationGroup[]: If a Modification Group is provided, the Invoice Summary is required. - … - `unitOfMeasure` 'EA' | 'GRM' | 'HUR' | 'KGM' | 'LTR' | 'MLT' | 'MTK' | 'MTR' | 'PCK' | 'SET' | 'CS' | 'CA' | 'DAY' | 'WEE' | 'MON' | 'CT' | 'CQ' | 'CU' | 'BJ' | 'BO' | 'MTQ' | 'PF' | 'BG' | 'RO' | 'TNE' | 'BE' | 'CMT' | 'KMT' | 'PR' | 'TU': Subset of the the UN/CEFACT Unit of Measure Common Codes. - `subItems` InvoiceItem[]: Sub items of this sub invoice item. - … - `summary` object: The summary is required if a modificationGroup exists on the invoice, otherwise the summary is optional. In API v3, the summary will be mandatory in any case. - `subtotalAmount` number, float: The sum of all line item subtotal amounts. The line item subtotal already includes all line item modifications. - `grossAmount` number, float: The netAmount plus taxes. - `netAmount` number, float: The subtotalAmount plus totalCharges and minus totalAllowances. - `dueAmount` number, float, required: The amount still owed, that is grossAmount minus paidAmount. It equals grossAmount when nothing was paid up front. - `paidAmount` number, float: The part of the invoice already settled before it was issued, for example a prepayment or a deposit. dueAmount is already net of this value. - `totalCharges` number, float: The total sum of all charges applied on document-level. Does not include charges applied on item-level. - `totalAllowances` number, float: The total sum of all allowances applied on invoice level. Does not include allowances applied on item-level. - `tax` object - `total` number, float, required - `description` string - `items` object[], required - … - `modificationGroups` ModificationGroup[] - `basis` number, float, required: The net base amount on which the modifications are applied. For item-level modifications on level 1, this equals the line item subtotal (quantity * unitPrice). For document-level modifications on level 1, this equals the subtotalAmount of the invoice. - `level` integer, required: Determines in which order the modifications group should be applied. Starting at 1 and continuously increasing. There should be no modification groups with the same level. - `modifications` Modification[], required - … - CreditNote: A credit note is a document sent to a customer in order to correct a mistake on an order or an invoice, or to refund an amount paid for products or services. - `header` CreditNoteHeader, required - `buyer` Party, required - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `supplier` Party, required - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `shipTo` ShipToParty: A party object where identifiers are optional, used specifically for shipTo fields. - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[] - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `billTo` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `billFrom` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `finalRecipient` FinalRecipientParty: A party object where identifiers are optional, used specifically for finalRecipient fields. - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[] - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `technicalRecipient` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `technicalSender` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `creditNoteIdentifier` string, required: Credit note number/reference. - `creditNoteDate` string, date-time, required - `creditNoteValueDate` string, date-time - `creditNoteDueDate` string, date-time - `type` 'CORRECTION' | 'VALUE_CREDIT': Credit note message type - `invoiceIdentifier` string: Invoice number/reference. - `invoiceDate` string, date-time - `shippingNoticeIdentifier` string: Shipping notice number/reference. - `shippingNoticeDate` string, date-time - `orderIdentifier` string: Order number assigned to the related purchase order by the buyer. - `orderDate` string, date-time - `requestedDeliveryDate` string, date-time - `expectedDeliveryDate` string, date-time - `paymentTerms` PaymentTerm[]: Used for defining payment targets and optional discounts. - `payInNumberOfDays` integer, required - `percentage` number, float, required: Discount in % which is granted if payment is made not later than payInNumberOfDays after invoice date. - `comments` string: Arbitrary human-readable information buyers can send within invoices - `deliveryInformation` string: Information about the delivery process. - `purchasingInformation` string: Additional information about purchasing. - `legalInformation` string: Legal notices and information. - `currency` string: ISO 4217 standard three-letter currency code. - `paymentMethod` 'CASH' | 'CREDIT_TRANSFER' | 'BANK_CARD' | 'DIRECT_DEBIT' | 'CREDIT_CARD': How the document is to be paid. - `promotionCode` string: Promotion code applied to the entire invoice. Does not affect invoice calculations. - `contractReference` string: Contract reference for the credit note. - `reason` string: Reason for the credit note - `organicControlPointNumber` string: Organic Control Point Number of the supplier - OCPN is a unique identifier that verifies that a producer of organic products is adhering to the standards for organic production. - `version` integer: The document version number. Subsequent updates should increment this number by 1. - `items` CreditNoteItemWithSubSubItems[], nullable: Can be left out or empty, e.g. when the credit note only has document-level charges. Some receivers can still require at least one line item. - `lineNumber` integer, required - `shippingNoticeIdentifier` string: Shipping notice number/reference. - `shippingNoticeDate` string, date-time - `shippingNoticeLineNumber` integer - `orderIdentifier` string: Order number assigned to the related purchase order by the buyer. - `orderDate` string, date-time - `orderLineNumber` integer - `requestedDeliveryDate` string, date-time - `expectedDeliveryDate` string, date-time - `identifiers` ItemIdentifier[], required: Which identifiers are required depends on your trade partner. Most trade partners expect at least one identifier with domain `GS1` or `BUYER`. - `identifier` string: Party identifier within the 'domain' such as EAN/GTIN on GS1 domain, buyer's internal SKU on BUYER domain, etc. - `domain` 'GS1' | 'BUYER' | 'SUPPLIER': Identification system the identifier belongs to. - `isDepositItem` boolean, required: If true, the item is a deposit item such as bottle deposit (German: Pfandartikel). - `isInvoicedItem` boolean, required: Determine if this item is the invoiced item. Only invoiced items can have a unitPrice != 0. If an item is not invoiced and no parent item is invoiced either, sub items must exist. - `description` string: Item description. - `comments` string - `quantity` number, float, required: For subitems, this must be the total quantity of this item. For example, the parent item is a display of chocolate bars and has quantity 2. Each display contains 50 chocolate bars. Therefore, the quantity of the "Chocolate Bar" subitem is 100 (2x50). - `freeQuantity` number, float: The quantity of this item that is free of charge, in addition to (not part of) `quantity`. For example, an order line with `quantity` 10 and `freeQuantity` 2 means 12 units are delivered in total, 2 of which are free of charge. For subitems, this must be the total free quantity of this item. For example, the parent item is a display of chocolate bars and has free quantity set to 2. Each display contains 50 chocolate bars. Therefore, the free quantity of the "Chocolate Bar" subitem is 100 (2x50). - `orderedQuantity` number, float: The quantity ordered by the customer. - `unitPrice` number, float, required - `pricingUnitOfMeasure` string: The unit of measure used for pricing. This field specifies the unit that the price refers to, which may differ from the quantity unit (e.g., price per carton when quantity is in pieces). - `pricingUnitQuantity` number, float: The quantity of base units contained in the pricing unit of measure. For example, if the price is per carton (pricingUnitOfMeasure: "CT") and each carton contains 100 pieces, this field stores 100. - `recommendedRetailPrice` number, float - `netWeight` number, float: Net weight of the item in grams. - `grossWeight` number, float: Gross weight of the item in grams. - `originCountryCode` string: ISO 3166-1 standard two-letter country code. - `colorCode` string: Color code of the item. - `colorName` string: Color name of the item. - `size` string: Size of the item. - `dimension` string: Dimension of the item. - `hsCode` string: Harmonized System Code of the item. - `cnCode` string: The 8-digit Combined Nomenclature (CN) code classifying this product for EU customs and trade statistics. Suppliers are responsible for providing a valid code. - `organicControlPointNumber` string: Organic Control Point Number of the supplier - OCPN is a unique identifier that verifies that a producer of organic products is adhering to the standards for organic production. - `fscNumber` string: An FSC number refers to an identification number issued by the Forest Stewardship Council (FSC), an international organization that certifies sustainable forestry practices. - `mscNumber` string: An MSC number refers to an identification number issued by the Marine Stewardship Council (MSC), an international organization that certifies sustainable fishing practices. - `certifications` Certifications: Item certifications for various standards and organizations. - `deBnn` string: DE-BNN (Bundesverband Naturkost Naturwaren) certification number - `eudr` object: EU Deforestation Regulation (EUDR) compliance information - … - `substituteOf` ItemSubstitution: A reference to the counterpart article in a substitution. - `identifiers` ItemIdentifier[]: Identifiers of the referenced article. Each entry must carry a `domain` and an `identifier`; name the counterpart with the same identifiers used on its own line item. - … - `substitutedBy` ItemSubstitution: A reference to the counterpart article in a substitution. - `identifiers` ItemIdentifier[]: Identifiers of the referenced article. Each entry must carry a `domain` and an `identifier`; name the counterpart with the same identifiers used on its own line item. - … - `promotionCode` string: Promotion code applied to this item. Does not affect invoice calculations. - `reason` string: Reason for the credit note - `tax` Tax, required - `amount` number, float, required: Tax value in currency. - `percentage` number, float, required: Tax value in percentage. - `description` string, nullable - `category` string: VAT category for this tax. One of VAT, EXEMPT, ZERO_RATED, VAT_REVERSE_CHARGE, VAT_INTRA_COMMUNITY, VAT_EXPORT or VAT_OUT_OF_SCOPE. - `batches` Batch[] - `batchIdentifier` string - `expirationDate` string, date - `quantity` number, float: How much of the shipping notice line item belongs to this batch. The sum of all batch quantities must be equal to the "shippedQuantity" of the shipping notice line item. - `netWeight` number, float: Net weight of the batch in grams. - `grossWeight` number, float: Gross weight of the batch in grams. - `serialNumbers` SerialNumber[]: Serial numbers of the individual units of this line item. - `identifiers` object, required: Identifiers of the serialized unit. At least one identifier should be provided. - … - `batchIdentifier` string: Identifier of the batch this unit belongs to. References the "batchIdentifier" of an entry in "batches". - `modificationGroups` ModificationGroup[]: If a Modification Group is provided, the Invoice Summary is required. - `basis` number, float, required: The net base amount on which the modifications are applied. For item-level modifications on level 1, this equals the line item subtotal (quantity * unitPrice). For document-level modifications on level 1, this equals the subtotalAmount of the invoice. - `level` integer, required: Determines in which order the modifications group should be applied. Starting at 1 and continuously increasing. There should be no modification groups with the same level. - `modifications` Modification[], required - … - `unitOfMeasure` 'EA' | 'GRM' | 'HUR' | 'KGM' | 'LTR' | 'MLT' | 'MTK' | 'MTR' | 'PCK' | 'SET' | 'CS' | 'CA' | 'DAY' | 'WEE' | 'MON' | 'CT' | 'CQ' | 'CU' | 'BJ' | 'BO' | 'MTQ' | 'PF' | 'BG' | 'RO' | 'TNE' | 'BE' | 'CMT' | 'KMT' | 'PR' | 'TU': Subset of the the UN/CEFACT Unit of Measure Common Codes. - `contractReference` string: Contract reference for the credit note item. - `subItems` CreditNoteItemWithSubItems[]: Sub items of this credit note item. Supports two levels of nesting. - `lineNumber` integer, required - `shippingNoticeIdentifier` string: Shipping notice number/reference. - `shippingNoticeDate` string, date-time - `shippingNoticeLineNumber` integer - `orderIdentifier` string: Order number assigned to the related purchase order by the buyer. - `orderDate` string, date-time - `orderLineNumber` integer - `requestedDeliveryDate` string, date-time - `expectedDeliveryDate` string, date-time - `identifiers` ItemIdentifier[], required: Which identifiers are required depends on your trade partner. Most trade partners expect at least one identifier with domain `GS1` or `BUYER`. - … - `isDepositItem` boolean, required: If true, the item is a deposit item such as bottle deposit (German: Pfandartikel). - `isInvoicedItem` boolean, required: Determine if this item is the invoiced item. Only invoiced items can have a unitPrice != 0. If an item is not invoiced and no parent item is invoiced either, sub items must exist. - `description` string: Item description. - `comments` string - `quantity` number, float, required: For subitems, this must be the total quantity of this item. For example, the parent item is a display of chocolate bars and has quantity 2. Each display contains 50 chocolate bars. Therefore, the quantity of the "Chocolate Bar" subitem is 100 (2x50). - `freeQuantity` number, float: The quantity of this item that is free of charge, in addition to (not part of) `quantity`. For example, an order line with `quantity` 10 and `freeQuantity` 2 means 12 units are delivered in total, 2 of which are free of charge. For subitems, this must be the total free quantity of this item. For example, the parent item is a display of chocolate bars and has free quantity set to 2. Each display contains 50 chocolate bars. Therefore, the free quantity of the "Chocolate Bar" subitem is 100 (2x50). - `orderedQuantity` number, float: The quantity ordered by the customer. - `unitPrice` number, float, required - `pricingUnitOfMeasure` string: The unit of measure used for pricing. This field specifies the unit that the price refers to, which may differ from the quantity unit (e.g., price per carton when quantity is in pieces). - `pricingUnitQuantity` number, float: The quantity of base units contained in the pricing unit of measure. For example, if the price is per carton (pricingUnitOfMeasure: "CT") and each carton contains 100 pieces, this field stores 100. - `recommendedRetailPrice` number, float - `netWeight` number, float: Net weight of the item in grams. - `grossWeight` number, float: Gross weight of the item in grams. - `originCountryCode` string: ISO 3166-1 standard two-letter country code. - `colorCode` string: Color code of the item. - `colorName` string: Color name of the item. - `size` string: Size of the item. - `dimension` string: Dimension of the item. - `hsCode` string: Harmonized System Code of the item. - `cnCode` string: The 8-digit Combined Nomenclature (CN) code classifying this product for EU customs and trade statistics. Suppliers are responsible for providing a valid code. - `organicControlPointNumber` string: Organic Control Point Number of the supplier - OCPN is a unique identifier that verifies that a producer of organic products is adhering to the standards for organic production. - `fscNumber` string: An FSC number refers to an identification number issued by the Forest Stewardship Council (FSC), an international organization that certifies sustainable forestry practices. - `mscNumber` string: An MSC number refers to an identification number issued by the Marine Stewardship Council (MSC), an international organization that certifies sustainable fishing practices. - `certifications` Certifications: Item certifications for various standards and organizations. - … - `substituteOf` ItemSubstitution: A reference to the counterpart article in a substitution. - … - `substitutedBy` ItemSubstitution: A reference to the counterpart article in a substitution. - … - `promotionCode` string: Promotion code applied to this item. Does not affect invoice calculations. - `reason` string: Reason for the credit note - `tax` Tax, required - … - `batches` Batch[] - … - `serialNumbers` SerialNumber[]: Serial numbers of the individual units of this line item. - … - `modificationGroups` ModificationGroup[]: If a Modification Group is provided, the Invoice Summary is required. - … - `unitOfMeasure` 'EA' | 'GRM' | 'HUR' | 'KGM' | 'LTR' | 'MLT' | 'MTK' | 'MTR' | 'PCK' | 'SET' | 'CS' | 'CA' | 'DAY' | 'WEE' | 'MON' | 'CT' | 'CQ' | 'CU' | 'BJ' | 'BO' | 'MTQ' | 'PF' | 'BG' | 'RO' | 'TNE' | 'BE' | 'CMT' | 'KMT' | 'PR' | 'TU': Subset of the the UN/CEFACT Unit of Measure Common Codes. - `contractReference` string: Contract reference for the credit note item. - `subItems` CreditNoteItem[]: Sub items of this sub credit note item. - … - `summary` object, required: The summary is required if a modificationGroup exists on the invoice, otherwise the summary is optional. In API v3, the summary will be mandatory in any case. - `subtotalAmount` number, float: The sum of all line item subtotal amounts. The line item subtotal already includes all line item modifications. - `grossAmount` number, float: The netAmount plus taxes. - `netAmount` number, float: The subtotalAmount plus totalCharges and minus totalAllowances. - `dueAmount` number, float, required: The amount still owed, that is grossAmount minus paidAmount. It equals grossAmount when nothing was paid up front. - `paidAmount` number, float: The part of the invoice already settled before it was issued, for example a prepayment or a deposit. dueAmount is already net of this value. - `totalCharges` number, float: The total sum of all charges applied on document-level. Does not include charges applied on item-level. - `totalAllowances` number, float: The total sum of all allowances applied on invoice level. Does not include allowances applied on item-level. - `tax` object - `total` number, float, required - `description` string - `items` object[], required - … - `modificationGroups` ModificationGroup[] - `basis` number, float, required: The net base amount on which the modifications are applied. For item-level modifications on level 1, this equals the line item subtotal (quantity * unitPrice). For document-level modifications on level 1, this equals the subtotalAmount of the invoice. - `level` integer, required: Determines in which order the modifications group should be applied. Starting at 1 and continuously increasing. There should be no modification groups with the same level. - `modifications` Modification[], required - … - DispatchInstruction - `header` DispatchInstructionHeader, required - `orderIdentifier` string: Order number assigned to the related purchase order by the buyer. - `orderDate` string, date-time - `shipmentIdentifier` string, required: Shipment identifier number/reference. - `noticeDate` string, date-time - `requestedDeliveryDate` string, date-time - `requestedDespatchDate` string, date-time - `shipFrom` Party, required - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `shipTo` ShipToParty: A party object where identifiers are optional, used specifically for shipTo fields. - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[] - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `billTo` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `finalRecipient` FinalRecipientParty: A party object where identifiers are optional, used specifically for finalRecipient fields. - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[] - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `technicalRecipient` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `technicalSender` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `customer` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `supplier` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `modeOfTransport` 'ROAD' | 'RAIL' | 'AIR' | 'SEA' | 'MULTIMODAL': Chosen mode of transport for the shipment. - `incoTerms` 'EXW' | 'FCA' | 'CPT' | 'CIP' | 'DAP' | 'DDP' | 'FAS' | 'FOB' | 'CFR' | 'CIF' | 'DAT': International Commercial Terms (INCOTERMS) as published by the International Chamber of Commerce (ICC). - `shippingMethod` string - `pickingNotes` string - `deliveryNotes` string - `comments` string: Arbitrary human-readable information buyers can send within dispatch instructions - `currency` string: ISO 4217 standard three-letter currency code. - `version` integer: The document version number. Subsequent updates should increment this number by 1. - `items` object[], required - `orderLineNumber` integer - `orderIdentifier` string: Order number assigned to the related purchase order by the buyer. Allows referencing different orders on different line items within the same dispatch instruction. - `shippingNoticeLineNumber` integer, required - `shippedQuantity` number, float, required - `orderedQuantity` number, float, required - `requestedDeliveryDate` string, date-time - `requestedDespatchDate` string, date-time - `identifiers` ItemIdentifier[], required: Which identifiers are required depends on your trade partner. Most trade partners expect at least one identifier with domain `GS1` or `BUYER`. - `identifier` string: Party identifier within the 'domain' such as EAN/GTIN on GS1 domain, buyer's internal SKU on BUYER domain, etc. - `domain` 'GS1' | 'BUYER' | 'SUPPLIER': Identification system the identifier belongs to. - `unitOfMeasure` 'EA' | 'GRM' | 'HUR' | 'KGM' | 'LTR' | 'MLT' | 'MTK' | 'MTR' | 'PCK' | 'SET' | 'CS' | 'CA' | 'DAY' | 'WEE' | 'MON' | 'CT' | 'CQ' | 'CU' | 'BJ' | 'BO' | 'MTQ' | 'PF' | 'BG' | 'RO' | 'TNE' | 'BE' | 'CMT' | 'KMT' | 'PR' | 'TU': Subset of the the UN/CEFACT Unit of Measure Common Codes. - `unitPrice` number, float - `pricingUnitOfMeasure` string: The unit of measure used for pricing. This field specifies the unit that the price refers to, which may differ from the quantity unit (e.g., price per carton when quantity is in pieces). - `pricingUnitQuantity` number, float: The quantity of base units contained in the pricing unit of measure. For example, if the price is per carton (pricingUnitOfMeasure: "CT") and each carton contains 100 pieces, this field stores 100. - `recommendedRetailPrice` number, float - `tax` Tax - `amount` number, float, required: Tax value in currency. - `percentage` number, float, required: Tax value in percentage. - `description` string, nullable - `category` string: VAT category for this tax. One of VAT, EXEMPT, ZERO_RATED, VAT_REVERSE_CHARGE, VAT_INTRA_COMMUNITY, VAT_EXPORT or VAT_OUT_OF_SCOPE. - `currency` string: ISO 4217 standard three-letter currency code. - `description` string: Item description. - `comments` string - `minimumRemainingShelfLifeInDays` integer: Minimum remaining shelf life in days. - `netWeight` number, float: Net weight of the item in grams. - `grossWeight` number, float: Gross weight of the item in grams. - `originCountryCode` string: ISO 3166-1 alpha-2 country code. - `colorCode` string: Color code of the item. - `colorName` string: Color name of the item. - `size` string: Size of the item. - `dimension` string: Dimension of the item. - `hsCode` string: Harmonized System Code of the item. - `organicControlPointNumber` string: Organic Control Point Number of the supplier - OCPN is a unique identifier that verifies that a producer of organic products is adhering to the standards for organic production. - `batches` Batch[], required - `batchIdentifier` string - `expirationDate` string, date - `quantity` number, float: How much of the shipping notice line item belongs to this batch. The sum of all batch quantities must be equal to the "shippedQuantity" of the shipping notice line item. - `netWeight` number, float: Net weight of the batch in grams. - `grossWeight` number, float: Gross weight of the batch in grams. - `serialNumbers` SerialNumber[]: Serial numbers of the individual units of this line item. - `identifiers` object, required: Identifiers of the serialized unit. At least one identifier should be provided. - … - `batchIdentifier` string: Identifier of the batch this unit belongs to. References the "batchIdentifier" of an entry in "batches". - `openQuantityAction` 'DISCARDED' | 'DELIVERED_LATER' - `subItems` object[]: Sub items of this dispatch instruction item. Supports two levels of nesting. - `orderLineNumber` integer - `orderIdentifier` string: Order number assigned to the related purchase order by the buyer. Allows referencing different orders on different line items within the same dispatch instruction. - `shippingNoticeLineNumber` integer, required - `shippedQuantity` number, float, required - `orderedQuantity` number, float, required - `requestedDeliveryDate` string, date-time - `requestedDespatchDate` string, date-time - `identifiers` ItemIdentifier[], required: Which identifiers are required depends on your trade partner. Most trade partners expect at least one identifier with domain `GS1` or `BUYER`. - … - `unitOfMeasure` 'EA' | 'GRM' | 'HUR' | 'KGM' | 'LTR' | 'MLT' | 'MTK' | 'MTR' | 'PCK' | 'SET' | 'CS' | 'CA' | 'DAY' | 'WEE' | 'MON' | 'CT' | 'CQ' | 'CU' | 'BJ' | 'BO' | 'MTQ' | 'PF' | 'BG' | 'RO' | 'TNE' | 'BE' | 'CMT' | 'KMT' | 'PR' | 'TU': Subset of the the UN/CEFACT Unit of Measure Common Codes. - `unitPrice` number, float - `pricingUnitOfMeasure` string: The unit of measure used for pricing. This field specifies the unit that the price refers to, which may differ from the quantity unit (e.g., price per carton when quantity is in pieces). - `pricingUnitQuantity` number, float: The quantity of base units contained in the pricing unit of measure. For example, if the price is per carton (pricingUnitOfMeasure: "CT") and each carton contains 100 pieces, this field stores 100. - `recommendedRetailPrice` number, float - `tax` Tax - … - `currency` string: ISO 4217 standard three-letter currency code. - `description` string: Item description. - `comments` string - `minimumRemainingShelfLifeInDays` integer: Minimum remaining shelf life in days. - `netWeight` number, float: Net weight of the item in grams. - `grossWeight` number, float: Gross weight of the item in grams. - `originCountryCode` string: ISO 3166-1 alpha-2 country code. - `colorCode` string: Color code of the item. - `colorName` string: Color name of the item. - `size` string: Size of the item. - `dimension` string: Dimension of the item. - `hsCode` string: Harmonized System Code of the item. - `organicControlPointNumber` string: Organic Control Point Number of the supplier - OCPN is a unique identifier that verifies that a producer of organic products is adhering to the standards for organic production. - `batches` Batch[], required - … - `serialNumbers` SerialNumber[]: Serial numbers of the individual units of this line item. - … - `openQuantityAction` 'DISCARDED' | 'DELIVERED_LATER' - `subItems` DispatchInstructionItem[]: Sub items of this sub dispatch instruction item. - … - DispatchInstructionResponse - `header` DispatchInstructionResponseHeader, required - `orderIdentifier` string: Order number assigned to the related purchase order by the buyer. - `orderDate` string, date-time - `shippingNoticeIdentifier` string, required: Shipment identifier number/reference. - `requestedDespatchDate` string, date-time - `dispatchInstructionResponseDate` string, date-time - `shippingNoticeDate` string, date-time - `requestedDeliveryDate` string, date-time - `expectedDeliveryDate` string, date-time - `carrier` string - `trackingNumber` string - `trackingUrl` string - `comments` string: Arbitrary human-readable information buyers can send within dispatch instruction responses - `buyer` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `supplier` Party, required - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `shipTo` ShipToParty: A party object where identifiers are optional, used specifically for shipTo fields. - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[] - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `billTo` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `shipFrom` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `finalRecipient` FinalRecipientParty: A party object where identifiers are optional, used specifically for finalRecipient fields. - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[] - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `technicalRecipient` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `technicalSender` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `modeOfTransport` 'ROAD' | 'RAIL' | 'AIR' | 'SEA' | 'MULTIMODAL': Chosen mode of transport for the shipment. - `incoTerms` 'EXW' | 'FCA' | 'CPT' | 'CIP' | 'DAP' | 'DDP' | 'FAS' | 'FOB' | 'CFR' | 'CIF' | 'DAT': International Commercial Terms (INCOTERMS) as published by the International Chamber of Commerce (ICC). - `shippingMethod` string - `status` string - `currency` string: ISO 4217 standard three-letter currency code. - `version` integer: The document version number. Subsequent updates should increment this number by 1. - `transportUnits` object[], required - `unitIdentifier` string - `unitType` 'EURO_PALLET' | 'EURO_PALLET_HALF' | 'EURO_PALLET_QUARTER' | 'CARTON' - `containedTradeUnitCount` integer - `requestedDeliveryDate` string, date-time - `expectedDeliveryDate` string, date-time - `requestedDespatchDate` string, date-time - `despatchDate` string, date-time - `carrier` TransportUnitCarrier: Carrier information for a transport unit. - `name` string: Carrier name. - `trackingNumber` string: Tracking number. - `trackingUrl` string: Tracking URL. - `transportLabel` TransportLabel: Transport label (ZPL + PDF) for a transport unit. - `zplUrl` string: URL to the raw ZPL of the transport label. - `pdfUrl` string: URL to the rendered PDF of the transport label. - `items` DispatchInstructionResponseItem[], required - `lineNumber` integer - `instructionLineNumber` integer - `orderLineNumber` integer - `isDepositItem` boolean: If true, the item is a deposit item such as bottle deposit (German: Pfandartikel). - `description` string: Item description. - `comments` string - `substituteOf` ItemSubstitution: A reference to the counterpart article in a substitution. - … - `substitutedBy` ItemSubstitution: A reference to the counterpart article in a substitution. - … - `netWeight` number, float: Net weight of the item in grams. - `grossWeight` number, float: Gross weight of the item in grams. - `originCountryCode` string: ISO 3166-1 alpha-2 country code. - `colorCode` string: Color code of the item. - `colorName` string: Color name of the item. - `size` string: Size of the item. - `dimension` string: Dimension of the item. - `hsCode` string: Harmonized System Code of the item. - `organicControlPointNumber` string: Organic Control Point Number of the supplier - OCPN is a unique identifier that verifies that a producer of organic products is adhering to the standards for organic production. - `orderedQuantity` number, float - `shippedQuantity` number, float - `openQuantityAction` 'DISCARDED' | 'DELIVERED_LATER' - `unitOfMeasure` 'EA' | 'GRM' | 'HUR' | 'KGM' | 'LTR' | 'MLT' | 'MTK' | 'MTR' | 'PCK' | 'SET' | 'CS' | 'CA' | 'DAY' | 'WEE' | 'MON' | 'CT' | 'CQ' | 'CU' | 'BJ' | 'BO' | 'MTQ' | 'PF' | 'BG' | 'RO' | 'TNE' | 'BE' | 'CMT' | 'KMT' | 'PR' | 'TU': Subset of the the UN/CEFACT Unit of Measure Common Codes. - `unitPrice` number, float - `pricingUnitOfMeasure` string: The unit of measure used for pricing. This field specifies the unit that the price refers to, which may differ from the quantity unit (e.g., price per carton when quantity is in pieces). - `pricingUnitQuantity` number, float: The quantity of base units contained in the pricing unit of measure. For example, if the price is per carton (pricingUnitOfMeasure: "CT") and each carton contains 100 pieces, this field stores 100. - `recommendedRetailPrice` number, float - `tax` Tax - … - `identifiers` ItemIdentifier[]: Which identifiers are required depends on your trade partner. Most trade partners expect at least one identifier with domain `GS1` or `BUYER`. - … - `batches` Batch[] - … - `serialNumbers` SerialNumber[]: Serial numbers of the individual units of this line item. - … - ReceivalNotice - `header` ReceivalNoticeHeader, required - `receivalAdviceNumber` string, required - `receivalDate` string, date-time, required - `deliveryNoteNumber` string - `customerOrderNumber` string - `shipTo` ShipToParty: A party object where identifiers are optional, used specifically for shipTo fields. - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[] - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `customer` Party, required - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `deliveryNoteDate` string, date-time - `orderDate` string, date-time - `shipFrom` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `billTo` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `supplier` Party, required - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `technicalRecipient` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `technicalSender` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `comments` string: Arbitrary human-readable information buyers can send within dispatch instruction responses - `carrierId` string - `carrierDomain` string - `trackingNumber` string - `trackingUrl` string - `version` integer: The document version number. Subsequent updates should increment this number by 1. - `transportUnits` object[], required - `unitIdentifier` string - `unitType` 'EURO_PALLET' | 'EURO_PALLET_HALF' | 'EURO_PALLET_QUARTER' | 'CARTON' - `containedTradeUnitCount` integer - `carrier` TransportUnitCarrier: Carrier information for a transport unit. - `name` string: Carrier name. - `trackingNumber` string: Tracking number. - `trackingUrl` string: Tracking URL. - `items` ReceivalNoticeItem[], required - `lineNumber` integer - `receivedQuantity` number, float - `shippedQuantity` number, float - `identifiers` ItemIdentifier[]: Which identifiers are required depends on your trade partner. Most trade partners expect at least one identifier with domain `GS1` or `BUYER`. - … - `orderLineNumber` integer - `orderedQuantity` number, float - `rejectedQuantity` number, float - `rejectReason` string - `openQuantityAction` 'DISCARDED' | 'DELIVERED_LATER' - `unitPrice` number, float - `currency` string: ISO 4217 standard three-letter currency code. - `unitOfMeasure` 'EA' | 'GRM' | 'HUR' | 'KGM' | 'LTR' | 'MLT' | 'MTK' | 'MTR' | 'PCK' | 'SET' | 'CS' | 'CA' | 'DAY' | 'WEE' | 'MON' | 'CT' | 'CQ' | 'CU' | 'BJ' | 'BO' | 'MTQ' | 'PF' | 'BG' | 'RO' | 'TNE' | 'BE' | 'CMT' | 'KMT' | 'PR' | 'TU': Subset of the the UN/CEFACT Unit of Measure Common Codes. - `description` string: Item description. - `batches` Batch[] - … - `serialNumbers` SerialNumber[]: Serial numbers of the individual units of this line item. - … - RemittanceAdvice - `header` RemittanceAdviceHeader, required - `adviceNumber` string, required - `adviceDate` string, date-time, required - `paymentMethod` string - `paymentReference` string - `remittanceDate` string, date-time - `currency` string: ISO 4217 standard three-letter currency code. - `payFrom` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `payTo` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `buyer` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `supplier` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `technicalRecipient` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `technicalSender` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `version` integer: The document version number. Subsequent updates should increment this number by 1. - `items` object[], required - `documentNumber` string - `documentDate` string, date-time - `externalDocumentNumber` string - `documentType` string - `dueTotal` number, float - `remittedTotal` number, float - `tax` Tax - `amount` number, float, required: Tax value in currency. - `percentage` number, float, required: Tax value in percentage. - `description` string, nullable - `category` string: VAT category for this tax. One of VAT, EXEMPT, ZERO_RATED, VAT_REVERSE_CHARGE, VAT_INTRA_COMMUNITY, VAT_EXPORT or VAT_OUT_OF_SCOPE. - `correctionTotal` number, float - `buyer` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `shipTo` ShipToParty: A party object where identifiers are optional, used specifically for shipTo fields. - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[] - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `corrections` object[] - `basis` number, float - `reason` string - `amount` number, float, required - `total` number, float, required - `tax` Tax - … - `summary` RemittanceAdviceSummary, required - `dueTotal` number, float - `remittedTotal` number, float - `correctionTotal` number, float - ProductCatalog - `header` ProductCatalogHeader, required - `catalogNumber` string - `catalogDate` string, date-time, required - `sender` Party, required - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `receiver` Party, required - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `importer` unknown - `manufacturer` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `technicalRecipient` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `technicalSender` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `comments` string: Arbitrary human-readable information buyers can send within product catalogs - `version` integer: The document version number. Subsequent updates should increment this number by 1. - `items` ProductCatalogItemWithSubSubItems[], required - `name` string - `lineNumber` integer, required - `quantity` number, float, required - `identity` ProductCatalogIdentity, required: Product identity containing sender partner ID, receiver partner ID, and GTIN. - `senderPartnerId` string: Sender partner product identifier (e.g., supplier SKU). - `receiverPartnerId` string: Receiver partner product identifier (e.g., buyer SKU). - `gtin` string: Global Trade Item Number (GTIN/EAN). - `predecessorIdentity` ProductCatalogIdentity: Product identity containing sender partner ID, receiver partner ID, and GTIN. - `senderPartnerId` string: Sender partner product identifier (e.g., supplier SKU). - `receiverPartnerId` string: Receiver partner product identifier (e.g., buyer SKU). - `gtin` string: Global Trade Item Number (GTIN/EAN). - `successorIdentity` ProductCatalogIdentity: Product identity containing sender partner ID, receiver partner ID, and GTIN. - `senderPartnerId` string: Sender partner product identifier (e.g., supplier SKU). - `receiverPartnerId` string: Receiver partner product identifier (e.g., buyer SKU). - `gtin` string: Global Trade Item Number (GTIN/EAN). - `alternativeIdentifiers` ProductCatalogIdentity[] - `senderPartnerId` string: Sender partner product identifier (e.g., supplier SKU). - `receiverPartnerId` string: Receiver partner product identifier (e.g., buyer SKU). - `gtin` string: Global Trade Item Number (GTIN/EAN). - `action` 'NEW' | 'CHANGED' | 'DELETED' - `currency` string: ISO 4217 standard three-letter currency code. - `unitOfMeasure` 'EA' | 'GRM' | 'HUR' | 'KGM' | 'LTR' | 'MLT' | 'MTK' | 'MTR' | 'PCK' | 'SET' | 'CS' | 'CA' | 'DAY' | 'WEE' | 'MON' | 'CT' | 'CQ' | 'CU' | 'BJ' | 'BO' | 'MTQ' | 'PF' | 'BG' | 'RO' | 'TNE' | 'BE' | 'CMT' | 'KMT' | 'PR' | 'TU': Subset of the the UN/CEFACT Unit of Measure Common Codes. - `isOrderable` boolean - `unitPrice` number, float - `pricingUnitOfMeasure` string: The unit of measure used for pricing. This field specifies the unit that the price refers to, which may differ from the quantity unit (e.g., price per carton when quantity is in pieces). - `pricingUnitQuantity` number, float: The quantity of base units contained in the pricing unit of measure. For example, if the price is per carton (pricingUnitOfMeasure: "CT") and each carton contains 100 pieces, this field stores 100. - `unitPriceValidFromDate` string, date-time - `unitPriceValidUntilDate` string, date-time - `recommendedRetailPrice` number, float - `recommendedRetailPriceValidFromDate` string, date-time - `recommendedRetailPriceValidUntilDate` string, date-time - `minimumOrderQuantity` number, float - `taxPercentage` number, float - `depositAmount` number, float: Deposit amount in the currency of the item. - `shortDescription` string - `description` string - `perUnitQuantity` number, float: Quantity of consumer units (pieces, bottles) contained in this item. - `length` integer: In millimeters - `width` integer: In millimeters - `height` integer: In millimeters - `netWeight` integer: In grams - `grossWeight` integer: In grams - `drainedWeight` integer: In grams - `volume` integer: In cubic centimeters - `category` string: Used for product category, commodity group - `subCategory` string - `unNumber` integer: 4-digit number assigned by the United Nations to classify hazardous substances and articles. - `hsCode` string - `cnCode` string: The 8-digit Combined Nomenclature (CN) code classifying this product for EU customs and trade statistics. Suppliers are responsible for providing a valid code. - `htsCode` string - `deliverableFromDate` string, date-time - `isDangerous` boolean - `hasExpiryDate` boolean - `hasBatchNumber` boolean - `hasSerialNumber` boolean - `minimumRemainingShelfLifeInDays` integer: Minimum remaining shelf life in days. - `sourceIdentifier` string: Identifies the source (warehouse, supplier, etc.) from which the item can be procured. - `originCountryCode` string: ISO 3166-1 alpha-2 country code. - `colorCode` string: Color code of the item. - `colorName` string: Color name of the item. - `size` string: Size of the item. - `dimension` string: Dimension of the item. - `organicControlPointNumber` string: Organic Control Point Number of the supplier - OCPN is a unique identifier that verifies that a producer of organic products is adhering to the standards for organic production. - `fscNumber` string: An FSC number refers to an identification number issued by the Forest Stewardship Council (FSC), an international organization that certifies sustainable forestry practices. - `mscNumber` string: An MSC number refers to an identification number issued by the Marine Stewardship Council (MSC), an international organization that certifies sustainable fishing practices. - `season` string: The season or collection period this item belongs to. Used to group and filter assortment by seasonal release. - `gender` string: The target gender this item is designed for (e.g. Male, Female, Unisex). Used to classify and filter assortment by gender segment. - `brand` string: BRAND in a PRICAT (Price Catalogue) refers to the name of the product’s brand or manufacturer. It helps identify the product’s origin and is essential for classification, marketing, and buyer recognition. - `declarationOfConformity` string: Declaration of Conformity in a PRICAT refers to a formal statement by the manufacturer confirming that the product meets all applicable EU safety, health, and environmental requirements. It is key for regulatory compliance and market approval. - `userManual` string: User Manual / Instructions in a PRICAT refers to the documentation provided with a product that explains its proper use, safety guidelines, and maintenance. It ensures safe handling and compliance with regulatory requirements. - `energyLabel` string: Energy Label in a PRICAT refers to the standardized label indicating a product’s energy efficiency class. It helps buyers assess energy consumption and supports compliance with EU energy labeling regulations. - `safetyDatasheet` string: Safety Datasheet in a PRICAT refers to a document providing detailed information on the safe handling, storage, and disposal of a product. It is essential for compliance with chemical safety regulations and workplace protection. - `technicalDatasheet` string: (Technical) Datasheet in a PRICAT refers to a document outlining the key technical specifications, features, and performance data of a product. It supports accurate product evaluation, comparison, and integration into systems or catalogues. - `euDatasheet` string: EU Datasheet in a PRICAT refers to a product information sheet tailored to meet EU regulatory and market requirements. It typically includes technical specifications, compliance details, and other essential data for distribution within the EU. - `safetyInstructions` string: Safety Instructions / Warnings in a PRICAT refer to mandatory information on potential hazards and safe usage of a product. They help ensure user safety and compliance with legal and regulatory standards. - `materialComposition` string: All material components - `ingredients` string: A simple string field to transmit the list of ingredients of a food item - `allergens` object[]: An array of allergens that are contained in a food item - `identifiers` object: Identifiers for the allergen - … - `name` string: Name of the allergen - `presence` 'PRESENT' | 'TRACES' | 'FREE_FROM' | 'UNKNOWN': Presence of the allergen in the product - `nutritionalInformation` object: Comprehensive nutritional information for the product - `energy` object - … - `fats` object - … - `carbohydrates` object - … - `fiber` object - … - `proteins` object - … - `saltInGrams` number, float - `sodiumInGrams` number, float - `alcoholInGrams` number, float - `waterInGrams` number, float - `caffeineInMilligrams` number, float - `taurineInMilligrams` number, float - `vitamins` object - … - `minerals` object - … - `otherCompounds` object - … - `specialDietaryInfo` object - … - `additives` object[]: Food additives contained in the product - `identifiers` object: Identifiers for the additive - … - `name` string: Name of the additive - `images` Attachment[]: Images of the product catalog item. - `fileName` string: Name of the file. - `url` string, uri: URL to the file. - `mimeType` string: MIME type of the file. - `comment` string - `batches` Batch[] - `batchIdentifier` string - `expirationDate` string, date - `quantity` number, float: How much of the shipping notice line item belongs to this batch. The sum of all batch quantities must be equal to the "shippedQuantity" of the shipping notice line item. - `netWeight` number, float: Net weight of the batch in grams. - `grossWeight` number, float: Gross weight of the batch in grams. - `serialNumbers` SerialNumber[]: Serial numbers of the individual units of this line item. - `identifiers` object, required: Identifiers of the serialized unit. At least one identifier should be provided. - … - `batchIdentifier` string: Identifier of the batch this unit belongs to. References the "batchIdentifier" of an entry in "batches". - `packagingUnits` ProductCatalogItemPackagingUnit[] - `quantity` number, float, required - `identity` ProductCatalogIdentity: Product identity containing sender partner ID, receiver partner ID, and GTIN. - … - `isOrderable` boolean - `length` integer: In millimeters - `width` integer: In millimeters - `height` integer: In millimeters - `netWeight` integer: In grams - `grossWeight` integer: In grams - `volume` integer: In cubic centimeters - `unitOfMeasure` 'EA' | 'GRM' | 'HUR' | 'KGM' | 'LTR' | 'MLT' | 'MTK' | 'MTR' | 'PCK' | 'SET' | 'CS' | 'CA' | 'DAY' | 'WEE' | 'MON' | 'CT' | 'CQ' | 'CU' | 'BJ' | 'BO' | 'MTQ' | 'PF' | 'BG' | 'RO' | 'TNE' | 'BE' | 'CMT' | 'KMT' | 'PR' | 'TU': Subset of the the UN/CEFACT Unit of Measure Common Codes. - `modificationGroups` ModificationGroup[] - `basis` number, float, required: The net base amount on which the modifications are applied. For item-level modifications on level 1, this equals the line item subtotal (quantity * unitPrice). For document-level modifications on level 1, this equals the subtotalAmount of the invoice. - `level` integer, required: Determines in which order the modifications group should be applied. Starting at 1 and continuously increasing. There should be no modification groups with the same level. - `modifications` Modification[], required - … - `manufacturer` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `importer` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `subItems` ProductCatalogItemWithSubItems[]: Sub items of this product catalog item. Supports two levels of nesting. - `name` string - `lineNumber` integer, required - `quantity` number, float, required - `identity` ProductCatalogIdentity, required: Product identity containing sender partner ID, receiver partner ID, and GTIN. - … - `predecessorIdentity` ProductCatalogIdentity: Product identity containing sender partner ID, receiver partner ID, and GTIN. - … - `successorIdentity` ProductCatalogIdentity: Product identity containing sender partner ID, receiver partner ID, and GTIN. - … - `alternativeIdentifiers` ProductCatalogIdentity[] - … - `action` 'NEW' | 'CHANGED' | 'DELETED' - `currency` string: ISO 4217 standard three-letter currency code. - `unitOfMeasure` 'EA' | 'GRM' | 'HUR' | 'KGM' | 'LTR' | 'MLT' | 'MTK' | 'MTR' | 'PCK' | 'SET' | 'CS' | 'CA' | 'DAY' | 'WEE' | 'MON' | 'CT' | 'CQ' | 'CU' | 'BJ' | 'BO' | 'MTQ' | 'PF' | 'BG' | 'RO' | 'TNE' | 'BE' | 'CMT' | 'KMT' | 'PR' | 'TU': Subset of the the UN/CEFACT Unit of Measure Common Codes. - `isOrderable` boolean - `unitPrice` number, float - `pricingUnitOfMeasure` string: The unit of measure used for pricing. This field specifies the unit that the price refers to, which may differ from the quantity unit (e.g., price per carton when quantity is in pieces). - `pricingUnitQuantity` number, float: The quantity of base units contained in the pricing unit of measure. For example, if the price is per carton (pricingUnitOfMeasure: "CT") and each carton contains 100 pieces, this field stores 100. - `unitPriceValidFromDate` string, date-time - `unitPriceValidUntilDate` string, date-time - `recommendedRetailPrice` number, float - `recommendedRetailPriceValidFromDate` string, date-time - `recommendedRetailPriceValidUntilDate` string, date-time - `minimumOrderQuantity` number, float - `taxPercentage` number, float - `depositAmount` number, float: Deposit amount in the currency of the item. - `shortDescription` string - `description` string - `perUnitQuantity` number, float: Quantity of consumer units (pieces, bottles) contained in this item. - `length` integer: In millimeters - `width` integer: In millimeters - `height` integer: In millimeters - `netWeight` integer: In grams - `grossWeight` integer: In grams - `drainedWeight` integer: In grams - `volume` integer: In cubic centimeters - `category` string: Used for product category, commodity group - `subCategory` string - `unNumber` integer: 4-digit number assigned by the United Nations to classify hazardous substances and articles. - `hsCode` string - `cnCode` string: The 8-digit Combined Nomenclature (CN) code classifying this product for EU customs and trade statistics. Suppliers are responsible for providing a valid code. - `htsCode` string - `deliverableFromDate` string, date-time - `isDangerous` boolean - `hasExpiryDate` boolean - `hasBatchNumber` boolean - `hasSerialNumber` boolean - `minimumRemainingShelfLifeInDays` integer: Minimum remaining shelf life in days. - `sourceIdentifier` string: Identifies the source (warehouse, supplier, etc.) from which the item can be procured. - `originCountryCode` string: ISO 3166-1 alpha-2 country code. - `colorCode` string: Color code of the item. - `colorName` string: Color name of the item. - `size` string: Size of the item. - `dimension` string: Dimension of the item. - `organicControlPointNumber` string: Organic Control Point Number of the supplier - OCPN is a unique identifier that verifies that a producer of organic products is adhering to the standards for organic production. - `fscNumber` string: An FSC number refers to an identification number issued by the Forest Stewardship Council (FSC), an international organization that certifies sustainable forestry practices. - `mscNumber` string: An MSC number refers to an identification number issued by the Marine Stewardship Council (MSC), an international organization that certifies sustainable fishing practices. - `season` string: The season or collection period this item belongs to. Used to group and filter assortment by seasonal release. - `gender` string: The target gender this item is designed for (e.g. Male, Female, Unisex). Used to classify and filter assortment by gender segment. - `brand` string: BRAND in a PRICAT (Price Catalogue) refers to the name of the product’s brand or manufacturer. It helps identify the product’s origin and is essential for classification, marketing, and buyer recognition. - `declarationOfConformity` string: Declaration of Conformity in a PRICAT refers to a formal statement by the manufacturer confirming that the product meets all applicable EU safety, health, and environmental requirements. It is key for regulatory compliance and market approval. - `userManual` string: User Manual / Instructions in a PRICAT refers to the documentation provided with a product that explains its proper use, safety guidelines, and maintenance. It ensures safe handling and compliance with regulatory requirements. - `energyLabel` string: Energy Label in a PRICAT refers to the standardized label indicating a product’s energy efficiency class. It helps buyers assess energy consumption and supports compliance with EU energy labeling regulations. - `safetyDatasheet` string: Safety Datasheet in a PRICAT refers to a document providing detailed information on the safe handling, storage, and disposal of a product. It is essential for compliance with chemical safety regulations and workplace protection. - `technicalDatasheet` string: (Technical) Datasheet in a PRICAT refers to a document outlining the key technical specifications, features, and performance data of a product. It supports accurate product evaluation, comparison, and integration into systems or catalogues. - `euDatasheet` string: EU Datasheet in a PRICAT refers to a product information sheet tailored to meet EU regulatory and market requirements. It typically includes technical specifications, compliance details, and other essential data for distribution within the EU. - `safetyInstructions` string: Safety Instructions / Warnings in a PRICAT refer to mandatory information on potential hazards and safe usage of a product. They help ensure user safety and compliance with legal and regulatory standards. - `materialComposition` string: All material components - `ingredients` string: A simple string field to transmit the list of ingredients of a food item - `allergens` object[]: An array of allergens that are contained in a food item - … - `nutritionalInformation` object: Comprehensive nutritional information for the product - … - `additives` object[]: Food additives contained in the product - … - `images` Attachment[]: Images of the product catalog item. - … - `comment` string - `batches` Batch[] - … - `serialNumbers` SerialNumber[]: Serial numbers of the individual units of this line item. - … - `packagingUnits` ProductCatalogItemPackagingUnit[] - … - `modificationGroups` ModificationGroup[] - … - `manufacturer` Party - … - `importer` Party - … - `subItems` ProductCatalogItem[]: Sub items of this product catalog item. - … - InventoryReport - `header` InventoryReportHeader, required - `inventoryReportIdentifier` string, required - `inventoryReportDate` string, date-time, required - `warehouse` Party, required - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `goodsOwner` Party, required - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `technicalRecipient` Party - `name` string: Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted. - `identifiers` PartyIdentifier[], required - … - `postalAddress` PostalAddress: Depending on the transaction different properties are required. Only on an invoice a full address is required. - … - `contacts` Contact[] - … - `financialInstitution` object - … - `technicalSender` Party - … truncated; see the full OpenAPI document linked below ## Other responses - `422`: Validation Error - `4XX`: Client Error - `5XX`: Server Error --- [API](https://skmtc.dev/procuros/apis/procuros-api.md) - [All operations](https://skmtc.dev/procuros/apis/procuros-api/llms.txt) - [OpenAPI document](https://skmtc.dev/procuros/apis/procuros-api/revisions/28a1d5326ce9?raw)