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
Cancel Request Register

Register for viewing the cancel requests

URL

sales/cancel/cancel_request_register

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 RJmYkvAd7u80RLwg3NCFMiLf0EXn9C1w Key obtained from authentiaction.
from String 10 10 M 2020-05-29 The from date in yyyy-MM-dd format
to String 10 10 M 2020-05-30 to date in yyyy-MM-dd format
audtype String 1 1 M A Variable for passing the filter condition
A -- for Approved
P -- for Pending
R -- for Rejected
F -- for All

 

Response Values
Name Data Type Min Length Max Length M/O Sample Value Comments
canc_register Array M cancel request register data
date String 10 10 M 29/02/2020 Date in dd/MM/yyyy format
refno Integer 1 999999 M 1003 Referance number of the cncel request
formtype String 1 25 M Gatepass Formtype of the cancel request
amount Decimal M 8100.00 Total amount.This field has 2 decimal values
details String 1 250 M ABBAS - KL 48 1845-0.00 (12MM-12@27) cancel request details
cancreason String 1 250 M AS PER MAIL RECEIVED Reason for request for cancellation
aud String 1 M P Status of the cancellation request
A -- for Approved
P -- for Pending
R -- for Rejected
audremarks String 1 250 M AS PER THE CALL FROM SITE Remarks for audit.

 

Sample Request
{
    "key": "QH7LlQ3wQMK9oYEKjeG5QOIVJQT4emeq",
    "from": "2020-05-29",
    "to": "2020-05-30",
    "audtype": "A"
}
Sample Success Response
{
    "canc_register": [
        {
            "date": "29/02/2020",
            "refno": "1003",
            "formtype": "Gatepass",
            "amount": "8100.00",
            "details": "ABBAS - KL 48 1845-0.00 (12MM-12@27)",
            "cancreason": "AS PER MAIL RECEIVED",
            "aud": "P",
            "audremarks": "AS PER THE CALL FROM SITE"
        }
    ],
    "e": 200,
    "msg": "Success"
}