Codelayer API Documentation

  • Introduction

    • General Information
  • API Reference

    • Fetch

      • Account Group
      • Account Heads
      • Firm Details
      • Purchase
      • Sales Invoice
      • Stock Item
      • UOM
      • Vouchers
    • Purchase

      • Purchase Invoice
    • Sales

      • Invoice
      • StockItem
      • UOM
    • System

      • Authentication
    • Accounts

      • Account Group
      • Account Heads
      • Firm Details
      • Vouchers
    • Response Codes
Codelayer API Documentation
Firm Details

URL

accounts/firmdet

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 r3tanzALxH3kQ1GuXSpLsHJVn4v8K49H Key obtained from authentiaction.
tfirmdb Array M
firmname String 1 55 M ABC Firm Company Name
clientid String 1 20 M ABC_01 Client ID
tfirmid Integer M 1 Firm ID
firmgstin String 15 M 01AMBPG7773M002 GSTIN of Firm

 

Response Values
Name Data Type Min Length Max Length M/O Sample Value Comments
status String M OK Updation Status

 

Sample Request
{
    "key": "QH7LlQ3wQMK9oYEKjeG5QOIVJQT4emeq",
    "tfirmdb": [
        {
            "firmname": "ABC Firm",
            "clientid": "ABC_01",
            "tfirmid": "1",
            "firmgstin": "01AMBPG7773M002"
        }
    ]
}
Sample Success Response
{
    "status": "OK",
    "e": 200,
    "msg": "Success"
}
Sample Failure Responses
{
    "e": 400,
    "msg": "Bad Request."
}
{
    "e": 401,
    "msg": "Invalid authentication credentials."
}