UpdatePartnerStatus (PUT) | GEP TECH DOCUMENTATION

Overview

This PUT API can be used to capture updates in partner status details from ERP into GEP SMART, that can be used as reference in P2P transactions.

URL Format: https://<Instance>/SmartInterfaceAPI/api/Partner/PartnerStatus

Request

[
 {
 "status": "string",
 "comments": "string",
 "sourceSystem": {
 "name": "string",
 "value": "string"
 },
 "gepPartnerCode": 0
 }
]

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:

[
   {
      "Status": "Approved",
      "Comments": "Comments1",
      "SourceSystem": {
         "Name": "Name1",
         "Value": "Value1"
      },
      "GEPPartnerCode": 189582
   }
]

Success Scenario - Response

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

Error Scenario - Request
Request below describes that this contains an invalid Partner code:

[
   {
      "Status": "Approved",
      "Comments": "Comments1",
      "SourceSystem": {
         "Name": "Name1",
         "Value": "Value1"
      },
      "GEPPartnerCode": 123
   }
]

Error Scenario – Response

{
   "data": null,
   "statusCode": "400",
   "errorDetails": [
      {
         "key": "123",
         "errors": [
            {
               "errorCode": "DataValidation",
               "errorDescription": "Invalid partner code"
            }
         ]
      }
   ],
   "successDetails": []
}

Data Elements

	PartnerStatus
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1	Status	Yes	String	Status is Of Partner	Status is mandatory
2	SourceSystem	Yes	List of SourceSystemDetails object	Check Data Type SourceSystemDetails for details	Please provide either GEP Partner code or Source System details
3	GEPPartnerCode	Yes	Long	Partner Code is Of Partner Status	Please provide either GEP Partner code or Source System details Invalid partner code Partner is not in valid status for updation
4	Comments	No	String	Comments is Of Partner

	SourceSystem
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
2.1	Name	Yes	String	Source System Name	SourceSystem Name is mandatory for all source systems
2.2	Value	Yes	String	Source System Value	SourceSystem Value is mandatory for all source systems