This POST API allows pushing Requisition posted in ERP to GEP SMART for further processing.
URL Format: https://<Instance>/smartInterfaceAPI/api/requisition/requisitionDetails
Success Scenario - Request
Request below describes that this contains only the mandatory attributes.
Success Scenario - Response
Error Scenerio - Request
Error Scenerio - Response
InterfaceRequisition |
||||
Property |
Required? |
Data type |
Description |
Validations / Exceptions |
BasicDetails |
Yes |
Document object |
Basic details of entity |
|
isUrgent |
Bool |
|||
RequesterId |
String |
RequesterId for Requisition details |
|
|
Yes |
List of requisitionItems object |
Check data type requisitionItems for details |
|
|
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 |
|
|
Attachments |
List of InterfaceCommentAttachment object |
Check data type InterfaceCommentAttachment for details |
||
Billable |
Boolean |
Billable of the entity |
||
Currency |
Yes |
String |
currency of the entity |
|
Tax |
Yes |
Decimal |
Tax of the entity |
|
Shipping |
Yes |
Decimal |
Shipping of the entity |
|
AdditionalCharges |
Yes |
Decimal |
Additional Charges of the entity |
|
TotalAmount |
Decimal |
Total Amount of the entity |
|
|
List of InterfaceComment object |
Check data type InterfaceComment for details |
|||
List of customAttributes object |
Check data type customAttributes for details |
|||
FobCode |
String |
Fob Code of the entity |
|
|
FobLocationCode |
String |
Fob Location Code of the entity |
|
|
FreightTermsCode |
String |
Freight Terms Code of the entity |
|
|
TransitTypeCode |
String |
Transit Type Code of the entity |
|
|
CarriersCode |
String |
Carriers Code of the entity |
|
|
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 |
|
DocumentStatus |
Yes |
String |
Document Status of the entity |
|
DocumentDescription |
String |
Document Description of the entity |
||
DocumentCreator |
Yes |
String |
Document Creator of the entity |
|
CreatedOn |
Yes |
String |
Created on date |
|
DocumentLobDetails |
List of InterfaceOrgEntity object |
Check data type InterfaceOrgEntity for details |
||
OperationName |
Yes |
String |
Operation Name of the entity |
|
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 |
|
OrderLocationName |
String |
OrderLocationName of the entity |
|
|
Description |
Yes |
String |
Description of the entity |
|
UnitPrice |
Yes |
Decimal |
UnitPrice of the entity |
|
Quantity |
Yes |
Decimal |
Quantity of the entity |
|
Uom |
Yes |
String |
Uom of the entity |
|
Manufacturers |
List Of Manufacturer object |
|||
ItemType |
String |
ItemType of the entity |
|
|
ItemExtendedType |
String |
ItemExtendedType of the entity |
|
|
DocumentItemShippingDetails |
List of InterfaceDocumentItemShippingDetail object |
Check data type InterfaceDocumentItemShippingDetail for details |
||
StartDate |
Yes |
DateTime |
StartDate of the entity |
|
EndDate |
Yes |
DateTime |
EndDate of the entity |
|
AdditionalCharges |
Yes |
Decimal |
AdditionalCharges of the entity |
|
ShippingCharges |
Yes |
Decimal |
ShippingCharges of the entity |
|
Tax |
Yes |
Decimal |
Tax of the entity |
|
DateNeeded |
Yes |
DateTime |
DateNeeded of the entity |
|
Unspsc |
Decimal |
Unspsc of the entity |
||
ClientPartnerCode |
Yes |
String |
ClientPartnerCode of the entity |
|
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 |
||
List of InterfaceComment object |
Check data type comments for details |
|||
ClientCategoryId |
String |
ClientCategoryId of the entity |
|
|
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 |
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: () cannot be negative |
|
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 |
There was an error in processing the requisition as the item(s) () has invalid Accounting entity type |
|
EntityCode |
Yes |
String |
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 |
|
|
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 |
|
|
DelivertoLocation |
List of InterfaceLocation object |
Check data type InterfaceLocation for details |
||
ShippingMethod |
String |
ShippingMethod of the entity |
|
|
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 |
|
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 |
|
AdditionalFieldAttribute |
||||
Property |
Required? |
Data type |
Description |
Validations / Exceptions |
AdditionalFieldValue |
String |
Additional Field Value of the entity |
|
|
AdditionalFieldCode |
String |
Additional Field Name of the entity |
|
|
AdditionalFieldName |
String |
Additional Field Name of the entity |
|
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 |
||
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 |
||
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 |
|
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 |
|
Yes |
List of StateInfo object |
Check data type StateInfo for details |
||
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 |