Entities

This page serves as a repository of entities in the GST API requests and responses for seamless integration. Users can access the data from this page whenever needed for different API interactions.

Compliance API

Taxpayer session

Key	Type	Description	Example
access_token	string	Taxpayer access token	eyJhbGcxxxxxxxxxxxx.eyJzdWIiOiIxMjxxxxxxxxxxxxxxx.SflKxwRJSMxxxxxxxx
status_cd	string	Status code	Possible values: 1 (Success), 0 (Failure)
token_expiry	string	Token expiry time in epoch	1712392826345
session_expiry	string	Session expiry time in epoch	1712947710000

Taxpayer API response

Key	Type	Description	Example
status_cd	string	Status code	Possible values: 1 (Success), 0 (Failure)

GSTR-3B

Key	Type	Description	Example
gstin	string	Supplier GSTIN	24AAACJ3770E2ZZ
ret_period	num	Return period	022020
sup_details	object	Details of Outward Supplies and inward supplies liable to reverse charge	Check object
inter_sup	object	Details of inter-state supplies made to unregistered persons, composition taxable persons and UIN holders	Check object
eco_dtls	object	Supplies notified under section 9(5) of the CGST Act, 2017	Check object
itc_elg	object	Eligible ITC	Check object
inward_sup	object	Values of exempt, nil-rated and non-GST inward supplies	Check object
intr_ltfee	object	Interest & late fees payable	Check object

Outward supplies

Key	Type	Description	Parent	Example
osup_nil_exmp	object	Other outward supplies (Nil rated, exempted)	sup_details	"txval": 250
osup_nongst	object	Non-GST outward supplies	sup_details	"txval": 250
osup_zero	object	Outward taxable supplies (zero rated )	sup_details	"txval": 250, "iamt": 100, "csamt": 400
osup_det	object	Outward taxable supplies (other than zero rated, nil rated and exempted)	sup_details	"txval": 250, "iamt": 100, "camt": 200, "samt": 300, "csamt": 400
isup_rev	object	Inward supplies (liable to reverse charge)	sup_details	"txval": 250, "iamt": 100, "camt": 200, "samt": 300, "csamt": 400
txval	num	Total Taxable value	osup_det	200
iamt	num	Integrated Tax amount available in the current month	osup_det	200
camt	num	Central Tax amount available in the current month	osup_det	200
samt	num	State/UT Tax amount available in the current month	osup_det	200
csamt	num	Cess Tax amount available in the current month	osup_det	200

inter_sup

Key	Type	Description	Parent	Example
comp_details	array	Supplies made to Composition Taxable Persons	inter_sup	{ "pos": "07", "txval": 250, "iamt": 200 }
uin_details	array	Supplies made to UIN holders	inter_sup	{ "pos": "07", "txval": 250, "iamt": 200 }
unreg_details	array	Supplies made to Unregistered Persons	inter_sup	{ "pos": "07", "txval": 250, "iamt": 200 }
pos	string	Place of Supply (State/UT)	comp_details	"07"
iamt	num	IGST Amount as per invoice	comp_details	200
txval	num	Taxable Value	comp_details	250

eco_dtls

Key	Type	Description	Parent	Example
eco_sup	object	Taxable supplies on which electronic commerce operator pays tax u/s 9(5)	eco_dtls	"txval": 250, "iamt": 100, "camt": 200, "samt": 300, "csamt": 400
eco_reg_sup	object	Taxable supplies made by registered person through electronics commerce operator	eco_dtls	"txval": 250
txval	num	Taxable Value	eco_sup	250
iamt	num	Integrated Tax amount available in the current month	eco_sup	100
camt	num	Central Tax amount available in the current month	eco_sup	200
samt	num	State/UT Tax amount available in the current month	eco_sup	300
csamt	num	Cess Tax amount available in the current month	eco_sup	400

itc_elg

Key	Type	Description	Parent	Example
itc_avl	array	ITC Available (whether in full or part)	itc_elg	{ "ty": "IMPG", "iamt": 136.53, "camt": 274, "samt": 162.99, "csamt": 103 }
itc_rev	array	ITC Reversed	itc_elg	{ "ty": "RUL", "iamt": 136.53, "camt": 274, "samt": 162.99, "csamt": 103 }
itc_net	object	Net ITC Available	itc_elg	"iamt": 136.53, "camt": 274, "samt": 162.99, "csamt": 103
itc_inelg	array	Ineligible ITC	itc_elg	{ "ty": "OTH", "iamt": 136.53, "camt": 274, "samt": 162.99, "csamt": 103 }
ty	string	Identifier if Goods or Services. Possible values: `IMPG`, `IMPS`, `ISRC`, `ISD`, `RUL`, `OTH`	itc_avl	"RUL"
iamt	num	Integrated Tax amount available in the current month	itc_avl	136.53
camt	num	CGST Amount as per invoice	itc_avl	274
samt	num	SGST Amount as per invoice	itc_avl	162.99
csamt	num	Cess Tax amount available in the current month	itc_avl	103

inward_sup

Key	Type	Description	Parent	Example
isup_details	array	Inward Supply Details	inward_sup	{ "ty": "GST", "inter": 100, "intra": 200 }
intra	num	Intra - State supplies	isup_details	400
ty	string	Identifer if Goods or Services. Possible values: GST, NONGST	isup_details	"GST"
inter	num	Inter - State supplies	isup_details	100

intr_ltfee

Key	Type	Description	Example
intr_details	object	Interest Paid	"iamt": 10, "camt": 20, "samt": 30, "csamt": 40

e-Invoice session

Key	Type	Description	Example
access_token	string	e-Invoice access token	eyJhbGcxxxxxxxxxxxx.eyJzdWIiOiIxMjxxxxxxxxxxxxxxx.SflKxwRJSMxxxxxxxx
Status	string	Status code	Possible values: 1 (Success), 0 (Failure)
expiry	string	Token expiry time in EPOCH	1708693832

e-Invoice

Key	Type	Description	Example
Version	string	Version of the schema	1.1
TranDtls	object	Transaction Details	Check object
DocDtls	object	Document Details	Check object
SellerDtls	object	Supplier Details	Check object
BuyerDtls	object	Buyer Details	Check object
DispDtls	object	Dispatch Details	Check object
ShipDtls	object	Shipping Details	Check object
ItemList	object	Item Lists	Check object
ValDtls	object	Invoice Value Details	Check object
PayDtls	object	Payment Details	Check object
RefDtls	object	Reference Details	Check object
AddlDocDtls	object	Additional Document Details	Check object
ExpDtls	object	Export Details	Check object
EwbDtls	object	E-Way Bill Details	Check object

Transaction Details

Key	Type	Description	Example
TaxSch	`string`	GST- Goods and Services Tax Scheme	GST
SupTyp	`string`	Type of Supply: `B2B`-Business to Business, `SEZWP` - SEZ with payment, `SEZWOP` - SEZ without payment, `EXPWP` - Export with Payment, `EXPWOP` - Export without payment, `DEXP` - Deemed Export	B2B
RegRev	`string`	whether the tax liability is payable under reverse charge. Possible values: `Y` or `N`	Y
EcmGstin	`string`	GSTIN of e-Commerce operator	null
IgstOnIntra	`string`	Supply is intra-state and chargeable to IGST. Possible Values: `Y` or `N`	N

Document Details

Key	Type	Description	Example
Typ	string	Document Type. Possible values: INV - Invoice, CRN - Credit note, DBN - Debit note	INV
No	string	Document Number	DOC/001
Dt	string	Document Date	18/08/2020

Seller Details

Key	Type	Description	Example
Gstin	`string`	GSTIN of supplier	37ARZPT4384Q1MT
LglNm	`string`	Legal Name	NIC company pvt ltd
TrdNm	`string`	Tradename	NIC Industries
Addr1	`string`	Building/Flat no, Road/Street	5th block, kuvempu layout
Addr2	`string`	Address 2 of the supplier (Floor no., Name of the premises/building)	kuvempu layout
Loc	`string`	Location	GANDHINAGAR
Pin	`string`	Pincode	518001
Stcd	`string`	State Code of the supplier	37
Ph	`string`	Phone or Mobile No	9000000000
Em	`string`	Email-Id	[email protected]

Buyer Details

Key	Type	Description	Example
Gstin	`string`	GSTIN of Buyer, URP if exporting	29AWGPV7107B1Z1
LglNm	`string`	Legal Name	XYZ company pvt ltd
TrdNm	`string`	Tradename	XYZ Industries
Pos	`string`	State code of Place of supply. If POS lies outside the country, the code shall be 96.	12
Addr1	`string`	Address 1 of the buyer. (Building/Flat no., Road/Street etc.)	7th block, kuvempu layout
Addr2	`string`	Address 2 of the buyer. (Floor no., Name of the premises/ building)	kuvempu layout
Loc	`string`	Location	GANDHINAGAR
Pin	`string`	Pincode	562160
Stcd	`string`	State Code of the buyer	29
Ph	`string`	Phone or Mobile No	91111111111
Em	`string`	Email-Id	[email protected]

Dispatch Details

Key	Type	Description	Example
Nm	`string`	Name of the company from which the goods are dispatched	ABC company pvt ltd
Addr1	`string`	Address 1 of the entity from which goods are dispatched. (Building/Flat no.Road/Street etc.)	7th block, kuvempu layout
Addr2	`string`	Address 2 of the entity from which goods are dispatched. (Floor no., Name of the premises/building)	kuvempu layout
Loc	`string`	Location	Banagalore
Pin	`string`	Pincode	562160
Stcd	`string`	State Code from where goods are dispatched.	29

Shipping Details

Key	Type	Description	Example
Gstin	`string`	GSTIN of entity to whom goods are shipped	29AWGPV7107B1Z1
LglNm	`string`	Legal Name	CBE company pvt ltd
TrdNm	`string`	Trade Name	kuvempu layout
Addr1	`string`	Address1 of the entity to whom the supplies are shipped to. (Building/Flat no., Road/Street etc.)	7th block, kuvempu layout
Addr2	`string`	Address 2 of the entity to whom the supplies are shipped to. (Floor no., Name of the premises/building).	kuvempu layout
Loc	`string`	Place (City,Town,Village) entity to whom the supplies are shipped to.	Banagalore
Pin	`string`	Pincode	562160
Stcd	`string`	State Code to which supplies are shipped to	29

Item List

Key	Type	Description	Example
SlNo	`string`	Serial No. of Item	1
PrdDesc	`string`	Product Description	Rice
IsServc	`string`	Specify whether the supply is service or not. `Y`- Service, `N` - Not service	N
HsnCd	`string`	HSN Code	1001
Barcde	`string`	Bar Code	123456
Qty	`string`	Quantity	100.35
FreeQty	`string`	Free Quantity	10
Unit	`string`	Unit	BAG
UnitPrice	`string`	Unit Price - Rate	99.545
TotAmt	`string`	Gross Amount (Unit Price * Quantity)	9988.84
Discount	`string`	Discount	10
PreTaxVal	`string`	Pre tax value	1
AssAmt	`string`	Taxable Value (Total Amount -Discount)	9978.84
GstRt	`string`	The GST rate, represented as percentage that applies to the invoiced item. It will IGST rate only.	12.0
IgstAmt	`string`	Amount of IGST payable	1197.46
CgstAmt	`string`	Amount of CGST payable	0
SgstAmt	`string`	Amount of SGST payable	0
CesRt	`string`	Cess Rate	5
CesAmt	`string`	Cess Amount(Advalorem) on basis of rate and quantity of item	498.94
CesNonAdvlAmt	`string`	Cess Non-Advol Amount	10
StateCesRt	`string`	State CESS Rate	12
StateCesAmt	`string`	State CESS Amount	1197.46
StateCesNonAdvlAmt	`string`	State CESS Non Adval Amount	5
OthChrg	`string`	Other Charges	10
TotItemVal	`string`	Total Item Value = Assessable Amount + CGST Amt + SGST Amt + Cess Amt + CesNonAdvlAmt + StateCesAmt + StateCesNonAdvlAmt+Otherchrg	12897.7
OrdLineRef	`string`	Order line reference	3256
OrgCntry	`string`	Origin Country.	AG
PrdSlNo	`string`	Serial number in case of each item having a unique number	12345
BchDtls	`json object`	Batch Details
AttribDtls	`json object`	Attribute Details

Batch Details

Key	Type	Description	Example
Nm	`string`	Batch number	123456
ExpDt	`string`	Batch Expiry Date	01/08/2020
WrDt	`string`	Warranty Date	01/09/2020

Attribute Details

Key	Type	Description	Example
Nm	`string`	Attribute name of the item	Rice
Val	`string`	Attribute value of the item	10000

Invoice Value Details

Key	Type	Description	Example
AssVal	`string`	Total Assessable value of all items	9978.84
CgstVal	`string`	Total CGST value of all items	0
SgstVal	`string`	Total SGST value of all items	0
IgstVal	`string`	Total IGST value of all items	1197.46
CesVal	`string`	Total CESS value of all items	508.94
StCesVal	`string`	Total State CESS value of all items	1202.46
Discount	`string`	Discount	10
OthChrg	`string`	Other Charges	20
RndOffAmt	`string`	Rounded off amount	0.3
TotInvVal	`string`	Final Invoice value	12908
TotInvValFc	`string`	Final Invoice value in Additional Currency	12897.7

Payment Details

Key	Type	Description	Example
Nm	`string`	Payee Name	ABCDE
AccDet	`string`	Bank account number of payee	5697389713210
Mode	`string`	Mode of Payment: Cash, Credit, Direct Transfer	Cash
FinInsBr	`string`	Branch or IFSC code	SBIN11000
PayTerm	`string`	Terms of Payment	100
PayInstr	`string`	Payment Instruction	Gift
CrTrn	`string`	Credit Transfer	test
DirDr	`string`	Direct Debit	test
CrDay	`string`	Credit Days	100
PaidAmt	`string`	The sum of amount which have been paid in advance	10000
PaymtDue	`string`	Outstanding amount that is required to be paid	5000

Reference Details

Key	Type	Description	Example
InvRm	`string`	Remarks/Note	TEST
DocPerdDtls	`json object`	Invoice Period Details

Invoice Period Details

Key	Type	Description	Example
InvStDt	`string`	Invoice Period Start Date	01/08/2020
InvEndDt	`string`	Invoice Period End Date	01/09/2020

Preceding Document/Invoice Details

Key	Type	Description	Example
InvNo	`string`	Reference of original invoice, if any	DOC/002
InvDt	`string`	Date of preceding invoice	01/08/2020
OthRefNo	`string`	Other Reference	123456

Contract Details

Key	Type	Description
RecAdvRefr	`string`	Receipt Advice No.	Doc/003
RecAdvDt	`string`	Date of receipt advice	01/08/2020
Abc001TendRefr	`string`	Lot/Batch Reference No.	Abc001
ContrRefr	`string`	Contract Reference Number	Co123
ExtRefr	`string`	Any other reference	Yo456
ProjRefr	`string`	Project Reference Number	Doc-456
PORefr	`string`	PO Reference Number	Doc-789
PORefDt	`string`	POReferencedate	01/08/2020

Additional Document Details

Key	Type	Description	Example
Url	`string`	Supporting document URL
Docs	`string`	Supporting document in Base64 Format
Info	`string`	Any additional information	Document Test

Export Details

Key	Type	Description	Example
ShipBNo	`string`	Shipping Bill No.	A-248
ShipBDt	`string`	Shipping Bill Date	01/08/2020
Port	`string`	Port Code.	INABG1
RefClm	`string`	Claiming Refund `Y` - Yes, `N` - No	N
ForCur	`string`	Additional Currency Code	AED
CntCode	`string`	Country Code	AE
ExpDuty	`string`	Export Duty	null

E-Way Bill Details

Key	Type	Description	Example
TransId	`string`	Transin/GSTIN	12AWGPV7107B1Z1
TransName	`string`	Name of the transporter	XYZ EXPORTS
TransMode	`string`	Mode of transport: `1` - Road `2` - Rail `3` - Air `4` - Ship	1
Distance	`string`	Distance between source and destination PIN codes	100
TransDocNo	`string`	Transport Document Number	DOC01
TransDocDt	`string`	Transport Document Date	18/08/2020
VehNo	`string`	Vehicle Number	ka123456
VehType	`string`	Vehicle Type: `O`-ODC (Overdimentional Cargo) `R`- Regular	R

Workbooks (Sheet JSON)

Purchase Ledger

Invoice Sheet

Key	Type	Required	Description
supplier_name	string	Yes	Supplier name
supplier_gstin	string	Yes	Supplier GSTIN
invoice_number	string	Yes	Invoice number
invoice_date_epoch	number	Yes	Invoice date in Epoch
irn	string	No	IRN if available
place_of_supply	string	Yes	Place of supply
sub_total	number	Yes	Subtotal
gst_rate	string	Yes	GST Rate
cgst	number	Yes	CGST, pass 0 if not applicable
sgst	number	Yes	SGST, pass 0 if not applicable
igst	number	Yes	IGST, pass 0 if not applicable
cess	number	Yes	Cess, pass 0 if not applicable
total	number	Yes	Total

Note Sheet

Key	Type	Required	Description
supplier_name	string	Yes	Supplier name
supplier_gstin	string	Yes	Supplier GSTIN
note_number	string	Yes	Debit note number
note_date_epoch	number	Yes	Debit note date in Epoch
irn	string	No	IRN if available
place_of_supply	string	Yes	Place of supply
sub_total	number	Yes	Subtotal
gst_rate	string	Yes	GST Rate
cgst	number	Yes	CGST, pass 0 if not applicable
sgst	number	Yes	SGST, pass 0 if not applicable
igst	number	Yes	IGST, pass 0 if not applicable
cess	number	Yes	Cess, pass 0 if not applicable
total	number	Yes	Total