UpdateProcessedCreditMemoStatus (PUT) | GEP TECH DOCUMENTATION

Overview

This Acknowledgment API allows to capture back the ERP processing status in Credit Memo Status in GEP SMART, that can be displayed to the user along with comments in case of failures.

URL Format: https://<Instance>/SmartInterfaceAPI/api/CreditMemo/CreditMemoStatus

Request

{
   "model": [
      {
         "key": "string",
         "description": "string",
         "status": "string",
         "sourceSystemName": "string",
         "sourceSystemValue": "string",
         "lob": "string",
         "errorCode": "string"
      }
   ]
}

Response

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

Examples

Success Scenario – Request

{
   "model": [
      {
         "key": "1017",
         "description": "",
         "status": "",
         "sourceSystemName": "",
         "sourceSystemValue": "",
         "lob": "",
         "errorCode": ""
      }
   ]
}

Success Scenario – Response

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

Error Scenario – Request

{
   "model": [
      {
         "key": "string",
         "description": "string",
         "status": "string",
         "sourceSystemName": "string",
         "sourceSystemValue": "string",
         "lob": "string",
         "errorCode": "string"
      }
   ]
}

Error Scenario – Response

{
   "data": null,
   "statusCode": "400",
   "errorDetails": [
      {
         "key": "string",
         "errors": [
            {
               "errorCode": "MandatoryField",
               "errorDescription": "Invalid Credit Memo Number"
            }
         ]
      }
   ],
   "successDetails": []
}

Data Elements

	UpdateProcessedCreditMemoStatus
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1	Model	No	List of UpdateProcessedDocumentStatusModel object	Check data type UpdateProcessedDocumentStatusModel for details

	Model
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1.1	Status	No	ErrorDetail object	Check data type ErrorDetail for details
1.2	Key	Yes	String	Key of the entity	Key is mandatory Invalid Credit Memo Number
1.3	Description	No	String	Description of the entity
1.4	SourceSystemDetailsName	No	String	Name of the entity
1.5	SourceSystemDetailsValue	No	String	Value of the entity
1.6	Lob	No	String	line-of-business
1.7	ErrorCode	No	String	Check data type Error Code