List All Transactions

Authorizations

Authorization

string

header

required

The API Token of your ERP Connection.

Query Parameters

filter[type]

enum<string>

Type of transaction.

Available options:

ORDER,

ORDER_RESPONSE,

SHIPPING_NOTICE,

INVOICE,

CREDIT_NOTE,

DISPATCH_INSTRUCTION,

DISPATCH_INSTRUCTION_RESPONSE,

RECEIVAL_NOTICE,

REMITTANCE_ADVICE,

PRODUCT_CATALOG,

INVENTORY_REPORT,

SALES_REPORT

filter[flow]

enum<string>

Flow (LIVE or TEST) of the transaction.

Available options:

LIVE,

TEST

filter[status]

enum<string>

Current status of the transaction.

Available options:

PENDING,

SUCCESS,

FAILED,

DROPPED,

UNKNOWN

filter[created_between]

string

Filter transactions created between two dates. Format: YYYY-MM-DD,YYYY-MM-DD

Example:

"2024-01-01,2024-01-31"

cursor

string

Page cursor

per_page

integer

default:100

Number of transactions returned per page.

Required range: 1 <= x <= 100

Response

Success

items

object[]

required

Show child attributes

items.procurosTransactionId

string<uuid>

required

Unique ID assigned to every transaction on the Procuros Network.

Example:

"949b2f25-fd9d-4c58-8899-b4dc277f8cf9"

items.type

enum<string>

required

Type of transaction.

Available options:

ORDER,

ORDER_RESPONSE,

SHIPPING_NOTICE,

INVOICE,

CREDIT_NOTE,

DISPATCH_INSTRUCTION,

DISPATCH_INSTRUCTION_RESPONSE,

RECEIVAL_NOTICE,

REMITTANCE_ADVICE,

PRODUCT_CATALOG,

INVENTORY_REPORT,

SALES_REPORT

items.status

enum<string>

required

Current status of the transaction.

Available options:

PENDING,

SUCCESS,

FAILED,

DROPPED,

UNKNOWN

items.flow

enum<string>

required

Flow (LIVE or TEST) of the transaction.

Available options:

LIVE,

TEST

items.createdAt

string<date-time>

required

Example:

"2021-10-23T00:00:00.000000Z"

items.content

Order · object

required

A purchase order is a formal request from a buying organization to a supplier to fulfill a contract.

Show child attributes

items.content.header

object

required

Show child attributes

items.content.header.buyer

object

required

Show child attributes

items.content.header.buyer.identifiers

object[]

required

Minimum array length: 1

Show child attributes

items.content.header.buyer.identifiers.identifier

string

required

Party identifier within the "domain" such as GLN on GS1 domain, DUNS number on DUNS domain, etc.

Example:

"1100001016310"

items.content.header.buyer.identifiers.domain

enum<string>

default:GS1

required

Identification system the identifier belongs to.

Available options:

GS1,

DUNS,

VAT_DE,

FED_TAX,

SENDER_INTERNAL,

RECEIVER_INTERNAL

items.content.header.buyer.name

string

Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted.

items.content.header.buyer.postalAddress

object

Depending on the transaction different properties are required. Only on an invoice a full address is required.

Show child attributes

items.content.header.buyer.postalAddress.name

string

deprecated

Use the "name" attribute on the "Party" object instead.

Example:

"ACME Germany GmbH - Außenstelle Hamburg"

items.content.header.buyer.postalAddress.street

string

Example:

"Sternstrasse 23"

items.content.header.buyer.postalAddress.addressExtra

string

Example:

"E4"

items.content.header.buyer.postalAddress.city

string

Example:

"Hamburg"

items.content.header.buyer.postalAddress.postalCode

string

Example:

"21571"

items.content.header.buyer.postalAddress.state

string

Example:

"HH"

items.content.header.buyer.postalAddress.countryCode

string

ISO 3166-1 standard two-letter country code.

Required string length: 2

Example:

"DE"

items.content.header.buyer.contacts

object[]

Minimum array length: 1

Show child attributes

items.content.header.buyer.contacts.firstName

string

Example:

"Atikin"

items.content.header.buyer.contacts.lastName

string

Example:

"Iar"

items.content.header.buyer.contacts.phone

string

Example:

"+491763021548"

items.content.header.buyer.contacts.mobile

string

Example:

"+447881561299"

items.content.header.buyer.contacts.email

string<email>

Example:

"[email protected]"

items.content.header.buyer.contacts.fax

string

Example:

"+491763021548-11"

items.content.header.buyer.contacts.department

string

Example:

"Purchasing"

items.content.header.buyer.financialInstitution

object

Show child attributes

items.content.header.buyer.financialInstitution.name

string

items.content.header.buyer.financialInstitution.institutionId

string

items.content.header.buyer.financialInstitution.institutionIdDomain

string

items.content.header.buyer.financialInstitution.accountNumber

string

items.content.header.buyer.financialInstitution.accountHolder

string

items.content.header.supplier

object

required

Show child attributes

items.content.header.supplier.identifiers

object[]

required

Minimum array length: 1

Show child attributes

items.content.header.supplier.identifiers.identifier

string

required

Party identifier within the "domain" such as GLN on GS1 domain, DUNS number on DUNS domain, etc.

Example:

"1100001016310"

items.content.header.supplier.identifiers.domain

enum<string>

default:GS1

required

Identification system the identifier belongs to.

Available options:

GS1,

DUNS,

VAT_DE,

FED_TAX,

SENDER_INTERNAL,

RECEIVER_INTERNAL

items.content.header.supplier.name

string

Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted.

items.content.header.supplier.postalAddress

object

Depending on the transaction different properties are required. Only on an invoice a full address is required.

Show child attributes

items.content.header.supplier.postalAddress.name

string

deprecated

Use the "name" attribute on the "Party" object instead.

Example:

"ACME Germany GmbH - Außenstelle Hamburg"

items.content.header.supplier.postalAddress.street

string

Example:

"Sternstrasse 23"

items.content.header.supplier.postalAddress.addressExtra

string

Example:

"E4"

items.content.header.supplier.postalAddress.city

string

Example:

"Hamburg"

items.content.header.supplier.postalAddress.postalCode

string

Example:

"21571"

items.content.header.supplier.postalAddress.state

string

Example:

"HH"

items.content.header.supplier.postalAddress.countryCode

string

ISO 3166-1 standard two-letter country code.

Required string length: 2

Example:

"DE"

items.content.header.supplier.contacts

object[]

Minimum array length: 1

Show child attributes

items.content.header.supplier.contacts.firstName

string

Example:

"Atikin"

items.content.header.supplier.contacts.lastName

string

Example:

"Iar"

items.content.header.supplier.contacts.phone

string

Example:

"+491763021548"

items.content.header.supplier.contacts.mobile

string

Example:

"+447881561299"

items.content.header.supplier.contacts.email

string<email>

Example:

"[email protected]"

items.content.header.supplier.contacts.fax

string

Example:

"+491763021548-11"

items.content.header.supplier.contacts.department

string

Example:

"Purchasing"

items.content.header.supplier.financialInstitution

object

Show child attributes

items.content.header.supplier.financialInstitution.name

string

items.content.header.supplier.financialInstitution.institutionId

string

items.content.header.supplier.financialInstitution.institutionIdDomain

string

items.content.header.supplier.financialInstitution.accountNumber

string

items.content.header.supplier.financialInstitution.accountHolder

string

items.content.header.orderIdentifier

string

required

Order number assigned to this purchase order by the buyer.

Example:

"PO9383-R45"

items.content.header.orderDate

string<date-time>

required

Example:

"2021-10-23T00:00:00.000000Z"

items.content.header.shipTo

object

If this is kept empty, the "buyer" is used as the "shipTo" party.

Show child attributes

items.content.header.shipTo.identifiers

object[]

required

Minimum array length: 1

Show child attributes

items.content.header.shipTo.identifiers.identifier

string

required

Party identifier within the "domain" such as GLN on GS1 domain, DUNS number on DUNS domain, etc.

Example:

"1100001016310"

items.content.header.shipTo.identifiers.domain

enum<string>

default:GS1

required

Identification system the identifier belongs to.

Available options:

GS1,

DUNS,

VAT_DE,

FED_TAX,

SENDER_INTERNAL,

RECEIVER_INTERNAL

items.content.header.shipTo.name

string

Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted.

items.content.header.shipTo.postalAddress

object

Depending on the transaction different properties are required. Only on an invoice a full address is required.

Show child attributes

items.content.header.shipTo.postalAddress.name

string

deprecated

Use the "name" attribute on the "Party" object instead.

Example:

"ACME Germany GmbH - Außenstelle Hamburg"

items.content.header.shipTo.postalAddress.street

string

Example:

"Sternstrasse 23"

items.content.header.shipTo.postalAddress.addressExtra

string

Example:

"E4"

items.content.header.shipTo.postalAddress.city

string

Example:

"Hamburg"

items.content.header.shipTo.postalAddress.postalCode

string

Example:

"21571"

items.content.header.shipTo.postalAddress.state

string

Example:

"HH"

items.content.header.shipTo.postalAddress.countryCode

string

ISO 3166-1 standard two-letter country code.

Required string length: 2

Example:

"DE"

items.content.header.shipTo.contacts

object[]

Minimum array length: 1

Show child attributes

items.content.header.shipTo.contacts.firstName

string

Example:

"Atikin"

items.content.header.shipTo.contacts.lastName

string

Example:

"Iar"

items.content.header.shipTo.contacts.phone

string

Example:

"+491763021548"

items.content.header.shipTo.contacts.mobile

string

Example:

"+447881561299"

items.content.header.shipTo.contacts.email

string<email>

Example:

"[email protected]"

items.content.header.shipTo.contacts.fax

string

Example:

"+491763021548-11"

items.content.header.shipTo.contacts.department

string

Example:

"Purchasing"

items.content.header.shipTo.financialInstitution

object

Show child attributes

items.content.header.shipTo.financialInstitution.name

string

items.content.header.shipTo.financialInstitution.institutionId

string

items.content.header.shipTo.financialInstitution.institutionIdDomain

string

items.content.header.shipTo.financialInstitution.accountNumber

string

items.content.header.shipTo.financialInstitution.accountHolder

string

items.content.header.billTo

object

If this is kept empty, the "buyer" is used as the "billTo" party.

Show child attributes

items.content.header.billTo.identifiers

object[]

required

Minimum array length: 1

Show child attributes

items.content.header.billTo.identifiers.identifier

string

required

Party identifier within the "domain" such as GLN on GS1 domain, DUNS number on DUNS domain, etc.

Example:

"1100001016310"

items.content.header.billTo.identifiers.domain

enum<string>

default:GS1

required

Identification system the identifier belongs to.

Available options:

GS1,

DUNS,

VAT_DE,

FED_TAX,

SENDER_INTERNAL,

RECEIVER_INTERNAL

items.content.header.billTo.name

string

Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted.

items.content.header.billTo.postalAddress

object

Depending on the transaction different properties are required. Only on an invoice a full address is required.

Show child attributes

items.content.header.billTo.postalAddress.name

string

deprecated

Use the "name" attribute on the "Party" object instead.

Example:

"ACME Germany GmbH - Außenstelle Hamburg"

items.content.header.billTo.postalAddress.street

string

Example:

"Sternstrasse 23"

items.content.header.billTo.postalAddress.addressExtra

string

Example:

"E4"

items.content.header.billTo.postalAddress.city

string

Example:

"Hamburg"

items.content.header.billTo.postalAddress.postalCode

string

Example:

"21571"

items.content.header.billTo.postalAddress.state

string

Example:

"HH"

items.content.header.billTo.postalAddress.countryCode

string

ISO 3166-1 standard two-letter country code.

Required string length: 2

Example:

"DE"

items.content.header.billTo.contacts

object[]

Minimum array length: 1

Show child attributes

items.content.header.billTo.contacts.firstName

string

Example:

"Atikin"

items.content.header.billTo.contacts.lastName

string

Example:

"Iar"

items.content.header.billTo.contacts.phone

string

Example:

"+491763021548"

items.content.header.billTo.contacts.mobile

string

Example:

"+447881561299"

items.content.header.billTo.contacts.email

string<email>

Example:

"[email protected]"

items.content.header.billTo.contacts.fax

string

Example:

"+491763021548-11"

items.content.header.billTo.contacts.department

string

Example:

"Purchasing"

items.content.header.billTo.financialInstitution

object

Show child attributes

items.content.header.billTo.financialInstitution.name

string

items.content.header.billTo.financialInstitution.institutionId

string

items.content.header.billTo.financialInstitution.institutionIdDomain

string

items.content.header.billTo.financialInstitution.accountNumber

string

items.content.header.billTo.financialInstitution.accountHolder

string

items.content.header.finalRecipient

object

Used in case the shipTo is not the final recipient. Mostly used in dropshipping or cross-docking scenarios.

Show child attributes

items.content.header.finalRecipient.identifiers

object[]

required

Minimum array length: 1

Show child attributes

items.content.header.finalRecipient.identifiers.identifier

string

required

Party identifier within the "domain" such as GLN on GS1 domain, DUNS number on DUNS domain, etc.

Example:

"1100001016310"

items.content.header.finalRecipient.identifiers.domain

enum<string>

default:GS1

required

Identification system the identifier belongs to.

Available options:

GS1,

DUNS,

VAT_DE,

FED_TAX,

SENDER_INTERNAL,

RECEIVER_INTERNAL

items.content.header.finalRecipient.name

string

Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted.

items.content.header.finalRecipient.postalAddress

object

Depending on the transaction different properties are required. Only on an invoice a full address is required.

Show child attributes

items.content.header.finalRecipient.postalAddress.name

string

deprecated

Use the "name" attribute on the "Party" object instead.

Example:

"ACME Germany GmbH - Außenstelle Hamburg"

items.content.header.finalRecipient.postalAddress.street

string

Example:

"Sternstrasse 23"

items.content.header.finalRecipient.postalAddress.addressExtra

string

Example:

"E4"

items.content.header.finalRecipient.postalAddress.city

string

Example:

"Hamburg"

items.content.header.finalRecipient.postalAddress.postalCode

string

Example:

"21571"

items.content.header.finalRecipient.postalAddress.state

string

Example:

"HH"

items.content.header.finalRecipient.postalAddress.countryCode

string

ISO 3166-1 standard two-letter country code.

Required string length: 2

Example:

"DE"

items.content.header.finalRecipient.contacts

object[]

Minimum array length: 1

Show child attributes

items.content.header.finalRecipient.contacts.firstName

string

Example:

"Atikin"

items.content.header.finalRecipient.contacts.lastName

string

Example:

"Iar"

items.content.header.finalRecipient.contacts.phone

string

Example:

"+491763021548"

items.content.header.finalRecipient.contacts.mobile

string

Example:

"+447881561299"

items.content.header.finalRecipient.contacts.email

string<email>

Example:

"[email protected]"

items.content.header.finalRecipient.contacts.fax

string

Example:

"+491763021548-11"

items.content.header.finalRecipient.contacts.department

string

Example:

"Purchasing"

items.content.header.finalRecipient.financialInstitution

object

Show child attributes

items.content.header.finalRecipient.financialInstitution.name

string

items.content.header.finalRecipient.financialInstitution.institutionId

string

items.content.header.finalRecipient.financialInstitution.institutionIdDomain

string

items.content.header.finalRecipient.financialInstitution.accountNumber

string

items.content.header.finalRecipient.financialInstitution.accountHolder

string

items.content.header.technicalRecipient

object

Used when the recipient of the message differs from the supplier party. Common in scenarios where invoices or documents need to be sent to a centralized receiving entity (e.g., a group headquarters or shared services center) that differs from the actual supplier in the transaction.

Show child attributes

items.content.header.technicalRecipient.identifiers

object[]

required

Minimum array length: 1

Show child attributes

items.content.header.technicalRecipient.identifiers.identifier

string

required

Party identifier within the "domain" such as GLN on GS1 domain, DUNS number on DUNS domain, etc.

Example:

"1100001016310"

items.content.header.technicalRecipient.identifiers.domain

enum<string>

default:GS1

required

Identification system the identifier belongs to.

Available options:

GS1,

DUNS,

VAT_DE,

FED_TAX,

SENDER_INTERNAL,

RECEIVER_INTERNAL

items.content.header.technicalRecipient.name

string

Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted.

items.content.header.technicalRecipient.postalAddress

object

Depending on the transaction different properties are required. Only on an invoice a full address is required.

Show child attributes

items.content.header.technicalRecipient.postalAddress.name

string

deprecated

Use the "name" attribute on the "Party" object instead.

Example:

"ACME Germany GmbH - Außenstelle Hamburg"

items.content.header.technicalRecipient.postalAddress.street

string

Example:

"Sternstrasse 23"

items.content.header.technicalRecipient.postalAddress.addressExtra

string

Example:

"E4"

items.content.header.technicalRecipient.postalAddress.city

string

Example:

"Hamburg"

items.content.header.technicalRecipient.postalAddress.postalCode

string

Example:

"21571"

items.content.header.technicalRecipient.postalAddress.state

string

Example:

"HH"

items.content.header.technicalRecipient.postalAddress.countryCode

string

ISO 3166-1 standard two-letter country code.

Required string length: 2

Example:

"DE"

items.content.header.technicalRecipient.contacts

object[]

Minimum array length: 1

Show child attributes

items.content.header.technicalRecipient.contacts.firstName

string

Example:

"Atikin"

items.content.header.technicalRecipient.contacts.lastName

string

Example:

"Iar"

items.content.header.technicalRecipient.contacts.phone

string

Example:

"+491763021548"

items.content.header.technicalRecipient.contacts.mobile

string

Example:

"+447881561299"

items.content.header.technicalRecipient.contacts.email

string<email>

Example:

"[email protected]"

items.content.header.technicalRecipient.contacts.fax

string

Example:

"+491763021548-11"

items.content.header.technicalRecipient.contacts.department

string

Example:

"Purchasing"

items.content.header.technicalRecipient.financialInstitution

object

Show child attributes

items.content.header.technicalRecipient.financialInstitution.name

string

items.content.header.technicalRecipient.financialInstitution.institutionId

string

items.content.header.technicalRecipient.financialInstitution.institutionIdDomain

string

items.content.header.technicalRecipient.financialInstitution.accountNumber

string

items.content.header.technicalRecipient.financialInstitution.accountHolder

string

items.content.header.AdditionalOrderIdentifiers

object

Additional order identifiers for different parties in the transaction.

Show child attributes

items.content.header.AdditionalOrderIdentifiers.supplierOrderIdentifier

string

Supplier order identifier.

Example:

"SUP-12345"

items.content.header.AdditionalOrderIdentifiers.shipToOrderIdentifier

string

Ship-to order identifier.

Example:

"ST-67890"

items.content.header.AdditionalOrderIdentifiers.shipFromOrderIdentifier

string

Ship-from order identifier.

Example:

"SF-11111"

items.content.header.AdditionalOrderIdentifiers.billToOrderIdentifier

string

Bill-to order identifier.

Example:

"BT-22222"

items.content.header.AdditionalOrderIdentifiers.billFromOrderIdentifier

string

Bill-from order identifier.

Example:

"BF-33333"

items.content.header.AdditionalOrderIdentifiers.finalRecipientOrderIdentifier

string

Final recipient order identifier.

Example:

"FR-44444"

items.content.header.AdditionalOrderIdentifiers.technicalRecipientOrderIdentifier

string

Technical recipient order identifier.

Example:

"TR-55555"

items.content.header.type

string

Type of the order as assigned by sender.

items.content.header.requestedDeliveryDate

string<date-time>

Example:

"2021-10-23T00:00:00.000000Z"

items.content.header.currency

string

ISO 4217 standard three-letter currency code.

Example:

"EUR"

items.content.header.paymentTerms

object[]

Used for defining payment targets and optional discounts.

Show child attributes

items.content.header.paymentTerms.payInNumberOfDays

integer

required

Example:

7

items.content.header.paymentTerms.percentage

number<float>

required

Discount in % which is granted if payment is made not later than payInNumberOfDays after invoice date.

Example:

3.5

items.content.header.comments

string

Arbitrary human-readable information buyers can send within purchase orders

Maximum string length: 100000

items.content.header.deliveryInformation

string

Delivery information for the order.

Maximum string length: 100000

items.content.header.purchasingInformation

string

Additional information about purchasing.

Maximum string length: 100000

items.content.header.legalInformation

string

Legal notices and information.

Maximum string length: 100000

items.content.header.promotionCode

string

Promotion code applied to the entire order.

Maximum string length: 255

items.content.header.contractReference

string

Contract reference for the order.

Maximum string length: 255

items.content.header.version

integer

The document version number. Subsequent updates should increment this number by 1.

items.content.header.attachments

object[]

Show child attributes

items.content.header.attachments.fileName

string

Name of the file.

items.content.header.attachments.url

string<uri>

URL to the file.

items.content.header.attachments.mimeType

string

MIME type of the file.

items.content.items

object[]

required

Minimum array length: 1

Show child attributes

items.content.items.lineNumber

integer

LineNumber attribute may remain constant for any item through updates to the order, therefor lineNumbers may not be consecutive.

Example:

1

items.content.items.identifiers

object[]

There must be at least one identifier with domain GS1 or BUYER.

Minimum array length: 1

Show child attributes

items.content.items.identifiers.identifier

string

Party identifier within the 'domain' such as EAN/GTIN on GS1 domain, buyer's internal SKU on BUYER domain, etc.

Example:

"43000000000011"

items.content.items.identifiers.domain

enum<string>

default:GS1

Identification system the identifier belongs to.

Available options:

GS1,

BUYER,

SUPPLIER

items.content.items.isDepositItem

boolean

If true, the item is a deposit item such as bottle deposit (German: Pfandartikel).

items.content.items.quantity

number<float>

Defaults to 1.

Example:

2

items.content.items.unitOfMeasure

enum<string>

default:EA

Subset of the the UN/CEFACT Unit of Measure Common Codes.

Available options:

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

items.content.items.description

string

items.content.items.comments

string

items.content.items.unitPrice

number<float>

Example:

4.75

items.content.items.recommendedRetailPrice

number<float>

Example:

5.25

items.content.items.tax

object

Show child attributes

items.content.items.tax.amount

number<float>

required

Tax value in currency.

Example:

0.15

items.content.items.tax.percentage

number<float>

required

Tax value in percentage.

Example:

19

items.content.items.tax.description

string | null

Example:

"Total item tax."

items.content.items.promotionCode

string

Promotion code applied to this item.

Maximum string length: 255

items.content.items.contractReference

string

Contract reference for this item.

Maximum string length: 255

items.content.items.requestedDeliveryDate

string<date-time>

Example:

"2021-10-23T00:00:00.000000Z"

items.content.items.requestedEarliestDeliveryDate

string<date-time>

Example:

"2021-10-23T00:00:00.000000Z"

items.content.items.requestedLatestDeliveryDate

string<date-time>

Example:

"2021-10-23T00:00:00.000000Z"

items.content.items.deliveryGracePeriodInDays

integer

Delivery grace period in days.

items.content.items.minimumRemainingShelfLifeInDays

integer

Minimum remaining shelf life in days.

items.content.items.netWeight

number<float>

Net weight of the item in grams.

items.content.items.grossWeight

number<float>

Gross weight of the item in grams.

items.content.items.originCountryCode

string

ISO 3166-1 alpha-2 country code.

Example:

"DE"

items.content.items.colorCode

string

Color code of the item.

items.content.items.colorName

string

Color name of the item.

items.content.items.size

string

Size of the item.

items.content.items.dimension

string

Dimension of the item.

items.content.items.hsCode

string

Harmonized System Code of the item.

items.content.items.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.

Maximum string length: 255

items.content.items.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.

items.content.items.brand

string

Brand or manufacturer name of the product (e.g., BOSCH, Kela).

Example:

"BOSCH"

items.content.items.consumerGroup

string

Gender for which this item is marketed (e.g., Unisex, Damen, Herren).

items.content.items.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).

items.content.items.category

string

Product category classification (e.g., 1008).

items.content.items.subCategory

string

Product sub-category classification.

items.content.items.certifications

object

Item certifications for various standards and organizations.

Show child attributes

items.content.items.certifications.deBnn

string

DE-BNN (Bundesverband Naturkost Naturwaren) certification number

Example:

"NUMBER-123"

items.content.items.attachments

object[]

Document attachments for this line item, such as technical datasheets, product labels, or compliance documentation.

Show child attributes

items.content.items.attachments.fileName

string

Name of the attachment file.

items.content.items.attachments.url

string<uri>

URL to the attachment file.

items.content.items.attachments.mimeType

string

MIME type of the attachment file (e.g., application/pdf).

items.content.items.attachments.type

enum<string>

Type/classification of the line item attachment document.

Available options:

DECLARATION_OF_CONFORMITY,

ENERGY_LABEL,

EU_DATASHEET,

SAFETY_DATASHEET,

TECHNICAL_DATASHEET,

PRODUCT_LABEL

items.content.items.modificationGroups

object[]

Show child attributes

items.content.items.modificationGroups.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.

Example:

1.5

items.content.items.modificationGroups.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.

Example:

1

items.content.items.modificationGroups.modifications

object[]

required

Minimum array length: 1

Show child attributes

items.content.items.modificationGroups.modifications.type

enum<string>

Type of the modification

Available options:

ALLOWANCE,

CHARGE

items.content.items.modificationGroups.modifications.calculationType

enum<string>

Type of the calculation

Available options:

ABSOLUTE,

RELATIVE

items.content.items.modificationGroups.modifications.reasonCode

enum<string>

Reason for the modification

Available options:

SHIPPING,

PACKAGING,

HANDLING,

DISCOUNT,

INSURANCE

items.content.items.modificationGroups.modifications.description

string

Description for the modification

items.content.items.modificationGroups.modifications.percentage

number<float>

Example:

1.5

items.content.items.modificationGroups.modifications.amount

number<float>

Example:

5.5

items.content.items.modificationGroups.modifications.tax

object

Show child attributes

items.content.items.modificationGroups.modifications.tax.amount

number<float>

required

Tax value in currency.

Example:

0.15

items.content.items.modificationGroups.modifications.tax.percentage

number<float>

required

Tax value in percentage.

Example:

19

items.content.items.modificationGroups.modifications.tax.description

string | null

Example:

"Total item tax."

items.content.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.

Show child attributes

items.content.summary.subtotalAmount

number<float>

required

The sum of all line item subtotal amounts. The line item subtotal already includes all line item modifications.

items.content.summary.grossAmount

number<float>

required

The netAmount plus taxes.

items.content.summary.netAmount

number<float>

required

The subtotalAmount plus totalCharges and minus totalAllowances.

items.content.summary.dueAmount

number<float>

required

The grossAmount minus deposit. Note: deposits are not yet supported, therefore dueAmount will always equal grossAmount for now.

items.content.summary.totalCharges

number<float>

required

The total sum of all charges applied on document-level. Does not include charges applied on item-level.

items.content.summary.totalAllowances

number<float>

required

The total sum of all allowances applied on invoice level. Does not include allowances applied on item-level.

items.content.summary.tax

object

required

Show child attributes

items.content.summary.tax.total

number<float>

required

items.content.summary.tax.items

object[]

required

Show child attributes

items.content.summary.tax.items.percentage

number<float>

required

items.content.summary.tax.items.taxableAmount

number<float>

required

items.content.summary.tax.items.taxAmount

number<float>

required

items.content.summary.tax.items.category

string

required

Category of the tax, such as "sales", "import", etc. This is free field attribute.

items.content.summary.tax.items.description

string

items.content.summary.tax.description

string

Example:

"Total item tax."

items.content.summary.modificationGroups

object[]

Show child attributes

items.content.summary.modificationGroups.basis

number<float>

required

Example:

1.5

items.content.summary.modificationGroups.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.

Example:

1

items.content.summary.modificationGroups.modifications

object[]

required

Minimum array length: 1

Show child attributes

items.content.summary.modificationGroups.modifications.type

enum<string>

Type of the modification

Available options:

ALLOWANCE,

CHARGE

items.content.summary.modificationGroups.modifications.calculationType

enum<string>

Type of the calculation

Available options:

ABSOLUTE,

RELATIVE

items.content.summary.modificationGroups.modifications.reasonCode

enum<string>

Reason for the modification

Available options:

SHIPPING,

PACKAGING,

HANDLING,

DISCOUNT,

INSURANCE

items.content.summary.modificationGroups.modifications.description

string

Description for the modification

items.content.summary.modificationGroups.modifications.percentage

number<float>

Example:

1.5

items.content.summary.modificationGroups.modifications.amount

number<float>

Example:

5.5

items.content.summary.modificationGroups.modifications.tax

object

Show child attributes

items.content.summary.modificationGroups.modifications.tax.amount

number<float>

required

Tax value in currency.

Example:

0.15

items.content.summary.modificationGroups.modifications.tax.percentage

number<float>

required

Tax value in percentage.

Example:

19

items.content.summary.modificationGroups.modifications.tax.description

string | null

Example:

"Total item tax."

hasMore

boolean

required

Whether or not more transactions can be fetched on the next page.

perPage

integer

required

Amount of transactions returned per page.

count

integer

required

Amount of transactions on the current page.

nextCursor

string | null

required

Supplied to the cursor query parameter. See [Pagination] for more info.

nextPageUrl

string<url> | null

required

Prebuilt URL to retrieve the next page of transactions.

Getting Started

Endpoints

Documents

Guides

List All Transactions

Authorizations

Query Parameters

Response