Codelayer API Documentation

  • Introduction

    • General
  • API Reference

    • System

      • License request
      • Register Device
      • Authentication
    • Accounts

      • Reports

        • Daily Statement
        • Daybook
        • Debtors Balance
    • Sales

      • Cancel

        • Cancel Request Register
        • Cancel Request Save
        • Pending Cancellations
      • Reports

        • Gatepass Register
        • Sales Summary
        • Vehicle Rent Details
    • Response Codes
Codelayer API Documentation
Pending Cancellations

To view the Cancellation Request generated from Application

URL

sales/cancel/cancel_request_view

Method

POST

Request Media type

application/json

Response Media type

application/json

Request Parameters
Parameter Data Type Min Max M/O Sample Value Comments
key String 32 32 M aR4wBJis5fx7XT3z5Aqe7jLBNwX1ibTu Key obtained from authentiaction.

 

Response Values
Name Data Type Min Length Max Length M/O Sample Value Comments
pending_requests Array M List of pending cancellations.
cancreason String 1 250 M TST Reason for cancel
formtype String 1 100 M Gatepass Request Type
folio String 1 10 M GP folio for reference
refno Integer 1 99999 M 12
details String 1 250 M BASHEER - KL326113-0.00 (20MM-158@25) Details of the cancelled request
amount Decimal 1 999999 M 5000.00
syncid Integer 1 999999 M 1 primary key value ,which need to be passed back during save

 

Sample Request
{
    "key": "QH7LlQ3wQMK9oYEKjeG5QOIVJQT4emeq"
}
Sample Success Response
{
    "pending_requests": [
        {
            "cancreason": "TST",
            "formtype": "Gatepass",
            "folio": "GP",
            "refno": "12",
            "details": "BASHEER - KL326113-0.00 (20MM-158@25)",
            "amount": "5000.00",
            "syncid": "1"
        }
    ],
    "e": 200,
    "msg": "Success"
}
Sample Failure Responses
{
    "e": 400,
    "msg": "Bad Request."
}