SaveCombinationCodes (POST) | GEP TECH DOCUMENTATION

Overview

This POST API can be used to capture new additions in bulk Combination Code details from ERP into GEP SMART, that can be used as reference in P2P transactions.

URL Format: https://<Instance>/SmartBulkInterfaceAPI/api/CombinationCodes/SaveCombinationCodes

Request

[
   {
      "Code": "String",
      "Status": 'Char',
      "lstOrgEntity": [
         {
            "EntityCode": "String",
            "IsDefault": true,
            "EntityType": "String",
            "LOBEntityCode": null
         }
      ]
   }
]

Response

{
   "statusCode": 202,
   "url": "String",
   "batchID": "String",
   "interval": 0,
   "interval Type": "String",
   "receivedCount": 0
}

Examples

Success Scenario - Request

Request below describes that this contains only the mandatory attributes:

[
   {
      "Code": "10|0420|20|6150000|00000",
      "Status": "A",
      "lstOrgEntity": [
         {
            "EntityCode": "CBAD",
            "IsDefault": true,
            "EntityType": "BusinessUnit",
            "LOBEntityCode": null
         }
      ]
   }
]

Success Scenario - Response

{
   "statusCode": 202,
   "url": "https://<instance>/SmartBulkInterfaceAPI/api/BulkResult/GetBulkResult?batchId=110e7c8551f647c39726b8e9e7ec2980",
   "batchID": "110e7c8551f647c39726b8e9e7ec2980",
   "interval": 60,
   "interval Type": "Seconds",
   "receivedCount": 10
}

Error Scenario – Request

Request has a missing value of the Authorization Header which is mandatory: (401 – Unauthorized)

Error Scenario - Response

Access to interface BulkAPI is denied, Authorization Header is missing.

Data Elements

	CombinationCode
S.No.	Property	Required?	Data type	Description	Validations / Exceptions
1	Code	Yes	String	Code of entity	Code is mandatory Validation failed for code combination Number of codes are not matching with entities configured
2	Status	No	Char	Status of the entity
3	LstOrgEntity	No	List of OrgEntity object	Check data type OrgEntity for details

	LstOrgEntity
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
3.1	EntityCode	No	String	Entity Code of the entity	Invalid EntityCode
3.2	IsDefault	No	Boolean	A flag used to denote if entity is the default or not
3.3	EntityType	No	String	Entity Type of the entity	Invalid EntityType
3.4	LOBEntityCode	No	String	Line of Business Entity Code of the entity	Invalid LOBEntityCode