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
Invoice

Sales Invoice

URL

sales/invoice

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 RdEN4XCqyXyoiiomrzmnszqYyxcnT3Bk Key obtained from authentiaction.
invoices Array M Array of Invoice
invoiceno String M 1 Invoice No
tvouchertype String M Sales Types of Voucher
tvoucherdate String M 2010-01-15 Invoice date
tvoucherid Integer M 2 Voucher ID From Tally
partyname String M John Name of Party
partyledgername String M John Ledger Name of Party
placeofsupply String M Kerala Place of Supply - State
place String M Kochi Final Destination
invoicedetails Array O
itemname String O 20MM METAL Name of Item
hsncode String 35 O 998714 HSN Code of Item
qty Decimal O 10 Quantity
rate Decimal O 120 Rate of Item
taxablevalue Decimal O 1200 Taxable Value
cgstrate Decimal O 2.5 CGST Rate
cgstamount Decimal O 30 CGST Amount
sgstrate Decimal O 2.5 SGST Rate
sgstamount Decimal O 30 SGST Amount
igstrate Decimal O 0 IGST Rate
igstamount Decimal O 0 IGST Amount
cgsthead String O CGST 2.5 Ledger Name of CGST
sgsthead String O SGST 2.5 Ledger Name of SGST
igsthead String O IGST 2.5 Ledger Name of IGST
cessdetails Array O Cess Details
cessrate Decimal O 1 Percentage of Cess
cessamount Decimal O 12 Amount of Cess
cesshead String O State Cess Ledger name of Cess
ledgerdetails Array M
ledgername String 100 M John Name of Ledger
amount Decimal M 1200 Amount
isdeemedpositive String M Yes Yes or No
tnarration String O Sales Narration in Voucher
partygstin String 15 O 01AMBPG7773M002 Party GSTIN
transportedby String O KL01 AB 123 Transported By
tfirmid Integer M 1 Firm ID from Tally
clientid String 20 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",
    "invoices": [
        {
            "invoiceno": "1",
            "tvouchertype": "Sales",
            "tvoucherdate": "2010-01-15",
            "tvoucherid": "2",
            "partyname": "John",
            "partyledgername": "John",
            "placeofsupply": "Kerala",
            "place": "Kochi",
            "invoicedetails": [
                {
                    "itemname": "20MM METAL",
                    "hsncode": "998714",
                    "qty": "10",
                    "rate": "120",
                    "taxablevalue": "1200",
                    "cgstrate": "2.5",
                    "cgstamount": "30",
                    "sgstrate": "2.5",
                    "sgstamount": "30",
                    "igstrate": "0",
                    "igstamount": "0",
                    "cgsthead": "CGST 2.5",
                    "sgsthead": "SGST 2.5",
                    "igsthead": "IGST 2.5",
                    "cessdetails": [
                        {
                            "cessrate": "1",
                            "cessamount": "12",
                            "cesshead": "State Cess"
                        }
                    ]
                }
            ],
            "ledgerdetails": [
                {
                    "ledgername": "John",
                    "amount": "1200",
                    "isdeemedpositive": "Yes",
                    "tnarration": "Sales"
                }
            ],
            "partygstin": "01AMBPG7773M002",
            "transportedby": "KL01 AB 123"
        }
    ],
    "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."
}