Tax Types

Overview:

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

Create:

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

This API will create a new Tax Type.

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

Request Body:

{
    "data_set": "<data-set>",                 //string
    "src_ttype": "<Source-Tax-Code>",         //string
    "src_dsca": "<Source-Tax-Description>",   //string
}

Fields Details:

Field Name	Description	Data Type	Length
data_set	DataSet	String	10
src_ttype	Source Tax Code	String	9
src_dsca	Source Tax Description	String	120

---

Response Body: (Status: 200)

{
    "data_set": "<data-set>",
    "src_dsca": "<Source-Tax-Description>",
    "src_ttype": "<Source-Tax-Code>"
}

Field Details:

Field Name	Description	Data Type	Example
data_set	Data Set	String	"dataset1"
src_dsca	Source tax description	String	"IT 6% -Adj up: AR AP Bad Debt"
src_ttype	Source Tax code	String	"AP001B100"

---

Response Body: (Status: 401 - Unauthorized / Invalid Token)

When there is no token / invalid token passed or When Normal user tries to create a new record:

{
    "message": "Unauthorized!"
}

Response Body: (Status: 400 - Bad Request / Invalid Tax code)

When passing invalid code to Tax Type code:

{
    "message": "Reference Error: Tax Type Code"
}

Response Body: (Status: 400 - Bad Request / Duplicate)

When the record is already present in the database:

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

Response Body: (Status: 400 - Bad Request / Invalid Datatype)

When passing a record with invalid datatype:

{
    "message": "Invalid Data Type"
}

Response Body: (Status: 500 - Internal Server Error / Empty Field)

When passing an empty field as input to source tax code:

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

when passing an empty field as input to dataset:

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

Update:

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

This API will update the existing Tax Type.

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

Request Body:

{
    "data_set": "<data-set>",                  //string
    "src_ttype": "<Source-Tax-Code>",          //string
    "src_dsca": "<Source-Tax-Description>"     //string
}

Response Body: (Status: 200)

{
    "data_set": "<data-set>",
    "src_dsca": "<Source-Tax-Description>",
    "src_ttype": "<Source-Tax-Code>",
}

Response Body: (Status: 401 - Unauthorized / Invalid Token)

When there is no token / invalid token passed or When Normal User tries to update the record :

{
    "message": "Unauthorized!"
}

Response Body: (Status: 400 - Bad Request / Not Found)

When the specified record is not found:

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

Response Body: (Status: 400 - Bad Request / Invalid Datatype)

When passing a record with invalid datatype:

{
    "message": "Invalid Data Type"
}

Response Body: (Status: 400 - Bad Request / Invalid payload)

When passing an invalid tax type code:

{
    "message": "Reference Error: Tax Type Code"
}

Response Body: (Status: 500 - Internal Server Error / Empty Field)

When passing an empty field as input to source tax code:

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

when passing an empty field as input to dataset:

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

Delete:

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

This API will delete the specified record id.

• Method: DELETE
• Authentication: Bearer <token>

Response Body: (Status: 200)

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

Response Body: (Status: 401 - Unauthorized / Invalid Token)

When there is no token / invalid token passed or When Normal user tries to delete the existing record:

{
    "message": "Unauthorized!"
}

Response Body: (Status: 500 - Internal Server Error / Invalid Record)

When there is no record or invalid record passed:

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

Get:

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

This API retrieves the specified record id.

• Method: GET
• Authentication: Bearer <token>

Response Body: (Status: 200)

{
    "data_set": "<data-set>",
    "dsca": "<Tax-Type-Description>",
    "src_dsca": "<Source-Tax-Description>",
    "src_ttype": "<Source-Tax-Code>"
}

Response Body: (Status: 200 - success status/invalid id)

When there is no such id or invalid id is passed :

{
    "message": "null"
}

Response Body: (Status: 401 - Unauthorized / Invalid Token)

When there is no token or invalid token passed :

{
    "message": "Unauthorized!"
}

Get All:

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

This API retrieves all records.

• Method: GET
• Authentication: Bearer <token>

Response Body: (Status: 200)

[
    {
        "data_set": "<data-set>",
        "dsca": "<Tax-Type-Description>",
        "src_dsca": "<Source-Tax-Description>",
        "src_ttype": "<Source-Tax-Code>"
    }
]

Response Body: (Status: 401 - Unauthorized / Invalid Token)

When there is no token or invalid token passed :

{
    "message": "Unauthorized!"
}