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
Debtors Balance

Display the Debtors Balance of the selected dates.

URL

accounts/reports/debtors_balance

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 4S2ZfkeEyPckDBXydow7EjP2v68vE0IB Key obtained from authentiaction.
from String 10 10 M 2019-05-30 The from date in yyyy-MM-dd format
to String 10 10 M 2019-11-30 To date in yyyy-MM-dd format

 

Response Values
Name Data Type Min Length Max Length M/O Sample Value Comments
balance Array M List of Debtors Balance
achead String 3 100 M RATHNAKAR Name of the debitor.
Amount String M -31200.00 The balance amount. Debit value is indicated by a negative number.

 

Sample Request
{
    "key": "QH7LlQ3wQMK9oYEKjeG5QOIVJQT4emeq",
    "from": "2019-05-30",
    "to": "2019-11-30"
}
Sample Success Response
{
    "balance": [
        {
            "achead": "RATHNAKAR",
            "Amount": "-31200.00"
        }
    ],
    "e": 200,
    "msg": "Success"
}
Sample Failure Responses
{
    "e": 400,
    "msg": "Bad Request."
}