Codelayer API Documentation

Fetch card settlement details

frontoffice/getcardsettlement

POST

application/json

application/json

Parameter	Data Type	Min	Max	M/O	Sample Value	Comments
key	String	32	32	M	Q1iu9oY7nML27jaLGkjS8f5FrMgoe8TP	Key obtained from authentiaction.
fyear	Integer			M	23	Financial YEar

 

Name	Data Type	Min Length	Max Length	M/O	Sample Value	Comments
lstCardSettlement	Array			M		Card settlement details
Billno	Integer			M	10	Sale bill no
BillDate	String			M	2023-04-01	Sale bill entry date as string
BillType	String			M	BB	Sale bill transaction type
Customer	String			M	CUSTOMER	Customer name
CustomerCode	Integer			M	789	Customer code
Vehicle	String			M	KL 01 AA 1234	Vehicle Registration no.
VehicleCode	Integer			M	987	Vehicle code
Amount	Decimal			M	1000.00	Sale amount without tax
Discount	Decimal			M	100.00	Sale discount given to the customer
TaxAmount	Decimal			M	50.00	Sale tax amount
NetAmount	Decimal			M	1050.00	Total sale amount including tax
Bankcode	Integer			M	99	Bank code
BankName	String			M	BANK	Bank name
BankChargePer	Decimal			M	5.00	Percentage of charge amount charged by the bank
BankCharge	Decimal			M	50.00	Amount charged by the bank
BankAmount	Decimal			M	1000.00	Total Amount after bank charge processed
settlement	String			M	T	Card payment settled status T Settled F Not Settled
CardSettlementNo	Integer			M	5	Unique number of card settlement entry
fyear	Integer			M	23	Financial Year
itemdetails	Array			M		Product details of the sale using card payment
itemcode	Integer			M	40	Product code
itemdetails	Array			M		Product details
pname	String			M	PRODUCT NAME	Product name
hsncode	String			M	120007	HSN code of the product
co_code	String			M	40	Product code as string
partno	String			M	799456	Part number of the product
pcode	Integer			M	40	Product code
exptype	String			M	P	Item type P Product M Material S Service
hsnid	Integer			M	12	Unique identification number of the HSN code
stockunit	Integer			M	17	Unit stock of the product
ptype	String			M	P	Product Type
saleshead	Integer			M	5	Sales head for the ledger posting
scheduleid	Integer			M	25	Tax schedule identification number
productunitwiseratedet	Array			M		Unit wise rate details of the product
uomid	Integer			M	2	Unit of measurement identification number
pcode	Integer			M	40	Product code
prate	Decimal			M	32.50	Rate of product per unit
scheduleid	Integer			M	25	Tax schedule identification number
uomid	Integer			M	2	Unit of measurement identification number
qty	Decimal			M	10.00	Product quantity saled
aqty	Decimal			M	5.00	additional product quantity saled
uprice	Decimal			M	32.50	Unit price of the product
discount	Decimal			M	1.50	Default product discount
userenteredprice	Decimal			M	30.50	Unit price entered by the user
taxpercent	Decimal			M	5.00	Percentage of tax used for tax calculation
taxdetails	Array			M		Details of tax calculation
TaxPercentage	Decimal			M	5.00	Percentage of tax used for tax calculation
TaxDisplayName	String			M	SGST	Tax Calculation name
PostingHeadCode	Integer			M	3	Tax posting head
PostingReverseCode	Integer			M	9	Reverse tax posting code
PostingAmount	Decimal			M	50.00	Tax amount after tax calculation
TaxFormulaCode	String			M	SGST	Formula used for tax calculation
taxrowid	Integer			M	1	Row id of calculated tax details

 

{
    "key": "QH7LlQ3wQMK9oYEKjeG5QOIVJQT4emeq",
    "fyear": "23"
}

{
    "lstCardSettlement": [
        {
            "Billno": "10",
            "BillDate": "2023-04-01",
            "BillType": "BB",
            "Customer": "CUSTOMER",
            "CustomerCode": "789",
            "Vehicle": "KL 01 AA 1234",
            "VehicleCode": "987",
            "Amount": "1000.00",
            "Discount": "100.00",
            "TaxAmount": "50.00",
            "NetAmount": "1050.00",
            "Bankcode": "99",
            "BankName": "BANK",
            "BankChargePer": "5.00",
            "BankCharge": "50.00",
            "BankAmount": "1000.00",
            "settlement": "T",
            "CardSettlementNo": "5",
            "fyear": "23",
            "itemdetails": [
                {
                    "itemcode": "40",
                    "itemdetails": [
                        {
                            "pname": "PRODUCT NAME",
                            "hsncode": "120007",
                            "co_code": "40",
                            "partno": "799456",
                            "pcode": "40",
                            "exptype": "P",
                            "hsnid": "12",
                            "stockunit": "17",
                            "ptype": "P",
                            "saleshead": "5",
                            "scheduleid": "25",
                            "productunitwiseratedet": [
                                {
                                    "uomid": "2",
                                    "pcode": "40",
                                    "prate": "32.50"
                                }
                            ]
                        }
                    ],
                    "scheduleid": "25",
                    "uomid": "2",
                    "qty": "10.00",
                    "aqty": "5.00",
                    "uprice": "32.50",
                    "discount": "1.50",
                    "userenteredprice": "30.50",
                    "taxpercent": "5.00",
                    "taxdetails": [
                        {
                            "TaxPercentage": "5.00",
                            "TaxDisplayName": "SGST",
                            "PostingHeadCode": "3",
                            "PostingReverseCode": "9",
                            "PostingAmount": "50.00",
                            "TaxFormulaCode": "SGST"
                        }
                    ],
                    "taxrowid": "1"
                }
            ]
        }
    ],
    "e": 200,
    "msg": "Success"
}

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