GetAllOrgEntityManagers (GET) | GEP TECH DOCUMENTATION

Overview

This GET API can be used to retrieve all org entity managers details in GEP SMART to post them into ERP.

URL Format: https://<Instance>/SmartInterfaceAPI/api/OrganizationManager/AllOrgEntityManagers

Request

https://<Instance>/SmartInterfaceAPI/api/OrganizationManager/AllOrgEntityManagers

Response

{
   "data": [

{
   "entityCode": "string",
   "managerCode": [
      "string"
   ],
   "thresholdAmount": 0,
   "currencyCode": "string",
   "isDeleted": true,
   "structureName": "string",
   "orgEntities": [
      {
         "entityCode": "string",
         "isDefault": true,
         "entityType": "string",
         "lobEntityCode": "string"
      }
   ]
}
   ],
   "statusCode": " String ",
   "errorDetails": [
      {
         "key": "string",
         "errors": [
            {
               "errorCode": "string",
               "errorDescription": "string"
            }
         ]
      }
   ],
   "successDetails": [
      {
         "key": "String"
      }
   ]
}

Examples

Success Scenario - Request

https://<Instance>/SmartInterfaceAPI/api/OrganizationManager/AllOrgEntityManagers

Success Scenario – Response

{
  "data": [
    {
      "entityCode": "GUBR",
      "managerCode": [
        "CC-2016.000071"
      ],
      "thresholdAmount": 0,
      "currencyCode": "EUR",
      "isDeleted": false
    },
    {
      "entityCode": "GUCH",
      "managerCode": [
        "CC-2016.000071"
      ],
      "thresholdAmount": 0,
      "currencyCode": "USD",
      "isDeleted": false
    }
  ],
  "statusCode": "200",
  "errorDetails": [],
  "successDetails": []
}

Data Elements

	Get All Org Entity Managers
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1	Data		List of OrgEntityManagers object
2	StatusCode		String
3	ErrorDetails		List of ErrorModel object
4	SuccessDetails		List of SuccessModel object

	Data
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1.1	EntityCode		String	Code of the entity
1.2	ManagerCode		List of String	Manager Code of the entity
1.3	ThresholdAmount		Decimal	Structure Name of the entity
1.4	CurrencyCode		String	Threshold Amount of the entity
1.5	IsDeleted		Boolean	Currency Code of the entity
1.6	StructureName		String	Status of the entity if they are to be visible or not on the application
1.7	OrgEntities		List of OrgEntity object	Check data type OrgEntity for details

	OrgEntities
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1.7.1	EntityCode		String	Entity Code of entity
1.7.2	IsDefault		Boolean	Status of the entity if this is default or not
1.7.3	EntityType		String	Entity Type of entity
1.7.4	LOBEntityCode		String	Line of Business Entity Code of entity

	ErrorDetails
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
3.1	Key		String
3.2	Errors		List of Error object

	Errors
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
3.2.1	ErrorCode		String
3.2.2	ErrorDescription		String

	SuccessDetails
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
4.1	Key		String