Procurement Common Objects
PurchaseOrderLineItem
"...": {
"article": {...},
"cargoReady": {...},
"cargoReadiness": {...},
"desiredDelivery": {...},
"estimatedArrival": {...},
"estimatedDeparture": {...},
"grossWeight": 0,
"leadTime": 0,
"mainModality": "AIR",
"plannedQuantity": 0,
"preCarriageTime": 0,
"quantity": 0,
"reference": "string",
"volume": 0
}| Property | Type | Mandatory | Description |
|---|---|---|---|
| article | PurchaseOrderArticle | M | |
| cargoReadiness | ApiDate | C | Mandatory if status is planned for transport. |
| cargoReady | ApiDateFromTo | C | Mandatory if DDto or leadtime is empty. |
| desiredDelivery | ApiDateFromTo | C | Mandatory if Cargo ready to or leadtime is empty. |
| estimatedArrival | ApiDate | C | Mandatory if status is planned for transport, planning pending. |
| estimatedDeparture | ApiDate | C | Mandatory if status is planned for transport, planning pending. |
| grossWeight | BigDecimal | O | Weight of article in KG with packaging. |
| leadTime | Integer | O | Mandatory if not defined in system settings. |
| mainModality | String | M | Main modality for procurement. AIR, SEA, ROAD. |
| plannedQuantity | Integer | O | Mandatory if status planned for transport is set. |
| mainCarriage | Integer | C | Mandatory if not defined in system settings. |
| preCarriageTime | Integer | C | Mandatory if not defined in system settings. |
| quantity | Integer | M | Quantity of lineitems. |
| reference | String | M | ID for each lineitem. |
| volume | BigDecimal | O | Volume of article in m³. |
PurchaseOrderArticle
"...": {
"code": "string",
"customsTariffNumber": "string",
"dangerousGoods": {...},
"description": "string",
"eanCode": "string",
"netPrice": 12.4,
"netWeight": 1.2,
"originCountry": "AT",
"supplierCode": "string",
"supplierDescription": "string"
}| Property | Type | Mandatory | Description |
|---|---|---|---|
| code | String | M | Article code. |
| customsTariffNumber | String | O | HS-code, customs tariff number. |
| dangerousGoods | DangerousGoods | M | |
| description | String | M | Description of article. |
| eanCode | String | O | European Article Number. |
| netPrice | BigDecimal | O | Final price after deducting all discounts and rebates. |
| netWeight | BigDecimal | O | Weight of article in KG without packaging. |
| originCountry | String | O | ISO origin country code (ISO 3166-1 Alpha-2). |
| supplierCode | String | O | Supplier's article code. |
| supplierDescription | String | O | Supplier's article description. |
PurchaseOrderParty
"...": {
"contacts": [{...}],
"partyId": 415645,
"partyType": "PRINCIPAL"
}| Property | Type | Mandatory | Description |
|---|---|---|---|
| contacts | Array[PurchaseOrderContact] | O | Array for contact persons. |
| partyId | Integer | M | Customer ID (Provided from us). |
| partyType | String | M | Possible types below. |
| partyAddress | PartyAddress | O | If no party ID is provided the address data have to be filled out. |
| PartyTypes |
|---|
PRINCIPAL SHIPPER PICKUP CONSIGNEE DELIVERY CONTROLLING_AGENT ORIGIN_AGENT DESTINATION_AGENT TRANSIT_HUB THIRD_PARTY NOTIFY_AGENT CONTROLLING_OFFICE HANDLING_OFFICE CUSTOMER SUPPLIER |
PurchaseOrderContact
"...": {
"contactPersonId": 0,
"emailBusiness": "string",
"firstName": "string",
"lastName": "string",
"mobile": "string",
"phoneBusiness": "string"
}| Property | Type | Mandatory | Description |
|---|---|---|---|
| contactPersonId | Integer | C | If an Id will be provided all other fields can be ignored. |
| emailBusiness | String | C | Contact business email address. |
| firstName | String | C | Mandatory if no ID is provided. |
| lastName | String | C | Mandatory if no ID is provided. |
| mobile | String | C | Mandatory if no ID is provided. |
| phoneBusiness | String | C | Contact business phone number. |
PurchaseOrderPartyAddress
If no partyId or externalReference is provided address data is mandatory.
"...": {
"externalReference": 0,
"name": "string",
"city": "string",
"street": "string",
"zipCode": "string",
"countryCode": "string",
"state": "string",
"email": "string",
"phone": {...},
"fax": {...},
"otherPhone": {...},
}| Property | Type | Mandatory | Description |
|---|---|---|---|
| externalReference | Integer | C | If an Id will be provided all other fields can be ignored. |
| name | String | C | |
| city | String | C | Name of the city/location. |
| street | String | C | Street address part (including house, store, door numbers). |
| zipCode | String | C | postal code of the city/location. |
| countryCode | String | C | ISO country code (ISO 3166-1 Alpha-2). |
| state | String | O | |
| String | C | ||
| phone | Phone | O | |
| fax | Phone | O | |
| otherPhone | Phone | O |