Codelayer API Documentation

Invoice Data

Get Invoice Data

URL

frontoffice/invoicedata

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	anFvtOd1aUSHVNGxaG3OOiBUOrLSlh6P	Key obtained from authentiaction.
islno	Integer			M	12	Unique number generated for the entry
fyear	Integer			M	23	Financial Year
firmid	Integer			M	1	Firm ID
fromdate	String			M	2023-06-01	Date from
todate	String			M	2023-06-12	Date to
excludecancel	String			M	F	Exclude cancelled entries

Response Values

Name	Data Type	M/O	Sample Value	Comments
invoicedet	Array	M		Invoice Details
invmode	String	M	D	Mode transaction, C - Credit, D - Debit
invtype	String	M	BB	Transaction type
edate	String	M	2023-04-01	Entry Date
firmid	Integer	M	1	Firm ID
cancel	String	M	F	Cancelled entry or not
customername	String	M	TEST	Name of the customer
customercode	Integer	M	4564	Customer code
saddress	String	M	ADDRESS	Customer address
agent	Integer	M	78	Agent code
cpin	Integer	M	695001	Customer Pincode
placeid	Integer	M	61	Place Code
vcode	Integer	M	6023	Vehicle Code
vtype	String	M	X	Vehicle type, X - external vehicle, O - own vehicle
remarks	String	M	test remarks	Entry remarks
gstreferanceno	String	M	BU/4	GST referance number
islno	Integer	M	4	Unique number generated for the entry
fyear	Integer	M	23	Financial Year
invdata	String	M	{"key":"AiKwioCpTUivXM0Cr2fl9A==", "eventid":"255", "invmode":"C", "invtype":"BU", "edate":"2023-4-27", "etime":"2023-4-27 07:18AM", "firmstateid":"KER", "firmgstin":"32AFJPK9650E1ZH", "firmid":1, "einv_Client_Id":"A19C0117AFDD4334857150D4370E1CB9", "cancel":"F", "customerdetails":null, "customername":"SAMYA, ", "customercode":0, "saddress":"", "agent":0, "baddress":"", "cpin":0, "accountto":0, "placeid":10, "placedetails":{"place":"MANJOOR","placecode":10,"stateid":"KER","gststatecode":32,"distance":40.00}, "vcode":6448,"vtype":"X", "vehicledetails":{"ccode":"","vcode":6448,"rgno":"KL3AF8010","vtype":"X","vehiclename":"","capacity":770.00,"ecapacity":0.00,"height":0.00,"length":0.00,"width":0.00,"constant":35.33,"mtype":"I","freeze":"F","mtypename":"Inches","vehiclecapacityStr":"770.00"}, "drivercode":0, "taxcalcneeded":"T", "remarks":""}	Invoice data of the entry (used only in response for fetching invoice data)
grossamt	Decimal	M	11956.00	Grand total
eventid	String	M		Event ID
etime	String	M		Time of bill entered
firmstateid	String	M		State ID of firm
firmgstin	String	M		GSTIN of firm
einv_Client_Id	String	M		E-Invoice Client ID
accountto	String	M		Customer head for ledger posting
placedetails	Array	M		Place Details
place	String	M		Customer place name
placecode	Integer	M		Place ID
stateid	String	M		State ID
gststatecode	Integer	M		State code for GST
distance	Decimal	M		Distance between Firm and Customer place
vehicledetails	Array	M		Vehicle details
vcode	Integer	M		Vehicle code
rgno	String	M		Registration number of the vehicle
vtype	String	M		Vehicle type, X - external vehicle, O - own vehicle
capacity	Decimal	M		Weight loading capacity of vehicle
ecapacity	Decimal	M		Extra weight loading capacity of vehicle
height	Decimal	M		Height of vehicle
length	Decimal	M		Length of vehicle
width	Decimal	M		Width of vehicle
constant	Decimal	M		Constant speed of vehicle
mtype	String	M		Metrics type, M - Meters, I - inches
freeze	String	M		Whether vehicle is active or not
drivercode	Integer	M		Driver code
taxcalcneeded	String	M		Whether tax calculation is needed or not
itemdetails	Array	M		Item details
itemcode	Integer	M		Product code
itemdetails	Array	M		Item details
pname	String	M		Product name
hsncode	String	M		HSN code of product
pcode	Integer	M		Product code
hsnid	String	M		HSN ID of product
stockunit	Integer	M		Stock unit of product in product master
ptype	String	M		Product type, P - Product, M - Material, S - Service
saleshead	Integer	M		Sales head
scheduleid	Integer	M		Schedule ID for tax calculation
productunitwiseratedet	Array	M		Unit wise rate details of product
uomid	Integer	M		Unit of Measurement ID
pcode	Integer	M		Product code
prate	Decimal	M		Rate of product
scheduleid	Integer	M		Schedule ID for tax calculation
uomid	Integer	M		Unit of Measurement ID
qty	Decimal	M		Product quantity
aqty	Decimal	M		Additional product quantity
uprice	Decimal	M		Rate of product per unit of product
discount	Decimal	M		Discount for sale
userenteredprice	Decimal	M		Price of product entered by Customer
taxpercent	Decimal	M		Percentage of tax
taxdetails	Array	M		Tax details
TaxPercentage	Decimal	M		Pecentage of tax
TaxDisplayName	String	M		Name of tax
PostingHeadCode	Integer	M		Sales posting head
PostingAmount	Decimal	M		Amount of tax
TaxFormulaCode	String	M		Formula code for GST calculation, SGST, CGST, IGST
detslno	Integer	M		Serial number of entry in details table
taxrowid	Integer	M		Row index of tax rows
roundoff	Decimal	M		Round off amount
source	String	M		Source, S - Stock, B - Bunker, P - From Purchase
bank	Integer	M		Bank ID
autoroundoff	String	M		Auto roundoff needed or not
autoroundoffvalue	Integer	M		Value that will rounded off automatically
lorrycash	Decimal	M		Lorry cash amount
gstrefno	Integer	M		GST referance number
eventtype	String	M		Event type, A - Add, E - Edit, C - Cancel
folio	String	M		Ledger folio
iqmslno	Integer	M		Unique number generated for the entry(used only in web application)
iqmfyear	Integer	M		Financial year (used only in web application)
int_referanceno	String	M		Encrypted GST referance number with leger folio (used only in web application)
ledgerdetails	Array	M		Ledger details
lfolio	String	M		Ledger folio
laccode	Integer	M		Ledger posting sales head account code
extype	String	M		Expense type (not used in Front Office API)
lremark	String	M		Ledger posting remarks of the entry
lamount	Decimal	M		Ledger posting amount
dc	String	M		Mode of sale, D - Debit, C - Credit
einvirn	String	M		Unique Invoice Referance Number (used only in web application)
einvjson	String	M		E-Invoice data as JSON string (used only in web application)
einvqrcode	String	M		E-Invoice unique QR code (used only in web application)
einvcancdate	String	M		E-Invoice date of entry cancellation (used only in web application)
ewaybillno	String	M		Unique number generated for Eway bill (used only in web application)
ewbresult	String	M		Fetches the result whether generation of Eway bill is succes or not (used only in web application)
lcashrefno	String	M		Lorry cash referance number, if lorry cash is entered data will be fetched (used for add or edit event type on saving an invoice)
customerdetails	Array	M		Customer details
name	String	M		Customer name
code	Integer	M		Customer code
sundrytype	Integer	M		Sundry type
gstin	String	M		Customer GSTIN number
active	String	M		Whether sundry is active or not
agent	Integer	M		Agent code
sphone	String	M		Customer phone number
baddress	String	M		Customer billing address
saddress	String	M		Customer address
pan	String	M		Customer PAN number
spin	String	M		Customer Pin code
agentname	String	M		Agent name
gstregistrationmode	Integer	M		GST registration mode, 1 - Normal, 2 - Compound, 3 - Unregistered, 4 - NotifiedServiceProviderWithReverseCharge

Sample Request

{
    "key": "QH7LlQ3wQMK9oYEKjeG5QOIVJQT4emeq",
    "islno": "12",
    "fyear": "23",
    "firmid": "1",
    "fromdate": "2023-06-01",
    "todate": "2023-06-12",
    "excludecancel": "F"
}

Sample Success Response

{
    "invoicedet": [
        {
            "invmode": "D",
            "invtype": "BB",
            "edate": "2023-04-01",
            "firmid": "1",
            "cancel": "F",
            "customername": "TEST",
            "customercode": "4564",
            "saddress": "ADDRESS",
            "agent": "78",
            "cpin": "695001",
            "placeid": "61",
            "vcode": "6023",
            "vtype": "X",
            "remarks": "test remarks",
            "gstreferanceno": "BU/4",
            "islno": "4",
            "fyear": "23",
            "invdata": "{"key":"AiKwioCpTUivXM0Cr2fl9A==",rn"eventid":"255",rn"invmode":"C",rn"invtype":"BU",rn"edate":"2023-4-27",rn"etime":"2023-4-27 07:18AM",rn"firmstateid":"KER",rn"firmgstin":"32AFJPK9650E1ZH",rn"firmid":1,rn"einv_Client_Id":"A19C0117AFDD4334857150D4370E1CB9",rn"cancel":"F",rn"customerdetails":null,rn"customername":"SAMYA, ",rn"customercode":0,rn"saddress":"",rn"agent":0,rn"baddress":"",rn"cpin":0,rn"accountto":0,rn"placeid":10,rn"placedetails":{"place":"MANJOOR","placecode":10,"stateid":"KER","gststatecode":32,"distance":40.00},rn"vcode":6448,"vtype":"X",rn"vehicledetails":{"ccode":"","vcode":6448,"rgno":"KL3AF8010","vtype":"X","vehiclename":"","capacity":770.00,"ecapacity":0.00,"height":0.00,"length":0.00,"width":0.00,"constant":35.33,"mtype":"I","freeze":"F","mtypename":"Inches","vehiclecapacityStr":"770.00"},rn"drivercode":0,rn"taxcalcneeded":"T",rn"remarks":""}",
            "grossamt": "11956.00",
            "eventid": "",
            "etime": "",
            "firmstateid": "",
            "firmgstin": "",
            "einv_Client_Id": "",
            "accountto": "",
            "placedetails": [
                {
                    "place": "",
                    "placecode": "",
                    "stateid": "",
                    "gststatecode": "",
                    "distance": ""
                }
            ],
            "vehicledetails": [
                {
                    "vcode": "",
                    "rgno": "",
                    "vtype": "",
                    "capacity": "",
                    "ecapacity": "",
                    "height": "",
                    "length": "",
                    "width": "",
                    "constant": "",
                    "mtype": "",
                    "freeze": ""
                }
            ],
            "drivercode": "",
            "taxcalcneeded": "",
            "itemdetails": [
                {
                    "itemcode": "",
                    "itemdetails": [
                        {
                            "pname": "",
                            "hsncode": "",
                            "pcode": "",
                            "hsnid": "",
                            "stockunit": "",
                            "ptype": "",
                            "saleshead": "",
                            "scheduleid": "",
                            "productunitwiseratedet": [
                                {
                                    "uomid": "",
                                    "pcode": "",
                                    "prate": ""
                                }
                            ]
                        }
                    ],
                    "scheduleid": "",
                    "uomid": "",
                    "qty": "",
                    "aqty": "",
                    "uprice": "",
                    "discount": "",
                    "userenteredprice": "",
                    "taxpercent": "",
                    "taxdetails": [
                        {
                            "TaxPercentage": "",
                            "TaxDisplayName": "",
                            "PostingHeadCode": "",
                            "PostingAmount": "",
                            "TaxFormulaCode": ""
                        }
                    ],
                    "detslno": "",
                    "taxrowid": ""
                }
            ],
            "roundoff": "",
            "source": "",
            "bank": "",
            "autoroundoff": "",
            "autoroundoffvalue": "",
            "lorrycash": "",
            "gstrefno": "",
            "eventtype": "",
            "folio": "",
            "iqmslno": "",
            "iqmfyear": "",
            "int_referanceno": "",
            "ledgerdetails": [
                {
                    "lfolio": "",
                    "laccode": "",
                    "extype": "",
                    "lremark": "",
                    "lamount": "",
                    "dc": ""
                }
            ],
            "einvirn": "",
            "einvjson": "",
            "einvqrcode": "",
            "einvcancdate": "",
            "ewaybillno": "",
            "ewbresult": "",
            "lcashrefno": "",
            "customerdetails": [
                {
                    "name": "",
                    "code": "",
                    "sundrytype": "",
                    "gstin": "",
                    "active": "",
                    "agent": "",
                    "sphone": "",
                    "baddress": "",
                    "saddress": "",
                    "pan": "",
                    "spin": "",
                    "agentname": "",
                    "gstregistrationmode": ""
                }
            ]
        }
    ],
    "e": 200,
    "msg": "Success"
}

Sample Failure Responses

{
    "e": 499,
    "msg": "Invalid Session"
}