GetReceipt (Get) | GEP TECH DOCUMENTATION

Overview

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

URL Format: https://<Instance>/smartInterfaceAPI/api/receipt/All

Request

https://<Instance>/smartInterfaceAPI/api/receipt/All

Response

{
   "basicDetails": {
      "documentName": "string",
      "documentNumber": "string",
      "documentStatus": "string",
      "documentCreator": "string",
      "createdOn": "string",
      "documentLobDetails": [
         {
            "entityCode": "string",
            "entityType": "string"
         }
      ],
      "operationName": "string"
   },
   "receiptType": "string",
   "returnNoteNumber": "string",
   "receiverId": "string",
   "headerEntities": [
      {
         "entityCode": "string",
         "entityType": "string"
      }
   ],
   "sourceSystemName": "string",
   "orderNumber": "string",
   "currency": "string",
   "comments": [
      {
         "commentText": "string",
         "accessType": "string"
      }
   ],
   "totalAmount": 0,
   "matchType": "string",
   "customAttributes": [
      {
         "questionnaireTitle": "string",
         "questionnaireResponseValues": [
            {
               "childQuestionSets": [
                  null
               ],
               "columnText": "string",
               "responseValue": "string",
               "rowId": "string"
            }
         ]
      }
   ],
   "requisitionNumber": "string",
   "partnerRmaNumber": "string",
   "orderDate": "2020-05-28T13:31:47.946Z",
   "additionalFieldAttributes": [
      {
         "additionalFieldValue": "string",
         "additionalFieldCode": "string",
         "additionalFieldName": "string"
      }
   ],
   "receiptItems": [
      {
         "itemLineNumber": 0,
         "poLineItemNumber": 0,
         "receivedQuantity": 0,
         "returnedQuantity": 0,
         "cancelledQuantity": 0,
         "acceptedQuantity": 0,
         "remainingQuantity": 0,
         "unitPrice": 0,
         "itemTotalAmount": 0,
         "receivedAmount": 0,
         "uom": "string",
         "matchType": "string",
         "itemNumber": "string",
         "receivedDate": "2020-05-28T13:31:47.947Z",
         "reasonForReturnCode": "string",
         "reasonForReturn": "string",
         "isClosedForReceiving": "string",
         "description": "string",
         "manufacturerName": "string",
         "manufacturerPartNumber": "string",
         "itemType": "string",
         "itemExtendedType": "string",
         "comments": [
            {
               "commentText": "string",
               "accessType": "string"
            }
         ],
         "supplierPartId": "string",
         "supplierPartAuxiliaryId": "string",
         "categoryName": "string",
         "clientCategoryId": "string",
         "unspsc": 0,
         "requisitionNumber": "string",
         "additionalFieldAttributes": [
            {
               "additionalFieldValue": "string",
               "additionalFieldCode": "string",
               "additionalFieldName": "string"
            }
         ],
         "assetTag": [
            {
               "assetKey": "string",
               "assetLocationCode": "string",
               "serialNumber": "string"
            }
         ],
         "customAttributes": [
            {
               "questionnaireTitle": "string",
               "questionnaireResponseValues": [
                  {
                     "childQuestionSets": [
                        null
                     ],
                     "columnText": "string",
                     "responseValue": "string",
                     "rowId": "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
            }
         ]
      }
   ]
}

Examples

Success Scenario - Request

https://<Instance>/SmartInterfaceAPI/api/Receipt/All

Success Scenario - Response

{
   "data": [
      {
         "basicDetails": {
            "documentNumber": "Receipt_Ketan_20052020_001",
            "createdOn": "2020-04-03T07:02:25.734Z",
            "documentCreator": "Santosh.Reddy.ChevronProd",
            "documentLobDetails": [
               {
                  "entityCode": "PC2"
               }
            ],
            "operationName": "new"
         },
         "Comments": [
            {
               "CommentText": "AA"
            }
         ],
         "receiptType": "receipt",
         "ReceiverId": "Santosh.Reddy.ChevronProd",
         "sourceSystemName": "SAP",
         "orderNumber": "0060200708",
         "currency": "USD",
         "totalAmount": 0.09,
         "CustomAttributes": [
            {
               "QuestionnaireTitle": "Delivery Note",
               "QuestionnaireResponseValues": [
                  {
                     "ResponseValue": "Test Delivery Note"
                  }
               ]
            },
            {
               "QuestionnaireTitle": "Source",
               "QuestionnaireResponseValues": [
                  {
                     "ResponseValue": "Test Source"
                  }
               ]
            },
            {
               "QuestionnaireTitle": "Outage-TA/Project Number",
               "QuestionnaireResponseValues": [
                  {
                     "ResponseValue": "TA/Project Number1234"
                  }
               ]
            },
            {
               "QuestionnaireTitle": "Outage-TA/Project Description",
               "QuestionnaireResponseValues": [
                  {
                     "ResponseValue": "Test Outage-TA/Project Description"
                  }
               ]
            }
         ],
         "orderDate": "2020-04-29 23:00:17.623",
         "receiptItems": [
            {
               "itemLineNumber": 1,
               "poLineItemNumber": 1,
               "receivedQuantity": 10,
               "cancelledQuantity": 0,
               "IsClosedForReceiving": true,
               "returnedQuantity": 0,
               "unitPrice": 0.02,
               "itemTotalAmount": 0.09,
               "receivedAmount": 0.09,
               "ReasonForReturnCode": "",
               "Comments": [
                  {
                     "CommentText": "AA"
                  }
               ],
               "CustomAttributes": [
                  {
                     "QuestionnaireTitle": "Delivery Note",
                     "QuestionnaireResponseValues": [
                        {
                           "ResponseValue": "Test Delivery Note"
                        }
                     ]
                  },
                  {
                     "QuestionnaireTitle": "Source",
                     "QuestionnaireResponseValues": [
                        {
                           "ResponseValue": "Test Source"
                        }
                     ]
                  },
                  {
                     "QuestionnaireTitle": "Outage-TA/Project Number",
                     "QuestionnaireResponseValues": [
                        {
                           "ResponseValue": "TA/Project Number1234"
                        }
                     ]
                  },
                  {
                     "QuestionnaireTitle": "Outage-TA/Project Description",
                     "QuestionnaireResponseValues": [
                        {
                           "ResponseValue": "Test Outage-TA/Project Description"
                        }
                     ]
                  }
               ],
               "ReasonForReturn": "",
               "uom": "EA",
               "receivedDate": "2020-05-18"
            }
         ]
      }
   ],
   "statusCode": "200",
   "errorDetails": [],
   "successDetails": []
}

Data Elements

InterfaceReceipt
Property	Required?	Data type	Description	Validations/Exceptions
BasicDetails	Yes	Document Object		BasicDetails is mandatory
ReceiptDate		DateTime	Receipt date	Receipt Order Date is not a valid DateTime value
ReturnNoteNumber		String	Return note number	Return note number is mandatory for return note reversals
HeaderEntities	Yes	List Of HeaderEntities
ReceiverId		String	Receiver Id
MatchType		String	Match Type
OrderNumber		String	Order number	Order Number is mandatory
OrderDate		DateTime	OrderDate
ReceiptItems		List of receiptItems object	Receipt items
RequisitionNumber		String	Requisition number
PartnerRMANumber		String	Partner RMA (return merchandise authorization) Number
ReceiptType		String	Receipt Type	Invalid Document Type/Document Type is mandatory
SourceSystemName		String	Source System Name
Currency		String	Currency
TotalAmount		Int	Total Amount
Comments		List of Interfacecomments object
AdditionalFieldAttributues	No	List of InterfaceP2PAdditionalFieldAtrribute object	Check data type InterfaceP2PAdditionalFieldAtrribute for details
CustomAttributes		List of customAttributes object

HeaderEntities
Property	Required?	Data type	Description	Validations/Exceptions
entityCode		string	Entity code
entityType		true	Entity Type

BasicDetails
Property	Required?	Data type	Description	Validations/Exceptions
DocumentName		String	Document Name of the entity
DocumentNumber	Yes	String	Document Number of the entity	Document Number is mandatory
DocumentStatus		String	Document Status of the entity
DocumentCreator		String	Document Creator of the entity
CreatedOn	Yes	String	CreatedOn of the entity	Receipt date is mandatory/Receipt date cannot be greater that current date
DocumentLobDetails	Yes	List of OrgEntity object	Check data type OrgEntity for details
OperationName	Yes	String	Operation Name of the entity	Operation is mandatory

AdditionalFieldAtrribute
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

ReceiptItems
Property	Required?	Data type	Description	Validations/Exceptions
AssetTag		List of assetTag object	Asset Tag
ReceivedQuantity	Yes	Int	Received Quantity
AcceptedQuantity		Int	Accepted Quantity
ReturnedQuantity	Yes	Int	Returned Quantity	ReturnedQuantity should be less than 0
PoLineItemNumber	Yes	Int	Po Line Item Number	PoLineItemNumber should be greater than 0
RequisitionNumber		String	Requisition Number
RemainingQuantity		Int	Remaining Quantity
ReceivedDate		DateTime	Received Date
ReceivedAmount		Int	Received Amount
ReasonForReturn	Yes	String	reasonForReturnCode	ReasonForReturnCode is missing
isClosedForReceiving		String	isClosedForReceiving
IsInternal		Boolean	Is Internal
PoLineItemId		Int	Po Line Item Id
ItemSplitsDetail		List of InterfaceOrderSplitItems object	Item Splits Detail
CancelledQuantity	Yes	Int	Cancelled Quantity	Cancelled Quantity for Item No cannot be 0 or negative
ItemLineNumber	Yes	Int	Item Line Number	Receipt Line Number for Item No is either not provided or not a valid value
Description		String	Description
UnitPrice	Yes	Decimal	Unit Price	UnitPrice should be greater than 0
Uom	Yes	String	Uom(unit of measure)
ManufacturerName		String	Manufacturer Name
ManufacturerPartNumber		String	Manufacturer Part Number
ItemType		String	Item Type
ItemExtendedType		String	Item Extended Type
CategoryName		String	Category Name
ItemTotalAmount		Decimal	Item Total Amount
ItemNumber		String	Item Number
Unspsc		Int	Unspsc
SupplierPartId		String	Supplier Part Id
SupplierPartAuxiliaryId		String	Supplier Part Auxiliary Id
Comments		List of InterfaceComments object	comments
ClientCategoryId		String	Client Category Id
CapitalCode		String	Capital Code
MatchType		String	Match Type
RecoupmentPercentage		Int	Recoupment Percentage
ManufacturerSupplierCode		String	Manufacturer Supplier Code
ManufacturerModel		String	Manufacturer Model
CustomAttributes		List of customAttributes object	Custom Attributes
Comments		List of Interfacecomments object
AdditionalFieldAttributues	No	List of InterfaceP2PAdditionalFieldAtrribute object	Check data type InterfaceP2PAdditionalFieldAtrribute for details
ItemSplitsDetails	No	List of ItemSplitsDetails

ItemSplitsDetails
Property	Required?	Data type	Description	Validations/Exceptions
DocumentSplitItemEntities	No	List of InterfaceDocumentSplit ItemEntity object	DocumentSplitItemEntities
SplitItemTotal	Yes	Decimal	SplitItemTotal	Split Total for Item No: () cannot be negative
Tax	No	Decimal	Tax
ShippingCharges	yes	Decimal	ShippingCharges	Shipping Charges cannot be negative
AdditionalCharges	Yes	Decimal	AdditionalCharges	Additional Charges cannot be negative
CustomAttributes	No	List of CustomAttribute object	CustomAttributes
SplitType	No	String	SplitType
Quantity	No	Decimal	Quantity
Percentage	No	Decimal	Percentage

Comments
Property	Required?	Data type	Description	Validations/Exceptions
commentText		string
accessType		string

AssetTag
Property	Required?	Data type	Description	Validations/Exceptions
SerialNumber		String	Serial Number
AssetKey		String	AssetKey
AssetLocationCode		String	Asset Location Code

InterfaceOrderSplitItems
Property	Required?	Data type	Description	Validations/Exceptions
DocumentSplitItemEntities	Yes	List of InterfaceDocumentSplitItemEntity object	Document Split Item Entities
SplitItemTotal		Int	Split Item Total
CustomAttributes		List of customAttributes object
SplitType		String	Split Type
Name		String	Name
Quantity		Int	Quantity
Percentage		Decimal	Percentage
CreatedOn		DateTime	Created On

InterfaceDocumentSplitItemEntity
Property	Required?	Data type	Description	Validations/Exceptions
EntityType		String	Entity Type
EntityCode	Yes	String	Entity Code
EntityDisplayName		String	Entity Display Name
CreatedOn		DateTime	Created On

InterfaceComment
Property	Required?	Data type	Description	Validations/Exceptions
CommentText		String	Comment Text
CommentAttachment		List of commentAttachment object	Comment Attachment
AccessType		String	Access type of the entity

CommentAttachment
Property	Required?	Data type	Description	Validations/Exceptions
Filename		String	File Name
FileUri		String	File Uri

CustomAttributes
Property	Required?	Data type	Description	Validations/Exceptions
QuestionnaireTitle	Yes	String	Questionnaire Title
QuestionnaireResponseValues	Yes	List of questionnaireResponseValues object	Questionnaire Response Values

QuestionnaireResponseValues
Property	Required?	Data type	Description	Validations/Exceptions
ChildQuestionSets		List of CustomAttributes object	Child Question Sets
ColumnText		String	Column Text
ResponseValue	Yes	String	Response Value
Row Id		String	Row Id

DocumentLobDetails
Property	Required?	Data type	Description	Validations/Exceptions
entityCode		string	Entity code
entityType		string	EntityType

OrgEntity
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