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
Sales Invoice

Sales Invoices

URL

fetch/sales

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 TDZRh2aDeRqJEHNJwbLfJADA0BV9PGe0 Key obtained from authentiaction.
clientid String M BEST_HMS Client ID
tvoucherid Integer O 0 Optional filter to fetch data for a specific voucher ID
tvouchertype String O GST Invoice B2C Optional filter to retrieve vouchers based on voucher type (e.g.,GST Invoice Local).
tvoucherno String O BP/C/0001/25-26 Optional filter to fetch a specific voucher using the voucher number.
partyname String O BEST_HMS Optional filter to retrieve vouchers for a specific party/customer name.
tvoucherfromdate String O 2025-06-10 Start date filter to retrieve vouchers from this date onwards. (Optional)
tvouchertodate String O 2025-07-10 Start date filter to retrieve vouchers till this date.(Optional)

 

Response Values
Name Data Type Min Length Max Length M/O Sample Value Comments
tsales Array M
tvoucherno String 50 M PI/G/001/22-23 Voucher No in Tally
tvoucherdate String M 2022-04-30 Voucher Date
tvouchertype String 30 M GST Invoice Local Voucher Type in Tally
tfirmid Integer M 1 Firm ID in Tally
clientid String 20 M BEST_HMS Client ID
partyname String 500 M ABC Party Name
partyledgername String 500 M ABC Party Ledger Name
partygstin String 15 M GSTIN GSTIN of Party
placeofsupply String 55 M Kerala Place of Supply - State
place String 55 M Place Place of Party
invoicedetails String M Invoice Details
ledgerdetails String M Ledger Details
transportedby String 50 M Vehicle Name Vehicle Name
tvoucherid Integer M 1 Voucher ID From Tally

 

Sample Request
{
    "key": "QH7LlQ3wQMK9oYEKjeG5QOIVJQT4emeq",
    "clientid": "BEST_HMS",
    "tvouchertype": "GST Invoice B2C",
    "tvoucherno": "BP/C/0001/25-26",
    "partyname": "BEST_HMS",
    "tvoucherfromdate": "2025-06-10",
    "tvouchertodate": "2025-07-10"
}
Sample Success Response
{
    "tsales": [
        {
            "tvoucherno": "PI/G/001/22-23",
            "tvoucherdate": "2022-04-30",
            "tvouchertype": "GST Invoice Local",
            "tfirmid": "1",
            "clientid": "BEST_HMS",
            "partyname": "ABC",
            "partyledgername": "ABC",
            "partygstin": "GSTIN",
            "placeofsupply": "Kerala",
            "place": "Place",
            "invoicedetails": "",
            "ledgerdetails": "",
            "transportedby": "Vehicle Name",
            "tvoucherid": "1"
        }
    ],
    "e": 200,
    "msg": "Success"
}