PostOrdercXML (POST) | GEP TECH DOCUMENTATION

Overview

This POST API allows pushing Order CXML posted in ERP to GEP SMART for further processing.

URL Format: https://<Instance>/SmartInterfaceAPI/api/Order/OrderDetails

Request

{
   "basicDetails": {
      "documentName": "string",
      "documentNumber": "string",
      "documentStatus": "string",
      "documentCreator": "string",
      "createdOn": "string",
      "documentLobDetails": [
         {
            "entityCode": "string",
            "entityType": "string"
         }
      ],
      "operationName": "string"
   },
   "orderSource": "string",
   "shiptoLocation": {
      "locationName": "string",
      "locationNumber": "string",
      "address": {
         "addressline1": "string",
         "addressline2": "string",
         "addressline3": "string",
         "city": "string",
         "zipCode": "string",
         "stateInfo": {
            "stateAbbrevationCode": "string",
            "stateName": "string"
         },
         "countryInfo": {
            "countryCode": "string",
            "countryName": "string"
         },
         "phoneNo1": "string",
         "extenstionNo1": "string",
         "phoneNo2": "string",
         "extenstionNo2": "string",
         "mobileNo": "string",
         "faxNo": "string",
         "county": "string"
      },
      "deliverTo": "string",
      "registrationDetails": [
         {
            "companyIdentificationDisplayName": "string",
            "companyIdentification": "string"
         }
      ]
   },
   "delivertoLocation": {
      "locationName": "string",
      "locationNumber": "string",
      "address": {
         "addressline1": "string",
         "addressline2": "string",
         "addressline3": "string",
         "city": "string",
         "zipCode": "string",
         "stateInfo": {
            "stateAbbrevationCode": "string",
            "stateName": "string"
         },
         "countryInfo": {
            "countryCode": "string",
            "countryName": "string"
         },
         "phoneNo1": "string",
         "extenstionNo1": "string",
         "phoneNo2": "string",
         "extenstionNo2": "string",
         "mobileNo": "string",
         "faxNo": "string",
         "county": "string"
      },
      "deliverTo": "string"
   },
   "billtoLocation": {
      "locationName": "string",
      "locationNumber": "string",
      "address": {
         "addressline1": "string",
         "addressline2": "string",
         "addressline3": "string",
         "city": "string",
         "zipCode": "string",
         "stateInfo": {
            "stateAbbrevationCode": "string",
            "stateName": "string"
         },
         "countryInfo": {
            "countryCode": "string",
            "countryName": "string"
         },
         "phoneNo1": "string",
         "extenstionNo1": "string",
         "phoneNo2": "string",
         "extenstionNo2": "string",
         "mobileNo": "string",
         "faxNo": "string",
         "county": "string"
      },
      "deliverTo": "string",
      "registrationDetails": [
         {
            "companyIdentificationDisplayName": "string",
            "companyIdentification": "string"
         }
      ]
   },
   "supplierDetails": {
      "clientPartnerCode": "string",
      "orderingLocation": "string",
      "supplierContact": {
         "clientContactCode": "string",
         "emailAddress": "string",
         "firstName": "string",
         "lastName": "string"
      },
      "paymentTermCode": "string"
   },
   "orderContact": {
      "clientContactCode": "string",
      "emailAddress": "string",
      "firstName": "string",
      "lastName": "string"
   },
   "headerEntities": [
      {
         "entityCode": "string",
         "entityType": "string"
      }
   ],
   "currency": "string",
   "itemTotalAmount": 0,
   "tax": 0,
   "shipping": 0,
   "additionalCharges": 0,
   "totalAmount": 0,
   "sourceSystemName": "string",
   "taxesAndCharges": [
      {
         "taxDescription": "string",
         "taxType": "string",
         "taxMode": "string",
         "taxValue": 0,
         "taxPercentage": 0,
         "taxCode": "string",
         "isAccrueTax": true
      }
   ],
   "comments": [
      {
         "commentText": "string",
         "accessType": "string"
      }
   ],
   "workOrderNumber": "string",
   "erpOrderType": "string",
   "budgetDescription": "string",
   "customAttributes": [
      {
         "questionnaireTitle": "string",
         "questionnaireResponseValues": [
            {
               "childQuestionSets": [
                  null
               ],
               "columnText": "string",
               "responseValue": "string",
               "rowId": "string"
            }
         ]
      }
   ],
   "fobCode": "string",
   "fobLocationCode": "string",
   "fobCodeDescription": "string",
   "fobLocationDescription": "string",
   "carriersDescription": "string",
   "transitTypeDescription": "string",
   "freightTermsDescription": "string",
   "freightTermsCode": "string",
   "transitTypeCode": "string",
   "carriersCode": "string",
   "isUrgent": true,
   "ers": true,
   "matchType": "string",
   "receivingStatus": "string",
   "blanketStartDate": "2020-04-29T10:22:17.716Z",
   "blanketEndDate": "2020-04-29T10:22:17.716Z",
   "revisionNumber": "string",
   "blanketDocumentNumber": "string",
   "transmissionMode": "string",
   "buyerVATNumber": "string",
   "purchaseTypeDescription": "string",
   "isPCardSupportedForOrder": true,
   "billable": true,
   "requisitionNumber": "string",
   "requisitionCreatorEmailAddress": "string",
   "materialReceivingTolerance": 0,
   "serviceReceivingTolerance": 0,
   "attachments": [
      {
         "fileName": "string",
         "fileUri": "string",
         "extension": "string",
         "contentTransferEncoding": "string",
         "attachmentData": "string"
      }
   ],
   "orderItems": [
      {
         "itemLineNumber": 0,
         "description": "string",
         "unitPrice": 0,
         "quantity": 0,
         "uom": "string",
         "manufacturerName": "string",
         "manufacturerPartNumber": "string",
         "itemType": "string",
         "itemExtendedType": "string",
         "documentItemShippingDetails": [
            {
               "shiptoLocation": {
                  "locationName": "string",
                  "locationNumber": "string",
                  "address": {
                     "addressline1": "string",
                     "addressline2": "string",
                     "addressline3": "string",
                     "city": "string",
                     "zipCode": "string",
                     "stateInfo": {
                        "stateAbbrevationCode": "string",
                        "stateName": "string"
                     },
                     "countryInfo": {
                        "countryCode": "string",
                        "countryName": "string"
                     },
                     "phoneNo1": "string",
                     "extenstionNo1": "string",
                     "phoneNo2": "string",
                     "extenstionNo2": "string",
                     "mobileNo": "string",
                     "faxNo": "string",
                     "county": "string"
                  },
                  "deliverTo": "string",
                  "registrationDetails": [
                     {
                        "companyIdentificationDisplayName": "string",
                        "companyIdentification": "string"
                     }
                  ]
               },
               "delivertoLocation": {
                  "locationName": "string",
                  "locationNumber": "string",
                  "address": {
                     "addressline1": "string",
                     "addressline2": "string",
                     "addressline3": "string",
                     "city": "string",
                     "zipCode": "string",
                     "stateInfo": {
                        "stateAbbrevationCode": "string",
                        "stateName": "string"
                     },
                     "countryInfo": {
                        "countryCode": "string",
                        "countryName": "string"
                     },
                     "phoneNo1": "string",
                     "extenstionNo1": "string",
                     "phoneNo2": "string",
                     "extenstionNo2": "string",
                     "mobileNo": "string",
                     "faxNo": "string",
                     "county": "string"
                  },
                  "deliverTo": "string"
               },
               "shippingMethod": "string"
            }
         ],
         "startDate": "2020-04-29T10:22:17.716Z",
         "endDate": "2020-04-29T10:22:17.716Z",
         "additionalCharges": 0,
         "shippingCharges": 0,
         "tax": 0,
         "isTaxExempt": true,
         "dateRequested": "2020-04-29T10:22:17.716Z",
         "dateNeeded": "2020-04-29T10:22:17.716Z",
         "promisedDate": "2020-04-29T10:22:17.716Z",
         "itemStatus": "string",
         "itemTotalAmount": 0,
         "unspsc": 0,
         "buyerItemNumber": "string",
         "supplierPartId": "string",
         "supplierPartAuxiliaryId": "string",
         "taxes": [
            {
               "taxDescription": "string",
               "taxType": "string",
               "taxMode": "string",
               "taxValue": 0,
               "taxPercentage": 0,
               "taxCode": "string",
               "isAccrueTax": true
            }
         ],
         "comments": [
            {
               "commentText": "string",
               "accessType": "string",
               "commentAttachment": [
                  {
                     "fileName": "string",
                     "fileUri": "string",
                     "extension": "string",
                     "contentTransferEncoding": "string",
                     "attachmentData": "string"
                  }
               ]
            }
         ],
         "contractNo": "string",
         "clientCategoryId": "string",
         "capitalCode": "string",
         "matchType": "string",
         "recoupmentPercentage": 0,
         "manufacturerSupplierCode": "string",
         "manufacturerModel": "string",
         "requestor": "string",
         "fobCode": "string",
         "fobLocationCode": "string",
         "fobCodeDescription": "string",
         "fobLocationDescription": "string",
         "requisitionNumber": "string",
         "isCloseForReceiving": true,
         "isCloseForInvoicing": true,
         "reqItemLineNumber": 0,
         "contingentWorkerName": "string",
         "jobTitleName": "string",
         "itemReceivingTolerance": 0,
         "tolerancePercentage": 0,
         "customAttributes": [
            {
               "questionnaireTitle": "string",
               "questionnaireResponseValues": [
                  {
                     "childQuestionSets": [
                        null
                     ],
                     "columnText": "string",
                     "responseValue": "string",
                     "rowId": "string"
                  }
               ]
            }
         ],
         "overallItemLimit": 0,
         "AdditionalFieldAttributes": [
            {
               "additionalFieldValue": "string",
               "additionalFieldCode": "string",
               "additionalFieldName": "string"
            }
         ],
         "itemSplitsDetail": [
            {
               "documentSplitItemEntities": [
                  {
                     "entityType": "string",
                     "entityCode": "string",
                     "entityDisplayName": "string"
                  }
               ],
               "requestorEmailAddress": "string",
               "splitItemTotal": 0,
               "customAttributes": [
                  {
                     "questionnaireTitle": "string",
                     "questionnaireResponseValues": [
                        {
                           "childQuestionSets": [
                              null
                           ],
                           "columnText": "string",
                           "responseValue": "string",
                           "rowId": "string"
                        }
                     ]
                  }
               ],
               "splitType": "string",
               "quantity": 0,
               "percentage": 0
            }
         ]
      }
   ]
}

Response

{
   "data": {},
   "statusCode": "string",
   "errorDetails": [
      {
         "key": "string",
         "errors": [
            {
               "errorCode": "string",
               "errorDescription": "string"
            }
         ]
      }
   ],
   "successDetails": [
      {
         "key": "string"
      }
   ]
}

Examples

Success Scenario - Request
Request below describes that this contains only the mandatory attributes:

{
   "BasicDetails": {
      "DocumentName": "KetanPO_27022020_01",
      "DocumentNumber": "KetanPO_27022020_01",
      "DocumentCreator": "USKDJU01",
      "CreatedOn": "2020-01-27",
      "DocumentLobDetails": [
         {
            "EntityCode": "KNA-SAP"
         }
      ],
      "OperationName": "new"
   },
   "OrderSource": "manualOrder",
   "BilltoLocation": {
      "LocationName": "",
      "LocationNumber": "NUHC",
      "Address": {
         "Addressline1": "",
         "Addressline2": "",
         "Addressline3": "",
         "City": "",
         "ZipCode": "",
         "StateInfo": {
            "StateAbbrevationCode": "",
            "StateName": ""
         },
         "CountryInfo": {
            "CountryCode": "",
            "CountryName": ""
         },
         "CreatedOn": "0001-01-01T00:00:00"
      }
   },
   "SupplierDetails": {
      "ClientPartnerCode": "0080005119",
      "OrderingLocation": "",
      "SupplierContact": null,
      "PaymentTermCode": "NT75"
   },
   "HeaderEntities": [
      {
         "EntityCode": "NUHC",
         "EntityType": "BusinessUnit"
      },
      {
         "EntityCode": "0100",
         "EntityType": "Purchasing Org"
      },
      {
         "EntityCode": "132",
         "EntityType": "Purchasing Group"
      }
   ],
   "Currency": "USD",
   "ItemTotalAmount": 0,
   "Tax": 0,
   "Shipping": 0,
   "AdditionalCharges": 0,
   "TotalAmount": 10000,
   "SourceSystemName": "KNA-SAP-INDIRECT",
   "Comments": [
      {
         "CommentText": "DDP - Delivered Duty Paid"
      }
   ],
   "ERPOrderType": 0,
   "IsUrgent": false,
   "ERS": false,
   "BlanketStartDate": "0001-01-01T00:00:00",
   "BlanketEndDate": "0001-01-01T00:00:00",
   "RevisionNumber": "1",
   "IsPCardSupportedForOrder": false,
   "Billable": true,
   "OrderItems": [
      {
         "ItemLineNumber": 1,
         "Description": "Mmeprazole DR Pellets, 80 mg/g",
         "UnitPrice": 100,
         "Quantity": 1,
         "UOM": "EA",
         "ItemType": "Material",
         "ItemExtendedType": "Material",
         "DocumentItemShippingDetails": [
            {
               "ShiptoLocation": {
                  "LocationName": "Mylan Pharmaceuticals, Inc.",
                  "LocationNumber": "1000",
                  "Address": {
                     "Addressline1": "781 Chestnut Ridge Rd",
                     "Addressline2": "Morgantown",
                     "Addressline3": "",
                     "City": "Morgantown",
                     "ZipCode": "265052730",
                     "StateInfo": {
                        "StateAbbrevationCode": "",
                        "StateName": "WV"
                     },
                     "CountryInfo": {
                        "CountryCode": "US",
                        "CountryName": ""
                     }
                  }
               },
               "DelivertoLocation": {
                  "LocationName": "",
                  "LocationNumber": "Carrie Long Line Level 1",
                  "Address": {
                     "Addressline1": "",
                     "Addressline2": "",
                     "Addressline3": "",
                     "City": "",
                     "ZipCode": "",
                     "StateInfo": {
                        "StateAbbrevationCode": "",
                        "StateName": ""
                     },
                     "CountryInfo": {
                        "CountryCode": "",
                        "CountryName": ""
                     }
                  }
               },
               "ShippingMethod": ""
            }
         ],
         "StartDate": "2020-01-22T12:11:45.813Z",
         "EndDate": "2020-01-22T12:11:45.813Z",
         "AdditionalCharges": 9,
         "ShippingCharges": 90,
         "Tax": 100,
         "IsTaxExempt": false,
         "DateRequested": "2020-01-22T12:11:45.813Z",
         "DateNeeded": "2020-01-22T12:11:45.813Z",
         "PromisedDate": "2020-01-22T12:11:45.813Z",
         "ItemStatus": "",
         "ItemTotalAmount": 0,
         "UNSPSC": 0,
         "BuyerItemNumber": "002500000010001082",
         "SupplierPartId": "",
         "SupplierPartAuxiliaryId": "",
         "ContractNo": "C1",
         "RecoupmentPercentage": 0,
         "IsCloseForReceiving": false,
         "IsCloseForInvoicing": false,
         "ReqItemLineNumber": 0,
         "OverallItemLimit": 0,
         "ItemSplitsDetail": [
            {
               "DocumentSplitItemEntities": [
                  {
                     "EntityType": "Purchasing Org",
                     "EntityCode": "0100"
                  },
                  {
                     "EntityType": "Purchasing Group",
                     "EntityCode": "132"
                  },
                  {
                     "EntityType": "Company Code",
                     "EntityCode": "NUHC"
                  },
                  {
                     "EntityType": "Plant",
                     "EntityCode": "0393"
                  },
                  {
                     "EntityType": "Material Group Level 1",
                     "EntityCode": "--"
                  },
                  {
                     "EntityType": "Material Group Level 2",
                     "EntityCode": "--"
                  },
                  {
                     "EntityType": "Material Group Level 3",
                     "EntityCode": "ELECCNTRL"
                  },
                  {
                     "EntityType": "Item Category",
                     "EntityCode": "Blank"
                  }
               ],
               "SplitItemTotal": 0,
               "Quantity": 0,
               "Percentage": 0
            }
         ]
      }
   ]
}

Success Scenario - Response

{
   "data": null,
   "statusCode": "200",
   "errorDetails": [],
   "successDetails": [
      {
         "key": "KetanPO_27022020_01"
      }
   ]
}

Error Scenario - Request

{
   "BasicDetails": {
      "DocumentName": "KetanPO_27022020_01",
      "DocumentNumber": "KetanPO_27022020_01",
      "DocumentCreator": "USKDJU01",
      "CreatedOn": "2020-01-27",
      "DocumentLobDetails": [
         {
            "EntityCode": "KNA-SAP"
         }
      ],
      "OperationName": "new"
   },
   "OrderSource": "manualOrder",
   "BilltoLocation": {
      "LocationName": "",
      "LocationNumber": "NUHC",
      "Address": {
         "Addressline1": "",
         "Addressline2": "",
         "Addressline3": "",
         "City": "",
         "ZipCode": "",
         "StateInfo": {
            "StateAbbrevationCode": "",
            "StateName": ""
         },
         "CountryInfo": {
            "CountryCode": "",
            "CountryName": ""
         }
      }
   },
   "SupplierDetails": {
      "ClientPartnerCode": "0080005119",
      "OrderingLocation": "",
      "SupplierContact": null,
      "PaymentTermCode": "NT75"
   },
   "HeaderEntities": [
      {
         "EntityCode": "NUHC",
         "EntityType": "BusinessUnit"
      },
      {
         "EntityCode": "0100",
         "EntityType": "Purchasing Org"
      },
      {
         "EntityCode": "132",
         "EntityType": "Purchasing Group"
      }
   ],
   "Currency": "USD",
   "ItemTotalAmount": 0,
   "Tax": 0,
   "Shipping": 0,
   "AdditionalCharges": 0,
   "TotalAmount": 10000,
   "SourceSystemName": "KNA-SAP-INDIRECT",
   "Comments": [
      {
         "CommentText": "DDP - Delivered Duty Paid"
      }
   ],
   "ERPOrderType": 0,
   "IsUrgent": false,
   "ERS": false,
   "BlanketStartDate": "0001-01-01T00:00:00",
   "BlanketEndDate": "0001-01-01T00:00:00",
   "RevisionNumber": "1",
   "IsPCardSupportedForOrder": false,
   "Billable": true,
   "OrderItems": [
      {
         "ItemLineNumber": 1,
         "Description": "Mmeprazole DR Pellets, 80 mg/g",
         "UnitPrice": 100,
         "Quantity": 1,
         "UOM": "",
         "ItemType": "Material",
         "ItemExtendedType": "Material",
         "DocumentItemShippingDetails": [
            {
               "ShiptoLocation": {
                  "LocationName": "Mylan Pharmaceuticals, Inc.",
                  "LocationNumber": "1000",
                  "Address": {
                     "Addressline1": "781 Chestnut Ridge Rd",
                     "Addressline2": "Morgantown",
                     "Addressline3": "",
                     "City": "Morgantown",
                     "ZipCode": "265052730",
                     "StateInfo": {
                        "StateAbbrevationCode": "",
                        "StateName": "WV"
                     },
                     "CountryInfo": {
                        "CountryCode": "US",
                        "CountryName": ""
                     }
                  }
               },
               "DelivertoLocation": {
                  "LocationName": "",
                  "LocationNumber": "Carrie Long Line Level 1",
                  "Address": {
                     "Addressline1": "",
                     "Addressline2": "",
                     "Addressline3": "",
                     "City": "",
                     "ZipCode": "",
                     "StateInfo": {
                        "StateAbbrevationCode": "",
                        "StateName": ""
                     },
                     "CountryInfo": {
                        "CountryCode": "",
                        "CountryName": ""
                     }
                  }
               },
               "ShippingMethod": ""
            }
         ],
         "StartDate": "2020-01-22T12:11:45.813Z",
         "EndDate": "2020-01-22T12:11:45.813Z",
         "AdditionalCharges": 9,
         "ShippingCharges": 90,
         "Tax": 100,
         "IsTaxExempt": false,
         "DateRequested": "2020-01-22T12:11:45.813Z",
         "DateNeeded": "2020-01-22T12:11:45.813Z",
         "PromisedDate": "2020-01-22T12:11:45.813Z",
         "ItemStatus": "",
         "ItemTotalAmount": 0,
         "UNSPSC": 0,
         "BuyerItemNumber": "002500000010001082",
         "SupplierPartId": "",
         "SupplierPartAuxiliaryId": "",
         "ContractNo": "C1",
         "RecoupmentPercentage": 0,
         "IsCloseForReceiving": false,
         "IsCloseForInvoicing": false,
         "ReqItemLineNumber": 0,
         "OverallItemLimit": 0,
         "ItemSplitsDetail": [
            {
               "DocumentSplitItemEntities": [
                  {
                     "EntityType": "Purchasing Org",
                     "EntityCode": "0100"
                  },
                  {
                     "EntityType": "Purchasing Group",
                     "EntityCode": "132"
                  },
                  {
                     "EntityType": "Company Code",
                     "EntityCode": "NUHC"
                  },
                  {
                     "EntityType": "Plant",
                     "EntityCode": "0393"
                  },
                  {
                     "EntityType": "Material Group Level 1",
                     "EntityCode": "--"
                  },
                  {
                     "EntityType": "Material Group Level 2",
                     "EntityCode": "--"
                  },
                  {
                     "EntityType": "Material Group Level 3",
                     "EntityCode": "ELECCNTRL"
                  },
                  {
                     "EntityType": "Item Category",
                     "EntityCode": "Blank"
                  }
               ],
               "SplitItemTotal": 0,
               "Quantity": 0,
               "Percentage": 0
            }
         ]
      }
   ]
}

Error Scenario - Response

{
   "data": null,
   "statusCode": "400",
   "errorDetails": [
      {
         "key": "KetanPO_27022020_01",
         "errors": [
            {
               "errorCode": "MandatoryException",
               "errorDescription": "UOM is Mandatory for Item No: 1"
            }
         ]
      }
   ],
   "successDetails": []
}

Data Elements

InterfaceOrder
Property	Required?	Data type	Description	Validations/Exceptions
BasicDetails	Yes	InterfaceDocument object
SupplierDetails	No	SupplierDetails object
OrderContact	No	List of InterfaceContact object	Check data type Order Contact for details
RequisitionNumber	No	String	Requisition Number of the entity
headerEntities	Yes	List of InterfaceOrgEntity
OrderSource	Yes	String	Order Source of the entity	OrderType is mandatory OrderType is invalid
BillToLocation	Yes	List of InterfaceLocation object	Check data type InterfaceLocation for details	BillTo is mandatory There was an error in processing the order as Bill to Location having invalid LOB and access control entity mapping There was an error in processing the order as the OrgEntity and Bill to Location Mapping is not valid
Currency	Yes	String	Currency of the entity	Currency is mandatory for Total Amount Multiple currencies are not supported within a document Invalid Currency Code Invoicing or receiving has initiated, and change order cannot be accepted with new currency
FobCode	Yes	String	Fob Code of the entity	FOBCode is mandatory Invalid FOBCode
FobLocationCode	Yes	String	Fob Location Code of the entity	FOBLocationCode is mandatory Invalid FOBLocationCode
FreightTermsCode	Yes	String	Freight Terms Code of the entity	FreightTermsCode is mandatory Invalid FreightTermsCode
TransitTypeCode	Yes	String	Transit Type Code of the entity	TransitTypeCode is mandatory Invalid TransitTypeCode
CarriersCode	Yes	String	Carriers Code of the entity	CarriersCode is mandatory Invalid CarriersCode
MatchType	No	String	Match Type of the entity
OrderItems	No	List of InterfaceOrderItem object	Check data type InterfaceOrderItem for details
ReceivingStatus	No	String	Receiving Status of the entity
BlanketStartDate	No	DateTime	Blanket Start Date of the entity
BlanketEndDate	No	DateTime	Blanket End Date of the entity
RevisionNumber	No	String	Revision Number of the entity	If Operation is update or historical: Invalid OrderVersion value It has negative or zero OrderVersion value (not in case of historical) OrderVersion value is more than three digits There was an error in processing the order as an old order revision number is greater than or equal to current revision number
BlanketDocumentNumber	No	String	Blanket Document Number of the entity
TransmissionMode	No	String
BuyerVatNumber	No	String	Buyer Vat Number of the entity
PurchaseTypeDescription	No	String	Purchase Type Description of the entity
IsPcardSupportedForOrder	No	Boolean
Billable	No	Boolean
SourceSystemName	No	String	Source System Name of the entity
ItemTotalAmount	No	Decimal	Item Total Amount of the entity
Tax	No	Decimal	Tax of the entity
Shipping	No	Decimal	Shipping of the entity
AdditionalCharges	No	Decimal	Additional Charges of the entity
TotalAmount	No	Decimal	Total Amount of the entity
TaxesAndCharges	No	List of TaxesAndCharges object	Check data type TaxesAndCharges for details
Comments	No	List of InterfaceComment object	Check data type InterfaceComment for details
WorkOrderNumber	No	String	Work Order Number of the entity
ErpOrderType	No	Int	ERP Order Type of the entity
BudgetDescription	No	String	Budget Description of the entity
CustomAttributes	No	List of CustomAttributes object	Check data type CustomAttributes for details
FobCodeDescription	No	String	Fob Code Description of the entity
FobLocationDescription	No	String	Fob Location Description of the entity
CarriersDescription	No	String	Carriers Description of the entity
TransitTypeDescription	No	String	Transit Type Description of the entity
FreightTermsDescription	No	String	Freight Terms Description of the entity
Ers	No	Boolean
isUrgent	No	Boolean
ShipToLocation	No	List of InterfaceLocation object	Check data type InterfaceLocation for details
DeliverToLocation	No	List of InterfaceLocation object	Check data type InterfaceLocation for details

InterfaceDocument
Property	Required?	Data type	Description	Validations / Exceptions
DocumentName		String	Document Name of the entity.
DocumentNumber	Yes	String	Document Number of the entity.	order Number is mandatory
DocumentStatus	Yes	String	Document Status of the entity
DocumentCreator	Yes	String	Document Creator of the entity
CreatedOn	Yes	String	Created On of the entity	Order Date is mandatory Order Date cannot be greater that current date
DocumentLobDetails	Yes	List of InterfaceOrgEntity object	Check data type InterfaceOrgEntity for details
OperationName	Yes	String	Operation Name of the entity.

SupplierDetails
Property	Required?	Data type	Description	Validations / Exceptions
clientPartnerCode	Yes	String	ClientPartnerCode of the entity
orderingLocation		String	OrderingLocation of the entity
supplierContact		Type of InterfaceContact	SupplierContact of the entity
paymentTermCode	Yes	String	Payment Term Code of the entity	Payment term is mandatory (if OrderSource is not ChangeOrder)

InterfaceContact
Property	Required?	Data type	Description	Validations / Exceptions
clientContactCode		String	ClientPartnerCode of an entity
emailAddress		String	The email address of the buyer
firstName		String	FirstName of the buyer
lastName		String	LastName of the entity

OrderItems
Property	Required?	Data type	Description	Validations/Exceptions
ItemLineNumber	Yes	Long	Item Line Number of the entity	Order Line Number is mandatory Order Line Number for Item No: is not a unique Order Line Number length is greater than 9 digits for Item No
Quantity	YES	Decimal	Quantity of the entity	Quantity is mandatory for Item No. There was an error in processing the order as Quantity Sign cannot be changed for Line Item Number item(s). Quantity must be 1 for Fixed Service Item No Quantity cannot be zero Quantity cannot be negative for Item No
UOM	YES	String	UOM of the entity	UOM is mandatory for Item No. There was an error in processing the order as the item(s) has invalid UOM code
StartDate	Yes	DateTime	Start Date of the entity	Start date is mandatory for Service Item No
EndDate	Yes	DateTime	End Date of the entity	End date is mandatory for Service Item No End date for Item No: cannot be less than the start date
DateNeeded	Yes	DateTime	Date Needed of the entity	Requested delivery date is mandatory for Item No
ItemSplitsDetail	No	List of itemSplitsDetail object	Check data type ItemSplitsDetail for details
Requestor	No	String	Requestor of the entity
RequisitionNumber	No	String	RequisitionNumber of the entity
IsCloseForReceiving	No	Boolean	IsCloseForReceiving of the entity	Is Closed for receiving value must have false in new order
IsCloseForInvoicing	No	Boolean	IsCloseForInvoicing of the entity	Is Closed for receiving value must have false in new order There was an error in processing the order as the item(s) is already closed for CFI OR CFR
LstStandardAndProcedureDetails	No	List of LstStandardAndProcedureDetails object	Check data type LstStandardAndProcedureDetails for details
ReqItemLineNumber	No	Long	ReqItemLine Number of the entity
ContingentWorkerName	No	String	Contingent Worker Name of the entity
LobTitleName	No	String	Job Title Name of the entity
RequestorEmailAddress	No	String	Requestor Email Address of the entity
Description	No	String	Description of the entity
UnitPrice	No	Decimal	Unit Price of the entity	Unit Price cannot be negative for Item No There was an error in processing the order as Unit Price Sign cannot be changed for Line Item Number item(s)
Currency	No	String	Currency of the entity
ManufacturerName	No	String	Manufacturer Name of the entity
ManufacturerPartNumber	No	String	Manufacturer Part Number of the entity
ItemType	No	String	ItemType of the entity	Item type must be Material or Service or Charge
ItemExtendedType	No	String	ItemExtendedType of the entity	Item Extended Type for Service items must be Fixed or Variable
DocumentItemShippingDetails	No	List of InterfaceDocumentItemShippingDetail object	Check data type InterfaceDocumentItemShippingDetail for details
AdditionalCharges	No	Decimal	Additional Charges of the entity	Additional Charges for Item No: cannot be negative
ShippingCharges	No	Decimal	Shipping Charges of the entity	Shipping Charges is not a valid decimal value for Item No Shipping Charges are not applicable for Service Items. Item No Shipping Charges for Item No cannot be negative
Tax	No	Decimal	Tax of the entity	Tax for Item No: cannot be negative
IsTaxExempt	No	Boolean
DateRequested	No	DateTime	Date Requested of the entity
ItemStatus	No	String	Item Status of the entity
CategoryName	No	String	Category Name of the entity
ItemTotalAmount	No	Decimal	Item Total Amount of the entity
UNSPSC	No	Decimal	UNSPSC of the entity
ItemNumber	No	String	Item Number of the entity	There was an error in processing the order as the item(s) has invalid Item number
SupplierPartId	No	String	Supplier Part Id of the entity
SupplierPartAuxiliaryId	No	String	Supplier Part Auxiliary Id of the entity	There was an error in processing the order as the item(s) has invalid Supplier Id There was an error in processing the order as the item(s) do not have same Supplier Id as the original order There was an error in processing the order as it has multiple supplier
Taxes	No	List of TaxesAndCharge object	Check data type TaxesAndCharge for details
Comments	No	List of InterfaceComment object	Check data type InterfaceComment for details
ContractNo	No	String	Contract No of the entity
ClientCategoryId	No	String	Client Category Id of the entity	There was an error in processing the order as the item(s) has invalid Category ID There was an error in processing the order as it has multiple Location Code
CapitalCode	No	String	Capital Code of the entity
MatchType	No	String	Match Type of the entity
RecoupmentPercentage	No	Long	Recoupment Percentage of the entity
ManufacturerSupplierCode	No	String	Manufacturer Supplier Code of the entity
ManufacturerModel	No	String	Manufacturer Model of the entity
CustomAttributes	No	List of CustomAttributes object	Check data type CustomAttributes for details
OverallItemLimit	No	Decimal	Overall Item Limit of the entity	Overall Limit for line item No. should be greater than or equal to the line item total
PromisedDate	No	DateTime	Promised Date of the entity
AdditionalFieldAttributes	No	List of InterfaceP2PAdditionalFieldAtrribute object	Check data type InterfaceP2PAdditionalFieldAtrribute for details
FobCode	Yes	String	Fob Code of the entity	FOBCode is mandatory Invalid FOBCode
FobLocationCode	Yes	String	Fob Location Code of the entity	FOBLocationCode is mandatory Invalid FOBLocationCode
FobCodeDescription	No	String	Fob Code Description of the entity
FobLocationDescription	No	String	Fob Location Description of the entity

ItemSplitsDetail
Property	Required?	Data type	Description	Validations/Exceptions
DocumentSplitItemEntities	No	List of InterfaceDocumentSplitItemEntity object	Check data type InterfaceDocumentSplitItemEntity for details
InterfaceDocumentSplitItems	No	Type of InterfaceDocumentSplitItems	Check data type InterfaceDocumentSplitItems for details
RequestorEmailAddress	No	String	RequestorEmailAddress of the entity

InterfaceDocumentSplitItems
Property	Required?	Data type	Description	Validations/Exceptions
SplitItemTotal	No	Decimal	Split Item Total of the entity
CustomAttributes	No	List of CustomAttributes object	Check data type CustomAttributes for details
SplitType	No	String	Split Type of the entity
Quantity	No	Decimal	Quantity of the entity
Percentage	No	Decimal	Percentage of the entity

DocumentSplitItemEntities
Property	Required?	Data type	Description	Validations/Exceptions
EntityType	No	String	Entity Type of the entity	There was an error in processing the order as the item(s) has invalid Accounting Entity Type There was an error in processing the order as the item(s) missing mandatory accounting value Line Level and Header Level has different accounting details value
EntityCode	No	String	Entity Code of the entity	There was an error in processing the order as the item(s) does not have accounting entity code. Invalid accounting entity codes
EntityDisplayName	No	String	Entity Display Name of the entity

CustomAttributes
Property	Required?	Data type	Description	Validations/Exceptions
QuestionnaireTitle	No	Decimal	Questionnaire Title of the entity	Custom Fields Key text is empty at header
QuestionnaireResponseValues	No	List of questionnaireResponseValues object	Check data type QuestionnaireResponseValues for details

QuestionnaireResponseValues
Property	Required?	Data type	Description	Validations/Exceptions
ChildQuestionSets	No
ColumnText	No	String		Custom fields key-value's column text is missing at header
ResponseValue	No	String
RowId	No	String	Row Id of the entity	Custom fields key-value's row is missing at header

DocumentItemShippingDetails
Property	Required?	Data type	Description	Validations/Exceptions
ShipToLocation	No	List of interfacelocation object	Check data type interfacelocation for details	There was an error in processing the order as the item(s) ShipToLocation and LOB mapping is not valid ShipToLocation, LOB and header level mapping is not valid ShipToLocation and header level mapping is not valid ShipToLocation and LOB mapping is not valid
DeliverToLocation	No	List of interfacelocation object	Check data type interfacelocation for details
shippingMethod	No	String	Entity Display Name of the entity	There was an error in processing the order as the item(s) has invalid Shipping Method There was an error in processing the order as the item(s) Shipping Method and LOB mapping is not valid Shipping Method having LOB and access control entity mapping is not valid

InterfaceLocation
Property	Required?	Data type	Description	Validations / Exceptions
LocationName	Yes	String	Name of the location from where the order is placed.	LocationName
LocationNumber	Yes	String	LocationNumber	LocationNumber
Address	Yes	String	Address	Address
RegistrationDetails	Yes	String	RegistrationDetails	RegistrationDetails

Address
Property	Required?	Data type	Description	Validations / Exceptions
AddressLine1	Yes	String	Address line 1 of the entity
AddressLine2		String	Address line 2 of the entity
AddressLine3		String	Address line 3 of the entity
City	Yes	String	City of the entity
ZipCode	Yes	String	Zip code of the entity
StateInfo	Yes	List of StateInfo object	Check data type StateInfo for details
CountryInfo	Yes	List of CountryInfo object	Check data type CountryInfo for details
PhoneNo1		String	PhoneNo1 of the entity
ExtenstionNo1		String	ExtenstionNo1 of the entity
PhoneNo2		String	PhoneNo2 of the entity
ExtenstionNo2		String	ExtenstionNo2 of the entity
MobileNo		String	MobileNo of the entity
FaxNo		String	FaxNo of the entity
County		String	County of the entity
PoBoxNumber		String	PoBoxNumber of the entity

StateInfo
Property	Required?	Data type	Description	Validations / Exceptions
StateAbbrevationCode	Yes	String	State Abbreviation Code of the entity	Invalid state code
StateName		String	State Name of the entity

CountryInfo
Property	Required?	Data type	Description	Validations / Exceptions
CountryCode	Yes	String	Country Code of the entity
CountryName		String	Country Name of the entity

PartnerWiseIdentificationDetail
Property	Required?	Data type	Description	Validations / Exceptions
CompanyIdentificationDisplayName		String	Company Identification Display Name of the entity
CompanyIdentification		String	Company Identification of the entity

Comments
Property	Required?	Data type	Description	Validations / Exceptions
CommentText		String	Comment Text of the entity
CommentAttachment		List of InterfaceCommentAttachment object	Check data type InterfaceCommentAttachment for details
AccessType		String	Access type of the entity

CommentAttachment
Property	Required?	Data type	Description	Validations / Exceptions
FileName		String	FileName of the entity
FileUri		String	FileUri of the entity
Extension		String	Extenstion of the entity
ContentTransferEncoding		String	ContentTransferEncoding of the entity
AttachmentData		String	AttachmentData of the query

AdditionalFieldAttributes
Property	Required?	Data type	Description	Validations/Exceptions
AdditionalFieldValue	No	String	Additional Field Value of the entity
AdditionalFieldCode	No	String	Additional Field Code of the entity
AdditionalFieldName	No	String	Additional Field Name of the entity

TaxesAndCharges
Property	Required?	Data type	Description	Validations/Exceptions
TaxDescription	No	String	Tax Description of the entity
TaxMode	No	String	Tax Mode of the entity
TaxValue	No	Decimal	Tax Value of the entity	There was an error in processing the order as Line Item Level Tax is not matching with Sub Tax
TaxPercentage	No	Decimal	Tax Percentage of the entity
TaxCode	No	String	Tax Code of the entity	There was an error in processing the order as following line item(s) has invalid Tax Codes There was an error in processing the order as following line item(s) has duplicate Tax Codes There was an error in processing the order as given tax code is not mapped with LOB for following line items
IsAccrueTax	No	Boolean	IsAccrueTax of the entity
TaxType		String	Tax Type of the Entity

FileDetail
Property	Required?	Data type	Description	Validations / Exceptions
FileName		String	File Name of the entity
FileUri		String	File Uri of the entity
AttachmentData		String	File Attachment Data of the entity

InterfaceOrgEntity
Property	Required?	Data type	Description	Validations / Exceptions
EntityCode	Yes	String	Entity Code of the entity
EntityType		String	Entity Type