GetGeneralLedgerDetails (GET) | GEP TECH DOCUMENTATION

Overview

This GET API can be used to retrieve General Ledger details in GEP SMART to post them into ERP.

URL Format: https://<Instance>/SmartInterfaceAPI/api/GeneralLedger/All

Request

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

Response

{
   "data": [
      {
         "name": "String",
         "code": "String",
         "coaCode": "String",
         "description": "String",
         "isDeleted": true,
         "isActive": true,
         "categories": [
            {
               "pasCode": 0,
               "isDefault": true,
               "clientPasCode": "String",
               "isDeleted": true
            }
         ]
      }
   ],
   "statusCode": "String",
   "errorDetails": [
      {
         "key": "string",
         "errors": [
            {
               "errorCode": "string",
               "errorDescription": "string"
            }
         ]
      }
   ],
   "successDetails": [
      {
         "key": "String"
      }
   ]
}

Examples

Success Scenario - Request

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

Success Scenario – Response

{
  "data": [
    {
      "name": "434405 Other Business Services",
      "code": "434405",
      "coaCode": "1000",
      "description": "434405  Other Business Services",
      "isDeleted": true,
      "isActive": false,
      "categories": [
        {
          "pasCode": 14450250001993,
          "isDefault": true,
          "clientPasCode": ""
        }
      ]
    }
  ],
  "statusCode": "200",
  "errorDetails": [],
  "successDetails": []
}

Data Elements

	Get General Ledger
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1	Data		List of GeneralLedger 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	Name		String	Name of entity
1.2	Code		String	Code of entity
1.3	COACode		String	COACode of entity
1.4	Description		String	Description of entity
1.5	IsDeleted		Boolean	A flag used to denote if entity is soft deleted or not
1.6	IsActive		Boolean	A flag used to denote if entity is active or not
1.7	Categories		List of PAS object	Check data type PAS for details.

	Categories
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1.7.1	PasCode		Long	Pas Code of entity
1.7.2	IsDefault		Boolean	Status of the entity if this is default or not
1.7.3	ClientPasCode		String	Client Pas Code of entity
1.7.4	IsDeleted		Boolean	Status of the entity on whether it should be visible on the application or not

	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