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
Vouchers

Voucher Transactions

URL

accounts/vouchers

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 kYkloia5s0MojpcBA3bckrPzAex9zU94 Key obtained from authentiaction.
vouchers Array M List of vouchers
place String O Kerala Place of Supply - State
transportedby String O KL01AB123 Vehicle
tvoucherid Integer M 1 Voucher ID from Tally
tvoucherno Integer M 1 Tally Voucher No
tvouchertype String M Payment Type Of Voucher
tvoucherdate String M 2010-10-15 Voucher Date
tnarration String O Paid to AB Narration in Voucher
voucherdetails Array M Details of vouchers
ledgername String M John Name of Ledger
amount Decimal M 250.00 Amount
isdeemedpositive String M Yes Yes or No
partygstin String O 01AMBPG7773M002 GSTIN of Party
gstdetails Array O GST Details
itemname String O itemname Name of Service or Goods (stockitem-> itemname)
hsncode String O 998714 HSN Code of Item
taxablevalue Decimal O 200.50 Taxable Value
cgstrate Decimal O 2.5 CGST Rate
cgstamount Decimal O 5 CGST Amount
cgsthead String O CGST 2.5 CGST Head
sgstrate Decimal O 2.5 SGST Rate
sgstamount Decimal O 5 SGST Amount
sgsthead String O SGST 2.5 SGST Head
igstrate Decimal O 0 IGST Rate
igstamount Decimal O 0 IGST Amount
igsthead String O IGST Head
cessdetails Array O Cess Details
cessrate Decimal O 1 Cess Rate
cessamount Decimal O 2 Cess amount
cesshead String M State Cess Cess Head
tfirmid Integer M 1 Firm ID from Tally
clientid String M ABC_01 Client ID

 

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

 

Sample Request
{
    "key": "QH7LlQ3wQMK9oYEKjeG5QOIVJQT4emeq",
    "vouchers": [
        {
            "place": "Kerala",
            "transportedby": "KL01AB123",
            "tvoucherid": "1",
            "tvoucherno": "1",
            "tvouchertype": "Payment",
            "tvoucherdate": "2010-10-15",
            "tnarration": "Paid to AB",
            "voucherdetails": [
                {
                    "ledgername": "John",
                    "amount": "250.00",
                    "isdeemedpositive": "Yes",
                    "partygstin": "01AMBPG7773M002",
                    "gstdetails": [
                        {
                            "itemname": "itemname",
                            "hsncode": "998714",
                            "taxablevalue": "200.50",
                            "cgstrate": "2.5",
                            "cgstamount": "5",
                            "cgsthead": "CGST 2.5",
                            "sgstrate": "2.5",
                            "sgstamount": "5",
                            "sgsthead": "SGST 2.5",
                            "igstrate": "0",
                            "igstamount": "0",
                            "igsthead": "",
                            "cessdetails": [
                                {
                                    "cessrate": "1",
                                    "cessamount": "2",
                                    "cesshead": "State Cess"
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ],
    "tfirmid": "1",
    "clientid": "ABC_01"
}
Sample Success Response
{
    "status": "OK",
    "e": 200,
    "msg": "Success"
}
Sample Failure Responses
{
    "e": 400,
    "msg": "Bad Request."
}
{
    "e": 401,
    "msg": "Invalid authentication credentials."
}