Invoice Save
Save Invoice
URL
frontoffice/invsave
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 | diBIz2TvzG26hNXq23Kj3Zlr2tfmKJ0V | Key obtained from authentiaction. |
| roundoff | Decimal | M | 0.34 | Round off amount | ||
| source | String | M | S | Source | ||
| lorrycash | Decimal | M | 200.00 | Lorry cash | ||
| gstrefno | String | M | 2305220005 | GST referance number | ||
| islno | Integer | M | 4 | Unique number generated for the entry | ||
| fyear | Integer | M | 23 | Financial Year | ||
| gstreferanceno | String | M | DC/23/2305220005 | GST referance number with folio | ||
| eventtype | String | M | A | Event type, A- Add, E - Edit, C - Cancel | ||
| folio | String | M | DC | Ledger folio | ||
| ledgerdetails | Array | M | Ledger details | |||
| lreferance | Integer | M | 4 | Ledger referance number | ||
| fyear | Integer | M | 23 | Financial year | ||
| ldate | String | M | 2023-04-01 | Ledger date | ||
| lfolio | String | M | DC | Ledger folio | ||
| laccode | Integer | M | 45612 | Ledger account code | ||
| lremark | String | M | REMARK | Ledger remark | ||
| lamount | Decimal | M | 8520.00 | Ledger amount | ||
| dc | String | M | D | Transaction type, D - Debit, C - Credit | ||
| achead | String | M | ACCOUNT HEAD | Account head | ||
| agent | Integer | M | 65454 | Agent code | ||
| saddress | String | M | ADDRESS | Sundry address | ||
| agent | Integer | M | Agent code | |||
| baddress | String | M | ADDRESS | Customer billing address | ||
| accountto | Integer | M | Customer head for ledger posting | |||
| bank | Integer | M | Bank ID | |||
| autoroundoff | String | M | F | Auto roundoff needed or not | ||
| autoroundoffvalue | Integer | M | 1 | Value that will rounded off automatically | ||
| invdata | String | M | Invoice data of the entry (used only in response for fetching invoice data) | |||
| iqmslno | Integer | M | Unique number generated for the entry(used only in web application) | |||
| iqmfyear | Integer | M | Financial year (used only in web application) | |||
| grossamt | Decimal | M | Grand total amount of the entry | |||
| int_referanceno | String | M | Encrypted GST referance number with leger folio (used only in web application) | |||
| 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) | |||
| eventid | String | M | 255 | Event ID | ||
| invmode | String | M | C | Mode of transaction | ||
| invtype | String | M | BB | Transaction type | ||
| edate | String | M | 2023-06-01 | Date of entry | ||
| etime | String | M | 2023-5-22 03:28PM | Time of entry | ||
| firmstateid | String | M | KER | State ID of Firm | ||
| firmgstin | String | M | 32AFJPK9650E1ZH | GSTIN number of Firm | ||
| firmid | Integer | M | 1 | Firm ID | ||
| einv_Client_Id | String | M | A19C0117AFDD4334857150D4370E1CB9 | E-Invoice client ID | ||
| cancel | String | M | F | Whether entry is cancelled or not | ||
| customerdetails | Array | M | Customer details | |||
| name | String | M | CUST | Customer name | ||
| code | Integer | M | 456 | Customer code | ||
| sundrytype | Integer | M | 5 | Type of Sundry | ||
| gstin | String | M | 32AAWFA6937C1ZD | Customer GSTIN number | ||
| active | String | M | T | Is active or not | ||
| agent | Integer | M | 78 | Agent code` | ||
| sphone | String | M | 7894561230 | Customer phone number | ||
| baddress | String | M | CUST ADDRESS | Customer address | ||
| saddress | String | M | CUST SHIP ADDRESS | Cumstomer shipping address | ||
| pan | String | M | 454IJ587M | Customer pan card number | ||
| spin | Integer | M | 695001 | Customer pincode | ||
| agentname | String | M | AGENT | Agent name | ||
| gstregistrationmode | Integer | M | 1 | GST resgistration mode, 1 - normal, 2- compound, 3 - unregistered | ||
| customername | String | M | CUST | Customer name | ||
| customercode | String | M | 7894 | Customer code | ||
| cpin | Integer | M | 695001 | Customer pincode | ||
| placeid | Integer | M | 31 | Place ID | ||
| placedetails | Array | M | Place details | |||
| place | String | M | PLACE NAME | Name of the place | ||
| placecode | Integer | M | 31 | Place ID | ||
| stateid | String | M | KER | State ID | ||
| gststatecode | Integer | M | 31 | GST code of state | ||
| distance | Decimal | M | 70.00 | distance between firm and customer place | ||
| vcode | Integer | M | 654 | Vehicle code | ||
| vtype | String | M | X | Vehicle type, X - external vehicle, O - own vehicle | ||
| vehicledetails | Array | M | Vehicle details | |||
| vcode | Integer | M | 68 | Vehicle code | ||
| rgno | String | M | KL 01 AA 1234 | Vehicle register number | ||
| vtype | String | M | X | Vehicle type, X - external vehicle, O - own vehicle | ||
| capacity | Decimal | M | 150.00 | Vehicle capacity | ||
| ecapacity | Decimal | M | 150.00 | Vehicle capcity extra | ||
| height | Decimal | M | 50.00 | Height of the vehicle | ||
| length | Decimal | M | 50.00 | length of the vehicle | ||
| width | Decimal | M | 50.00 | width of the vehicle | ||
| constant | Decimal | M | 1728.00 | Constant of the vehicle | ||
| mtype | String | M | I | Metrice type, I - Inches, M - Metres | ||
| freeze | String | M | F | Vehicle freezed or not | ||
| drivercode | Integer | M | 89 | Driver code | ||
| taxcalcneeded | String | M | T | Needed tax calculation | ||
| remarks | String | M | REMARKS | Entry remarks | ||
| itemdetails | Array | M | Product details | |||
| scheduleid | Integer | M | 10 | Schedule ID for tax calculation | ||
| uomid | Integer | M | 7 | Unit of Measurement ID | ||
| qty | Decimal | M | 800 | Product quantity | ||
| aqty | Decimal | M | 100.00 | Additional product quantity | ||
| uprice | Decimal | M | 35.00 | Rate of product per unit of product | ||
| discount | Decimal | M | 100.00 | Discount for sale | ||
| userenteredprice | Decimal | M | 30.00 | Price of product entered by Customer | ||
| taxpercent | Decimal | M | 5.00 | Percentage of tax | ||
| taxdetails | Array | M | Tax details | |||
| TaxPercentage | Decimal | M | 5.00 | Pecentage of tax | ||
| TaxDisplayName | String | M | SGST | Name of tax | ||
| PostingHeadCode | Integer | M | 110 | Sales posting head | ||
| PostingAmount | Decimal | M | 1100.00 | Amount of tax | ||
| TaxFormulaCode | String | M | SGST | Formula code for GST calculation, SGST, CGST, IGST | ||
| taxrowid | Integer | M | 5 | Row index of tax rows | ||
| detslno | Integer | M | 1 | Serial number of entry in details table | ||
| itemcode | Integer | M | 8 | Product code | ||
| itemdetails | Array | M | Product details | |||
| pname | String | M | PROD | Product name | ||
| hsncode | String | M | 25171010 | HSN code | ||
| pcode | Integer | M | 954 | Product code | ||
| hsnid | Integer | M | 2661 | HSN ID | ||
| stockunit | Integer | M | 10 | Stock unit | ||
| ptype | String | M | P | Product type, P - Product, M - Material, S- Service | ||
| saleshead | Integer | M | 1 | Sales head | ||
| scheduleid | Integer | M | 3 | Schedule ID | ||
| productunitwiseratedet | Array | M | Unit wise rate details of the product | |||
| prate | Decimal | M | 54.25 | Product rate | ||
| uomid | Integer | M | 11 | Unit of measurement ID | ||
| pcode | Integer | M | 954 | Product code | ||
| editinvoicealso | String | M | false | Loading pass edit flag if true Invoice is also edited (used only in loading pass entries) |
Response Values
| Name | Data Type | Min Length | Max Length | M/O | Sample Value | Comments |
|---|---|---|---|---|---|---|
| islno | Integer | M | 12 | Unique number generated for the entry | ||
| folio | String | M | DC | Ledger folio | ||
| fyear | Integer | M | 23 | Financial year | ||
| gstreferanceno | String | M | BB/202306010012 | GST referance number with transaction type | ||
| gstrefno | Integer | M | 202306010012 | GST referance number | ||
| 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) |
Sample Request
{
"key": "QH7LlQ3wQMK9oYEKjeG5QOIVJQT4emeq",
"roundoff": "0.34",
"source": "S",
"lorrycash": "200.00",
"gstrefno": "2305220005",
"islno": "4",
"fyear": "23",
"gstreferanceno": "DC/23/2305220005",
"eventtype": "A",
"folio": "DC",
"ledgerdetails": [
{
"lreferance": "4",
"fyear": "23",
"ldate": "2023-04-01",
"lfolio": "DC",
"laccode": "45612",
"lremark": "REMARK",
"lamount": "8520.00",
"dc": "D",
"achead": "ACCOUNT HEAD",
"agent": "65454"
}
],
"saddress": "ADDRESS",
"agent": "",
"baddress": "ADDRESS",
"accountto": "",
"bank": "",
"autoroundoff": "F",
"autoroundoffvalue": "1",
"invdata": "",
"iqmslno": "",
"iqmfyear": "",
"grossamt": "",
"int_referanceno": "",
"einvirn": "",
"einvjson": "",
"einvqrcode": "",
"einvcancdate": "",
"ewaybillno": "",
"ewbresult": "",
"lcashrefno": "",
"eventid": "255",
"invmode": "C",
"invtype": "BB",
"edate": "2023-06-01",
"etime": "2023-5-22 03:28PM",
"firmstateid": "KER",
"firmgstin": "32AFJPK9650E1ZH",
"firmid": "1",
"einv_Client_Id": "A19C0117AFDD4334857150D4370E1CB9",
"cancel": "F",
"customerdetails": [
{
"name": "CUST",
"code": "456",
"sundrytype": "5",
"gstin": "32AAWFA6937C1ZD",
"active": "T",
"agent": "78",
"sphone": "7894561230",
"baddress": "CUST ADDRESS",
"saddress": "CUST SHIP ADDRESS",
"pan": "454IJ587M",
"spin": "695001",
"agentname": "AGENT",
"gstregistrationmode": "1"
}
],
"customername": "CUST",
"customercode": "7894",
"cpin": "695001",
"placeid": "31",
"placedetails": [
{
"place": "PLACE NAME",
"placecode": "31",
"stateid": "KER",
"gststatecode": "31",
"distance": "70.00"
}
],
"vcode": "654",
"vtype": "X",
"vehicledetails": [
{
"vcode": "68",
"rgno": "KL 01 AA 1234",
"vtype": "X",
"capacity": "150.00",
"ecapacity": "150.00",
"height": "50.00",
"length": "50.00",
"width": "50.00",
"constant": "1728.00",
"mtype": "I",
"freeze": "F"
}
],
"drivercode": "89",
"taxcalcneeded": "T",
"remarks": "REMARKS",
"itemdetails": [
{
"scheduleid": "10",
"uomid": "7",
"qty": "800",
"aqty": "100.00",
"uprice": "35.00",
"discount": "100.00",
"userenteredprice": "30.00",
"taxpercent": "5.00",
"taxdetails": [
{
"TaxPercentage": "5.00",
"TaxDisplayName": "SGST",
"PostingHeadCode": "110",
"PostingAmount": "1100.00",
"TaxFormulaCode": "SGST"
}
],
"taxrowid": "5",
"detslno": "1",
"itemcode": "8",
"itemdetails": [
{
"pname": "PROD",
"hsncode": "25171010",
"pcode": "954",
"hsnid": "2661",
"stockunit": "10",
"ptype": "P",
"saleshead": "1",
"scheduleid": "3",
"productunitwiseratedet": [
{
"prate": "54.25",
"uomid": "11",
"pcode": "954"
}
]
}
]
}
],
"editinvoicealso": "false"
}Sample Success Response
{
"islno": "12",
"folio": "DC",
"fyear": "23",
"gstreferanceno": "BB/202306010012",
"gstrefno": "202306010012",
"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":""}",
"e": 200,
"msg": "Success"
}Sample Failure Responses
{
"e": 499,
"msg": "Invalid Session"
}