GetPurchaseOrders (GET) | GEP TECH DOCUMENTATION

Overview

This GET API allows retrieval of Order details created in GEP SMART to post them into ERP.

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

Request

https://api-smartdev.gep.com/SmartInterfaceAPI/api/Order/GetPurchaseOrders

Response

{
   "data": {
      "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
               }
            ]
         }
      ]
   },
   "statusCode": "string",
   "errorDetails": [
      {
         "key": "string",
         "errors": [
            {
               "errorCode": "string",
               "errorDescription": "string"
            }
         ]
      }
   ],
   "successDetails": [
      {
         "key": "string"
      }
   ]
}

Examples

Success Scenario - Request

https://api-smartdev.gep.com/SmartInterfaceAPI/api/Order/GetPurchaseOrders

Success Scenario - Response

{
   "data": [
      {
         "basicDetails": {
            "documentName": "Order1 for AutoREQ_2020020500254yf",
            "documentNumber": "PerfAvgPO4800386534",
            "documentStatus": "SubmittedToPartner",
            "documentCreator": "USKJXK93",
            "createdOn": "2020-02-04T19:05:24.5670000+00:00",
            "documentLobDetails": [
               {
                  "entityCode": "KNA-SAP",
                  "entityType": null
               }
            ]
         },
         "orderSource": "RequisitionOrder",
         "shiptoLocation": {
            "locationName": "0001-Plant Mariemont ,OH",
            "locationNumber": "0000023617",
            "address": {
               "addressline1": "1 Trade ST",
               "addressline2": null,
               "addressline3": null,
               "city": "Mariemont",
               "zipCode": "45227-4509",
               "stateInfo": {
                  "stateAbbrevationCode": null,
                  "stateName": "OH"
               },
               "countryInfo": {
                  "countryCode": "US",
                  "countryName": "US"
               },
               "phoneNo1": null,
               "extenstionNo1": null,
               "phoneNo2": null,
               "extenstionNo2": null,
               "mobileNo": null,
               "faxNo": null,
               "county": null,
               "poBoxNumber": null
            },
            "registrationDetails": []
         },
         "delivertoLocation": {
            "locationName": null,
            "locationNumber": null,
            "address": null
         },
         "billtoLocation": {
            "locationName": "GBS Center",
            "locationNumber": "NUNA",
            "address": {
               "addressline1": "PO Box 8881011",
               "addressline2": null,
               "addressline3": null,
               "city": "Grand Rapids",
               "zipCode": "49588",
               "stateInfo": {
                  "stateAbbrevationCode": null,
                  "stateName": "MI"
               },
               "countryInfo": {
                  "countryCode": "US",
                  "countryName": null
               },
               "phoneNo1": null,
               "extenstionNo1": null,
               "phoneNo2": null,
               "extenstionNo2": null,
               "mobileNo": null,
               "faxNo": null,
               "county": null,
               "poBoxNumber": null
            },
            "registrationDetails": []
         },
         "supplierDetails": {
            "clientPartnerCode": null,
            "orderingLocation": "0080007742-0080007742",
            "supplierContact": null,
            "paymentTermCode": "NT30"
         },
         "orderContact": {
            "clientContactCode": null,
            "emailAddress": "123@gep.com",
            "firstName": "Buying",
            "lastName": "Helpdesk"
         },
         "headerEntities": [
            {
               "entityCode": "NUNA",
               "entityType": null
            },
            {
               "entityCode": "0100",
               "entityType": null
            },
            {
               "entityCode": "001",
               "entityType": null
            }
         ],
         "currency": "USD",
         "itemTotalAmount": 0,
         "tax": 0,
         "shipping": 0,
         "additionalCharges": 0,
         "totalAmount": 1100,
         "sourceSystemName": "KNA-SAP",
         "taxesAndCharges": [],
         "comments": [
            {
               "commentText": "",
               "accessType": null,
               "commentAttachment": []
            }
         ],
         "workOrderNumber": null,
         "erpOrderType": 0,
         "budgetDescription": null,
         "customAttributes": [],
         "fobCodeDescription": null,
         "fobLocationDescription": null,
         "carriersDescription": null,
         "transitTypeDescription": null,
         "freightTermsDescription": null,
         "fobCode": null,
         "fobLocationCode": null,
         "freightTermsCode": null,
         "transitTypeCode": null,
         "carriersCode": null,
         "isUrgent": false,
         "ers": false,
         "matchType": "ThreeWayMatch",
         "receivingStatus": null,
         "blanketStartDate": "0001-01-01T00:00:00",
         "blanketEndDate": "0001-01-01T00:00:00",
         "revisionNumber": "50241629",
         "blanketDocumentNumber": "",
         "transmissionMode": "CallAndSubmit",
         "buyerVATNumber": null,
         "purchaseTypeDescription": "Standard",
         "isPCardSupportedForOrder": false,
         "billable": false,
         "requisitionNumber": null,
         "attachments": [],
         "orderItems": [
            {
               "itemLineNumber": 1,
               "description": "Laptop",
               "unitPrice": 100,
               "quantity": 10,
               "uom": "EA",
               "manufacturerName": null,
               "manufacturerPartNumber": null,
               "itemType": "Material",
               "itemExtendedType": "Material",
               "sourceType": null,
               "documentItemShippingDetails": [
                  {
                     "shiptoLocation": {
                        "locationName": "0001-Plant Mariemont ,OH",
                        "locationNumber": "0000023617",
                        "address": {
                           "addressline1": "1 Trade ST",
                           "addressline2": null,
                           "addressline3": null,
                           "city": "Mariemont",
                           "zipCode": "45227-4509",
                           "stateInfo": {
                              "stateAbbrevationCode": null,
                              "stateName": "OH"
                           },
                           "countryInfo": {
                              "countryCode": "US",
                              "countryName": "true"
                           },
                           "phoneNo1": null,
                           "extenstionNo1": null,
                           "phoneNo2": null,
                           "extenstionNo2": null,
                           "mobileNo": null,
                           "faxNo": null,
                           "county": null,
                           "poBoxNumber": null
                        },
                        "registrationDetails": []
                     },
                     "delivertoLocation": null,
                     "shippingMethod": "Best Available"
                  }
               ],
               "startDate": "0001-01-01T00:00:00",
               "endDate": "0001-01-01T00:00:00",
               "additionalCharges": 0,
               "shippingCharges": 0,
               "tax": 0,
               "isTaxExempt": false,
               "dateRequested": "0001-01-01T00:00:00",
               "dateNeeded": "2020-02-15T17:30:00+05:30",
               "promisedDate": "0001-01-01T00:00:00",
               "itemStatus": "SubmittedToPartner",
               "itemTotalAmount": 1000,
               "unspsc": 0,
               "buyerItemNumber": null,
               "supplierPartId": "",
               "supplierPartAuxiliaryId": null,
               "taxes": [],
               "comments": [],
               "contractNo": null,
               "clientCategoryId": "476350000861",
               "capitalCode": null,
               "matchType": "ThreeWayMatch",
               "recoupmentPercentage": 0,
               "manufacturerSupplierCode": "",
               "manufacturerModel": "",
               "requestor": "USKJXK93",
               "requisitionNumber": "50241629",
               "isCloseForReceiving": false,
               "isCloseForInvoicing": false,
               "reqItemLineNumber": 1,
               "contingentWorkerName": null,
               "jobTitleName": null,
               "customAttributes": [],
               "overallItemLimit": 0,
               "AdditionalFieldAttributes": [],
               "itemSplitsDetail": [
                  {
                     "documentSplitItemEntities": [
                        {
                           "entityType": "Requester",
                           "entityCode": "USKJXK93",
                           "entityDisplayName": "Kellogg Admin Admin"
                        },
                        {
                           "entityType": "Business Region",
                           "entityCode": "KNA",
                           "entityDisplayName": "KNA"
                        },
                        {
                           "entityType": "Source System",
                           "entityCode": "KNA-SAP",
                           "entityDisplayName": "KNA-SAP"
                        },
                        {
                           "entityType": "Company Code",
                           "entityCode": "NUNA",
                           "entityDisplayName": "NUNA - Kellogg North America Com"
                        },
                        {
                           "entityType": "Purchasing Org",
                           "entityCode": "0100",
                           "entityDisplayName": "NA Indirect"
                        },
                        {
                           "entityType": "Purchasing Group",
                           "entityCode": "001",
                           "entityDisplayName": "RQT"
                        },
                        {
                           "entityType": "Account Assignment",
                           "entityCode": "K",
                           "entityDisplayName": "Cost center"
                        },
                        {
                           "entityType": "Item Category",
                           "entityCode": "Blank",
                           "entityDisplayName": "Standard"
                        },
                        {
                           "entityType": "Cost Center",
                           "entityCode": "0100020000",
                           "entityDisplayName": "KNA NUTRITION"
                        },
                        {
                           "entityType": "GL Code",
                           "entityCode": "6450100000",
                           "entityDisplayName": "Consulting Services"
                        },
                        {
                           "entityType": "Material Group Level 1",
                           "entityCode": "500",
                           "entityDisplayName": "CAPITAL MATERIALS - IT"
                        },
                        {
                           "entityType": "Material Group Level 2",
                           "entityCode": "5002000",
                           "entityDisplayName": "COMPUTER HARDWARE PURCHASE"
                        },
                        {
                           "entityType": "Material Group Level 3",
                           "entityCode": "500200025",
                           "entityDisplayName": "CORRUGATED PKG UP TO (NOT INCL) UNITIZER"
                        },
                        {
                           "entityType": "Plant",
                           "entityCode": "0201",
                           "entityDisplayName": "RQT - WKKI"
                        }
                     ],
                     "splitItemTotal": 1000,
                     "customAttributes": [],
                     "splitType": "Quantity",
                     "quantity": 10,
                     "percentage": 100
                  }
               ]
            },
            {
               "itemLineNumber": 2,
               "description": "Service",
               "unitPrice": 100,
               "quantity": 1,
               "uom": "EA",
               "manufacturerName": null,
               "manufacturerPartNumber": null,
               "itemType": "Service",
               "itemExtendedType": "Variable",
               "sourceType": null,
               "documentItemShippingDetails": [
                  {
                     "shiptoLocation": {
                        "locationName": "0001-Plant Mariemont ,OH",
                        "locationNumber": "0000023617",
                        "address": {
                           "addressline1": "1 Trade ST",
                           "addressline2": null,
                           "addressline3": null,
                           "city": "Mariemont",
                           "zipCode": "45227-4509",
                           "stateInfo": {
                              "stateAbbrevationCode": null,
                              "stateName": "OH"
                           },
                           "countryInfo": {
                              "countryCode": "US",
                              "countryName": "true"
                           },
                           "phoneNo1": null,
                           "extenstionNo1": null,
                           "phoneNo2": null,
                           "extenstionNo2": null,
                           "mobileNo": null,
                           "faxNo": null,
                           "county": null,
                           "poBoxNumber": null
                        },
                        "registrationDetails": []
                     },
                     "delivertoLocation": null,
                     "shippingMethod": null
                  }
               ],
               "startDate": "2020-02-05T17:30:00+05:30",
               "endDate": "2020-02-15T17:30:00+05:30",
               "additionalCharges": 0,
               "shippingCharges": 0,
               "tax": 0,
               "isTaxExempt": false,
               "dateRequested": "0001-01-01T00:00:00",
               "dateNeeded": "0001-01-01T00:00:00",
               "promisedDate": "0001-01-01T00:00:00",
               "itemStatus": "SubmittedToPartner",
               "itemTotalAmount": 100,
               "unspsc": 0,
               "buyerItemNumber": null,
               "supplierPartId": "",
               "supplierPartAuxiliaryId": null,
               "taxes": [],
               "comments": [],
               "contractNo": null,
               "clientCategoryId": "476350000868",
               "capitalCode": null,
               "matchType": "TwoWayMatch",
               "recoupmentPercentage": 0,
               "manufacturerSupplierCode": "",
               "manufacturerModel": "",
               "requestor": "USKJXK93",
               "requisitionNumber": "50241629",
               "isCloseForReceiving": false,
               "isCloseForInvoicing": false,
               "reqItemLineNumber": 2,
               "contingentWorkerName": null,
               "jobTitleName": null,
               "customAttributes": [],
               "overallItemLimit": 0,
               "AdditionalFieldAttributes": [],
               "itemSplitsDetail": [
                  {
                     "documentSplitItemEntities": [
                        {
                           "entityType": "Requester",
                           "entityCode": "USKJXK93",
                           "entityDisplayName": "Kellogg Admin Admin"
                        },
                        {
                           "entityType": "Business Region",
                           "entityCode": "KNA",
                           "entityDisplayName": "KNA"
                        },
                        {
                           "entityType": "Source System",
                           "entityCode": "KNA-SAP",
                           "entityDisplayName": "KNA-SAP"
                        },
                        {
                           "entityType": "Company Code",
                           "entityCode": "NUNA",
                           "entityDisplayName": "NUNA - Kellogg North America Com"
                        },
                        {
                           "entityType": "Purchasing Org",
                           "entityCode": "0100",
                           "entityDisplayName": "NA Indirect"
                        },
                        {
                           "entityType": "Purchasing Group",
                           "entityCode": "001",
                           "entityDisplayName": "RQT"
                        },
                        {
                           "entityType": "Account Assignment",
                           "entityCode": "K",
                           "entityDisplayName": "Cost center"
                        },
                        {
                           "entityType": "Item Category",
                           "entityCode": "Blank",
                           "entityDisplayName": "Standard"
                        },
                        {
                           "entityType": "Cost Center",
                           "entityCode": "0100020000",
                           "entityDisplayName": "KNA NUTRITION"
                        },
                        {
                           "entityType": "GL Code",
                           "entityCode": "6450100000",
                           "entityDisplayName": "Consulting Services"
                        },
                        {
                           "entityType": "Material Group Level 1",
                           "entityCode": "500",
                           "entityDisplayName": "CAPITAL MATERIALS - IT"
                        },
                        {
                           "entityType": "Material Group Level 2",
                           "entityCode": "5002000",
                           "entityDisplayName": "COMPUTER HARDWARE PURCHASE"
                        },
                        {
                           "entityType": "Material Group Level 3",
                           "entityCode": "500200025",
                           "entityDisplayName": "CORRUGATED PKG UP TO (NOT INCL) UNITIZER"
                        },
                        {
                           "entityType": "Plant",
                           "entityCode": "0201",
                           "entityDisplayName": "RQT - WKKI"
                        }
                     ],
                     "splitItemTotal": 100,
                     "customAttributes": [],
                     "splitType": "Quantity",
                     "quantity": 1,
                     "percentage": 100
                  }
               ]
            }
         ]
      }
   ],
   "statusCode": "200",
   "errorDetails": [],
   "successDetails": []
}

Data Elements

GetPurchaseOrders
Property	Required?	Data type	Description	Validations/Exceptions
Data		List of InterfaceOrder object	InterfaceOrder object
StatusCode		String	Status Code
ErrorDetails		List of Errordetails object	Error Details
SuccessDetails		List of Successdetails object	Success Details

Data
Property	Required?	Data type	Description	Validations/Exceptions
Order		List of InterfaceOrder object	Check data type InterfaceOrder for details

Order
Property	Required?	Data type	Description	Validations/Exceptions
BasicDetails	Yes	InterfaceDocument object
SupplierDetails	No	SupplierDetails object
OrderContact	No	List of InterfaceBuyerContact 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
BillToLocation	Yes	List of InterfaceLocation object	Check data type InterfaceLocation for details
Currency	Yes	String	Currency of the entity
FobCode	Yes	String	Fob Code of the entity
FobLocationCode	Yes	String	Fob Location Code of the entity
FreightTermsCode	Yes	String	Freight Terms Code of the entity
TransitTypeCode	Yes	String	Transit Type Code of the entity
CarriersCode	Yes	String	Carriers Code of the entity
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
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		String	Document Number of the entity
DocumentStatus		String	Document Status of the entity
DocumentCreator		String	Document Creator of the entity
CreatedOn		String	CreatedOn of the entity
DocumentLobDetails		List of InterfaceOrgEntity object	Check data type InterfaceOrgEntity for details
OperationName		String	Operation Name of the entity

SupplierDetails
Property	Required?	Data type	Description	Validations / Exceptions
clientPartnerCode		String	ClientPartnerCode of the entity
orderingLocation		String	OrderingLocation of the entity
supplierContact		InterfaceContact	SupplierContact of the entity
paymentTermCode		String	Payment Term Code of the entity

OrderItems
Property	Required?	Data type	Description	Validations/Exceptions
ItemLineNumber	Yes	Long	Item Line Number of the entity
Quantity	YES	Decimal	Quantity of the entity
UOM	YES	String	UOM of the entity
StartDate	Yes	DateTime	Start Date of the entity
EndDate	Yes	DateTime	End Date of the entity
DateNeeded	Yes	DateTime	Date Needed of the entity
ClientPartnerCode	Yes	String	Client Partner Code of the entity
ItemSplitsDetail	No	List of InterfaceOrderSplitItems object	Check data type InterfaceOrderSplitItems for details
Requestor	No	String	Requestor of the entity
RequisitionNumber	No	String	RequisitionNumber of the entity
IsCloseForReceiving	No	Boolean	IsCloseForReceiving of the entity
IsCloseForInvoicing	No	Boolean	IsCloseForInvoicing of the entity
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
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
ItemExtendedType	No	String	ItemExtendedType of the entity
DocumentItemShippingDetails	No	List of InterfaceDocumentItemShippingDetail object	Check data type InterfaceDocumentItemShippingDetail for details
AdditionalCharges	No	Decimal	Additional Charges of the entity
ShippingCharges	No	Decimal	Shipping Charges of the entity
Tax	No	Decimal	Tax of the entity
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
SupplierPartId	No	String	Supplier Part Id of the entity
SupplierPartAuxiliaryId	No	String	Supplier Part Auxiliary Id of the entity
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
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
PromisedDate	No	DateTime	Promised Date of the entity
AdditionalFieldAttributes	No	List of InterfaceP2PAdditionalFieldAtrribute object	Check data type InterfaceP2PAdditionalFieldAtrribute for details

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
EntityCode	No	String	Entity Code of the entity
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
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
ResponseValue	No	String
RowId	No	String	Row Id of the entity

DocumentItemShippingDetails
Property	Required?	Data type	Description	Validations/Exceptions
ShipToLocation	No	List of interfacelocation object	Check data type interfacelocation for details
DeliverToLocation	No	List of interfacelocation object	Check data type interfacelocation for details
shippingMethod	No	String	Entity Display Name of the entity

InterfaceLocation
Property	Required?	Data type	Description	Validations / Exceptions
LocationName		String	Location Name of the entity
LocationNumber		String	Location Number of the entity
Address		InterfaceAddress of object	Check data type InterfaceAddress for details
RegistrationDetails		List of PartnerWiseIdentificationDetail object	Check data type PartnerWiseIdentificationDetail for details

Address
Property	Required?	Data type	Description	Validations / Exceptions
AddressLine1		String	Address line 1 of the entity
AddressLine2		String	Address line 2 of the entity
AddressLine3		String	Address line 3 of the entity
City		String	City of the entity
ZipCode		String	Zip code of the entity
StateInfo		List of StateInfo object	Check data type StateInfo for details
CountryInfo		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		String	State Abbreviation Code of the entity
StateName		String	State Name of the entity

CountryInfo
Property	Required?	Data type	Description	Validations / Exceptions
CountryCode		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
TaxPercentage	No	Decimal	Tax Percentage of the entity
TaxCode	No	String	Tax Code of the entity
IsAccrueTax	No	Boolean	IsAccrueTax of the entity
TaxType	No	String	TaxType 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 AttachmentData of the entity

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

ErrorDetails
Property	Required?	Data type	Description	Validations/Exceptions
Key		String
Errors

Errors
Property	Required?	Data type	Description	Validations/Exceptions
ErrorCode		String
ErrorDescription		String

SuccessDetails
Property	Required?	Data type	Description	Validations/Exceptions
Key		String