Get E-Invoices - Request (URL parameters other than action)

Sl No Parameter Name Description

1 gstin GSTIN of the taxpayer
2 ret_period Return Period
3 sec Table Name
4 from_time From Time
Get E-Invoice Details
3 List{b2b} B2B E-Invoices
4 List<cdnr> CDNR E-Invoices
5 List<cdnur> CDNUR E-Invoices
6 List<exp> EXP E-Invoices
quest (URL parameters other than action)

Field Specification
Alphanumeric with 15 characters
MMYYYY
String
dd-mm-yyyy
Get E-Invoice Details
Refer to B2B
Refer to CDNR
Refer to CDNUR
Refer to EXP
 Get B2B invoices - Request (URL parameters other than actio

Sl No Parameter Name Description Field Specification

1 gstin GSTIN of the taxpayer Alphanumeric with 15 characters

2 ret_period Return Period MMYYYY

3 sec Table Name String
4 from_time From Time dd-mm-yyyy
Get B2B Response (data)
S No Response Actual Response format
1A Get B2B Response

Generic response.If the response data is within the max size alloted,
data will contain complete B2B invoice information
1B In case the response payload is above the allotted<<max size>>, Get B2B Token Response
token will be generated as response. Using this token the user can
call GetFileDetails, Download File API's.

Get B2B Response

S No Parameter Name Description Field Specifications
1 List{b2b} B2B Invoices Refer A 1.1

A 1.1 B2B Invoices

S No Parameter Name Description Field Specifications
1 ctin GSTIN/UID of the Receiver taxpayer/UN, Govt Alphanumeric with 15 characters
Bodies
2 trdname Receiver Name String
3 List{inv} Invoice Details Refer to B2B Invoice Data

B2B Invoice Data

A 1.1.1 Invoice Details
S No Parameter Name Description Field Specifications
1 chksum Invoice Check sum value String (Max length:64)
2 inum Supplier Invoice Number String (Max length:16)
3 idt Supplier Invoice Date string (DD-MM-YYYY)
4 val Supplier Invoice Value Decimal(15,2)
5 pos Place of supply String(Max length:2)
6 rchrg Reverse Charge Character
etin EcomOperator Alphanumeric with 15 characters
7
 inv_typ Invoice type String (Max length: 5)
(R/SEWP/SEWOP/DE/CBW)

9 srctyp Source Type of IRN String

irn IRN number Alphanumeric with 64 characters
10

11 irngendate IRN generation Date string (DD-MM-YYYY)

12 einvstatus E-Invoice Status String
autodft Auto Draft status String
Auto-populated/Deleted/Auto-
population failed/Deletion failed
13

14 autodftdt AutoDrafted Date string (DD-MM-YYYY)

errorCd String
15 Error Code

16 errorMsg Error Message String

17 List {itms} Items Refer A 1.1.2

A 1.1.2 Items
S No Parameter Name Description Field Specifications
1 num Serial no Integer
2 itm_det Item Details Refer to A 1.1.2.1

A 1.1.2.1 Items Details

S No Parameter Name Description Field Specifications
1 rt Rate Decimal(3,2)
2 txval Taxable value of Goods or Service as per invoice Decimal(11,2)

3 iamt IGST Amount as per invoice Decimal(11,2)

4 camt CGST Amount as per invoice Decimal(11,2)
5 samt SGST Amount as per invoice Decimal(11,2)
6 csamt cess Amount as per invoice Decimal(11,2)

Get B2B Token Response

S No Parameter Name Description Field Specifications
1 token Token String
2 est Estimated Time in minutes String
arameters other than action)

Mandatory Sample Value

Y 29HJKPS9689A8Z4

Y 072016
Y B2B
N 22-08-2019

Sample Value
if ctin attribute is present in the GET
request, list contains only the invoices
corresponds to that cgstin

Sample Value
06ADECO9084R5Z4

E-Invoicer
ta

Sample Value
AflJufPlFStqKBZ
S008400
03-02-2016
10000.00
04
Y/N
06ADECO9084R5Z5
R- Regular B2B Invoices, DE – Deemed
Exports, SEWP – SEZ Exports with
payment,
SEWOP – SEZ exports without payment
CBW - Custom Bonded Warehouse

e-Invoice
897ADG56RTY78956HYUG90BNHHIJK45
3GFTD99845672FDHHHSHGFH4567FG5
6TR

03-02-2016
Active
Auto-populated, Deleted, Auto-
population failed, Deletion failed

03-02-2016
RET1012

Autodraft issue

Sample Value
2

Sample Value
10.00
10000.00

650.00
650.00
650.00
65.00

Sample Value
XYZABC
30
Get Credit/Debit notes - Request (URL parameters other than action)
Sl No Parameter Name Description Field Specification
Alphanumeric with 15
1 gstin GSTIN of the taxpayer characters
2 ret_period Return Period MMYYYY
3 sec Table Name String
4 from_time From Time dd-mm-yyyy

Get CDNR Response (data)

S No Response Actual Response format

1A Get CDNR Response

Generic response.If the response data is within the max

size alloted, data will contain complete CDNR invoice
information
1B In case the response payload is above the allotted<<max Get CDNR Token Response
size>>, token will be generated as response. Using this
CDN Response Data
1.CDNR
S No Parameter Name Description Field Specifications
Alphanumeric with 15
ctin Counter party GSTIN
1 characters
2 trdname Counter Party Name String
3 List<nt> Credit Debit Note details Refer to Credit/Debit Notes
A 1.1 Credit/Debit Notes
S No Parameter Name Description Field Specifications
1 chksum Invoice Check sum value String (Max length:64)
2 ntty Credit/debit note type One character

3 nt_num Credit note/debit note number Alphanumeric(max length:16)

4 nt_dt Credit Note/Debit Note Date string (DD-MM-YYYY)

5 val Total Note Value Decimal(15, 2)
pos Place of supply String(Max length:2)

7 rchrg Reverse Charge Character

 inv_typ Invoice type String (Max length: 5)
(R/SEWP/SEWOP/DE/CBW)

9 srctyp Source Type of IRN String

irn IRN number Alphanumeric with 64
10 characters

11 irngendate IRN generation Date string (DD-MM-YYYY)

12 einvstatus E-Invoice Status String
autodft Auto Draft status String
Auto-populated/Deleted/Auto-
population failed/Deletion
13 failed

14 autodftdt AutoDrafted Date string (DD-MM-YYYY)

errorCd String
15 Error Code

16 errorMsg Error Message String

17 List {itms} Items Refer A 1.1.2

A 1.1.2 Items
S No Parameter Name Description Field Specifications
1 num Serial no Integer
2 itm_det Item Details Refer to A 1.1.2.1

A 1.1.2.1 Items Details

S No Parameter Name Description Field Specifications
1 rt Rate Decimal(3,2)
2 txval Taxable value of Goods or Service as Decimal(11,2)
per invoice
3 iamt IGST Amount as per invoice Decimal(11,2)
4 camt CGST Amount as per invoice Decimal(11,2)
5 samt SGST Amount as per invoice Decimal(11,2)
6 csamt cess Amount as per invoice Decimal(11,2)

Get CDNR Token Response

S No Parameter Name Description Field Specifications
1 token Token String
2 est Estimated Time in minutes String
 Mandatory Sample Value

Y 29HJKPS9689A8Z4
Y 072016
Y CDNR
N 22-08-2019

Sample Value

20GRRHF2562D3A3

Notes

Sample Value
AflJufPlFStqKBZ
C/D

NT100001

02-03-2016
10000.00
04
This attribute is optional
and will be present for the
return saved after
delinking
Y/N
R- Regular B2B Invoices, DE –
Deemed Exports, SEWP – SEZ
Exports with payment,
SEWOP – SEZ exports without
payment
CBW - Intra state supplies
attracting igst
This attribute is optional
and will be present for the
return saved after
delinking
e-Invoice
897ADG56RTY78956HYUG90BNH
HIJK453GFTD99845672FDHHHSH
GFH4567FG56TR

03-02-2016
Active
Auto-populated, Deleted, Auto-
population failed, Deletion failed

03-02-2016
RET1012

Autodraft issue

Sample Value
2

Sample Value
10.00
10000.00

1000.00
1000.00
1000.00
100.00

Sample Value
XYZABC
30
 Get Credit/Debit notes for Unregistered Taxpayers - Request (URL parameters other than action)
Sl No Parameter Name Description Field Specification
Alphanumeric with 15 characters
1 gstin GSTIN of the taxpayer
2 ret_period Return Period MMYYYY
3 sec Table Name String
4 from_time From Time dd-mm-yyyy
CDNUR Response Data
1.CDNUR
S No Parameter Name Description Field Specifications
1 chksum Invoice Check sum value String (Max length:64)
2 typ EXPWP/ EXPWOP/ B2CL String (Max length: 6)
3 ntty Credit/debit note type One character
4 nt_num Credit note/debit note Alphanumeric(max length: 16)
5 nt_dt Credit Note/Debit Note string (DD-MM-YYYY)
6 val Total Note Value Decimal(15, 2)
pos Place of supply String(Max length:2)

7
8 srctyp Source Type of IRN String
irn IRN number Alphanumeric with 64 characters
9

10 irngendate IRN generation Date string (DD-MM-YYYY)

11 einvstatus E-Invoice Status String
autodft Auto Draft status String
Auto-populated/Deleted/Auto-
12 population failed/Deletion failed

13 autodftdt AutoDrafted Date string (DD-MM-YYYY)

errorCd String
14 Error Code

15 errorMsg Error Message String

16 List {itms} Items Refer A 1.1.2
A 1.1.2 Items
S No Parameter Name Description Field Specifications
1 num Serial no Integer
2 itm_det Item Details Refer to A 1.1.2.1

A 1.1.2.1 Items Details

S No Parameter Name Description Field Specifications
1 rt Rate Decimal(3,2)
2 txval Taxable value of Goods or Service as Decimal(11,2)
per invoice
3 iamt IGST Amount as per invoice Decimal(11,2)
4 csamt cess Amount as per invoice Decimal(11,2)
(URL parameters other than action)CDNUR
Mandatory Sample Value

Y 29HJKPS9689A8Z4
Y 072016
Y CDNUR
N 22-08-2019

Sample Value
AflJufPlFStqKBZ
B2CL
C/D/R
NT100001
02-03-2016
10000.00
04

This attribute is
optional and will be
present for the return
saved after delinking
e-Invoice
897ADG56RTY78956HYUG90BNH
HIJK453GFTD99845672FDHHHSH
GFH4567FG56TR

03-02-2016
Active
Auto-populated, Deleted, Auto-
population failed, Deletion failed

03-02-2016
RET1012

Autodraft issue

Sample Value
2

Sample Value
10.00
10000.00

650.00
65.00
Get EXP-Request (URL parameters other than action)
Sl No Parameter Name Description Field Specification
Alphanumeric with 15
1 gstin GSTIN of the taxpayer characters
2 ret_period Return Period MMYYYY
3 sec Table Name String
4 from_time From Time dd-mm-yyyy
EXP File Format
S No Parameter Name Description Field Specifications
1 List{exp} Exports Invoices Refer A 1.1

A 1.1 EXP Invoices

S No Parameter Name Description Field Specifications

Export Type : With/Without

exp_typ String with 5 characters
payment of GST

1
2 List{inv} Invoice Details Refer A 1.1.1

A 1.1.1 Invoice Details

S No Parameter Name Description Field Specifications
1 chksum Invoice Check sum value string(Max length:64)
2 inum Supplier Invoice Number String (Max length:16)
3 idt Supplier Invoice Date string (DD-MM-YYYY)
4 val Supplier Invoice Value Decimal(15,2)

5 sbpcode Shipping Bill Port Code Alphanumeric (Max length:6)

Shipping Bill No. or Bill of

sbnum String(Min length:3)(Max
Export No
6 Length:7)
Shipping Bill Date. or Bill of
7 sbdt string (DD-MM-YYYY)
Export Date
8 srctyp Source Type of IRN String
irn IRN number Alphanumeric with 64
characters
9

10 irngendate IRN generation Date string (DD-MM-YYYY)

11 einvstatus E-Invoice Status String
 autodft Auto Draft status String
Auto-populated/Deleted/Auto-
population failed/Deletion
12 failed

13 autodftdt AutoDrafted Date string (DD-MM-YYYY)

errorCd String
14 Error Code

15 errorMsg Error Message String

16 List {itms} Item Details Refer A 1.1.2
A 1.1.2 Item Details
S No Parameter Name Description Field Specifications
Taxable value of Goods or
txval Decimal(11,2)
1 Service as per invoice
2 rt Rate as per invoice Decimal(3,2)

iamt IGST Amount as per invoice Decimal(11,2)

3
csamt Cess amount as per invoice Decimal(11,2)
4
Mandatory Sample Value

Y 29HJKPS9689A8Z4
Y 072016
Y EXP
N 22-08-2019

Sample Value

Sample Value

Only Exports with

payment of
WPAY / WOPAY GST(WPAY) invoices
will have impact on
tax liability

Sample Value Remarks

AflJufPlFStqKBZ
S008400
03-02-2016
10000.00

SB1249

2425321.00

04-02-2017
e-Invoice
897ADG56RTY78956HYUG90
BNHHIJK453GFTD99845672F
DHHHSHGFH4567FG56TR

03-02-2016
Active
Auto-populated, Deleted,
Auto-population failed,
Deletion failed

03-02-2016
RET1012

Autodraft issue

Sample Value

10000.00

10.00

1000.00

100.00