Item Classification via GL

Overview

The GL Codes API enables the creation, retrieval, updating, and deletion of GL codes records. This documentation provides detailed information on the endpoints, request and response formats, and field descriptions.

Create

Endpoint: /api/message/gl_codes/{ Company }

This API will create a new GL code.

• Method: POST
• Content-Type: application/json
• Authentication: Bearer <token>

Request Body:

{
    "data_set": "<Data-set>",                    //string
    "src_leac": "<Source-Ledger-Account>",       //String
    "src_dsca": "<Source-Description>",          //string
}

Fields Details:

Field Name	Description	Data Type	Length
data_set	Data Set	String	10
src_leac	Source Ledger Account	String	12
src_dsca	Source Description	String	120

---

Response Body: (Status: 200)

{
    "data_set": "<Data_set>", 
    "src_leac": "<Source-Ledger-Account>",
    "src_dsca": "<Source-Description>",
}

Fields Details:

Field Name	Description	Data Type	Example
data_set	Data Set	String	"Dataset1"
src_leac	Source Ledger Account	String	"1543289"
src_dsca	Source Description	String	"Factory"

---

Response Body: (Status: 401 - Unauthorized)

When there is no token or invalid token passed:

{
    "message": "Unauthorized!"
}

Response Body: (Status: 400 - Bad Request)

When both the Data set and Source Ledger Account is already present in the database:

{
    "message": "Record already exists!"
}

Response Body: (Status: 400 - Bad Request)

When invalid or wrong Classification code is passed:

{
    "message": "Reference Error: Classification codes."
}

Response Body: (Status: 400 - Bad Request)

When invalid or wrong Data set is passed:

{
    "message": "Reference Error"
}

Response Body: (Status: 400 - Bad Request)

When there is an invalid data type is passed:

{
    "message": "Invalid Data Type"
}

Response Body: (Status: 500 - Internal Server Error)

When the mandatory fields are passed as an empty field:

{
    "message":  "Validation Errors|Validation 'isNotEmpty' failed for field 'data_set'|Validation 'isNotEmpty' failed for field 'src_leac'"
}

Update

Endpoint: /api/message/gl_codes/{ Company }

This API will update a GL codes.

• Method: PUT
• Content-Type: application/json
• Authentication: Bearer <token>

Request Body:

{
    "data_set": "<Data-set>",                    //string
    "src_leac": "<Source-Ledger-Account>",       //String
    "src_dsca": "<Source-Description>",          //string
}

Response Body: (Status: 200)

{
    "data_set": "<Data_set>", 
    "src_leac": "<Source-Ledger-Account>",
    "src_dsca": "<Source-Description>", 
}

Response Body: (Status: 401 - Unauthorized)

When there is no token or invalid token passed:

{
    "message": "Unauthorized!"
}

Response Body: (Status: 400 - Bad Request)

When there is an invalid data type is passed:

{
    "message": "Invalid Data Type"
}

Response Body: (Status: 400 - Bad Request)

When you are trying to update both the Data set and Source Ledger Account:

{
    "message": "Record not found!"
}

Response Body: (Status: 400 - Bad Request)

When invalid or wrong Classification code is passed:

{
    "message": "Reference Error: Classification codes."
}

Response Body: (Status: 500 - Internal Server Error)

When the mandatory fields are passed as an empty field:

{
    "message":  "Validation Errors|Validation 'isNotEmpty' failed for field 'data_set'|Validation 'isNotEmpty' failed for field 'src_leac'"
}

Delete

Endpoint: /api/message/gl_codes/{ Company }/{ record_id }

This API will delete a GL codes.

• Method: DELETE
• Authentication: Bearer <token>

Response Body: (Status: 200)

{
    "Message": "Message Deleted Sucessfully!"
}

Response Body: (Status: 401 - Unauthorized)

When there is no token or invalid token passed:

{
    "message": "Unauthorized!"
}

Response Body: (Status: 500 - Internal Server Error)

When invalid or wrong GL codes id is paased:

{
    "Message": "Unable to Delete Record - Invalid Data Type"
}

Get

Endpoint: /api/message/gl_codes/{ Company }/{ record_id }

This API will get a GL code.

• Method: GET
• Authentication: Bearer <token>

Response Body: (Status: 200)

{
    "ccode": "<Classification-code>",
    "data_set": "<Data_set>", 
    "dsca": "<Description>",
    "src_leac": "<Source-Ledger-Account>",
    "src_dsca": "<Source-Description>", 
}

Response Body: (Status: 200)

When invalid or wrong GL codes id is paased:

{
    "message": "null"
}

Response Body: (Status: 401 - Unauthorized)

When there is no token or invalid token passed:

{
    "message": "Unauthorized!"
}

Get All

Endpoint: /api/messages/gl_codes/{ Company }/{ PageSize }/{ PageNumber }

This API will get all GL codes.

• Method: GET
• Authentication: Bearer <token>

Response Body: (Status: 200)

[
   {
    "ccode": "<Classification-code>",
    "data_set": "<Data_set>", 
    "dsca": "<Description>",
    "src_leac": "<Source-Ledger-Account>",
    "src_dsca": "<Source-Description>",   
   },
   .
   .
   .
]

Response Body: (Status: 401 - Unauthorized)

When there is no token or invalid token passed:

{
    "message": "Unauthorized!"
}