Codelayer API Documentation

  • Introduction

    • General
  • API Reference

    • System

      • License request
      • Register Device
      • Authentication
    • Sales

      • Active Firm
      • Add Customer
      • Check Customer
      • Device Location
      • Master Place
      • Master Routes
      • Notification Details
      • Product Summary
      • Return details
      • Route Closing
      • Route Customers
      • Route Customers Balance
      • Route Details
      • Route Path
      • Route Products
      • Route Products Return
      • Route Report
      • Route Return
      • Route Salesmen
      • Route Save
      • Route Save With Remarks
      • Route Shops
      • Sales Closing
      • Sales Details
      • Shop Limit Override Request
      • Stock Transfer
      • Update Device Token
      • Update Notifications
      • update Shop Details
    • Response Codes
Codelayer API Documentation
Active Firm

URL

sales/get_firm

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 z5y5TZqUQdiShjBagueBAmZua1DuZGoG Key obtained from authentiaction.

 

Response Values
Name Data Type Min Length Max Length M/O Sample Value Comments
firm_details Array M
firmname String M
firmdesc String M
firmadd String M
gstin String M

 

Sample Request
{
    "key": "QH7LlQ3wQMK9oYEKjeG5QOIVJQT4emeq"
}
Sample Success Response
{
    "firm_details": [
        {
            "firmname": "",
            "firmdesc": "",
            "firmadd": "",
            "gstin": ""
        }
    ],
    "e": 200,
    "msg": "Success"
}