API Pricing Image

Overview

Get all amended credit/debit notes for the authenticated taxpayer (gstin) for the particular year and month.
The result can be further filtered by adding from date and action_required. The action_required filter is used for filter invoices where the taxpayer has some pending actions.

Endpoint

HTTP Method	Resource
`Get`	/gsp/tax-payer/{gstin}/gstrs/gstr-1/cdnra/{year}/{month}?action_required={}action_required{}&from={}from{}

Path Parameters

Param	Type	Description	Example
gstin	`string`	15-character alpha-numeric unique identifier assigned to business entities registering under the GST regime	22AAAAA0000A1Z5
year	`string`	Year for which Advance Tax needs to be fetched.	2020
month	`string`	Month for which Advance Tax needs to be fetched.	01

Query Parameters

Param	Type	Description	Example
action_required	`string`	Status filter for filtering the invoices. Possible values: Y or N. Status filter for filtering the invoices. Use filter value Y to fetches the invoices where taxpayer need to take action. Already accepted or uploaded invoices can be fetched by using filter value N.	Y
from	`string`	From Date (DD/MM/YYYY)	21/11/2020

Once the values are added, Your curl will look something like this

curl --request GET \
     --url 'https://api.sandbox.co.in/gsp/tax-payer/22AAAAA0000A1Z5/gstrs/gstr-1/cdnra/2020/01?action_required=Y&from=21%2F11%2F2020' \
     --header 'Authorization: xxxxxxxxxx' \
     --header 'accept: application/json' \
     --header 'x-api-key: xxxxxxxxxx' \
     --header 'x-api-version: 1.0'

❗️
Test Environment Not Available

Response

The response includes the following amended Credit/Debit notes details below

cdnra Invoices

Param	Type	Description	Example
ctin	`string`	Counter party GSTIN	20GRRHF2562D3A3
List{inv}	Credit Debit Note details	Refer to the Table below

Credit Debit Note details

Param	Type	Description	Example
flag	`string`	Invoice Status	`N` - No Action
updby	`string`	Uploaded by	`R` - Receiver `S` - Supplier
chksum	`string`	Invoice Check sum value	AflJufPlFStqKBZ
idt	`string`	Supplier Invoice Date	03-02-2016
val	`num`	Supplier Invoice Value	10000.00
pos	`string`	Place of Supply (statecode)	04
ont_num	`string`	Original Credit/debit note number	NT100001
ont_dt	`string`	Original Credit/Debit Note date (DD-MM-YYYY)	02-03-2016
rchrg	`string`	Reverse Charge	`Y`- Yes `N` - No
inv_typ	`string`	Invoice type	"R- Regular B2B Invoices, DE – Deemed Exports, SEWP – SEZ Exports with payment, SEWOP – SEZ exports without payment CBW - Custom Bonded Warehouse"
cflag	`string`	Counter Party Flag	A-Accepted ,R-Rejected,N-No action ,U-Uploaded, P-Pending, DF-Deferred, FR-Forward
opd	`num`	Original Period (YYYY-MM)	2016-12
ntty	`string`	Credit/debit note type	C/D
nt_num	`string`	Credit note/debit note	NT100001
nt_dt	`string`	Credit Note/Debit Note (DD-MM-YYYY)	02-03-2016
p_gst	`string`	Pre GST Regime Dr./ Cr. Notes	Y/N
d_flag	`string`	delink flag	Y
diff_percent	`num`	Differential percentage	.65 (65%)
list {itms}	Items	Refer to the table below

Items

Param	Type	Description	Example
num	`num`	Serial no	2
itm_det	Item Details	Refer to the table below

Item Details

Param	Type	Description	Example
rt	`num`	Rate of Invoice	5
txval	`num`	Taxable value of Goods or Service as per invoice	10000.00
iamt	`num`	IGST Amount as per invoice	650.00
camt	`num`	CGST Amount as per invoice	650.00
samt	`num`	SGST Amount as per invoice	650.00
csamt	`num`	Cess Amount as per invoice	650.00

Response Caching

Response caching is not available for this API. Learn more about our response caching mechanism here

Wallet Charges

Since GSTR-1 CDNRA is a Paid API, a wallet charge of INR 0.25 + GST per API call will be applicable.

Versioning

This API is currently in major version 1.0. Refer to our versioning policies here

Overview

Endpoint

Path Parameters

Query Parameters

❗️Test Environment Not Available

Response

Response Caching

Wallet Charges

Versioning

❗️
Test Environment Not Available