Codelayer API Documentation

  • Introduction

    • General
    • Version History
  • API Reference

    • System

      • License request
      • Register Device
      • Authentication
    • Acounts

      • Reports

        • Daily Statement
        • Daybook
        • Debtors Balance
    • Masters

      • Customers
      • Products
    • Sales

      • Reports

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

Display the Gatepass Register of the selected dates.

URL

sales/reports/gatepass_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 Ickub8eP2DlZ0gDdAnjq37GnYp0l8P6w Key obtained from authentiaction.
from String 10 10 M 2020-03-18 The from date in yyyy-MM-dd format
to String 10 10 M 2020-03-19 To date in yyyy-MM-dd format
customer_id Integer M 0 ID from Customer Name selection. Omit this field or pass 0 to select all customers.
product_id Integer M 0 Product ID from product selection. Omit this field or pass 0 to select all products.

 

Response Values
Name Data Type Min Length Max Length M/O Sample Value Comments
gp_register Array M Gatepass register data
date String 10 10 M 30/10/2019 Date in dd/MM/yyyy format
gpno Integer 1 M 2700 Gatepass number
customer String 50 M SRENIVAS NAGANPALLY Name of the customer
lorry String 15 M TS16UB 1644 Number or description of the transporting vehicle.
item_name String 1 15 M 12 MM Product name
qty Decimal M 210.000 Quantity in Tonne. This field can have up to 3 decimal places.
rate Decimal M 16.00 Rate of the product. This field can have up to 2 decimal places
taxable_value Decimal M 3770.00 The Taxable value of the product. This field can have up to 2 decimal places.
cgstamt Decimal M 25.00 CGST Amount. This field has 2 decimal places.
sgstamt Decimal M 12.00 SGST Amount. This field has 2 decimal places.
igstamt Decimal M 0.00 IGST Amount. This field has 2 decimal places.
gtotal Decimal M 4750.00 Total value. This field has 2 decimal places.

 

Sample Request
{
    "key": "QH7LlQ3wQMK9oYEKjeG5QOIVJQT4emeq",
    "from": "2020-03-18",
    "to": "2020-03-19",
    "customer_id": "",
    "product_id": ""
}
Sample Success Response
{
    "gp_register": [
        {
            "date": "30/10/2019",
            "gpno": "2700",
            "customer": "SRENIVAS NAGANPALLY",
            "lorry": "TS16UB 1644",
            "item_name": "12 MM",
            "qty": "210.000",
            "rate": "16.00",
            "taxable_value": "3770.00",
            "cgstamt": "25.00",
            "sgstamt": "12.00",
            "igstamt": "0.00",
            "gtotal": "4750.00"
        }
    ],
    "e": 200,
    "msg": "Success"
}
Sample Failure Responses
{
    "e": 400,
    "msg": "Bad Request."
}