Getting Started
Documents
curl --request POST \
--url https://api.procuros.io/v2/transactions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "ORDER",
"content": {
"header": {
"buyer": {
"name": "ACME Co. Ltd.",
"identifiers": [
{
"identifier": "1100001016310",
"domain": "GS1"
}
],
"postalAddress": {
"city": "Berlin",
"countryCode": "DE",
"name": "ACME Co. Ltd.",
"postalCode": "82643",
"street": "Elroy-Fritsch-Ring 15"
},
"contacts": [
{
"firstName": "Jane",
"lastName": "Doe",
"email": "[email protected]",
"fax": "(818) 463-6124",
"phone": "+1.352.856.0626"
}
]
},
"supplier": {
"name": "Testsupplier",
"identifiers": [
{
"identifier": "1100001016312",
"domain": "GS1"
}
]
},
"shipTo": {
"identifiers": [
{
"identifier": "1100001016313",
"domain": "GS1"
}
]
},
"billTo": {
"identifiers": [
{
"identifier": "1100001016314",
"domain": "GS1"
}
]
},
"orderIdentifier": "PO9383-R45",
"orderDate": "2021-09-30",
"AdditionalOrderIdentifiers": {
"supplierOrderIdentifier": "SUP-12345",
"shipToOrderIdentifier": "ST-67890",
"billToOrderIdentifier": "BT-22222",
"finalRecipientOrderIdentifier": "FR-44444",
"technicalRecipientOrderIdentifier": "TR-55555"
},
"currency": "EUR",
"requestedDeliveryDate": "2021-10-05",
"paymentTerms": [
{
"payInNumberOfDays": 28,
"percentage": 3
}
]
},
"items": [
{
"lineNumber": 1,
"identifiers": [
{
"identifier": "4300348765432",
"domain": "GS1"
},
{
"identifier": "PROD-77-LS",
"domain": "BUYER"
},
{
"identifier": "sp_gr_8",
"domain": "SUPPLIER"
}
],
"isDepositItem": false,
"quantity": 10,
"unitOfMeasure": "EA",
"description": "First product description.",
"unitPrice": 1.23,
"tax": {
"percentage": 7,
"description": "Umsatzsteuer"
},
"brand": "kela",
"assortment": "ME_GEN",
"consumerGroup": "Unisex",
"category": "1008",
"subCategory": "Beverages",
"modificationGroups": [
{
"modifications": [
{
"type": "ALLOWANCE",
"reasonCode": "DISCOUNT",
"description": "Contract trade discount",
"percentage": 7
}
]
}
]
}
]
}
}
'{
"procurosTransactionId": "949b2f25-fd9d-4c58-8899-b4dc277f8cf9"
}Send Transaction
Create and send a new transaction to one of your trade partners.
curl --request POST \
--url https://api.procuros.io/v2/transactions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "ORDER",
"content": {
"header": {
"buyer": {
"name": "ACME Co. Ltd.",
"identifiers": [
{
"identifier": "1100001016310",
"domain": "GS1"
}
],
"postalAddress": {
"city": "Berlin",
"countryCode": "DE",
"name": "ACME Co. Ltd.",
"postalCode": "82643",
"street": "Elroy-Fritsch-Ring 15"
},
"contacts": [
{
"firstName": "Jane",
"lastName": "Doe",
"email": "[email protected]",
"fax": "(818) 463-6124",
"phone": "+1.352.856.0626"
}
]
},
"supplier": {
"name": "Testsupplier",
"identifiers": [
{
"identifier": "1100001016312",
"domain": "GS1"
}
]
},
"shipTo": {
"identifiers": [
{
"identifier": "1100001016313",
"domain": "GS1"
}
]
},
"billTo": {
"identifiers": [
{
"identifier": "1100001016314",
"domain": "GS1"
}
]
},
"orderIdentifier": "PO9383-R45",
"orderDate": "2021-09-30",
"AdditionalOrderIdentifiers": {
"supplierOrderIdentifier": "SUP-12345",
"shipToOrderIdentifier": "ST-67890",
"billToOrderIdentifier": "BT-22222",
"finalRecipientOrderIdentifier": "FR-44444",
"technicalRecipientOrderIdentifier": "TR-55555"
},
"currency": "EUR",
"requestedDeliveryDate": "2021-10-05",
"paymentTerms": [
{
"payInNumberOfDays": 28,
"percentage": 3
}
]
},
"items": [
{
"lineNumber": 1,
"identifiers": [
{
"identifier": "4300348765432",
"domain": "GS1"
},
{
"identifier": "PROD-77-LS",
"domain": "BUYER"
},
{
"identifier": "sp_gr_8",
"domain": "SUPPLIER"
}
],
"isDepositItem": false,
"quantity": 10,
"unitOfMeasure": "EA",
"description": "First product description.",
"unitPrice": 1.23,
"tax": {
"percentage": 7,
"description": "Umsatzsteuer"
},
"brand": "kela",
"assortment": "ME_GEN",
"consumerGroup": "Unisex",
"category": "1008",
"subCategory": "Beverages",
"modificationGroups": [
{
"modifications": [
{
"type": "ALLOWANCE",
"reasonCode": "DISCOUNT",
"description": "Contract trade discount",
"percentage": 7
}
]
}
]
}
]
}
}
'{
"procurosTransactionId": "949b2f25-fd9d-4c58-8899-b4dc277f8cf9"
}Authorizations
The API Token of your ERP Connection.
Body
Type of transaction.
ORDER, ORDER_RESPONSE, SHIPPING_NOTICE, INVOICE, CREDIT_NOTE, DISPATCH_INSTRUCTION, DISPATCH_INSTRUCTION_RESPONSE, RECEIVAL_NOTICE, REMITTANCE_ADVICE, PRODUCT_CATALOG, INVENTORY_REPORT, SALES_REPORT A purchase order is a formal request from a buying organization to a supplier to fulfill a contract.
- Order
- Order Response
- Shipping Notice
- Invoice
- Credit Note
- Dispatch Instruction
- Dispatch Instruction Response
- Receival Notice
- Remittance Advice
- Product Catalog
- Inventory Report
- Sales Report
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
1Show child attributes
Show child attributes
Party identifier within the "domain" such as GLN on GS1 domain, DUNS number on DUNS domain, etc.
"1100001016310"
Identification system the identifier belongs to.
GS1, DUNS, VAT_DE, FED_TAX, SENDER_INTERNAL, RECEIVER_INTERNAL Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted.
Depending on the transaction different properties are required. Only on an invoice a full address is required.
Show child attributes
Show child attributes
Use the "name" attribute on the "Party" object instead.
"ACME Germany GmbH - Außenstelle Hamburg"
"Sternstrasse 23"
"E4"
"Hamburg"
"21571"
"HH"
ISO 3166-1 standard two-letter country code.
2"DE"
1Show child attributes
Show child attributes
"Atikin"
"Iar"
"+491763021548"
"+447881561299"
"+491763021548-11"
"Purchasing"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
1Show child attributes
Show child attributes
Party identifier within the "domain" such as GLN on GS1 domain, DUNS number on DUNS domain, etc.
"1100001016310"
Identification system the identifier belongs to.
GS1, DUNS, VAT_DE, FED_TAX, SENDER_INTERNAL, RECEIVER_INTERNAL Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted.
Depending on the transaction different properties are required. Only on an invoice a full address is required.
Show child attributes
Show child attributes
Use the "name" attribute on the "Party" object instead.
"ACME Germany GmbH - Außenstelle Hamburg"
"Sternstrasse 23"
"E4"
"Hamburg"
"21571"
"HH"
ISO 3166-1 standard two-letter country code.
2"DE"
1Show child attributes
Show child attributes
"Atikin"
"Iar"
"+491763021548"
"+447881561299"
"+491763021548-11"
"Purchasing"
Show child attributes
Show child attributes
Order number assigned to this purchase order by the buyer.
"PO9383-R45"
"2021-10-23T00:00:00.000000Z"
If this is kept empty, the "buyer" is used as the "shipTo" party.
Show child attributes
Show child attributes
1Show child attributes
Show child attributes
Party identifier within the "domain" such as GLN on GS1 domain, DUNS number on DUNS domain, etc.
"1100001016310"
Identification system the identifier belongs to.
GS1, DUNS, VAT_DE, FED_TAX, SENDER_INTERNAL, RECEIVER_INTERNAL Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted.
Depending on the transaction different properties are required. Only on an invoice a full address is required.
Show child attributes
Show child attributes
Use the "name" attribute on the "Party" object instead.
"ACME Germany GmbH - Außenstelle Hamburg"
"Sternstrasse 23"
"E4"
"Hamburg"
"21571"
"HH"
ISO 3166-1 standard two-letter country code.
2"DE"
1Show child attributes
Show child attributes
"Atikin"
"Iar"
"+491763021548"
"+447881561299"
"+491763021548-11"
"Purchasing"
Show child attributes
Show child attributes
If this is kept empty, the "buyer" is used as the "billTo" party.
Show child attributes
Show child attributes
1Show child attributes
Show child attributes
Party identifier within the "domain" such as GLN on GS1 domain, DUNS number on DUNS domain, etc.
"1100001016310"
Identification system the identifier belongs to.
GS1, DUNS, VAT_DE, FED_TAX, SENDER_INTERNAL, RECEIVER_INTERNAL Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted.
Depending on the transaction different properties are required. Only on an invoice a full address is required.
Show child attributes
Show child attributes
Use the "name" attribute on the "Party" object instead.
"ACME Germany GmbH - Außenstelle Hamburg"
"Sternstrasse 23"
"E4"
"Hamburg"
"21571"
"HH"
ISO 3166-1 standard two-letter country code.
2"DE"
1Show child attributes
Show child attributes
"Atikin"
"Iar"
"+491763021548"
"+447881561299"
"+491763021548-11"
"Purchasing"
Show child attributes
Show child attributes
Used in case the shipTo is not the final recipient. Mostly used in dropshipping or cross-docking scenarios.
Show child attributes
Show child attributes
1Show child attributes
Show child attributes
Party identifier within the "domain" such as GLN on GS1 domain, DUNS number on DUNS domain, etc.
"1100001016310"
Identification system the identifier belongs to.
GS1, DUNS, VAT_DE, FED_TAX, SENDER_INTERNAL, RECEIVER_INTERNAL Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted.
Depending on the transaction different properties are required. Only on an invoice a full address is required.
Show child attributes
Show child attributes
Use the "name" attribute on the "Party" object instead.
"ACME Germany GmbH - Außenstelle Hamburg"
"Sternstrasse 23"
"E4"
"Hamburg"
"21571"
"HH"
ISO 3166-1 standard two-letter country code.
2"DE"
1Show child attributes
Show child attributes
"Atikin"
"Iar"
"+491763021548"
"+447881561299"
"+491763021548-11"
"Purchasing"
Show child attributes
Show child attributes
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
Show child attributes
1Show child attributes
Show child attributes
Party identifier within the "domain" such as GLN on GS1 domain, DUNS number on DUNS domain, etc.
"1100001016310"
Identification system the identifier belongs to.
GS1, DUNS, VAT_DE, FED_TAX, SENDER_INTERNAL, RECEIVER_INTERNAL Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted.
Depending on the transaction different properties are required. Only on an invoice a full address is required.
Show child attributes
Show child attributes
Use the "name" attribute on the "Party" object instead.
"ACME Germany GmbH - Außenstelle Hamburg"
"Sternstrasse 23"
"E4"
"Hamburg"
"21571"
"HH"
ISO 3166-1 standard two-letter country code.
2"DE"
1Show child attributes
Show child attributes
"Atikin"
"Iar"
"+491763021548"
"+447881561299"
"+491763021548-11"
"Purchasing"
Show child attributes
Show child attributes
Additional order identifiers for different parties in the transaction.
Show child attributes
Show child attributes
Supplier order identifier.
"SUP-12345"
Ship-to order identifier.
"ST-67890"
Ship-from order identifier.
"SF-11111"
Bill-to order identifier.
"BT-22222"
Bill-from order identifier.
"BF-33333"
Final recipient order identifier.
"FR-44444"
Technical recipient order identifier.
"TR-55555"
Type of the order as assigned by sender.
"2021-10-23T00:00:00.000000Z"
ISO 4217 standard three-letter currency code.
"EUR"
Used for defining payment targets and optional discounts.
Arbitrary human-readable information buyers can send within purchase orders
100000Delivery information for the order.
100000Additional information about purchasing.
100000Legal notices and information.
100000Promotion code applied to the entire order.
255Contract reference for the order.
255The document version number. Subsequent updates should increment this number by 1.
1Show child attributes
Show child attributes
LineNumber attribute may remain constant for any item through updates to the order, therefor lineNumbers may not be consecutive.
1
There must be at least one identifier with domain GS1 or BUYER.
1Show child attributes
Show child attributes
Party identifier within the 'domain' such as EAN/GTIN on GS1 domain, buyer's internal SKU on BUYER domain, etc.
"43000000000011"
Identification system the identifier belongs to.
GS1, BUYER, SUPPLIER If true, the item is a deposit item such as bottle deposit (German: Pfandartikel).
Defaults to 1.
2
Subset of the the UN/CEFACT Unit of Measure Common Codes.
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 4.75
5.25
Promotion code applied to this item.
255Contract reference for this item.
255"2021-10-23T00:00:00.000000Z"
"2021-10-23T00:00:00.000000Z"
"2021-10-23T00:00:00.000000Z"
Delivery grace period in days.
Minimum remaining shelf life in days.
Net weight of the item in grams.
Gross weight of the item in grams.
ISO 3166-1 alpha-2 country code.
"DE"
Color code of the item.
Color name of the item.
Size of the item.
Dimension of the item.
Harmonized System Code of the item.
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.
255An FSC number refers to an identification number issued by the Forest Stewardship Council (FSC), an international organization that certifies sustainable forestry practices.
Brand or manufacturer name of the product (e.g., BOSCH, Kela).
"BOSCH"
Gender for which this item is marketed (e.g., Unisex, Damen, Herren).
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).
Product category classification (e.g., 1008).
Product sub-category classification.
Show child attributes
Show child attributes
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.
1.5
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.
1
1Show child attributes
Show child attributes
Type of the modification
ALLOWANCE, CHARGE Type of the calculation
ABSOLUTE, RELATIVE Reason for the modification
SHIPPING, PACKAGING, HANDLING, DISCOUNT, INSURANCE Description for the modification
1.5
5.5
Show child attributes
Show child attributes
Tax value in currency.
0.15
Tax value in percentage.
19
"Total item tax."
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
Show child attributes
The sum of all line item subtotal amounts. The line item subtotal already includes all line item modifications.
The netAmount plus taxes.
The subtotalAmount plus totalCharges and minus totalAllowances.
The grossAmount minus deposit. Note: deposits are not yet supported, therefore dueAmount will always equal grossAmount for now.
The total sum of all charges applied on document-level. Does not include charges applied on item-level.
The total sum of all allowances applied on invoice level. Does not include allowances applied on item-level.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Category of the tax, such as "sales", "import", etc. This is free field attribute.
"Total item tax."
Show child attributes
Show child attributes
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.
1.5
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.
1
1Show child attributes
Show child attributes
Type of the modification
ALLOWANCE, CHARGE Type of the calculation
ABSOLUTE, RELATIVE Reason for the modification
SHIPPING, PACKAGING, HANDLING, DISCOUNT, INSURANCE Description for the modification
1.5
5.5
Show child attributes
Show child attributes
Tax value in currency.
0.15
Tax value in percentage.
19
"Total item tax."
Response
Created
Unique ID assigned to every transaction on the Procuros Network.
"949b2f25-fd9d-4c58-8899-b4dc277f8cf9"
Was this page helpful?