CreateRequisition (POST)

Overview

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

 

URL Format:   https://<Instance>/smartInterfaceAPI/api/requisition/requisitionDetails

Request
{
   "basicDetails": 
   {
      "documentName": "string",
      "documentNumber": "string",
      "documentStatus": "string",
      "documentCreator": "string",
      "createdOn": "string",
      "documentLobDetails": 
      [         
         {
            "entityCode": "string",
            "entityType": "string"
         }
      ],
      "operationName": "string"
   },
   "isUrgent": true,
   "totalAmount": 0,
   "currency": "string",
   "tax": 0,
   "shipping": 0,
   "additionalCharges": 0,
   "customAttributes": 
   [      
      {
         "questionnaireTitle": "string",
         "questionnaireResponseValues": 
         [            
            {
               "childQuestionSets": 
               [
                  null
               ],
               "columnText": "string",
               "responseValue": "string",
               "rowId": "string"
            }
         ]
      }
   ],
   "headerEntities": 
   [      
      {
         "entityCode": "string",
         "entityType": "string"
      }
   ],
   "comments": 
   [      
      {
         "commentText": "string",
         "accessType": "string",
         "commentAttachment": 
         [            
            {
               "fileName": "string",
               "fileUri": "string",
               "extension": "string",
               "contentTransferEncoding": "string",
               "attachmentData": "string"
            }
         ]
      }
   ],
   "fobCode": "string",
   "fobLocationCode": "string",
   "freightTermsCode": "string",
   "transitTypeCode": "string",
   "carriersCode": "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",
      "registrationDetails": 
      [         
         {
            "companyIdentificationDisplayName": "string",
            "companyIdentification": "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"
         }
      ]
   },
   "purchaseTypeDescription": "string",
   "billable": true,
   "sourceSystemName": "string",
   "requesterId": "string",
   "attachments": 
   [      
      {
         "fileName": "string",
         "fileUri": "string",
         "extension": "string",
         "contentTransferEncoding": "string",
         "attachmentData": "string"
      }
   ],
   "requisitionItems": 
   [      
      {
         "itemLineNumber": 0,
         "uom": "string",
         "quantity": 0,
         "unitPrice": 0,
         "description": "string",
         "dateNeeded": "2020-07-09T10:28:42.014Z",
         "clientPartnerCode": "string",
         "clientContactCode": "string",
         "contractNumber": "string",
         "orderLocationName": "string",
         "orderLocationCode": "string",
         "procurementStatus": "string",
         "inventoryType": true,
         "fobCode": "string",
         "fobLocationCode": "string",
         "startDate": "2020-07-09T10:28:42.014Z",
         "endDate": "2020-07-09T10:28:42.014Z",
         "buyerItemNumber": "string",
         "itemType": "string",
         "itemExtendedType": "string",
         "additionalCharges": 0,
         "customAttributes": 
         [            
            {
               "questionnaireTitle": "string",
               "questionnaireResponseValues": 
               [                  
                  {
                     "childQuestionSets": 
                     [
                        null
                     ],
                     "columnText": "string",
                     "responseValue": "string",
                     "rowId": "string"
                  }
               ]
            }
         ],
         "additionalFieldAttributes": 
         [            
            {
               "additionalFieldValue": "string",
               "additionalFieldCode": "string",
               "additionalFieldName": "string"
            }
         ],
         "clientCategoryId": "string",
         "manufacturers": 
         [            
            {
               "manufacturerModel": "string",
               "manufacturerName": "string",
               "manufacturerPartNumber": "string",
               "manufacturerSupplierCode": "string"
            }
         ],
         "supplierPartAuxiliaryId": "string",
         "supplierPartId": "string",
         "sourceSystemInformation": 
         [            
            {
               "name": "string",
               "value": "string"
            }
         ],
         "unspsc": 0,
         "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",
                  "registrationDetails": 
                  [                     
                     {
                        "companyIdentificationDisplayName": "string",
                        "companyIdentification": "string"
                     }
                  ]
               },
               "shippingMethod": "string"
            }
         ],
         "tax": 0,
         "taxes": 
         [            
            {
               "taxDescription": "string",
               "taxType": "string",
               "taxMode": "string",
               "taxValue": 0,
               "taxPercentage": 0,
               "taxCode": "string",
               "isAccrueTax": true
            }
         ],
         "shippingCharges": 0,
         "comments": 
         [            
            {
               "commentText": "string",
               "accessType": "string",
               "commentAttachment": 
               [                  
                  {
                     "fileName": "string",
                     "fileUri": "string",
                     "extension": "string",
                     "contentTransferEncoding": "string",
                     "attachmentData": "string"
                  }
               ]
            }
         ],
         "partnerSourceSystemValue": "string",
         "itemSplitsDetail": 
         [            
            {
               "documentSplitItemEntities": 
               [                  
                  {
                     "entityType": "string",
                     "entityCode": "string",
                     "entityDisplayName": "string"
                  }
               ],
               "splitItemTotal": 0,
               "customAttributes": 
               [                  
                  {
                     "questionnaireTitle": "string",
                     "questionnaireResponseValues": 
                     [                        
                        {
                           "childQuestionSets": 
                           [
                              null
                           ],
                           "columnText": "string",
                           "responseValue": "string",
                           "rowId": "string"
                        }
                     ]
                  }
               ],
               "splitType": "string",
               "quantity": 0,
               "percentage": 0
            }
         ],
         "itemSource": "string"
      }
   ],
   "buyingChannel": "string",
   "oboClientContactCode": "string",
   "additionalFieldAttributes": 
   [      
      {
         "additionalFieldValue": "string",
         "additionalFieldCode": "string",
         "additionalFieldName": "string"
      }
   ]
}

 

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": "Ketan_Req_25022020_02",
      "documentNumber": "Ketan_Req_25022020_02",
      "documentStatus": "ApprovalPending",
      "documentDescription": "",
      "documentCreator": "USKKLM11",
      "createdOn": "2020-02-25",
      "documentBu": [],
      "documentLobDetails": 
      [         
         {
            "entityCode": "KNA-SAP"
         }
      ],
      "operationName": "new"
   },
   "isUrgent": true,
   "totalAmount": 50000,
   "currency": "USD",
   "tax": 0,
   "shipping": 0,
   "additionalCharges": 0,
   "customAttributes": [],
   "headerEntities": 
   [      
      {
         "entityCode": "NUNA|0100|998"
      }
   ],
   "comments": 
   [      
      {
         "commentText": "TEST Header comments1 - START - TEST Header - END"
      }
   ],
   "fobCode": "",
   "fobLocationCode": "",
   "freightTermsCode": "",
   "transitTypeCode": "",
   "carriersCode": "",
   "requisitionItems": 
   [      
      {
         "itemType": "",
         "itemExtendedType": "",
         "itemLineNumber": 1,
         "uom": "EA",
         "quantity": 10,
         "unitPrice": 5000,
         "dateNeeded": "2020-02-12T10:38:01.623Z",
         "clientPartnerCode": "0080005790",
         "clientContactCode": "USKKLM11",
         "orderLocationName": "",
         "startDate": "2020-02-12T10:38:01.623Z",
         "endDate": "2020-02-12T10:38:01.623Z",
         "buyerItemNumber": "1",
         "additionalCharges": 0,
         "customAttributes": [],
         "additionalFieldAttributes": 
         [            
            {
               "additionalFieldValue": "",
               "additionalFieldCode": "",
               "additionalFieldName": ""
            }
         ],
         "clientCategoryId": "476350000466",
         "manufacturers": 
         [            
            {
               "manufacturerModel": "",
               "manufacturerName": "COGNEX",
               "manufacturerPartNumber": "DMR-362X-0000",
               "manufacturerSupplierCode": ""
            }
         ],
         "description": "Glass Phone",
         "supplierPartAuxiliaryId": "",
         "supplierPartId": "",
         "unspsc": 0,
         "documentItemShippingDetails": 
         [            
            {
               "shiptoLocation": 
               {
                  "locationName": "",
                  "locationNumber": "0000023145",
                  "address": 
                  {
                     "addressline1": "",
                     "addressline2": "",
                     "addressline3": "",
                     "city": "",
                     "zipCode": "",
                     "stateInfo": 
                     {
                        "stateAbbrevationCode": "",
                        "stateName": ""
                     },
                     "countryInfo": 
                     {
                        "countryCode": "",
                        "countryName": ""
                     }
                  }
               },
               "delivertoLocation": 
               {
                  "locationName": "",
                  "locationNumber": "",
                  "address": 
                  {
                     "addressline1": "",
                     "addressline2": "",
                     "addressline3": "",
                     "city": "",
                     "zipCode": "",
                     "stateInfo": 
                     {
                        "stateAbbrevationCode": "",
                        "stateName": ""
                     },
                     "countryInfo": 
                     {
                        "countryCode": "",
                        "countryName": ""
                     }
                  }
               },
               "shippingMethod": ""
            }
         ],
         "tax": 0,
         "taxes": 
         [            
            {
               "taxDescription": "",
               "taxMode": "",
               "taxValue": 0,
               "taxPercentage": 0,
               "taxCode": "",
               "isAccrueTax": true,
               "defaultCurrencyCode": ""
            }
         ],
         "shippingCharges": 0,
         "comments": 
         [            
            {
               "commentText": "TEST Line comments1 - START - TEST Line - END"
            }
         ],
         "partnerSourceSystemValue": "",
         "itemSplitsDetail": 
         [            
            {
               "documentSplitItemEntities": 
               [                  
                  {
                     "entityType": "Item Category",
                     "entityCode": "Blank",
                     "entityDisplayName": "Standard"
                  },                  
                  {
                     "entityType": "Plant",
                     "entityCode": "0313",
                     "entityDisplayName": "string"
                  },                  
                  {
                     "entityType": "Account Assignment",
                     "entityCode": "N",
                     "entityDisplayName": "Network"
                  },                  
                  {
                     "entityType": "Purchasing Org",
                     "entityCode": "0100",
                     "entityDisplayName": "NA Indirect"
                  },                  
                  {
                     "entityType": "Purchasing Group",
                     "entityCode": "998",
                     "entityDisplayName": "Capital Equipment"
                  },                  
                  {
                     "entityType": "Material Group Level 1",
                     "entityCode": "--",
                     "entityDisplayName": ""
                  },                  
                  {
                     "entityType": "Material Group Level 2",
                     "entityCode": "--",
                     "entityDisplayName": ""
                  },                  
                  {
                     "entityType": "Material Group Level 3",
                     "entityCode": "600574005",
                     "entityDisplayName": ""
                  },                  
                  {
                     "entityType": "GL Code",
                     "entityCode": "6280100000",
                     "entityDisplayName": ""
                  },                  
                  {
                     "entityType": "Network",
                     "entityCode": "A-16-01400-1|0030",
                     "entityDisplayName": ""
                  }
               ],
               "splitItemTotal": 0,
               "customAttributes": [],
               "splitType": "",
               "name": "string",
               "quantity": 0,
               "percentage": 0
            }
         ]
      }
   ],
   "shiptoLocation": 
   {
      "locationName": "",
      "locationNumber": "0000023145",
      "address": 
      {
         "addressline1": "",
         "addressline2": "",
         "addressline3": "",
         "city": "",
         "zipCode": "",
         "stateInfo": 
         {
            "stateAbbrevationCode": "",
            "stateName": ""
         },
         "countryInfo": 
         {
            "countryCode": "",
            "countryName": ""
         }
      }
   },
   "delivertoLocation": 
   {
      "locationName": "",
      "locationNumber": "",
      "address": 
      {
         "addressline1": "",
         "addressline2": "",
         "addressline3": "",
         "city": "",
         "zipCode": "",
         "stateInfo": 
         {
            "stateAbbrevationCode": "",
            "stateName": ""
         },
         "countryInfo": 
         {
            "countryCode": "",
            "countryName": ""
         }
      }
   },
   "billtoLocation": 
   {
      "locationName": "",
      "locationNumber": "NUNA",
      "address": 
      {
         "addressline1": "",
         "addressline2": "",
         "addressline3": "",
         "city": "",
         "zipCode": "",
         "stateInfo": 
         {
            "stateAbbrevationCode": "",
            "stateName": ""
         },
         "countryInfo": 
         {
            "countryCode": "",
            "countryName": ""
         }
      }
   },
   "purchaseTypeDescription": "",
   "billable": true,
   "sourceSystemName": "KNA-SAP",
   "requesterId": ""
}

Success Scenario - Response

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

Error Scenerio - Request

{
   "BasicDetails": 
   {
      "documentName": "Ketan_Req_25022020_02",
      "documentNumber": "Ketan_Req_25022020_02",
      "documentStatus": "ApprovalPending",
      "documentDescription": "",
      "documentCreator": "USKKLM11",
      "createdOn": "2020-02-25",
      "documentBu": [],
      "documentLobDetails": 
      [         
         {
            "entityCode": "KNA-SAP"
         }
      ],
      "operationName": "new"
   },
   "isUrgent": true,
   "totalAmount": 50000,
   "currency": "",
   "tax": 0,
   "shipping": 0,
   "additionalCharges": 0,
   "customAttributes": [],
   "headerEntities": 
   [      
      {
         "entityCode": "NUNA|0100|998"
      }
   ],
   "comments": 
   [      
      {
         "commentText": "TEST Header comments1 - START - TEST Header - END"
      }
   ],
   "fobCode": "",
   "fobLocationCode": "",
   "freightTermsCode": "",
   "transitTypeCode": "",
   "carriersCode": "",
   "requisitionItems": 
   [      
      {
         "itemType": "",
         "itemExtendedType": "",
         "itemLineNumber": 1,
         "uom": "EA",
         "quantity": 10,
         "unitPrice": 5000,
         "dateNeeded": "2020-02-12T10:38:01.623Z",
         "clientPartnerCode": "0080005790",
         "clientContactCode": "USKKLM11",
         "orderLocationName": "",
         "startDate": "2020-02-12T10:38:01.623Z",
         "endDate": "2020-02-12T10:38:01.623Z",
         "buyerItemNumber": "1",
         "additionalCharges": 0,
         "customAttributes": [],
         "additionalFieldAttributes": 
         [            
            {
               "additionalFieldValue": "",
               "additionalFieldCode": "",
               "additionalFieldName": ""
            }
         ],
         "clientCategoryId": "476350000466",
         "manufacturers": 
         [            
            {
               "manufacturerModel": "",
               "manufacturerName": "COGNEX",
               "manufacturerPartNumber": "DMR-362X-0000",
               "manufacturerSupplierCode": ""
            }
         ],
         "description": "Glass Phone",
         "supplierPartAuxiliaryId": "",
         "supplierPartId": "",
         "unspsc": 0,
         "documentItemShippingDetails": 
         [            
            {
               "shiptoLocation": 
               {
                  "locationName": "",
                  "locationNumber": "0000023145",
                  "address": 
                  {
                     "addressline1": "",
                     "addressline2": "",
                     "addressline3": "",
                     "city": "",
                     "zipCode": "",
                     "stateInfo": 
                     {
                        "stateAbbrevationCode": "",
                        "stateName": ""
                     },
                     "countryInfo": 
                     {
                        "countryCode": "",
                        "countryName": ""
                     }
                  }
               },
               "delivertoLocation": 
               {
                  "locationName": "",
                  "locationNumber": "",
                  "address": 
                  {
                     "addressline1": "",
                     "addressline2": "",
                     "addressline3": "",
                     "city": "",
                     "zipCode": "",
                     "stateInfo": 
                     {
                        "stateAbbrevationCode": "",
                        "stateName": ""
                     },
                     "countryInfo": 
                     {
                        "countryCode": "",
                        "countryName": ""
                     }
                  }
               },
               "shippingMethod": ""
            }
         ],
         "tax": 0,
         "taxes": 
         [            
            {
               "taxDescription": "",
               "taxMode": "",
               "taxValue": 0,
               "taxPercentage": 0,
               "taxCode": "",
               "isAccrueTax": true,
               "defaultCurrencyCode": ""
            }
         ],
         "shippingCharges": 0,
         "comments": 
         [            
            {
               "commentText": "TEST Line comments1 - START - TEST Line - END"
            }
         ],
         "partnerSourceSystemValue": "",
         "itemSplitsDetail": 
         [            
            {
               "documentSplitItemEntities": 
               [                  
                  {
                     "entityType": "Item Category",
                     "entityCode": "Blank",
                     "entityDisplayName": "Standard"
                  },                  
                  {
                     "entityType": "Plant",
                     "entityCode": "0313",
                     "entityDisplayName": "string"
                  },                  
                  {
                     "entityType": "Account Assignment",
                     "entityCode": "N",
                     "entityDisplayName": "Network"
                  },                  
                  {
                     "entityType": "Purchasing Org",
                     "entityCode": "0100",
                     "entityDisplayName": "NA Indirect"
                  },                  
                  {
                     "entityType": "Purchasing Group",
                     "entityCode": "998",
                     "entityDisplayName": "Capital Equipment"
                  },                  
                  {
                     "entityType": "Material Group Level 1",
                     "entityCode": "--",
                     "entityDisplayName": ""
                  },                  
                  {
                     "entityType": "Material Group Level 2",
                     "entityCode": "--",
                     "entityDisplayName": ""
                  },                  
                  {
                     "entityType": "Material Group Level 3",
                     "entityCode": "600574005",
                     "entityDisplayName": ""
                  },                  
                  {
                     "entityType": "GL Code",
                     "entityCode": "6280100000",
                     "entityDisplayName": ""
                  },                  
                  {
                     "entityType": "Network",
                     "entityCode": "A-16-01400-1|0030",
                     "entityDisplayName": ""
                  }
               ],
               "splitItemTotal": 0,
               "customAttributes": [],
               "splitType": "",
               "name": "string",
               "quantity": 0,
               "percentage": 0
            }
         ]
      }
   ],
   "shiptoLocation": 
   {
      "locationName": "",
      "locationNumber": "0000023145",
      "address": 
      {
         "addressline1": "",
         "addressline2": "",
         "addressline3": "",
         "city": "",
         "zipCode": "",
         "stateInfo": 
         {
            "stateAbbrevationCode": "",
            "stateName": ""
         },
         "countryInfo": 
         {
            "countryCode": "",
            "countryName": ""
         }
      }
   },
   "delivertoLocation": 
   {
      "locationName": "",
      "locationNumber": "",
      "address": 
      {
         "addressline1": "",
         "addressline2": "",
         "addressline3": "",
         "city": "",
         "zipCode": "",
         "stateInfo": 
         {
            "stateAbbrevationCode": "",
            "stateName": ""
         },
         "countryInfo": 
         {
            "countryCode": "",
            "countryName": ""
         }
      }
   },
   "billtoLocation": 
   {
      "locationName": "",
      "locationNumber": "NUNA",
      "address": 
      {
         "addressline1": "",
         "addressline2": "",
         "addressline3": "",
         "city": "",
         "zipCode": "",
         "stateInfo": 
         {
            "stateAbbrevationCode": "",
            "stateName": ""
         },
         "countryInfo": 
         {
            "countryCode": "",
            "countryName": ""
         }
      }
   },
   "purchaseTypeDescription": "",
   "billable": true,
   "sourceSystemName": "KNA-SAP",
   "requesterId": ""
}

Error Scenerio - Response

{
   "data": null,
   "statusCode": "400",
   "errorDetails": 
   [      
      {
         "key": "Ketan_Req_25022020_02",
         "errors": 
         [            
            {
               "errorCode": "MandatoryField",
               "errorDescription": "There was an error in processing the Requisition as Currency is Mandatory for Total Amount"
            }
         ]
      }
   ],
   "successDetails": []
}

 

Data Elements

InterfaceRequisition

Property

Required?

Data type

Description

Validations / Exceptions

BasicDetails

Yes

Document object

Basic details of entity

  • BasicDetails is mandatory

isUrgent

 

Bool

   

RequesterId

 

String

RequesterId for Requisition details

  • Invalid Requester Id: ()

RequisitionItems

Yes

List of requisitionItems object

Check data type requisitionItems for details

  • There was an error in processing the requisition as an at least one-line item is mandatory

ShiptoLocation

 

List of InterfaceLocation object

Check data type InterfaceLocation for details

 

DelivertoLocation

 

List of InterfaceLocation object

Check data type InterfaceLocation for details

 

BilltoLocation

 

List of InterfaceLocation object

Check data type InterfaceLocation for details

 

PurchaseTypeDescription

 

String

purchaseTypeDescription for Requisition details

  • There was an error in processing the requisition as the Purchase type value () is invalid

Attachments

 

List of InterfaceCommentAttachment object

Check data type InterfaceCommentAttachment for details

 

Billable

 

Boolean

Billable of the entity

 

Currency

Yes

String

currency of the entity

  • Currency is mandatory for Total Amount

  • Currency is mandatory for Tax

Tax

Yes

Decimal

Tax of the entity

  • Tax () is not a valid decimal value

  • Tax () cannot be negative

  • Currency is mandatory for Shipping

Shipping

Yes

Decimal

Shipping of the entity

  • Shipping () is not a valid Decimal value

  • Shipping charges () cannot be negative

AdditionalCharges

Yes

Decimal

Additional Charges of the entity

  • Additional Charges () is not a valid decimal value

  • Additional Charges () cannot be negative

TotalAmount

 

Decimal

Total Amount of the entity

  • Total Amount () is not a valid decimal value

  • Total Amount () cannot be negative

Comments

 

List of InterfaceComment object

Check data type InterfaceComment for details

 

CustomAttributes

 

List of customAttributes object

Check data type customAttributes for details

 

FobCode

 

String

Fob Code of the entity

  • Invalid FOBCode

FobLocationCode

 

String

Fob Location Code of the entity

  • Invalid FOBLocationCode

FreightTermsCode

 

String

Freight Terms Code of the entity

  • Invalid FreightTermsCode

TransitTypeCode

 

String

Transit Type Code of the entity

  • Invalid TransitTypeCode

CarriersCode

 

String

Carriers Code of the entity

  • Invalid CarriersCode

headerEntities

 

List of InterfaceOrgEntity object

Contains headerentities

 

sourceSystemName

 

String

Source System Name

 

AdditionalFieldAttributues

 

List of InterfaceP2PAdditionalFieldAttribute object

Check data type InterfaceP2PAdditionalFieldAttribute for details

 

Document

Property

Required?

Data type

Description

Validations / Exceptions

DocumentName

 

String

Document Name of the entity

 

DocumentNumber

Yes

String

Document Number of the entity

  • Requisition Number is mandatory

DocumentStatus

Yes

String

Document Status of the entity

 

DocumentDescription

 

String

Document Description of the entity

 

DocumentCreator

Yes

String

Document Creator of the entity

  • BuyerUserId is mandatory

CreatedOn

Yes

String

Created on date

  • Requisition Date is mandatory

  • Date cannot be greater than current date

DocumentLobDetails

 

List of InterfaceOrgEntity object

Check data type InterfaceOrgEntity for details

 

OperationName

Yes

String

Operation Name of the entity

  • OperationName is missing

  • OperationName is invalid

RequisitionItems

Property

Required?

Data type

Description

Validations / Exceptions

ItemSplitsDetail

Yes

List of InterfaceRequisitionSplitItems object

Check data type InterfaceRequisitionSplitItems for details

 

ClientContactCode

Yes

String

ClientContactCode of the entity

 

PartnerSourceSystemValue

 

String

PartnerSourceSystemValue of the entity

 

ItemLineNumber

Yes

Decimal

ItemLineNumber of the entity

  • Requisition Line Number () for Item No: () is not a valid integer value

  • Requisition Line Number () for Item No: () is not a unique

  • Requisition Line Number () length is greater than 9 digits for Item No: ()

  • Requisition Line Number is mandatory

  • Item Line number is missing in some line item(s) ()

  • The requisition cannot be updated for Line Item Number

  • The requisition cannot be deleted for Line Item Number

OrderLocationName

 

String

OrderLocationName of the entity

  • Ordering location is mandatory and must not be blank for Item No

Description

Yes

String

Description of the entity

 

UnitPrice

Yes

Decimal

UnitPrice of the entity

  • Unit Price () for Item No: () is not a valid decimal value

  • 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)

Quantity

Yes

Decimal

Quantity of the entity

  • Quantity () for Item No: () is not a valid decimal value.

  • Quantity is mandatory for Item No: ()

  • Quantity () must be 1 for Fixed Service Item No: ()

  • Quantity () cannot be zero for Item No: ()

  • 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 requisition as UOM () is not supported by the Partner

Manufacturers

 

List Of Manufacturer object

   

ItemType

 

String

ItemType of the entity

  • Item type must be Material or Service

  • Item type cannot be empty for Line Level Charge Item No.

ItemExtendedType

 

String

ItemExtendedType of the entity

  • Item Extended type for Service items must be Fixed or Variable.

  • Item Extended type for Line Level Charge item () Cannot Empty.

DocumentItemShippingDetails

 

List of InterfaceDocumentItemShippingDetail object

Check data type InterfaceDocumentItemShippingDetail for details

 

StartDate

Yes

DateTime

StartDate of the entity

  • Start date () for Item No: () is not a valid DateTime value

  • Start date is mandatory for Service Item No:

EndDate

Yes

DateTime

EndDate of the entity

  • End date () for Item No: () is not a valid DateTime value

  • End date () for Item No: () cannot be less than Start date

  • End date is mandatory for Service Item No: ()

AdditionalCharges

Yes

Decimal

AdditionalCharges of the entity

  • Additional Charges () for Item No: () is not a valid decimal value

  • Additional Charges () for Item No: () cannot be negative

ShippingCharges

Yes

Decimal

ShippingCharges of the entity

  • Shipping Charges () are not applicable for Service Items. Item No: ()

  • Shipping charges () for Item No: () is not a valid decimal value

  • Shipping charges () for Item No: () cannot be negative

  • There was an error in processing the requisition as Header Level Shipping Charges are not applicable for Service Items

Tax

Yes

Decimal

Tax of the entity

  • Tax () for Item No: () is not a valid decimal value

  • Tax () for Item No: () cannot be negative

DateNeeded

Yes

DateTime

DateNeeded of the entity

 

Unspsc

 

Decimal

Unspsc of the entity

 

ClientPartnerCode

Yes

String

ClientPartnerCode of the entity

  • Supplier Id is blank and ordering location cannot be saved for Item No: ()

  • There was an error in processing the requisition as requisition item(s) () name is having invalid Supplier Id

buyerItemNumber

Yes

String

ItemNumber of the entity

There was an error in processing the requisition as the item(s) () has invalid Item number

SupplierPartId

 

String

SupplierPartId of the entity

 

SupplierPartAuxiliaryId

 

String

SupplierPartAuxiliaryId of the entity

 

Taxes

 

List of TaxesAndCharge object

Check data type TaxesAndCharge for details

 

Comments

 

List of InterfaceComment object

Check data type comments for details

 

ClientCategoryId

 

String

ClientCategoryId of the entity

  • There was an error in processing the requisition as the item(s) () has invalid Category id

CustomAttributes

 

List of customAttributes object

Check data type customAttributes for details

 

AdditionalFieldAttributues

 

List of InterfaceP2PAdditionalFieldAttribute object

Check data type InterfaceP2PAdditionalFieldAttribute for details

 

contractNumber

 

String

ContractNumber of entity

 

oboClientContactCode

 

String

oboClientContactCode of entity

 

buyingChannel

 

String

buyingChannel of entity

 

Manufacturer

Property

Required?

Data type

Description

Validations / Exceptions

ManufacturerName

 

String

ManufacturerName of the entity

 

ManufacturerPartNumber

 

String

ManufacturerPartNumber of the entity

 

ManufacturerSupplierCode

 

String

ManufacturerSupplierCode of the entity

 

ManufacturerModel

 

String

ManufacturerModel of the entity

 

RequisitionSplitItems

Property

Required?

Data type

Description

Validations / Exceptions

DocumentSplitItemEntities

 

List of InterfaceDocumentSplitItemEntity object

Check data type InterfaceDocumentSplitItemEntity for details

There was an error in processing the requisition as the item(s) () missing Mandatory Accounting Value

SplitItemTotal

 

Decimal

SplitItemTotal

  • Split total () for Item No: () is not a valid decimal value.

Split total () for Item No: () cannot be negative

CustomAttributes

 

List of customAttributes object

Check data type CustomAttributes for details

 

SplitType

 

String

Split Type of the entity

 

Name

 

String

Name of the entity

 

Quantity

 

Decimal

Quantity of the entity

 

Percentage

 

Decimal

Percentage of the entity

 

CreatedOn

 

DateTime

Created On of the entity

 

DocumentSplitItemEntities

Property

Required?

Data type

Description

Validations / Exceptions

EntityType

 

String

Entity Type

  • It has duplicate Accounting entity for Item No: ()

There was an error in processing the requisition as the item(s) () has invalid Accounting entity type

EntityCode

Yes

String

Entity Code

  • There was an error in processing the requisition as Header level entity code () is invalid

  • There was an error in processing the requisition as All Header level entity code is mandatory

  • There was an error in processing the requisition as All Header level entity code Should Belong to One LOB

  • Line Level and Header Level has different Accounting Details value.

  • There was an error in processing the requisition as the item(s) () does not have Accounting entity code

  • There was an error in processing the requisition as the item(s) () has invalid Accounting entity code

EntityDisplayName

 

String

Entity Display Name

 

TaxesAndCharge

Property

Required?

Data type

Description

Validations / Exceptions

TaxDescription

 

String

TaxDescription of the entity

 

TaxMode

 

String

TaxMode of the entity

  • Invalid tax mode for Item No: ()

TaxValue

 

Decimal

TaxValue of the entity

 

TaxPercentage

 

Decimal

TaxPercentage of the entity

 

TaxCode

 

String

TaxCode of the entity

 

IsAccrueTax

 

Boolean

IsAccrueTax of the entity

 

DefaultCurrencyCode

 

String

DefaultCurrencyCode of the entity

 

DocumentItemShippingDetail

Property

Required?

Data type

Description

Validations / Exceptions

ShiptoLocation

 

List of InterfaceLocation object

Check data type InterfaceLocation for details

  • There was an error in processing the requisition as the item(s) () ShipToLocation and Header Level Mapping is not valid

DelivertoLocation

 

List of InterfaceLocation object

Check data type InterfaceLocation for details

 

ShippingMethod

 

String

ShippingMethod of the entity

  • There was an error in processing the requisition as the item(s) () has invalid Shipping method

  • There was an error in processing the requisition as the item(s) () Shipping method and LOB Mapping is not valid

  • There was an error in processing the requisition as the item(s) () Shipping method having LOB and access Control Entity Mapping is not valid

  • There was an error in processing the requisition as Ship to location having Invalid Lob Mapping

deliverTo

 

String

Deliverto of the entity

 

Location

Property

Required?

Data type

Description

Validations / Exceptions

LocationName

Yes

String

Location Name of the entity

 

LocationNumber

Yes

String

Location Number of the entity

  • Invalid Deliver to Location number at Header

  • Invalid Deliver to Location number at line level

Address

Yes

InterfaceAddress of object

Check data type InterfaceAddress for details

 

RegistrationDetails

 

Check data type PartnerWiseIdentificationDetail for details

 

deliverTo

 

String

Deliverto of the entity

 

IntefaceOrgEntity

Property

Required?

Data type

Description

Validations / Exceptions

EntityCode

Yes

String

Entity Code of the entity

 

IsDefault

 

Boolean

Created On of the entity

 

EntityType

 

String

EntityType

 

LobEntityCode

 

String

LobEntityCode of the entity

  • There was an error in processing the requisition as the LOB Value () is Invalid.

  • There was an error in processing the requisition as the LOB Value () is not mapped with Buyer User Id ()

  • There was an error in processing the requisition as the Requisition Header Entity and Contact Code Should mapped to Same LOB. ()

  • There was an error in processing the change requisition as LOB Value cannot be change.

  • There was an error in processing the requisition as Ship to location having Invalid OrgEntity and Lob Mapping

AdditionalFieldAttribute

Property

Required?

Data type

Description

Validations / Exceptions

AdditionalFieldValue

 

String

Additional Field Value of the entity

  • There was an error in processing the requisition as the item () have invalid Additional Field Value

AdditionalFieldCode

 

String

Additional Field Name of the entity

  • There was an error in processing the requisition as the item () have invalid Additional Field Code

AdditionalFieldName

 

String

Additional Field Name of the entity

  • There was an error in processing the requisition as the item () have invalid Additional Field name () AdditionalFieldName)

  • There was an error in processing the requisition as the item () have invalid header entity map to (AdditionalFieldName)

  • There was an error in processing the requisition as the item '() Parent AdditionalField was not sent for AdditionalField ( AdditionalFieldName)

QuestionnaireResponseValues

Property

Required?

Data type

Description

Validations / Exceptions

ChildQuestionSets

 

list of CustomAttribute object

   

ColumnText

 

String

   

ResponseValue

Yes

String

   

RowId

 

String

Row id of the entity

 

CustomAttributes

Property

Required?

Data type

Description

Validations / Exceptions

QuestionnaireTitle

 

Decimal

Questionnaire Title of the entity

 

QuestionnaireResponseValues

 

List of questionnaireResponseValues object

Check data type questionnaireResponseValues for details

 

CommentAttachment

Property

Required?

Data type

Description

Validations / Exceptions

FileName

 

String

Filename of the entity

 

FileUri

 

String

FileUri of the entity

 

AttachmentData

 

String

File AttachmentData of the entity

 

extension

 

String

File extension of the entity

 

contentTransferEncoding

 

String

File contentTransferEncoding of the entity

 

Comments

Property

Required?

Data type

Description

Validations / Exceptions

CommentText

 

String

Comment Text of the entity

 

CommentAttachment

 

List of commentAttachment object

Check data type CommentAttachment for details

 

AccessType

 

String

Access type 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

 

CountryInfo

Property

Required?

Data type

Description

Validations / Exceptions

CountryCode

Yes

String

Country Code of the entity

 

CountryName

 

String

Country Name 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

 

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

 

IsdCode

 

String

IsdCode of the entity

 

GeoCode

 

String

GeoCode of the entity

 

AreaCode

 

String

AreaCode of the entity

 

CreatedOn

 

DateTime

CreatedOn of the entity