{ "openapi": "3.0.0", "info": { "version": "1.0", "title": "GST-API", "description": "GST-API", "contact": { "name": "WhiteBooks Developer Support", "email": "sales@whitebooks.in", "url": "https://whitebooks.in/about/contact-us" }, "license": { "name": "Commercial — WhiteBooks API Terms", "url": "https://whitebooks.in/about/terms" } }, "security": [ { "OAuth2": [ "read" ] } ], "servers": [ { "url": "https://api.whitebooks.in", "description": "Production" }, { "url": "https://apisandbox.whitebooks.in", "description": "Sandbox" } ], "basePath": "/", "tags": [ { "name": "Public", "description": "Public API" }, { "name": "Authentication", "description": "Authentication API" }, { "name": "GSTR", "description": "GSTR API" }, { "name": "GSTR1", "description": "GSTR1 API" }, { "name": "GSTR1A", "description": "GSTR1A API" }, { "name": "GSTR2A", "description": "GSTR2A API" }, { "name": "GSTR2B", "description": "GSTR2B API" }, { "name": "GSTR2X", "description": "GSTR2X API" }, { "name": "GSTR3B", "description": "GSTR3B API" }, { "name": "GSTR4", "description": "GSTR4 API" }, { "name": "GSTR4A", "description": "GSTR4A API" }, { "name": "GSTR4Annual", "description": "GSTR4Annual API" }, { "name": "GSTR5", "description": "GSTR5 API" }, { "name": "GSTR6", "description": "GSTR6 API" }, { "name": "GSTR6A", "description": "GSTR6A API" }, { "name": "GSTR7", "description": "GSTR7 API" }, { "name": "GSTR8", "description": "GSTR8 API" }, { "name": "GSTR9", "description": "GSTR9 API" }, { "name": "GSTR9A", "description": "GSTR9A API" }, { "name": "GSTR9C", "description": "GSTR9C API" }, { "name": "SPIKE", "description": "SPIKE API" }, { "name": "ALL", "description": "All API Overview" }, { "name": "ITC03", "description": "ITC03 API" }, { "name": "ITC04", "description": "ITC04 API" }, { "name": "CMP", "description": "CMP API" }, { "name": "Payment", "description": "Payment API" }, { "name": "Ledger", "description": "GST Ledger" }, { "name": "e-Invoice", "description": "e-Invoice API" } ], "paths": { "/public/search": { "get": { "tags": [ "Public" ], "summary": "Search Taxpayer", "description": "This API will be used to search taxpayer details", "operationId": "searchTaxpayer", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/public/rettrack": { "get": { "tags": [ "Public" ], "summary": "View and Track Returns", "description": "To view and track Returns status ", "operationId": "getViewandTrackReturns", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "fy", "in": "query", "description": "Financial Year (YYYY-YY)", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Return Type Sample Value(R1)", "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/public/pref": { "get": { "tags": [ "Public" ], "summary": "Get Preference", "description": "This API is called for get Preference", "operationId": "getPreference", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "fy", "in": "query", "description": "Financial Year (YYYY-YY)", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/public/unregistered-applicants": { "get": { "tags": [ "Public" ], "summary": "Unregistered Applicants API", "description": "This API is called to fetch details of the URD for e-commerce supplier", "operationId": "unregisteredApplicants", "parameters": [ { "name": "uid", "in": "query", "description": "UID of the Unregistered Applicants", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/public/unregistered-applicants-validation": { "get": { "tags": [ "Public" ], "summary": "Unregistered Applicants Validation", "description": "This API is called validate Mobile Number and Email Address of unregistered applicants", "operationId": "unregisteredApplicantsValidation", "parameters": [ { "name": "uid", "in": "query", "description": "EnrolmentId of Unregistered Applicants", "required": true, "schema": { "type": "string" } }, { "name": "ecomEmail", "in": "query", "description": "Email of Unregistered Applicant used in E-Comerce website", "schema": { "type": "string" } }, { "name": "mobile", "in": "query", "description": "Mobile Number of Unregistered Applicant used in E-Comerce website", "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/authentication/otprequest": { "get": { "tags": [ "Authentication" ], "summary": "Request for OTP", "description": "Tax payer and tax consultant using GSP application will be authenticated asynchronously using OTP. OTP Request API is used by the GSP to initiate the issue of OTP to tax payer.After the successful verification of request parameters, GST system sends the OTP to the taxpayer's primary business credentials through Email and SMS", "operationId": "otpRequest", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/authentication/authtoken": { "get": { "tags": [ "Authentication" ], "summary": "Request for Authorization Token", "description": "Tax payer and tax consultant using GSP application will be authenticated asynchronously using OTP. OTP Request API is used by the GSP to initiate the issue of OTP to tax payer.After the successful verification of request parameters, GST system sends the OTP to the taxpayer's primary business credentials through Email and SMS", "operationId": "authtoken", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "otp", "in": "query", "description": "GST User Recived OTP,Default OTP for SandBox is 575757", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/authentication/refreshtoken": { "get": { "tags": [ "Authentication" ], "summary": "Request for extension of authorization token", "description": "Refresh token can be used by GSP to extend access through Authorization code and allow for access to data on behalf of tax payer / tax consultant without user intervention.", "operationId": "refreshToken", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/authentication/logout": { "get": { "tags": [ "Authentication" ], "summary": "Request for logout", "description": "Request for user logout.", "operationId": "logout", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/authentication/otpforevc": { "get": { "tags": [ "Authentication" ], "summary": "Initiate OTP for EVC", "description": "This API is used to send OTP to the users for filing through EVC.", "operationId": "otpforevc", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "pan", "in": "query", "description": "Pan number of the authorised signatory", "required": true, "schema": { "type": "string" } }, { "name": "form_type", "in": "query", "description": "Form Number", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr1/retsum": { "get": { "tags": [ "GSTR1" ], "summary": "Get GSTR1 Summary", "description": "Get the table wise summary of GSTR1 data.", "operationId": "getGSTR1Summary", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "smrytyp", "in": "query", "description": "Default Summary is Short Summary,If long summary is required, smrytyp parameter should be passed along with value L", "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr1/dociss": { "get": { "tags": [ "GSTR1" ], "summary": "Get GSTR1 Document Issued", "description": "Get the Document Issued details of GSTR1 data.", "operationId": "getDocIssued", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr1/cdnra": { "get": { "tags": [ "GSTR1" ], "summary": "Get CDNRA Invoices", "description": "Will call CDNRA for getting all amended Credit/Debit notes for a return period.", "operationId": "getCDNRAInvoices", "parameters": [ { "name": "actionrequired", "in": "query", "description": "Status filter for filtering the invoices. Action_required = Y, fetches the invoices where tax payer need to take action (Accept/Reject). Already accepted or uploaded invoices can be fetched by using action_required=N filter.", "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr/retstatus": { "get": { "tags": [ "GSTR" ], "summary": "Get Return Status", "description": "Get the status of the Returns submitted", "operationId": "getReturnStatus", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "returnperiod", "in": "query", "description": "Return Period", "required": true, "schema": { "type": "string" } }, { "name": "refid", "in": "query", "description": "Reference ID", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr/rettrack": { "get": { "tags": [ "GSTR" ], "summary": "View and Track Returns", "description": "To view and track Returns status ", "operationId": "getViewandTrackReturns", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "returnperiod", "in": "query", "description": "Return Period", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Return Type Sample Value(R1)", "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr1/b2cl": { "get": { "tags": [ "GSTR1" ], "summary": "Get B2CL Invoices", "description": "Getting all B2C Large invoices for a return period..", "operationId": "getB2CLInvoices", "parameters": [ { "name": "statecd", "in": "query", "description": "State code", "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr1/b2ba": { "get": { "tags": [ "GSTR1" ], "summary": "Get B2BA Invoices", "description": "Getting all B2BA invoices for a return period.", "operationId": "getB2BAInvoices", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "actionrequired", "in": "query", "description": "Status filter for filtering the invoices. Action_required = Y, fetches the invoices where tax payer need to take action (Accept/Reject). Already accepted or uploaded invoices can be fetched by using action_required=N filter.", "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "ctin", "in": "query", "description": "CTIN of the taxpayer", "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr1/ata": { "get": { "tags": [ "GSTR1" ], "summary": "Get ATA", "description": "Getting amended advance tax details for a return period.", "operationId": "getATA", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr1/txp": { "get": { "tags": [ "GSTR1" ], "summary": "Get TXP", "description": "Getting tax paid details for a return period.", "operationId": "getTXP", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr1/retsave": { "put": { "tags": [ "GSTR1" ], "summary": "Save GSTR1 data", "description": "Used to save entire GSTR1 invoices.", "operationId": "saveGSTR1", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "type": "object", "properties": { "gstin": { "type": "string", "description": "GSTIN number", "example": "27AHQPA7588L1ZJ" }, "fp": { "type": "string", "description": "Fp Type", "example": "122016" }, "gt": { "type": "number", "description": "gt Type", "example": 3782969.01 }, "cur_gt": { "type": "number", "description": "Document Number (Alphanumeric with / and - are allowed)", "example": 3782969.01 }, "b2b": { "type": "array", "items": { "type": "object", "properties": { "ctin": { "type": "string", "description": "Challan Temporary Identification Number", "example": "01AABCE2207R1Z5" }, "inv": { "type": "array", "items": { "type": "object", "properties": { "inum": { "type": "string", "description": "Invoice Number", "example": "S008400" }, "idt": { "type": "string", "description": "Invoice Date", "example": "24-11-2016" }, "val": { "type": "number", "description": "Invoice Value", "example": 729248.16 }, "pos": { "type": "string", "description": "Place of Supply", "example": "06" }, "rchrg": { "type": "string", "description": "Reverse Charge", "example": "N" }, "etin": { "type": "string", "description": "etin Number", "example": "01AABCE5507R1C4" }, "inv_typ": { "type": "string", "description": "Invoice Type", "example": "R" }, "diff_percent": { "type": "number", "description": "Differencial Percentage", "example": 0.65 }, "itms": { "type": "array", "items": { "type": "object", "properties": { "num": { "type": "number", "description": "number", "example": 1 }, "itm_det": { "type": "object", "properties": { "rt": { "type": "number", "description": "item Rate", "example": 5 }, "txval": { "type": "number", "description": "Taxable Value", "example": 10000 }, "iamt": { "type": "number", "description": "igst Amount", "example": 325 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 500 } } } } } } } } } } } }, "b2ba": { "type": "array", "items": { "type": "object", "properties": { "ctin": { "type": "string", "description": "Challan Temporary Identification Number", "example": "01AABCE2207R1Z5" }, "inv": { "type": "array", "items": { "type": "object", "properties": { "oinum": { "type": "string", "description": "Original Invoice Number", "example": "S008400" }, "oidt": { "type": "string", "description": "Original Invoice Date", "example": "24-11-2016" }, "inum": { "type": "string", "description": "Invoice Number", "example": "S008400" }, "idt": { "type": "string", "description": "Invoice Date", "example": "24-11-2016" }, "val": { "type": "number", "description": "Invoice Amount", "example": 729248.16 }, "pos": { "type": "string", "description": "Place Of Supply", "example": "06" }, "rchrg": { "type": "string", "description": "Reverse Charge", "example": "N" }, "etin": { "type": "string", "description": "etin number", "example": "01AABCE5507R1C4" }, "inv_typ": { "type": "string", "description": "Invoice Type", "example": "R" }, "diff_percent": { "type": "number", "description": "Differencial Percentage", "example": 0.65 }, "itms": { "type": "array", "items": { "type": "object", "properties": { "num": { "type": "number", "description": "number", "example": 1 }, "itm_det": { "type": "object", "properties": { "rt": { "type": "number", "description": "item Rate", "example": 5 }, "txval": { "type": "number", "description": "Taxable Value", "example": 10000 }, "iamt": { "type": "number", "description": "Igst Amount", "example": 325 }, "camt": { "type": "number", "description": "CGST Amount", "example": 0 }, "samt": { "type": "number", "description": "SGST Amount", "example": 0 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 500 } } } } } } } } } } } }, "b2cl": { "type": "array", "items": { "type": "object", "properties": { "pos": { "type": "string", "description": "Place Of Supply", "example": "05" }, "inv": { "type": "array", "items": { "type": "object", "properties": { "inum": { "type": "string", "description": "Invoice Number", "example": "92661" }, "idt": { "type": "string", "description": "Invoice Date", "example": "10-01-2016" }, "val": { "type": "number", "description": "Invoice Value", "example": 784586.33 }, "inv_typ": { "type": "string", "description": "Invoice Type", "example": "CBW" }, "etin": { "type": "string", "description": "etin", "example": "27AHQPA8875L1CU" }, "diff_percent": { "type": "number", "description": "Differencial Percentage", "example": 0.65 }, "itms": { "type": "array", "items": { "type": "object", "properties": { "num": { "type": "number", "description": "item number", "example": 1 }, "itm_det": { "type": "object", "properties": { "rt": { "type": "number", "description": "rate", "example": 5 }, "txval": { "type": "number", "description": "Taxable Value", "example": 10000 }, "iamt": { "type": "number", "description": "Igst Amount", "example": 325 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 500 } } } } } } } } } } } }, "b2cla": { "type": "array", "items": { "type": "object", "properties": { "pos": { "type": "string", "description": "Place of Supply", "example": "06" }, "inv": { "type": "array", "items": { "type": "object", "properties": { "oinum": { "type": "string", "description": "Original Invoice Number", "example": "9266" }, "oidt": { "type": "string", "description": "Original Invoice Date", "example": "10-02-2016" }, "inv_typ": { "type": "string", "description": "Invoice Type", "example": "CBW" }, "diff_percent": { "type": "number", "description": "Differencial percentage", "example": 0.65 }, "inum": { "type": "string", "description": "Invoice Number", "example": "92661" }, "idt": { "type": "string", "description": "Invoice Date", "example": "10-01-2016" }, "val": { "type": "number", "description": "Invoice Value", "example": 784586.33 }, "etin": { "type": "string", "description": "etin number", "example": "01AABCE5507R1C4" }, "itms": { "type": "array", "items": { "type": "object", "properties": { "num": { "type": "number", "description": "Number", "example": 1 }, "itm_det": { "type": "object", "properties": { "rt": { "type": "number", "description": "item rate", "example": 5 }, "txval": { "type": "number", "description": "Taxable Value", "example": 10000 }, "iamt": { "type": "number", "description": "Igst Amount", "example": 833.33 } } } } } } } } } } } }, "cdnr": { "type": "array", "items": { "type": "object", "properties": { "ctin": { "type": "string", "description": "ctin Number", "example": "01AAAAP1208Q1ZS" }, "nt": { "type": "array", "items": { "type": "object", "properties": { "ntty": { "type": "string", "description": "Note Type", "example": "C" }, "nt_num": { "type": "string", "description": "Note Number", "example": "533515" }, "nt_dt": { "type": "string", "description": "Note Date", "example": "23-09-2016" }, "p_gst": { "type": "string", "description": "Pre GST", "example": "N" }, "pos": { "type": "string", "description": "Place of Supply", "example": "01" }, "rchrg": { "type": "string", "description": "Reverse Charge", "example": "N" }, "inv_typ": { "type": "string", "description": "Invoice Type", "example": "R" }, "val": { "type": "number", "description": "Invoice Value", "example": 123123 }, "diff_percent": { "type": "number", "description": "Differencial Percentage", "example": 0.65 }, "itms": { "type": "array", "items": { "type": "object", "properties": { "num": { "type": "number", "description": "item Number", "example": 1 }, "itm_det": { "type": "object", "properties": { "rt": { "type": "number", "description": "item Rate", "example": 10 }, "txval": { "type": "number", "maxLength": 100, "description": "Taxable Value", "example": 5225.28 }, "iamt": { "type": "number", "description": "Igst Amount", "example": 339.64 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 789.52 } } } } } } } } } } } }, "cdnra": { "type": "array", "items": { "type": "object", "properties": { "ctin": { "type": "string", "description": "ctin number", "example": "01AAAAP1208Q1ZS" }, "nt": { "type": "array", "items": { "type": "object", "properties": { "ntty": { "type": "string", "description": "Note Type", "example": "C" }, "ont_num": { "type": "string", "description": "Original Note Number", "example": "533515" }, "ont_dt": { "type": "string", "description": "Original Note Date", "example": "23-09-2016" }, "nt_num": { "type": "string", "description": "Note Number", "example": "533515" }, "nt_dt": { "type": "string", "description": "Note Date", "example": "23-09-2016" }, "p_gst": { "type": "string", "description": "Pre GST", "example": "N" }, "pos": { "type": "string", "description": "Place of Supply", "example": "01" }, "rchrg": { "type": "string", "description": "Reverse Charge", "example": "N" }, "inv_typ": { "type": "string", "description": "Invoice Type", "example": "R" }, "diff_percent": { "type": "number", "description": "Differencial Percentage", "example": 0.65 }, "val": { "type": "number", "description": "Invoice Value", "example": 123123 }, "itms": { "type": "array", "items": { "type": "object", "properties": { "num": { "type": "number", "description": "number", "example": 1 }, "itm_det": { "type": "object", "properties": { "rt": { "type": "number", "description": "Item rate", "example": 10 }, "txval": { "type": "number", "maxLength": 100, "description": "Taxable value", "example": 5225.28 }, "iamt": { "type": "number", "description": "Igst Amount", "example": 845.22 }, "camt": { "type": "number", "description": "CGST Amount", "example": 0 }, "samt": { "type": "number", "description": "sgst Amount", "example": 0 }, "csamt": { "type": "number", "description": "cess Amount", "example": 789.52 } } } } } } } } } } } }, "b2cs": { "type": "array", "items": { "type": "object", "properties": { "sply_ty": { "type": "string", "description": "Supply Type", "example": "INTER" }, "diff_percent": { "type": "number", "description": "Differencial Percentage", "example": 0.65 }, "rt": { "type": "number", "maxLength": 100, "description": "Rate", "example": 5 }, "typ": { "type": "string", "description": "Type", "example": "E" }, "etin": { "type": "string", "description": "etin", "example": "01AABCE5507R1C4" }, "pos": { "type": "string", "description": "Place Of Supply", "example": "05" }, "txval": { "type": "number", "description": "Taxable Value", "example": 110 }, "iamt": { "type": "number", "description": "igst Amount", "example": 10 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 10 } } } }, "b2csa": { "type": "array", "items": { "type": "object", "properties": { "omon": { "type": "string", "description": "Original Month Of Invoice", "example": "122016" }, "sply_ty": { "type": "string", "description": "Supply Type", "example": "INTER" }, "diff_percent": { "type": "number", "description": "Differencial Percentage", "example": 0.65 }, "typ": { "type": "string", "description": "Type", "example": "E" }, "etin": { "type": "string", "description": "etin number", "example": "01AABCE5507R1C4" }, "pos": { "type": "string", "description": "Place Of Supply", "example": "05" }, "itms": { "type": "array", "items": { "type": "object", "properties": { "rt": { "type": "number", "description": "Product / Item Rate", "example": 5 }, "txval": { "type": "number", "description": "Taxable Value", "example": 110 }, "iamt": { "type": "number", "description": "Igst Amount", "example": 10 }, "camt": { "type": "number", "description": "CGST Amount", "example": 0 }, "samt": { "type": "number", "description": "SGST Amount", "example": 0 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 10 } } } } } } }, "exp": { "type": "array", "items": { "type": "object", "properties": { "exp_typ": { "type": "string", "description": "Export Type", "example": "WPAY" }, "inv": { "type": "array", "items": { "type": "object", "properties": { "inum": { "type": "string", "description": "Invoice Number", "example": "81542" }, "idt": { "type": "string", "description": "Invoice Date", "example": "12-02-2016" }, "val": { "type": "number", "description": "Invoice Value", "example": 995048.36 }, "diff_percent": { "type": "number", "description": "Differencial Percentage", "example": 0.65 }, "sbpcode": { "type": "string", "description": "prort Code", "example": "ASB991" }, "sbnum": { "type": "string", "description": "Shipping Bill Number", "example": "7896542" }, "sbdt": { "type": "string", "description": "Shipping Bill Date", "example": "04-10-2016" }, "itms": { "type": "array", "items": { "type": "object", "properties": { "txval": { "type": "number", "description": "Taxable Value", "example": 10000 }, "rt": { "type": "number", "description": "Product / Item Rate", "example": 5 }, "iamt": { "type": "number", "description": "Igst Amount", "example": 833.33 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 100 } } } } } } } } } }, "expa": { "type": "array", "items": { "type": "object", "properties": { "exp_typ": { "type": "string", "description": "Export Type", "example": "WPAY" }, "inv": { "type": "array", "items": { "type": "object", "properties": { "oinum": { "type": "string", "description": "Original Invoice Number", "example": "81542" }, "oidt": { "type": "string", "description": "Original Invoice Date", "example": "12-02-2016" }, "inum": { "type": "string", "description": "Invoice Number", "example": "81542" }, "idt": { "type": "string", "description": "Invoice Date", "example": "12-02-2016" }, "diff_percent": { "type": "number", "description": "Differencial Percentage", "example": 0.65 }, "val": { "type": "number", "description": "Invoice Value", "example": 995048.36 }, "sbpcode": { "type": "string", "description": "prort Code", "example": "ASB995" }, "sbnum": { "type": "string", "description": "Shipping Bill Number", "example": "1234567" }, "sbdt": { "type": "string", "description": "Shipping Bill Date", "example": "04-10-2016" }, "itms": { "type": "array", "items": { "type": "object", "properties": { "txval": { "type": "number", "description": "Taxable Value", "example": 10000 }, "rt": { "type": "number", "description": "Product / Item Rate", "example": 5 }, "iamt": { "type": "number", "description": "Igst Amount", "example": 833.33 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 100 } } } } } } } } } }, "hsn": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "num": { "type": "number", "description": "Product / Item number", "example": 1 }, "hsn_sc": { "type": "string", "description": "HSN/SAC CODE", "example": "1009" }, "desc": { "type": "string", "description": "Goods Description", "example": "Goods Description" }, "uqc": { "type": "string", "description": "uqc", "example": "kg" }, "qty": { "type": "number", "description": "Quantity", "example": 2.05 }, "rt": { "type": "number", "description": "Invoice Value", "example": 0.1 }, "txval": { "type": "number", "description": "Taxable Value", "example": 10.23 }, "iamt": { "type": "number", "description": "Igst Amount", "example": 14.52 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 500 } } } } } }, "nil": { "type": "object", "properties": { "inv": { "type": "array", "items": { "type": "object", "properties": { "sply_ty": { "type": "string", "description": "Supply Type", "example": "INTRB2B" }, "expt_amt": { "type": "number", "description": "Exempted Amount", "example": 123.45 }, "nil_amt": { "type": "number", "description": "Total Nil rated outward supplies", "example": 1470.85 }, "ngsup_amt": { "type": "number", "description": "Total Non GST outward supplies", "example": 1258.5 } } } } } }, "txpd": { "type": "array", "items": { "type": "object", "properties": { "pos": { "type": "string", "description": "Place Of Supply", "example": "05" }, "sply_ty": { "type": "string", "description": "Supply Type", "example": "INTER" }, "diff_percent": { "type": "number", "description": "Differencial Percentage", "example": 0.65 }, "itms": { "type": "array", "items": { "type": "object", "properties": { "rt": { "type": "number", "description": "Product / Item Rate", "example": 5 }, "ad_amt": { "type": "number", "description": "Advance to be adjusted", "example": 100 }, "iamt": { "type": "number", "description": "Igst Amount", "example": 9400 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 500 } } } } } } }, "txpda": { "type": "array", "items": { "type": "object", "properties": { "omon": { "type": "string", "description": "Original Month", "example": "122016" }, "pos": { "type": "string", "description": "Place Of Supply", "example": "05" }, "sply_ty": { "type": "string", "description": "Supply Type", "example": "INTER" }, "diff_percent": { "type": "number", "description": "Differencial Percentage", "example": 0.65 }, "itms": { "type": "array", "items": { "type": "object", "properties": { "rt": { "type": "number", "description": "Product / Item Rate", "example": 5 }, "ad_amt": { "type": "number", "description": "Advance to be adjusted", "example": 100 }, "iamt": { "type": "number", "description": "Igst Amount", "example": 9400 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 500 } } } } } } }, "at": { "type": "array", "items": { "type": "object", "properties": { "pos": { "type": "string", "description": "Place Of Supply", "example": "05" }, "sply_ty": { "type": "string", "description": "Supply Type", "example": "INTER" }, "diff_percent": { "type": "number", "description": "Differencial Percentage", "example": 0.65 }, "itms": { "type": "array", "items": { "type": "object", "properties": { "rt": { "type": "number", "description": "Product / Item Rate", "example": 5 }, "ad_amt": { "type": "number", "description": "Advance to be adjusted", "example": 100 }, "iamt": { "type": "number", "description": "Igst Amount", "example": 9400 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 500 } } } } } } }, "ata": { "type": "array", "items": { "type": "object", "properties": { "omon": { "type": "string", "description": "Original Month", "example": "022017" }, "pos": { "type": "string", "description": "Place Of Supply", "example": "05" }, "sply_ty": { "type": "string", "description": "Supply Type", "example": "INTER" }, "diff_percent": { "type": "number", "description": "Differencial Percentage", "example": 0.65 }, "itms": { "type": "array", "items": { "type": "object", "properties": { "rt": { "type": "number", "description": "Product / Item Rate", "example": 5 }, "ad_amt": { "type": "number", "description": "Advance to be adjusted", "example": 100 }, "iamt": { "type": "number", "description": "Igst Amount", "example": 9400 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 500 } } } } } } }, "doc_issue": { "type": "object", "properties": { "doc_det": { "type": "array", "items": { "type": "object", "properties": { "doc_num": { "type": "number", "description": "Document Number", "example": 1 }, "docs": { "type": "array", "items": { "type": "object", "properties": { "num": { "type": "number", "description": "Serial Number", "example": 1 }, "from": { "type": "string", "description": "from Serial Number", "example": "20" }, "to": { "type": "string", "description": "to Serial Number", "example": "29" }, "totnum": { "type": "number", "description": "Total Number", "example": 20 }, "cancel": { "type": "number", "description": "Cancelled", "example": 3 }, "net_issue": { "type": "number", "description": "Net issued", "example": 17 } } } } } } } } }, "cdnur": { "type": "array", "items": { "type": "object", "properties": { "typ": { "type": "string", "description": "EXPWP/ EXPWOP/ B2CL", "example": "B2CL" }, "ntty": { "type": "string", "description": "Credit/debit note type/ Refund Voucher", "example": "C" }, "nt_num": { "type": "string", "description": "Credit note/debit note / Refund Voucher Number", "example": "533515" }, "nt_dt": { "type": "string", "description": "Credit Note/Debit Note/ Refund Voucher date", "example": "23-09-2016" }, "p_gst": { "type": "string", "description": "Pre GST Regime Dr./ Cr. Notes", "example": "N" }, "pos": { "type": "string", "description": "Place Of Supply", "example": "05" }, "val": { "type": "number", "description": "Invoice Value", "example": 64646 }, "diff_percent": { "type": "number", "description": "Differencial Percentage", "example": 0.65 }, "itms": { "type": "array", "items": { "type": "object", "properties": { "num": { "type": "number", "description": "Product / Item number", "example": 1 }, "itm_det": { "type": "object", "properties": { "rt": { "type": "number", "description": "Product / Item Rate", "example": 10 }, "txval": { "type": "number", "description": "Taxable Value", "example": 5225.28 }, "iamt": { "type": "number", "description": "Product / Item Name", "example": 339.64 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 789.52 } } } } } } } } }, "cdnura": { "type": "array", "items": { "type": "object", "properties": { "ont_num": { "type": "string", "description": "Original Credit note/debit note / Refund Voucher Number", "example": "533515" }, "ont_dt": { "type": "string", "description": "Original Credit Note/Debit Note/ Refund Voucher date", "example": "23-09-2016" }, "nt_num": { "type": "string", "description": "Credit note/debit note / Refund Voucher Number", "example": "533515" }, "nt_dt": { "type": "string", "description": "Credit Note/Debit Note/ Refund Voucher date", "example": "23-09-2016" }, "ntty": { "type": "string", "description": "Credit/debit note type/ Refund Voucher", "example": "C" }, "typ": { "type": "string", "description": "EXPWP/ EXPWOP/ B2CL", "example": "B2CL" }, "p_gst": { "type": "string", "description": "Pre GST Regime Dr./ Cr. Notes", "example": "N" }, "inum": { "type": "string", "description": "Invoice Number", "example": "915914" }, "val": { "type": "number", "description": "Invoice Value", "example": 123123 }, "idt": { "type": "string", "description": "Invoice Date", "example": "23-09-2016" }, "diff_percent": { "type": "number", "description": "Differencial Percentage", "example": 0.65 }, "itms": { "type": "array", "items": { "type": "object", "properties": { "num": { "type": "number", "description": "Product / Item number", "example": 1 }, "itm_det": { "type": "object", "properties": { "rt": { "type": "number", "description": "Product / Item Rate", "example": 10 }, "txval": { "type": "number", "description": "Taxable Value", "example": 5225.28 }, "iamt": { "type": "number", "description": "Product / Item Name", "example": 845.22 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 789.52 } } } } } } } } } } } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/gstr1/b2b": { "get": { "tags": [ "GSTR1" ], "summary": "Get B2B Invoices", "description": "Getting all B2B invoices for a return period.", "operationId": "getB2BInvoices", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "actionrequired", "in": "query", "description": "Status filter for filtering the invoices. Action_required = Y, fetches the invoices where tax payer need to take action (Accept/Reject). Already accepted or uploaded invoices can be fetched by using action_required=N filter.", "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "ctin", "in": "query", "description": "CTIN of the taxpayer", "schema": { "type": "string" } }, { "name": "fromtime", "in": "query", "description": "From time format DD-MM-YYYY,20-12-2016", "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr1/b2cla": { "get": { "tags": [ "GSTR1" ], "summary": "Get B2CLA Invoices", "description": "Getting all B2C Large invoices with amendments for a return period.", "operationId": "getB2CLAInvoices", "parameters": [ { "name": "statecd", "in": "query", "description": "State code", "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr1/b2csa": { "get": { "tags": [ "GSTR1" ], "summary": "Get B2CSA Invoices", "description": "Will be used for getting all B2CSA HSN data for a return period.", "operationId": "getB2CSAInvoices", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr1/cdnr": { "get": { "tags": [ "GSTR1" ], "summary": "Get CDNR Invoices", "description": "Will call CDNR for getting all Credit/Debit notes for a return period.", "operationId": "getCDNRInvoices", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "actionrequired", "in": "query", "description": "Status filter for filtering the invoices. Action_required = Y, fetches the invoices where tax payer need to take action (Accept/Reject). Already accepted or uploaded invoices can be fetched by using action_required=N filter.", "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr1/at": { "get": { "tags": [ "GSTR1" ], "summary": "Get AT", "description": "Getting advance tax details for a return period.", "operationId": "getAT", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr1/expa": { "get": { "tags": [ "GSTR1" ], "summary": "Get EXPA", "description": "Getting amended invoices related to supplies exported for a return period.", "operationId": "getEXPA", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr1/b2cs": { "get": { "tags": [ "GSTR1" ], "summary": "Get B2CS Invoices", "description": "Will be used for getting all B2C HSN data for a return period.", "operationId": "getB2CSInvoices", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr1/exp": { "get": { "tags": [ "GSTR1" ], "summary": "Get EXP", "description": "Getting invoices related to supplies exported for a return period.", "operationId": "getEXP", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr1/nil": { "get": { "tags": [ "GSTR1" ], "summary": "Get Nil Rated Supplies", "description": "NIL for getting liabilities such as 'Nil Rated', 'Exempted', and 'Non GST' supplies for a return period. ", "operationId": "getNilRatedSupplies", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr1/hsnsum": { "get": { "tags": [ "GSTR1" ], "summary": "Get HSN Summary details", "description": "Getting HSN Summary details.", "operationId": "getHSNSummaryDetails", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr1/validatehsnsum": { "get": { "tags": [ "GSTR1" ], "summary": "Validate the HSN Summary details", "description": "Validate the HSN Summary details.", "operationId": "validatehsnsum", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr1/cdnur": { "get": { "tags": [ "GSTR1" ], "summary": "API call for getting all Credit/ Debit Notes issued to un-registered persons for a return period.", "description": "API call for getting all Credit/ Debit Notes issued to un-registered persons for a return period.", "operationId": "getCDNUR", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr1/cdnura": { "get": { "tags": [ "GSTR1" ], "summary": "API call for getting all amended Credit/ Debit Notes issued to un-registered persons for a return period.", "description": "API call for getting all amended Credit/ Debit Notes issued to un-registered persons for a return period.", "operationId": "getCDNURA", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr1/reset": { "post": { "tags": [ "GSTR1" ], "summary": "Reset GSTR1 Data", "description": "Used to Reset GSTR1 Data.", "operationId": "resetGSTR", "parameters": [ { "name": "email", "in": "query", "description": "API Developer User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "type": "object", "properties": { "gstin": { "type": "string", "description": "GSTIN number", "example": "27AHQPA7588L1ZJ" }, "ret_period": { "type": "string", "description": "Return Period", "example": "072017" } } } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/gstr1/retfile": { "post": { "tags": [ "GSTR1" ], "summary": "File GSTR1 data", "description": "Used to file entire GSTR1 invoices.", "operationId": "fileGSTR", "parameters": [ { "name": "email", "in": "query", "description": "API Developer User Email", "required": true, "schema": { "type": "string" } }, { "name": "pan", "in": "query", "description": "PAN Number", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload Format : {\"content\":\"{\"gstin\": \"37ABCDE9552F3Z4\", \"ret_period\": \"072017\",\"chksum\": \"AflJufPlFStqKBZ\",\"summ_typ\": \"L\"}\",\"pkcs7\":\"MIIFrwYJKoZIhvcNAQcCoI==\"}", "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "signedcontent" } }, "/gstr1/retevcfile": { "post": { "tags": [ "GSTR1" ], "summary": "File GSTR1 data", "description": "Used to file entire GSTR1 invoices using EVC.", "operationId": "fileGSTRByEVC", "parameters": [ { "name": "email", "in": "query", "description": "API Developer User Email", "required": true, "schema": { "type": "string" } }, { "name": "pan", "in": "query", "description": "PAN Number", "required": true, "schema": { "type": "string" } }, { "name": "evcotp", "in": "query", "description": "OTP for EVC", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload Format : {\"content\":\"{\"gstin\": \"37ABCDE9552F3Z4\", \"ret_period\": \"072017\",\"chksum\": \"AflJufPlFStqKBZ\",\"summ_typ\": \"L\"}\"}", "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "content" } }, "/gstr1a/retsave": { "put": { "tags": [ "GSTR1A" ], "summary": "Save GSTR1A data", "description": "Used to save entire GSTR1A invoices.", "operationId": "saveGSTR", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "type": "object", "properties": { "gstin": { "type": "string", "description": "GSTIN number", "example": "25ABCDE1028F6Z4" }, "fp": { "type": "string", "description": "Financial Period", "example": "062016" }, "b2b": { "type": "array", "items": { "type": "object", "properties": { "ctin": { "type": "string", "description": "ctin Number", "example": "01AABCE2207R1Z5" }, "inv": { "type": "array", "items": { "type": "object", "properties": { "flag": { "type": "string", "description": "Flag Type", "example": "A" }, "chksum": { "type": "string", "description": "Checksum Value", "example": "BBUIBUIUIJKKBJKGUYFTFGUY" }, "inum": { "type": "string", "description": "Invoice Number", "example": "S008400" }, "idt": { "type": "string", "description": "Invoice Date", "example": "24-11-2016" }, "val": { "type": "number", "description": "Invoice Value", "example": 729248.16 }, "pos": { "type": "string", "description": "Place of Supply", "example": "06" }, "rchrg": { "type": "string", "description": "Reverse Charge", "example": "N" }, "inv_typ": { "type": "string", "description": "Invoice Type", "example": "R" }, "itms": { "type": "array", "items": { "type": "object", "properties": { "num": { "type": "number", "description": "Product / Item Number", "example": 1 }, "itm_det": { "type": "object", "properties": { "rt": { "type": "number", "description": "Item Rate", "example": 5 }, "txval": { "type": "number", "description": "Taxable Value", "example": 10000 }, "iamt": { "type": "number", "description": "Igst Amount", "example": 0 }, "camt": { "type": "number", "description": "Cgst Amount", "example": 500 }, "samt": { "type": "number", "description": "Taxable Amount", "example": 900 }, "csamt": { "type": "number", "description": "Taxable Amount", "example": 500 } } } } } } } } } } } }, "b2ba": { "type": "array", "items": { "type": "object", "properties": { "ctin": { "type": "string", "description": "ctin Number", "example": "01AABCE2207R1Z5" }, "inv": { "type": "array", "items": { "type": "object", "properties": { "flag": { "type": "string", "description": "Flag Type", "example": "A" }, "chksum": { "type": "string", "description": "Checksum Value", "example": "BBUIBUIUIJKKBJKGGYGUYFTFGUY" }, "oinum": { "type": "string", "description": "Original Invoice Number", "example": "S008400" }, "oidt": { "type": "string", "maxLength": 100, "description": "Original Invoice Date", "example": "24-11-2016" }, "inum": { "type": "string", "description": "Invoice Number", "example": "S008400" }, "idt": { "type": "string", "description": "Invoice Date", "example": "24-11-2016" }, "val": { "type": "number", "description": "Invoice Value", "example": 729248.16 }, "pos": { "type": "string", "description": "Place of Supply", "example": "06" }, "rchrg": { "type": "string", "description": "Reverse Charge", "example": "N" }, "inv_typ": { "type": "string", "description": "Invoice Type", "example": "R" }, "itms": { "type": "array", "items": { "type": "object", "properties": { "num": { "type": "number", "description": "Product / Item Number", "example": 1 }, "itm_det": { "type": "object", "properties": { "rt": { "type": "number", "description": "Item Rate", "example": 5 }, "txval": { "type": "number", "description": "Taxable Value", "example": 10000 }, "iamt": { "type": "number", "description": "Igst Amount", "example": 0 }, "camt": { "type": "number", "description": "Unit", "example": 500 }, "samt": { "type": "number", "description": "Taxable Amount", "example": 900 }, "csamt": { "type": "number", "description": "Taxable Amount", "example": 500 } } } } } } } } } } } }, "cdnr": { "type": "array", "items": { "type": "object", "properties": { "ctin": { "type": "string", "description": "ctin Number", "example": "01AAAAP1208Q1ZS" }, "nt": { "type": "array", "items": { "type": "object", "properties": { "flag": { "type": "string", "description": "Flag Type", "example": "A" }, "chksum": { "type": "string", "description": "Checksum Value", "example": "ADSDSFSJSKSSSSQ" }, "ntty": { "type": "string", "description": "Type Of Voucher", "example": "C" }, "nt_num": { "type": "string", "description": "Note Number", "example": "533515" }, "nt_dt": { "type": "string", "description": "Note Date", "example": "23-09-2016" }, "rsn": { "type": "string", "description": "Reason", "example": "Not Mentioned" }, "p_gst": { "type": "string", "description": "Pre GST Regime Dr./ Cr. Notes", "example": "N" }, "inum": { "type": "string", "description": "Invoice Number", "example": "915914" }, "idt": { "type": "string", "description": "Invoice Date", "example": "23-09-2016" }, "val": { "type": "number", "description": "Invoice Value", "example": 123123 }, "itms": { "type": "array", "items": { "type": "object", "properties": { "num": { "type": "number", "description": "Product / Item Number", "example": 1 }, "itm_det": { "type": "object", "properties": { "rt": { "type": "number", "description": "Item Rate", "example": 10 }, "txval": { "type": "number", "description": "Taxable Value", "example": 5225.28 }, "iamt": { "type": "number", "description": "Igst Amount", "example": 845.22 }, "camt": { "type": "number", "description": "Cgst Amount", "example": 0 }, "samt": { "type": "number", "description": "Sgst Amount", "example": 0 }, "csamt": { "type": "number", "description": "CESS Amount", "example": 789.52 } } } } } } } } } } } }, "cdnra": { "type": "array", "items": { "type": "object", "properties": { "ctin": { "type": "string", "description": "ctin Number", "example": "01AAAAP1208Q1ZS" }, "nt": { "type": "array", "items": { "type": "object", "properties": { "flag": { "type": "string", "description": "Flag Type", "example": "A" }, "chksum": { "type": "string", "description": "Checksum Value", "example": "ADSDSFSJSKSSSSQ" }, "ont_num": { "type": "string", "description": "Original note number", "example": "533515" }, "ont_dt": { "type": "string", "description": "Original note Date", "example": "23-09-2016" }, "ntty": { "type": "string", "description": "Type Of Voucher", "example": "C" }, "nt_num": { "type": "string", "description": "Note Number", "example": "533515" }, "nt_dt": { "type": "string", "description": "Note Date", "example": "23-09-2016" }, "rsn": { "type": "string", "description": "Reason", "example": "Not Mentioned" }, "p_gst": { "type": "string", "description": "Pre GST Regime Dr./ Cr. Notes", "example": "N" }, "val": { "type": "number", "description": "Invoice Value", "example": 123123 }, "itms": { "type": "array", "items": { "type": "object", "properties": { "num": { "type": "number", "description": "Product / Item Number", "example": 1 }, "itm_det": { "type": "object", "properties": { "rt": { "type": "number", "description": "Item Rate", "example": 10 }, "txval": { "type": "number", "description": "Taxable Value", "example": 5225.28 }, "iamt": { "type": "number", "description": "Igst Amount", "example": 845.22 }, "camt": { "type": "number", "description": "Cgst Amount", "example": 0 }, "samt": { "type": "number", "description": "Sgst Amount", "example": 0 }, "csamt": { "type": "number", "description": "CESS Amount", "example": 789.52 } } } } } } } } } } } } } } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/gstr1a/b2b": { "get": { "tags": [ "GSTR1A" ], "summary": "Get B2B Invoices", "description": "Getting all B2B invoices for a return period.", "operationId": "getB2BInvoices", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "actionrequired", "in": "query", "description": "Status filter for filtering the invoices. Action_required = Y, fetches the invoices where tax payer need to take action (Accept/Reject). Already accepted or uploaded invoices can be fetched by using action_required=N filter.", "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "ctin", "in": "query", "description": "CTIN of the taxpayer", "schema": { "type": "string" } }, { "name": "fromtime", "in": "query", "description": "From time format DD-MM-YYYY,20-12-2016", "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr1a/b2ba": { "get": { "tags": [ "GSTR1A" ], "summary": "Get B2BA Invoices", "description": "Getting all B2BA invoices for a return period.", "operationId": "getB2BAInvoices", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "actionrequired", "in": "query", "description": "Status filter for filtering the invoices. Action_required = Y, fetches the invoices where tax payer need to take action (Accept/Reject). Already accepted or uploaded invoices can be fetched by using action_required=N filter.", "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "ctin", "in": "query", "description": "CTIN of the taxpayer", "schema": { "type": "string" } }, { "name": "fromtime", "in": "query", "description": "From time format DD-MM-YYYY,20-12-2016", "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr1a/cdnr": { "get": { "tags": [ "GSTR1A" ], "summary": "Get CDN Invoices", "description": "Will call CDN for getting all Credit/Debit notes in GSTR1A for a return period.", "operationId": "getCDNRInvoices", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "actionrequired", "in": "query", "description": "Status filter for filtering the invoices. Action_required = Y, fetches the invoices where tax payer need to take action (Accept/Reject). Already accepted or uploaded invoices can be fetched by using action_required=N filter.", "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "ctin", "in": "query", "description": "CTIN of the taxpayer", "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr1a/cdnra": { "get": { "tags": [ "GSTR1A" ], "summary": "Get CDNRA Invoices", "description": "Will call CDNRA for getting all Credit/Debit notes in GSTR1A for a return period.", "operationId": "getCDNRAInvoices", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "actionrequired", "in": "query", "description": "Status filter for filtering the invoices. Action_required = Y, fetches the invoices where tax payer need to take action (Accept/Reject). Already accepted or uploaded invoices can be fetched by using action_required=N filter.", "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "ctin", "in": "query", "description": "CTIN of the taxpayer", "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr1a/retsubmit": { "post": { "tags": [ "GSTR1A" ], "summary": "Submit GSTR1A data", "description": "Used to Submit entire GSTR1A invoices.", "operationId": "submitGSTR", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/gstr1a/retsum": { "get": { "tags": [ "GSTR1A" ], "summary": "Get GSTR1A Summary", "description": "Get the table wise summary of GSTR1A data.", "operationId": "getGSTR1ASummary", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr1a/retfile": { "post": { "tags": [ "GSTR1A" ], "summary": "File GSTR1A data", "description": "Used to file entire GSTR1A invoices.", "operationId": "fileGSTR", "parameters": [ { "name": "email", "in": "query", "description": "API Developer User Email", "required": true, "schema": { "type": "string" } }, { "name": "pan", "in": "query", "description": "PAN Number", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload Format : {\"content\":\"{\"gstin\": \"37ABCDE9552F3Z4\", \"ret_period\": \"072017\",\"chksum\": \"AflJufPlFStqKBZ\",\"summ_typ\": \"L\"}\",\"pkcs7\":\"MIIFrwYJKoZIhvcNAQcCoI==\"}", "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "signedcontent" } }, "/itc03/retsave": { "put": { "tags": [ "ITC03" ], "summary": "Save ITC03 data", "description": "Used to save entire ITC03 invoices.", "operationId": "saveITC03", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Type (SAV4A / SAV4B)", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "type": "object", "properties": { "gstin": { "type": "string", "description": "GSTIN number", "example": "08AJIPA1572EEZ8" }, "rtn_typ": { "type": "string", "description": "Return Type", "example": "ITC03-4A" }, "comp_arn": { "type": "string", "description": "Composition ARN", "example": "AA0705171234561" }, "dof": { "type": "string", "description": "Document Number (Alphanumeric with / and - are allowed)", "example": "22-10-2017" }, "invs": { "type": "array", "items": { "type": "object" } }, "attachment": { "type": "object", "properties": { "docid": { "type": "string", "description": "Document ID", "example": "360234" }, "cadetails": { "type": "object", "properties": { "caname": { "type": "string", "description": "Name of the certifying Chartered Accountant/Cost Accountant", "example": "AKHIL ARORA" }, "firm": { "type": "string", "description": "Name of the certifying Chartered Accountant/Cost Accountant", "example": "TALLY" }, "member": { "type": "string", "description": "Membership Number", "example": "567899" }, "cadt": { "type": "string", "description": "Date of issuance of certificate", "example": "04-04-2017" } } } } } } } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/itc03/retsum": { "get": { "tags": [ "ITC03" ], "summary": "Get ITC03 Summary", "description": "Get ITC03 Summary", "operationId": "getITC03Summary", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Summary Type (SUM4A / SUM4B)", "required": true, "schema": { "type": "string" } }, { "name": "arnnum", "in": "query", "description": "ARN Number", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/itc03/retfile": { "post": { "tags": [ "ITC03" ], "summary": "File ITC03 data", "description": "Used to File ITC03 invoices.", "operationId": "fileITC03", "parameters": [ { "name": "email", "in": "query", "description": "API Developer User Email", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Filing Type (FIL4A / FIL4B)", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload Format : {\"content\":\"{\"gstin\": \"37ABCDE9552F3Z4\", \"ret_period\": \"072017\",\"chksum\": \"AflJufPlFStqKBZ\",\"summ_typ\": \"L\"}\",\"pkcs7\":\"MIIFrwYJKoZIhvcNAQcCoI==\"}", "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "signedcontent" } }, "/itc03/retevcfile": { "post": { "tags": [ "ITC03" ], "summary": "File ITC03 data", "description": "Used to file entire ITC03 invoices using EVC.", "operationId": "fileGSTR", "parameters": [ { "name": "email", "in": "query", "description": "API Developer User Email", "required": true, "schema": { "type": "string" } }, { "name": "pan", "in": "query", "description": "PAN Number", "required": true, "schema": { "type": "string" } }, { "name": "evcotp", "in": "query", "description": "OTP for EVC", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Filing Type (FIL4A / FIL4B)", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload Format : \"{\"gstin\": \"37ABCDE9552F3Z4\", \"ret_period\": \"072017\",\"chksum\": \"AflJufPlFStqKBZ\"}", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "content" } }, "/itc03/close": { "get": { "tags": [ "ITC03" ], "summary": "Get ITC03 Invoices", "description": "Getting all ITC03 invoices for a return period.", "operationId": "close", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Type (CLOSE4A / CLOSE4B)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/itc03/getinv": { "get": { "tags": [ "ITC03" ], "summary": "Get ITC03 Invoices", "description": "Getting all ITC03 invoices for a return period.", "operationId": "getInvoices", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Invoice Type (INV4A / INV4B)", "required": true, "schema": { "type": "string" } }, { "name": "arnnum", "in": "query", "description": "ARN Number", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/itc03/retoffset": { "put": { "tags": [ "ITC03" ], "summary": " Offset Liability ITC03 data", "description": "API call for offsetting the liabilities from ITC03", "operationId": "offsetLiability", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Type (SETOFF4A / SETOFF4B)", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/itc04/retsave": { "put": { "tags": [ "ITC04" ], "summary": "Save ITC04 data", "description": "Used to save entire ITC04 invoices.", "operationId": "saveITC04", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "type": "object", "properties": { "gstin": { "type": "string", "description": "GSTIN Number", "example": "27GSPMH1222G1ZY" }, "fp": { "type": "string", "description": "Return Period", "example": "132017" }, "m2jw": { "type": "array", "items": { "type": "object" } }, "table5A": { "type": "array", "items": { "type": "object" } }, "table5B": { "type": "array", "items": { "type": "object" } }, "table5C": { "type": "array", "items": { "type": "object" } } } } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/itc04/retsum": { "get": { "tags": [ "ITC04" ], "summary": "Get ITC04 Summary", "description": "Get ITC04 Summary", "operationId": "getITC04Summary", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/itc04/retfile": { "post": { "tags": [ "ITC04" ], "summary": "File ITC04 data", "description": "Used to File ITC04 invoices.", "operationId": "fileITC04", "parameters": [ { "name": "email", "in": "query", "description": "API Developer User Email", "required": true, "schema": { "type": "string" } }, { "name": "pan", "in": "query", "description": "PAN Number", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload Format : {\"content\":\"{\"gstin\": \"37ABCDE9552F3Z4\", \"ret_period\": \"072017\",\"chksum\": \"AflJufPlFStqKBZ\",\"summ_typ\": \"L\"}\",\"pkcs7\":\"MIIFrwYJKoZIhvcNAQcCoI==\"}", "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "signedcontent" } }, "/itc04/retevcfile": { "post": { "tags": [ "ITC04" ], "summary": "File ITC04 data", "description": "Used to file entire ITC04 invoices using EVC.", "operationId": "fileGSTR", "parameters": [ { "name": "email", "in": "query", "description": "API Developer User Email", "required": true, "schema": { "type": "string" } }, { "name": "pan", "in": "query", "description": "PAN Number", "required": true, "schema": { "type": "string" } }, { "name": "evcotp", "in": "query", "description": "OTP for EVC", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload Format : \"{\"gstin\": \"37ABCDE9552F3Z4\", \"ret_period\": \"072017\",\"chksum\": \"AflJufPlFStqKBZ\"}", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "content" } }, "/itc04/getinv": { "get": { "tags": [ "ITC04" ], "summary": "Get ITC04 Invoices", "description": "Getting all ITC04 invoices for a return period.", "operationId": "getInvoices", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/spike/spikesave": { "put": { "tags": [ "SPIKE" ], "summary": "Save SPIKE data", "description": "Used to save entire SPIKE Data.", "operationId": "saveSPIKE", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "required": [ "deldrc03arn", "drc03arn", "frmtyp", "gstin", "reasons", "refid", "rtnprd" ], "type": "object", "properties": { "frmtyp": { "type": "string", "description": "Form Type", "example": "DRC01B" }, "refid": { "type": "string", "description": "Reference Id for DRC01B", "example": "AA070922000131X" }, "rtnprd": { "type": "string", "description": "Return Period", "example": "092022" }, "gstin": { "type": "string", "description": "GSTIN", "example": "07CMNPV1083B1ZX" }, "drc03arn": { "type": "array", "description": "Drc03 ARN", "example": "" }, "reasons": { "type": "array", "description": "Reasons", "items": { "type": "object" } }, "deldrc03arn": { "type": "array", "description": "Deleted DRC03 ARN", "example": "" } } } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/spike/rtncomplist": { "get": { "tags": [ "SPIKE" ], "summary": "Get DRC01C/DRC01B Data", "description": "Getting all DRC01C/DRC01B reference id.", "operationId": "getDRC01C/DRC01B", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "refid", "in": "query", "description": "Refid", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Status", "schema": { "type": "string" } }, { "name": "frmtyp", "in": "query", "description": "Form Type", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/spike/rtncompsum": { "get": { "tags": [ "SPIKE" ], "summary": "get mismatch in GSTR1 and GSTR3B", "description": "Get mismatch in GSTR1 and GSTR3B", "operationId": "getDRC01C/DRC01B", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "refid", "in": "query", "description": "Refid", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/spike/retfile": { "post": { "tags": [ "SPIKE" ], "summary": "File SPIKE data", "description": "Used to file entire SPIKE Data.", "operationId": "fileSPIKE", "parameters": [ { "name": "email", "in": "query", "description": "API Developer User Email", "required": true, "schema": { "type": "string" } }, { "name": "pan", "in": "query", "description": "PAN Number", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "signedcontent" } }, "/all/filedet": { "get": { "tags": [ "ALL" ], "summary": "Get File Details", "description": "This API is called with the file_num to get the file URL", "operationId": "getFileDetails", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "returnperiod", "in": "query", "description": "Return Period", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "description": "Transaction ID", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/all/largefile": { "get": { "tags": [ "ALL" ], "summary": "Get Large File Details", "description": "This API is called with the large file url to get the data", "operationId": "getLargeFileDetails", "parameters": [ { "name": "url", "in": "query", "description": "Large file url", "required": true, "schema": { "type": "string" } }, { "name": "ek", "in": "query", "description": "Encryption key from file details response", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "returnperiod", "in": "query", "description": "Return Period", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/all/latefee": { "get": { "tags": [ "ALL" ], "summary": "Late Fee", "description": "This API is called to get details of late fee levied in GSTR3B and GSTR4", "operationId": "latefee", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period", "required": true, "schema": { "type": "string" } }, { "name": "rettype", "in": "query", "description": "Return Type", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/all/latefeebreakup": { "get": { "tags": [ "ALL" ], "summary": "Get additional late fee breakup", "description": "This API will help taxpayer to fetch the break up of the additonal late fee posted in their current return period", "operationId": "latefeebreakup", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period", "required": true, "schema": { "type": "string" } }, { "name": "rettype", "in": "query", "description": "Return Type", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/all/docdwld": { "get": { "tags": [ "ALL" ], "summary": "Document Download", "description": "This API is called for document download", "operationId": "documentDownload", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "ID", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/all/proceedfile": { "get": { "tags": [ "ALL" ], "summary": "Proceed To File", "description": "This API is called for proceed to file", "operationId": "proceedToFile", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/all/newproceedfile": { "get": { "tags": [ "ALL" ], "summary": "New Proceed To File(GSTR1,GSTR5,GSTR6)", "description": "This API is called for new proceed to file", "operationId": "newProceedToFile", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Return Type Sample Value(GSTR1)", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/all/docupld": { "post": { "tags": [ "ALL" ], "summary": "Document Upload", "description": "Used to upload Document", "operationId": "documentUpload", "parameters": [ { "name": "email", "in": "query", "description": "API Developer User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/all/newretstatus": { "get": { "tags": [ "ALL" ], "summary": "Get Return Status", "description": "This API is called for get return status", "operationId": "getNewReturnStatus", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "returnperiod", "in": "query", "description": "Return Period", "required": true, "schema": { "type": "string" } }, { "name": "refid", "in": "query", "description": "Reference Id", "required": true, "schema": { "type": "string" } }, { "name": "rettype", "in": "query", "description": "Return Type", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/all/savepref": { "put": { "tags": [ "ALL" ], "summary": "Save Preference", "description": "Used to Save Preference", "operationId": "savePreference", "parameters": [ { "name": "email", "in": "query", "description": "API Developer User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/all/getpref": { "get": { "tags": [ "ALL" ], "summary": "Get Preference", "description": "This API is called for get Preference", "operationId": "getPreference", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "fy", "in": "query", "description": "Financial Year (YYYY-YY)", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gst/einvoice/irnlist": { "get": { "tags": [ "e-Invoice" ], "summary": "Get list of IRNs", "description": "This API is called for get list of IRNs", "operationId": "getlistofIRNs", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "suptyp", "in": "query", "description": "(B2B/SEZWP/SEZWOP/DEXP/EXPWP/EXPWOP)", "required": true, "schema": { "type": "string" } }, { "name": "rtnprd", "in": "query", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gst/einvoice/filedtl": { "get": { "tags": [ "e-Invoice" ], "summary": "Get file URL", "description": "This API is called for get file URL", "operationId": "getFileURL", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "rtnprd", "in": "query", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "description": "Token", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gst/einvoice/irndtl": { "get": { "tags": [ "e-Invoice" ], "summary": "Get Json for IRN", "description": "This API is called for get json for IRN", "operationId": "getJsonforIRN", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "irn", "in": "query", "description": "IRN No", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/cmp/getcmp": { "get": { "tags": [ "CMP" ], "summary": "Get CMP", "description": "This API is called for get CMP", "operationId": "getCMP", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/cmp/savecmp": { "post": { "tags": [ "CMP" ], "summary": "Save CMP", "description": "API call to save CMP details", "operationId": "saveCMP", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "type": "object", "properties": { "gstin": { "type": "string", "description": "GST Number", "example": "01AAAAB1726H1ZI" }, "ret_period": { "type": "string", "description": "Return Period", "example": "032018" }, "isnil": { "type": "string", "description": "Returns NIL", "example": "N" }, "table3": { "type": "object", "properties": { "out_sup": { "type": "object", "properties": { "tax_val": { "type": "number", "description": "Product / Item description", "example": 40 }, "camt": { "type": "number", "description": "Unit", "example": 20 }, "samt": { "type": "number", "description": "Unit", "example": 20 } } }, "in_sup": { "type": "object", "properties": { "tax_val": { "type": "number", "description": "Product / Item description", "example": 40 }, "iamt": { "type": "number", "description": "Unit", "example": 10 }, "camt": { "type": "number", "description": "Unit", "example": 20 }, "samt": { "type": "number", "description": "Unit", "example": 20 }, "csamt": { "type": "number", "description": "Unit", "example": 10 } } }, "intr_pay": { "type": "object", "properties": { "iamt": { "type": "number", "description": "Unit", "example": 10 }, "camt": { "type": "number", "description": "Unit", "example": 20 }, "samt": { "type": "number", "description": "Unit", "example": 20 }, "csamt": { "type": "number", "description": "Unit", "example": 10 } } } } } } } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/cmp/retfile": { "post": { "tags": [ "CMP" ], "summary": "File CMP data", "description": "Used to file entire CMP invoices", "operationId": "fileCMP", "parameters": [ { "name": "email", "in": "query", "description": "API Developer User Email", "required": true, "schema": { "type": "string" } }, { "name": "pan", "in": "query", "description": "PAN Number", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "type": "object", "properties": { "gstin": { "type": "string", "description": "GST Number", "example": "01AAAAB1726H1ZI" }, "ret_period": { "type": "string", "description": "Return Period", "example": "032018" }, "isnil": { "type": "string", "description": "Is Nil Return", "example": "N" }, "table3": { "type": "object", "properties": { "out_sup": { "type": "object", "properties": { "tax_val": { "type": "number", "description": "Value of goods", "example": 40 }, "camt": { "type": "number", "description": "CGST payable", "example": 20 }, "samt": { "type": "number", "description": "SGST payable", "example": 20 } } }, "in_sup": { "type": "object", "properties": { "tax_val": { "type": "number", "description": "Value of goods", "example": 40 }, "iamt": { "type": "number", "description": "IGST payable", "example": 10 }, "camt": { "type": "number", "description": "CGST payable", "example": 20 }, "samt": { "type": "number", "description": "SGST payable", "example": 20 }, "csamt": { "type": "number", "description": "CESS payable", "example": 10 } } }, "intr_pay": { "type": "object", "properties": { "iamt": { "type": "number", "description": "IGST payable", "example": 10 }, "camt": { "type": "number", "description": "CGST payable", "example": 20 }, "samt": { "type": "number", "description": "SGST payable", "example": 20 }, "csamt": { "type": "number", "description": "CESS payable", "example": 10 } } }, "tax_pay": { "type": "object", "properties": { "tax_val": { "type": "number", "description": "Value of goods", "example": 1000 }, "iamt": { "type": "number", "description": "IGST payable", "example": 20 }, "camt": { "type": "number", "description": "CGST payable", "example": 10 }, "samt": { "type": "number", "description": "SGST payable", "example": 10 }, "csamt": { "type": "number", "description": "CESS payable", "example": 5 } } } } }, "table4": { "type": "object", "properties": { "rchrg": { "type": "object", "properties": { "iamt": { "type": "number", "description": "IGST payable", "example": 10 }, "camt": { "type": "number", "description": "CGST payable", "example": 10 }, "samt": { "type": "number", "description": "SGST payable", "example": 10 }, "csamt": { "type": "number", "description": "CESS payable", "example": 10 } } }, "otr_rchrg": { "type": "object", "properties": { "iamt": { "type": "number", "description": "IGST payable", "example": 10 }, "camt": { "type": "number", "description": "CGST payable", "example": 10 }, "samt": { "type": "number", "description": "SGST payable", "example": 10 }, "csamt": { "type": "number", "description": "CESS payable", "example": 10 } } }, "neg_liab": { "type": "object", "properties": { "rchrg": { "type": "object", "properties": { "iamt": { "type": "number", "description": "IGST payable", "example": 10 }, "camt": { "type": "number", "description": "CGST payable", "example": 10 }, "samt": { "type": "number", "description": "SGST payable", "example": 10 }, "csamt": { "type": "number", "description": "CESS payable", "example": 10 } } }, "otr_rchrg": { "type": "object", "properties": { "iamt": { "type": "number", "description": "IGST payable", "example": 10 }, "camt": { "type": "number", "description": "CGST payable", "example": 10 }, "samt": { "type": "number", "description": "SGST payable", "example": 10 }, "csamt": { "type": "number", "description": "CESS payable", "example": 10 } } } } }, "intr_pay": { "type": "object", "properties": { "iamt": { "type": "number", "description": "IGST payable", "example": 10 }, "camt": { "type": "number", "description": "CGST payable", "example": 10 }, "samt": { "type": "number", "description": "SGST payable", "example": 10 }, "csamt": { "type": "number", "description": "CESS payable", "example": 10 } } } } }, "tax_pay": { "type": "array", "items": { "type": "object" } }, "offset": { "type": "array", "items": { "type": "object" } } } } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "signedcontent" } }, "/cmp/retevcfile": { "post": { "tags": [ "CMP" ], "summary": "File CMP data", "description": "Used to file entire CMP invoices using EVC.", "operationId": "fileCMP", "parameters": [ { "name": "email", "in": "query", "description": "API Developer User Email", "required": true, "schema": { "type": "string" } }, { "name": "pan", "in": "query", "description": "PAN Number", "required": true, "schema": { "type": "string" } }, { "name": "evcotp", "in": "query", "description": "OTP for EVC", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "type": "object", "properties": { "gstin": { "type": "string", "description": "GST Number", "example": "01AAAAB1726H1ZI" }, "ret_period": { "type": "string", "description": "Return Period", "example": "032018" }, "isnil": { "type": "string", "description": "Is Nil Return", "example": "N" }, "table3": { "type": "object", "properties": { "out_sup": { "type": "object", "properties": { "tax_val": { "type": "number", "description": "Value of goods", "example": 40 }, "camt": { "type": "number", "description": "CGST payable", "example": 20 }, "samt": { "type": "number", "description": "SGST payable", "example": 20 } } }, "in_sup": { "type": "object", "properties": { "tax_val": { "type": "number", "description": "Value of goods", "example": 40 }, "iamt": { "type": "number", "description": "IGST payable", "example": 10 }, "camt": { "type": "number", "description": "CGST payable", "example": 20 }, "samt": { "type": "number", "description": "SGST payable", "example": 20 }, "csamt": { "type": "number", "description": "CESS payable", "example": 10 } } }, "intr_pay": { "type": "object", "properties": { "iamt": { "type": "number", "description": "IGST payable", "example": 10 }, "camt": { "type": "number", "description": "CGST payable", "example": 20 }, "samt": { "type": "number", "description": "SGST payable", "example": 20 }, "csamt": { "type": "number", "description": "CESS payable", "example": 10 } } }, "tax_pay": { "type": "object", "properties": { "tax_val": { "type": "number", "description": "Value of goods", "example": 1000 }, "iamt": { "type": "number", "description": "IGST payable", "example": 20 }, "camt": { "type": "number", "description": "CGST payable", "example": 10 }, "samt": { "type": "number", "description": "SGST payable", "example": 10 }, "csamt": { "type": "number", "description": "CESS payable", "example": 5 } } } } }, "table4": { "type": "object", "properties": { "rchrg": { "type": "object", "properties": { "iamt": { "type": "number", "description": "IGST payable", "example": 10 }, "camt": { "type": "number", "description": "CGST payable", "example": 10 }, "samt": { "type": "number", "description": "SGST payable", "example": 10 }, "csamt": { "type": "number", "description": "CESS payable", "example": 10 } } }, "otr_rchrg": { "type": "object", "properties": { "iamt": { "type": "number", "description": "IGST payable", "example": 10 }, "camt": { "type": "number", "description": "CGST payable", "example": 10 }, "samt": { "type": "number", "description": "SGST payable", "example": 10 }, "csamt": { "type": "number", "description": "CESS payable", "example": 10 } } }, "neg_liab": { "type": "object", "properties": { "rchrg": { "type": "object", "properties": { "iamt": { "type": "number", "description": "IGST payable", "example": 10 }, "camt": { "type": "number", "description": "CGST payable", "example": 10 }, "samt": { "type": "number", "description": "SGST payable", "example": 10 }, "csamt": { "type": "number", "description": "CESS payable", "example": 10 } } }, "otr_rchrg": { "type": "object", "properties": { "iamt": { "type": "number", "description": "IGST payable", "example": 10 }, "camt": { "type": "number", "description": "CGST payable", "example": 10 }, "samt": { "type": "number", "description": "SGST payable", "example": 10 }, "csamt": { "type": "number", "description": "CESS payable", "example": 10 } } } } }, "intr_pay": { "type": "object", "properties": { "iamt": { "type": "number", "description": "IGST payable", "example": 10 }, "camt": { "type": "number", "description": "CGST payable", "example": 10 }, "samt": { "type": "number", "description": "SGST payable", "example": 10 }, "csamt": { "type": "number", "description": "CESS payable", "example": 10 } } } } }, "tax_pay": { "type": "array", "items": { "type": "object" } }, "offset": { "type": "array", "items": { "type": "object" } } } } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "content" } }, "/cmp/validateturnover": { "get": { "tags": [ "CMP" ], "summary": "Get validate turnover for CMP", "description": "Getting validate turnover for CMP for a return period.", "operationId": "getValidateTurnover", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr8/tcs": { "get": { "tags": [ "GSTR8" ], "summary": "Get TCS Invoices", "description": "Getting all TCS invoices for a return period.", "operationId": "getTCSInvoice", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "fromtime", "in": "query", "description": "From time format DD-MM-YYYY HH:MM,20-12-2016 09:30", "schema": { "type": "string" } }, { "name": "rettype", "in": "query", "description": "Return Type", "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr8/retsum": { "get": { "tags": [ "GSTR8" ], "summary": "Get GSTR8 Summary", "description": "Getting GSTR8 Summary for a return period.", "operationId": "getGSTRSummary", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "fnl", "in": "query", "description": "flag to indicate that a FINAL get call before filing of return.This will be set to Y when GSTR8 is submitted", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr8/retsave": { "put": { "tags": [ "GSTR8" ], "summary": "Save GSTR8 data", "description": "Used to save entire GSTR8 invoices.", "operationId": "saveGSTR", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "type": "object", "properties": { "gstin": { "type": "string", "description": "gstin number", "example": "08GGMPS7032E6C7" }, "fp": { "type": "string", "description": "financial period", "example": "102017" }, "tcs": { "type": "array", "items": { "type": "object" } }, "tcsa": { "type": "array", "items": { "type": "object" } } } } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/gstr8/retfile": { "post": { "tags": [ "GSTR8" ], "summary": "File GSTR8 data", "description": "Used to File GSTR8 invoices.", "operationId": "fileGSTR", "parameters": [ { "name": "email", "in": "query", "description": "API Developer User Email", "required": true, "schema": { "type": "string" } }, { "name": "pan", "in": "query", "description": "PAN Number", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload Format : {\"content\":\"{\"gstin\": \"37ABCDE9552F3Z4\", \"ret_period\": \"072017\",\"chksum\": \"AflJufPlFStqKBZ\",\"summ_typ\": \"L\"}\",\"pkcs7\":\"MIIFrwYJKoZIhvcNAQcCoI==\"}", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "signedcontent" } }, "/gstr8/retevcfile": { "post": { "tags": [ "GSTR8" ], "summary": "File GSTR8 data", "description": "Used to file entire GSTR8 invoices using EVC.", "operationId": "fileGSTR", "parameters": [ { "name": "email", "in": "query", "description": "API Developer User Email", "required": true, "schema": { "type": "string" } }, { "name": "pan", "in": "query", "description": "PAN Number", "required": true, "schema": { "type": "string" } }, { "name": "evcotp", "in": "query", "description": "OTP for EVC", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload Format : \"{\"gstin\": \"37ABCDE9552F3Z4\", \"ret_period\": \"072017\",\"chksum\": \"AflJufPlFStqKBZ\"}", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "content" } }, "/payment/generateChallan": { "post": { "tags": [ "Payment" ], "summary": "Generate Challan", "description": "Generate Challan.", "operationId": "Generate Challan", "parameters": [ { "name": "email", "in": "query", "description": "API Developer User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "type": "object", "properties": { "gstin": { "type": "string", "description": "GSTIN number", "example": "27AHQPA7588L1ZJ" }, "email_id": { "type": "string", "description": "email", "example": "abc@gmail.com" }, "mobile_num": { "type": "string", "description": "Mobile Number", "example": "9889898999" }, "tp_name": { "type": "string", "description": "Tax payer name", "example": "NEELAM NAIDU" }, "address": { "type": "string", "description": "Address", "example": "1234,KamalaNagar,Delhi" }, "payment_mod": { "type": "string", "description": "Payment mode", "example": "OTC" }, "bank_cd": { "type": "string", "description": "Bank Code", "example": "ICIC" }, "sub_pay_mod": { "type": "string", "description": "Sub Payment mode", "example": "CQ" }, "ipAddr": { "type": "string", "description": "Ip address", "example": "12.8.91.80" }, "cgst_tax_amt": { "type": "number", "description": "Cgst tax amount", "example": 42848 }, "cgst_int_amt": { "type": "number", "description": "Cgst interest amount", "example": 0 }, "cgst_fee_amt": { "type": "number", "description": "Cgst fee amount", "example": 0 }, "cgst_oth_amt": { "type": "number", "description": "Cgst other amount", "example": 0 }, "cgst_pen_amt": { "type": "number", "description": "Cgst penalty amount", "example": 0 }, "igst_tax_amt": { "type": "number", "description": "Igst tax amount", "example": 43202 }, "igst_int_amt": { "type": "number", "description": "Igst interest amount", "example": 0 }, "igst_fee_amt": { "type": "number", "description": "Igst fee amount", "example": 0 }, "igst_oth_amt": { "type": "number", "description": "Igst other amount", "example": 0 }, "igst_pen_amt": { "type": "number", "description": "Igst penalty amount", "example": 0 }, "sgst_tax_amt": { "type": "number", "description": "Sgst tax amount", "example": 42848 }, "sgst_int_amt": { "type": "number", "description": "Sgst interest amount", "example": 0 }, "sgst_fee_amt": { "type": "number", "description": "Sgst fee amount", "example": 0 }, "sgst_oth_amt": { "type": "number", "description": "Sgst other amount", "example": 0 }, "sgst_pen_amt": { "type": "number", "description": "Sgst penalty amount", "example": 0 }, "cess_tax_amt": { "type": "number", "description": "Cess tax amount", "example": 46738 }, "cess_int_amt": { "type": "number", "description": "Cess interest amount", "example": 0 }, "cess_fee_amt": { "type": "number", "description": "Cess fee amount", "example": 0 }, "cess_oth_amt": { "type": "number", "description": "Cess other amount", "example": 0 }, "cess_pen_amt": { "type": "number", "description": "Cess penalty amount", "example": 0 }, "cgst_tot_amt": { "type": "number", "description": "Cgst Total amount", "example": 42848 }, "igst_tot_amt": { "type": "number", "description": "Igst Total amount", "example": 43202 }, "sgst_tot_amt": { "type": "number", "description": "Sgst Total amount", "example": 42848 }, "cess_tot_amt": { "type": "number", "description": "Cess Total amount", "example": 46738 }, "total_amt": { "type": "number", "description": "Total amount", "example": 175636 }, "chln_rsn": { "type": "string", "description": "Challan reason", "example": "QRMP35" }, "chln_prd": { "type": "string", "description": "Challan reason period", "example": "112020" } } } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/payment/chllnlst": { "get": { "tags": [ "Payment" ], "summary": "Get Challan History", "description": "As per SRS, Taxpayer can view the challan history through GSP after logging in to the account.TaxPayer need to provide the inputs for parameters (from date, to date) along with GSTIN.GSP invoke this interface to get the Challan history for the period and GST Backend system returns the Challan History Details with CPIN, Expiry Date, Creation Date, Total amount etc. ", "operationId": "getChallanHistory", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "fromdate", "in": "query", "description": "From Date (DD-MM-YYYY,20-12-2016)", "required": true, "schema": { "type": "string" } }, { "name": "todate", "in": "query", "description": "To Date (DD-MM-YYYY,20-12-2016)", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/payment/chllnsum": { "get": { "tags": [ "Payment" ], "summary": "Get Challan Summary", "description": "As per SRS, Taxpayer can view the challan Summary details through GSP after logging in to account.TaxPayer need to provide the GSTIN and CPIN and GSP invoke this interface the to get the challan summary. GST Backend system returns the Challan Summary Details with CPIN, Expiry Date, Creation Date, Total amount along with Payment status etc. ", "operationId": "getChallanSummary", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "cpin", "in": "query", "description": "CPIN", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/payment/validatechlnrsn": { "post": { "tags": [ "Payment" ], "summary": "Validate Challan Reason", "description": "Validate Challan Reason.", "operationId": "Validate Challan Reason", "parameters": [ { "name": "email", "in": "query", "description": "API Developer User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "type": "object", "properties": { "gstin": { "type": "string", "description": "GSTIN number", "example": "27AHQPA7588L1ZJ" }, "email_id": { "type": "string", "description": "email", "example": "abc@gmail.com" }, "mobile_num": { "type": "string", "description": "Mobile Number", "example": "9889898999" }, "tp_name": { "type": "string", "description": "Tax payer name", "example": "NEELAM NAIDU" }, "address": { "type": "string", "description": "Address", "example": "1234,KamalaNagar,Delhi" }, "payment_mod": { "type": "string", "description": "Payment mode", "example": "OTC" }, "bank_cd": { "type": "string", "description": "Bank Code", "example": "ICIC" }, "sub_pay_mod": { "type": "string", "description": "Sub Payment mode", "example": "CQ" }, "ipAddr": { "type": "string", "description": "Ip address", "example": "12.8.91.80" }, "cgst_tax_amt": { "type": "number", "description": "Cgst tax amount", "example": 42848 }, "cgst_int_amt": { "type": "number", "description": "Cgst interest amount", "example": 0 }, "cgst_fee_amt": { "type": "number", "description": "Cgst fee amount", "example": 0 }, "cgst_oth_amt": { "type": "number", "description": "Cgst other amount", "example": 0 }, "cgst_pen_amt": { "type": "number", "description": "Cgst penalty amount", "example": 0 }, "igst_tax_amt": { "type": "number", "description": "Igst tax amount", "example": 43202 }, "igst_int_amt": { "type": "number", "description": "Igst interest amount", "example": 0 }, "igst_fee_amt": { "type": "number", "description": "Igst fee amount", "example": 0 }, "igst_oth_amt": { "type": "number", "description": "Igst other amount", "example": 0 }, "igst_pen_amt": { "type": "number", "description": "Igst penalty amount", "example": 0 }, "sgst_tax_amt": { "type": "number", "description": "Sgst tax amount", "example": 42848 }, "sgst_int_amt": { "type": "number", "description": "Sgst interest amount", "example": 0 }, "sgst_fee_amt": { "type": "number", "description": "Sgst fee amount", "example": 0 }, "sgst_oth_amt": { "type": "number", "description": "Sgst other amount", "example": 0 }, "sgst_pen_amt": { "type": "number", "description": "Sgst penalty amount", "example": 0 }, "cess_tax_amt": { "type": "number", "description": "Cess tax amount", "example": 46738 }, "cess_int_amt": { "type": "number", "description": "Cess interest amount", "example": 0 }, "cess_fee_amt": { "type": "number", "description": "Cess fee amount", "example": 0 }, "cess_oth_amt": { "type": "number", "description": "Cess other amount", "example": 0 }, "cess_pen_amt": { "type": "number", "description": "Cess penalty amount", "example": 0 }, "cgst_tot_amt": { "type": "number", "description": "Cgst Total amount", "example": 42848 }, "igst_tot_amt": { "type": "number", "description": "Igst Total amount", "example": 43202 }, "sgst_tot_amt": { "type": "number", "description": "Sgst Total amount", "example": 42848 }, "cess_tot_amt": { "type": "number", "description": "Cess Total amount", "example": 46738 }, "total_amt": { "type": "number", "description": "Total amount", "example": 175636 }, "chln_rsn": { "type": "string", "description": "Challan reason", "example": "QRMP35" }, "chln_prd": { "type": "string", "description": "Challan reason period", "example": "112020" } } } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/ledgers/cashdtl": { "get": { "tags": [ "Ledger" ], "summary": "Cash Ledger Details", "description": "This API call is for getting cash ledger details for the specified period.", "operationId": "getCashLedgerDetails", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "frdt", "in": "query", "description": "From Date (DD-MM-YYYY,20-12-2016)", "required": true, "schema": { "type": "string" } }, { "name": "todt", "in": "query", "description": "To Date (DD-MM-YYYY,20-12-2016)", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/ledgers/itc": { "get": { "tags": [ "Ledger" ], "summary": "ITC Ledger Details", "description": "This API call is for get detailed ITC ledger for the specified period .", "operationId": "getITCLedgerDetails", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "frdt", "in": "query", "description": "From Date (DD-MM-YYYY,20-12-2016)", "required": true, "schema": { "type": "string" } }, { "name": "todt", "in": "query", "description": "To Date (DD-MM-YYYY,20-12-2016)", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/ledgers/tax": { "get": { "tags": [ "Ledger" ], "summary": "Get Liability Ledger Details", "description": "This API call is for getting Tax ledger details for the specified period.", "operationId": "getLiabilityLedgerDetails", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "frdt", "in": "query", "description": "From Period MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "todt", "in": "query", "description": "To Period MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/ledgers/bal": { "get": { "tags": [ "Ledger" ], "summary": "Get Cash ITC Balance", "description": "This API is to get the balance for ITC and Cash as on date.", "operationId": "getCashITCBalance", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/ledgers/taxpayable": { "get": { "tags": [ "Ledger" ], "summary": "Get RetLiab Balance", "description": "This API is to get the Return Related Liability Balance for the user for the tax period.", "operationId": "getRetLiabBalance", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "rettype", "in": "query", "description": "Return Type", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/ledgers/itcblocktrandetls": { "get": { "tags": [ "Ledger" ], "summary": "Get Block Unblock", "description": "This API is provided for getting details of blocking or unblocking the tax amounts of a particular taxpayer.", "operationId": "getBlockUnBlockDetails", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "frdt", "in": "query", "description": "From Date (DD-MM-YYYY,20-12-2016)", "required": true, "schema": { "type": "string" } }, { "name": "todt", "in": "query", "description": "To Date (DD-MM-YYYY,20-12-2016)", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/ledgers/utlcsh": { "post": { "tags": [ "Ledger" ], "summary": "Utilize Cash", "description": "This API call is to utilize the Cash Balance for paying the liability.", "operationId": "utilizeCash", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/ledgers/utlitc": { "post": { "tags": [ "Ledger" ], "summary": "Utilize ITC", "description": "This API call is to utilize the ITC Balance for paying the liability.", "operationId": "utilizeITC", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/gstr6/b2b": { "get": { "tags": [ "GSTR6" ], "summary": "Get B2B Invoices", "description": "Getting all B2B invoices for a return period.", "operationId": "getB2BInvoices", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "actionrequired", "in": "query", "description": "Status filter for filtering the invoices. Action_required = Y, fetches the invoices where tax payer need to take action (Accept/Reject). Already accepted or uploaded invoices can be fetched by using action_required=N filter.", "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "ctin", "in": "query", "description": "CTIN of the taxpayer", "schema": { "type": "string" } }, { "name": "fromtime", "in": "query", "description": "From time format DD-MM-YYYY,20-12-2016", "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr6/retcal": { "post": { "tags": [ "GSTR6" ], "summary": "GSTR6 Calculate R6", "description": "Used to get the status on click of calculate R6", "operationId": "CalculateR6", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "required": [ "gstin", "ret_period" ], "type": "object", "properties": { "gstin": { "type": "string", "description": "GSTIN number", "example": "05AFVPB9858F1ZZ" }, "ret_period": { "type": "string", "description": "Return period", "example": "072017" } } } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/gstr6/savecrossitcdetails": { "post": { "tags": [ "GSTR6" ], "summary": "Save GSTR6 Cross ITC details", "description": "Used to save the cross ITC details.", "operationId": "saveCrossGSTR", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "required": [ "fp", "gstin", "isdItcCross" ], "type": "object", "properties": { "gstin": { "type": "string", "description": "GSTIN number", "example": "09AISDA1572E3ZY" }, "fp": { "type": "string", "description": "Financial period", "example": "072017" }, "isdItcCross": { "type": "object", "additionalProperties": false } } } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/gstr6/retoffsetlatefee": { "put": { "tags": [ "GSTR6" ], "summary": " Offset Liability GSTR6 Late fee", "description": "API call for Offset GSTR6 Late fee", "operationId": "offsetLiability", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "required": [ "cgstfee", "gstin", "liab_id", "ret_period", "ret_type", "sgstfee", "tran_cd" ], "type": "object", "properties": { "gstin": { "type": "string", "description": "Supplier GSTIN", "example": "12cdfsdfsd" }, "ret_type": { "type": "string", "description": "Return type", "example": "R6" }, "ret_period": { "type": "string", "description": "Return period", "example": "032020" }, "liab_id": { "type": "number", "description": "Liability Id", "example": 20 }, "tran_cd": { "type": "number", "description": "Transaction code", "example": 20 }, "cgstfee": { "type": "number", "description": "CGST Latefee Amount", "example": 200 }, "sgstfee": { "type": "number", "description": "SGST Latefee Amount", "example": 300 } } } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/gstr6/retsave": { "put": { "tags": [ "GSTR6" ], "summary": "Save GSTR8 data", "description": "Used to save entire GSTR8 invoices.", "operationId": "saveGSTR", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "type": "object", "properties": { "gstin": { "type": "string", "description": "GSTIN number", "example": "07CQZCD1111I4Z7" }, "fp": { "type": "string", "description": "Financial period", "example": "082016" }, "b2b": { "type": "array", "items": { "type": "object" } }, "cdn": { "type": "array", "items": { "type": "object" } }, "isd": { "type": "object", "properties": { "elglst": { "type": "array", "items": { "type": "object" } }, "inelglst": { "type": "array", "items": { "type": "object" } } } }, "b2ba": { "type": "array", "items": { "type": "object" } }, "cdna": { "type": "array", "items": { "type": "object" } }, "isda": { "type": "object", "properties": { "elglst": { "type": "array", "items": { "type": "object" } }, "inelglst": { "type": "array", "items": { "type": "object" } } } } } } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/gstr6/cdn": { "get": { "tags": [ "GSTR6" ], "summary": "Get CDNR Invoices", "description": "Will call CDN for getting all Credit/Debit notes for a return period.", "operationId": "getCDNInvoices", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "actionrequired", "in": "query", "description": "Status filter for filtering the invoices. Action_required = Y, fetches the invoices where tax payer need to take action (Accept/Reject). Already accepted or uploaded invoices can be fetched by using action_required=N filter.", "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "ctin", "in": "query", "description": "CTIN of the taxpayer", "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr6/isd": { "get": { "tags": [ "GSTR6" ], "summary": "Get ISD Details", "description": "Get ISD Details", "operationId": "getISDDetails", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr6/retsum": { "get": { "tags": [ "GSTR6" ], "summary": "Get GSTR6 Summary", "description": "Get GSTR6 Summary", "operationId": "getGSTRSummary", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr6/retsubmit": { "post": { "tags": [ "GSTR6" ], "summary": "Submit GSTR6 data", "description": "Used to Submit entire GSTR6 invoices.", "operationId": "submitGSTR", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/gstr6/retfile": { "post": { "tags": [ "GSTR6" ], "summary": "File GSTR6 data", "description": "Used to File GSTR6 invoices.", "operationId": "fileGSTR", "parameters": [ { "name": "email", "in": "query", "description": "API Developer User Email", "required": true, "schema": { "type": "string" } }, { "name": "pan", "in": "query", "description": "PAN Number", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload Format : {\"content\":\"{\"gstin\": \"37ABCDE9552F3Z4\", \"ret_period\": \"072017\",\"chksum\": \"AflJufPlFStqKBZ\",\"summ_typ\": \"L\"}\",\"pkcs7\":\"MIIFrwYJKoZIhvcNAQcCoI==\"}", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "signedcontent" } }, "/gstr6/retevcfile": { "post": { "tags": [ "GSTR6" ], "summary": "File GSTR6 data", "description": "Used to file entire GSTR6 invoices using EVC.", "operationId": "fileGSTR", "parameters": [ { "name": "email", "in": "query", "description": "API Developer User Email", "required": true, "schema": { "type": "string" } }, { "name": "pan", "in": "query", "description": "PAN Number", "required": true, "schema": { "type": "string" } }, { "name": "evcotp", "in": "query", "description": "OTP for EVC", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload Format : \"{\"gstin\": \"37ABCDE9552F3Z4\", \"ret_period\": \"072017\",\"chksum\": \"AflJufPlFStqKBZ\"}", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "content" } }, "/gstr6/latefee": { "get": { "tags": [ "GSTR6" ], "summary": "Get Late Fee", "description": "Get Late Fee", "operationId": "getLatefee", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr6/itc": { "get": { "tags": [ "GSTR6" ], "summary": "Get ITC Details", "description": "Get ITC Details", "operationId": "getITCdetails", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr6a/b2b": { "get": { "tags": [ "GSTR6A" ], "summary": "Get B2B Invoices", "description": "Getting all B2B invoices for a return period.", "operationId": "getB2BInvoices", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "actionrequired", "in": "query", "description": "Status filter for filtering the invoices. Action_required = Y, fetches the invoices where tax payer need to take action (Accept/Reject). Already accepted or uploaded invoices can be fetched by using action_required=N filter.", "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "ctin", "in": "query", "description": "CTIN of the taxpayer", "schema": { "type": "string" } }, { "name": "fromtime", "in": "query", "description": "From time format DD-MM-YYYY,20-12-2016", "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr6a/cdn": { "get": { "tags": [ "GSTR6A" ], "summary": "Get CDNR Invoices", "description": "Will call CDN for getting all Credit/Debit notes for a return period.", "operationId": "getCDNInvoices", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "actionrequired", "in": "query", "description": "Status filter for filtering the invoices. Action_required = Y, fetches the invoices where tax payer need to take action (Accept/Reject). Already accepted or uploaded invoices can be fetched by using action_required=N filter.", "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "ctin", "in": "query", "description": "CTIN of the taxpayer", "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr6a/b2ba": { "get": { "tags": [ "GSTR6A" ], "summary": "Get B2BA Invoices", "description": "Getting all B2BA invoices for a return period.", "operationId": "getB2BAInvoices", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "actionrequired", "in": "query", "description": "Status filter for filtering the invoices. Action_required = Y, fetches the invoices where tax payer need to take action (Accept/Reject). Already accepted or uploaded invoices can be fetched by using action_required=N filter.", "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "ctin", "in": "query", "description": "CTIN of the taxpayer", "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr6a/cdna": { "get": { "tags": [ "GSTR6A" ], "summary": "Get CDNRA Invoices", "description": "Will call CDNA for getting all amended Credit/Debit notes for a return period.", "operationId": "getCDNAInvoices", "parameters": [ { "name": "actionrequired", "in": "query", "description": "Status filter for filtering the invoices. Action_required = Y, fetches the invoices where tax payer need to take action (Accept/Reject). Already accepted or uploaded invoices can be fetched by using action_required=N filter.", "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "ctin", "in": "query", "description": "CTIN of the taxpayer", "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr7/retfile": { "post": { "tags": [ "GSTR7" ], "summary": "File GSTR7", "description": "This API is to File GSTR7 ", "operationId": "fileGSTR", "parameters": [ { "name": "email", "in": "query", "description": "API Developer User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload Format : {\"content\":\"{\"gstin\": \"37ABCDE9552F3Z4\", \"ret_period\": \"072017\",\"chksum\": \"AflJufPlFStqKBZ\",\"summ_typ\": \"L\"}\",\"pkcs7\":\"MIIFrwYJKoZIhvcNAQcCoI==\"}", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "signedcontent" } }, "/gstr7/retevcfile": { "post": { "tags": [ "GSTR7" ], "summary": "File GSTR7 data", "description": "Used to file entire GSTR7 invoices using EVC.", "operationId": "fileGSTR", "parameters": [ { "name": "email", "in": "query", "description": "API Developer User Email", "required": true, "schema": { "type": "string" } }, { "name": "pan", "in": "query", "description": "PAN Number", "required": true, "schema": { "type": "string" } }, { "name": "evcotp", "in": "query", "description": "OTP for EVC", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload Format : \"{\"gstin\": \"37ABCDE9552F3Z4\", \"ret_period\": \"072017\",\"chksum\": \"AflJufPlFStqKBZ\"}", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "content" } }, "/gstr7/retsave": { "put": { "tags": [ "GSTR7" ], "summary": "Save GSTR7", "description": "This API is to save GSTR7 data", "operationId": "saveGSTR", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "type": "object", "properties": { "gstin": { "type": "string", "description": "gstin number", "example": "08AUGGC1893FDD5" }, "fp": { "type": "string", "description": "financial period", "example": "032018" }, "tds": { "type": "array", "items": { "type": "object" } }, "tdsa": { "type": "array", "items": { "type": "object" } } } } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/gstr7/retsum": { "get": { "tags": [ "GSTR7" ], "summary": "Get GSTR7 Summary", "description": "This API is to get GSTR7 summary", "operationId": "getGSTRSummary", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr7/tds": { "get": { "tags": [ "GSTR7" ], "summary": "Get TDS details", "description": "API call for getting invoices related to TDS credit received. ", "operationId": "getTDSDetails", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "fromtime", "in": "query", "description": "From time format DD-MM-YYYY HH:mm,20-12-2016 11:15", "required": true, "schema": { "type": "string" } }, { "name": "rectype", "in": "query", "description": "Rec Type", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr7/tdschecksum": { "get": { "tags": [ "GSTR7" ], "summary": "Get TDS Checksum", "description": "API call for getting TDS Checksum. ", "operationId": "getTDSChecksum", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "fromtime", "in": "query", "description": "From time format DD-MM-YYYY HH:mm,20-12-2016 11:15", "required": true, "schema": { "type": "string" } }, { "name": "rectype", "in": "query", "description": "Rec Type", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr8/checksum": { "get": { "tags": [ "GSTR8" ], "summary": "Get Checksum", "description": "API call for getting Checksum. ", "operationId": "getChecksum", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "fromtime", "in": "query", "description": "From time format DD-MM-YYYY HH:MM,20-12-2016 11:15", "schema": { "type": "string" } }, { "name": "rettype", "in": "query", "description": "Return Type", "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr8/eid": { "get": { "tags": [ "GSTR8" ], "summary": "Get EID", "description": "API call for original and amended supplies of the unregistered suppliers. ", "operationId": "getEid", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "fromtime", "in": "query", "description": "From time format DD-MM-YYYY HH:MM,20-12-2016 11:15", "schema": { "type": "string" } }, { "name": "rettype", "in": "query", "description": "Return Type", "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr3b/retsum": { "get": { "tags": [ "GSTR3B" ], "summary": "Get GSTR3B Summary", "description": "Get the table wise summary of GSTR3B data.", "operationId": "getGSTRSummary", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr3b/autoliab": { "get": { "tags": [ "GSTR3B" ], "summary": "Get GSTR1 auto calculated liability details", "description": "Get GSTR1 Liability Auto Calc Details.", "operationId": "getGSTR1AutoCalculatedLiabilityDetails", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr3b/retsave": { "put": { "tags": [ "GSTR3B" ], "summary": "Save GSTR3B data", "description": "Used to save entire GSTR3B invoices.", "operationId": "saveGSTR", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "type": "object", "properties": { "gstin": { "maxLength": 15, "minLength": 15, "pattern": "[0-9]{2}[a-zA-Z]{5}[0-9]{4}[a-zA-Z]{1}[1-9A-Za-z]{1}[Zz1-9A-Ja-j]{1}[0-9a-zA-Z]{1}", "type": "string", "description": "Supplier GSTIN", "example": "05AVHPB7348G1ZP" }, "ret_period": { "pattern": "^((0[1-9]|1[012])((19|20)\\d\\d))$", "type": "string", "description": "Return period", "example": "042017" }, "sup_details": { "type": "object", "properties": { "osup_det": { "type": "object", "properties": { "txval": { "type": "number", "description": "Taxable Value", "example": 250 }, "iamt": { "type": "number", "description": "integrated Taxamount available in the current month", "example": 100 }, "camt": { "type": "number", "description": "central tax amount available in the current month", "example": 200 }, "samt": { "type": "number", "description": "State Tax amount available in the current month", "example": 300 }, "csamt": { "type": "number", "description": "CESS Amount", "example": 400 } } }, "osup_zero": { "type": "object", "properties": { "txval": { "type": "number", "description": "Taxable Value", "example": 250 }, "iamt": { "type": "number", "description": "integrated Taxamount available in the current month", "example": 100 }, "csamt": { "type": "number", "description": "CESS Amount", "example": 400 } } }, "osup_nil_exmp": { "type": "object", "properties": { "txval": { "type": "number", "description": "Taxable Value", "example": 250 } } }, "isup_rev": { "type": "object", "properties": { "txval": { "type": "number", "description": "Taxable Value", "example": 250 }, "iamt": { "type": "number", "description": "integrated Taxamount available in the current month", "example": 100 }, "camt": { "type": "number", "description": "Taxable Amount", "example": 200 }, "samt": { "type": "number", "description": "Taxable Amount", "example": 300 }, "csamt": { "type": "number", "description": "CESS Amount", "example": 400 } } }, "osup_nongst": { "type": "object", "properties": { "txval": { "type": "object", "description": "Taxable Value", "example": "250" } } } } }, "inter_sup": { "type": "object", "properties": { "unreg_details": { "type": "array", "items": { "type": "object" } }, "comp_details": { "type": "array", "items": { "type": "object" } }, "uin_details": { "type": "array", "items": { "type": "object" } } } }, "itc_elg": { "type": "object", "properties": { "itc_avl": { "type": "array", "items": { "type": "object" } }, "itc_rev": { "type": "array", "items": { "type": "object" } }, "itc_net": { "type": "object", "properties": { "iamt": { "type": "number", "description": "integrated Taxamount available in the current month", "example": 136.53 }, "camt": { "type": "number", "description": "central tax amount available in the current month", "example": 274 }, "samt": { "type": "number", "description": "State Tax amount available in the current month", "example": 162.99 }, "csamt": { "type": "number", "description": "CESS Amount", "example": 103 } } }, "itc_inelg": { "type": "array", "items": { "type": "object" } } } }, "inward_sup": { "type": "object", "properties": { "isup_details": { "type": "array", "items": { "type": "object" } } } }, "intr_ltfee": { "type": "object", "properties": { "intr_details": { "type": "object", "properties": { "iamt": { "type": "number", "description": "integrated Taxamount available in the current month", "example": 10 }, "camt": { "type": "number", "description": "central tax amount available in the current month", "example": 20 }, "samt": { "type": "number", "description": "State Tax amount available in the current month", "example": 30 }, "csamt": { "type": "number", "description": "CESS Amount", "example": 40 } } } } } } } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/gstr3b/retoffset": { "put": { "tags": [ "GSTR3B" ], "summary": "Offset Liability GSTR3B Data", "description": "Offset Liability GSTR3B Data.", "operationId": "offsetLiabilityGSTR3B", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/gstr3b/liabilitybreakup": { "put": { "tags": [ "GSTR3B" ], "summary": "Save past liability breakup GSTR3B Data", "description": "Save past liability breakup GSTR3B Data.", "operationId": "savepastliabilitybreakupGSTR3B", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/gstr3b/retfile": { "post": { "tags": [ "GSTR3B" ], "summary": "File GSTR3B data", "description": "Used to File GSTR3B invoices.", "operationId": "fileGSTR", "parameters": [ { "name": "email", "in": "query", "description": "API Developer User Email", "required": true, "schema": { "type": "string" } }, { "name": "pan", "in": "query", "description": "PAN Number", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload Format : {\"content\":\"{\"gstin\": \"37ABCDE9552F3Z4\", \"ret_period\": \"072017\",\"chksum\": \"AflJufPlFStqKBZ\",\"summ_typ\": \"L\"}\",\"pkcs7\":\"MIIFrwYJKoZIhvcNAQcCoI==\"}", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "signedcontent" } }, "/gstr3b/retevcfile": { "post": { "tags": [ "GSTR3B" ], "summary": "File GSTR3B data", "description": "Used to File GSTR3B invoices using EVC.", "operationId": "fileGSTRByEVC", "parameters": [ { "name": "email", "in": "query", "description": "API Developer User Email", "required": true, "schema": { "type": "string" } }, { "name": "pan", "in": "query", "description": "PAN Number", "required": true, "schema": { "type": "string" } }, { "name": "evcotp", "in": "query", "description": "OTP for EVC", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload Format : {\"content\":\"{\"gstin\": \"37ABCDE9552F3Z4\", \"ret_period\": \"072017\",\"chksum\": \"AflJufPlFStqKBZ\"}", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "content" } }, "/gstr3b/validateautocalculatedata": { "post": { "tags": [ "GSTR3B" ], "summary": "validate GSTR3B against auto calculated values", "description": "validate GSTR3B against auto calculated values.", "operationId": "validateGSTR3Bautocalculatedvalues", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/gstr3b/cmpint": { "post": { "tags": [ "GSTR3B" ], "summary": "Recompute System Calulated Interest", "description": "Recompute System Calulated Interest.", "operationId": "Re-computeinterest", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/gstr3b/syscalcintrst": { "get": { "tags": [ "GSTR3B" ], "summary": "Get system calculated interest", "description": "Get system calculated interest.", "operationId": "getSystemCalculatedInterest", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr3b/closingbal": { "get": { "tags": [ "GSTR3B" ], "summary": "Get ITC Reversal Balance", "description": "Get latest closing balance of Electronic Credit Reversal and Re-claimed Statement.", "operationId": "getITCReversalBalance", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr3b/openingbal": { "get": { "tags": [ "GSTR3B" ], "summary": "Get Opening Balance For Credit Reversal and Re-claimed Details", "description": "Get declared and amended opening balance.", "operationId": "getOpeningBalance", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr2a/b2b": { "get": { "tags": [ "GSTR2A" ], "summary": "Get B2B Invoices", "description": "Getting all B2B invoices for a return period.", "operationId": "getB2BInvoices", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "ctin", "in": "query", "description": "CTIN of the taxpayer", "schema": { "type": "string" } }, { "name": "fromtime", "in": "query", "description": "From Time format DD-MM-YYYY", "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr2a/b2ba": { "get": { "tags": [ "GSTR2A" ], "summary": "Get B2BA Invoices", "description": "API call for getting all B2BA invoices for a return period.", "operationId": "getB2BAInvoices", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "ctin", "in": "query", "description": "CTIN of the taxpayer", "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr2a/cdn": { "get": { "tags": [ "GSTR2A" ], "summary": "CDN Invoice", "description": "Getting all CDN invoices for a return period.", "operationId": "getCDNInvoices", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "ctin", "in": "query", "description": "CTIN of the taxpayer", "schema": { "type": "string" } }, { "name": "fromtime", "in": "query", "description": "From Time format DD-MM-YYYY", "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr2a/cdna": { "get": { "tags": [ "GSTR2A" ], "summary": "Get CDNA Invoices", "description": " CDNA for getting all amended Credit/Debit notes in GSTR1A for a return period. ", "operationId": "getCDNAInvoices", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "ctin", "in": "query", "description": "CTIN of the taxpayer", "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr2a/impg": { "get": { "tags": [ "GSTR2A" ], "summary": "Get IMPG", "description": "Get import of goods Invoices.", "operationId": "getIMPG", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "fromtime", "in": "query", "description": "From time format DD-MM-YYYY, 13-07-2020", "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr2a/impgsez": { "get": { "tags": [ "GSTR2A" ], "summary": "Get IMPGSEZ", "description": "Get import of goods from sez.", "operationId": "getIMPGSEZ", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "fromtime", "in": "query", "description": "From time format DD-MM-YYYY, 13-07-2020", "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr2a/tcs": { "get": { "tags": [ "GSTR2A" ], "summary": "Get TCS", "description": "Get TCS Credit.", "operationId": "getTCS", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr2a/tds": { "get": { "tags": [ "GSTR2A" ], "summary": "Get TDS Credit", "description": "API call for getting invoices related to TDS credit received. ", "operationId": "getTDSInvoices", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr2a/amdhist": { "get": { "tags": [ "GSTR2A" ], "summary": "Get AMDHIST", "description": "Getting the amendment history for a Bill of Entry.", "operationId": "getAMDHIST", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "portcode", "in": "query", "description": "Port Code", "required": true, "schema": { "type": "string" } }, { "name": "benumber", "in": "query", "description": "Bill of Entry Number", "required": true, "schema": { "type": "string" } }, { "name": "bedate", "in": "query", "description": "Date when Bill of Entry was created format DD-MM-YYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr2b/all": { "get": { "tags": [ "GSTR2B" ], "summary": "Get All Details", "description": "Getting the details for given GSTIN, Return Period.", "operationId": "getAllDetails", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "rtnprd", "in": "query", "description": "Return Period", "required": true, "schema": { "type": "string" } }, { "name": "filenum", "in": "query", "description": "File Number", "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr2x/retsave": { "put": { "tags": [ "GSTR2X" ], "summary": "Save GSTR2X data", "description": "Used to save entire GSTR2X invoices.", "operationId": "saveGSTR", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "type": "object", "properties": { "gstin": { "type": "string", "description": "GSTIN number", "example": "36ACXPK3463A719" }, "fp": { "type": "string", "description": "Finacial Period", "example": "092017" }, "tds": { "type": "array", "items": { "type": "object" } }, "tdsa": { "type": "array", "items": { "type": "object" } }, "tcs": { "type": "array", "items": { "type": "object" } }, "tcsa": { "type": "array", "items": { "type": "object" } } } } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/gstr2x/retfile": { "post": { "tags": [ "GSTR2X" ], "summary": "File GSTR2X data", "description": "Used to file entire GSTR2X invoices.", "operationId": "fileGSTR", "parameters": [ { "name": "email", "in": "query", "description": "API Developer User Email", "required": true, "schema": { "type": "string" } }, { "name": "pan", "in": "query", "description": "PAN Number", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload Format : {\"content\":\"{\"gstin\": \"37ABCDE9552F3Z4\", \"ret_period\": \"072017\",\"chksum\": \"AflJufPlFStqKBZ\",\"summ_typ\": \"L\"}\",\"pkcs7\":\"MIIFrwYJKoZIhvcNAQcCoI==\"}", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "signedcontent" } }, "/gstr2x/retevcfile": { "post": { "tags": [ "GSTR2X" ], "summary": "File GSTR2X data", "description": "Used to file entire GSTR2X invoices using EVC.", "operationId": "fileGSTR2XByEVC", "parameters": [ { "name": "email", "in": "query", "description": "API Developer User Email", "required": true, "schema": { "type": "string" } }, { "name": "pan", "in": "query", "description": "PAN Number", "required": true, "schema": { "type": "string" } }, { "name": "evcotp", "in": "query", "description": "OTP for EVC", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload Format : {\"gstin\": \"37ABCDE9552F3Z4\", \"ret_period\": \"072017\",\"chksum\": \"AflJufPlFStqKBZ\"}", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "content" } }, "/gstr2x/tdstcs": { "get": { "tags": [ "GSTR2X" ], "summary": "Get TDS", "description": "Get TDS-TCS Credit Received Details", "operationId": "getTDS", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "fromtime", "in": "query", "description": "From time format DD-MM-YYYY,20-12-2016", "required": true, "schema": { "type": "string" } }, { "name": "rectype", "in": "query", "description": "Rec Type", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr4/retsave": { "put": { "tags": [ "GSTR4" ], "summary": "Save GSTR4 data", "description": "Used to save entire GSTR4 invoices.", "operationId": "saveGSTR", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "type": "object", "properties": { "gstin": { "type": "string", "description": "GSTIN number", "example": "04AUGGC1893F3ZE" }, "fp": { "type": "string", "description": "Fp Type", "example": "032018" }, "b2b": { "type": "array", "items": { "type": "object" } }, "cdnr": { "type": "array", "items": { "type": "object" } }, "txpd": { "type": "array", "items": { "type": "object" } }, "at": { "type": "array", "items": { "type": "object" } }, "b2bur": { "type": "array", "items": { "type": "object" } }, "imp_s": { "type": "array", "items": { "type": "object" } }, "txos": { "type": "object", "properties": { "itms": { "type": "array", "items": { "type": "object" } } } }, "b2ba": { "type": "array", "items": { "type": "object" } }, "b2bura": { "type": "array", "items": { "type": "object" } }, "imp_sa": { "type": "array", "items": { "type": "object" } }, "cdnra": { "type": "array", "items": { "type": "object" } }, "cdnura": { "type": "array", "items": { "type": "object" } }, "txosa": { "type": "array", "items": { "type": "object" } }, "ata": { "type": "array", "items": { "type": "object" } }, "txpda": { "type": "array", "items": { "type": "object" } } } } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/gstr4/b2b": { "get": { "tags": [ "GSTR4" ], "summary": "Get B2B Invoices", "description": "Getting all B2B invoices for a return period.", "operationId": "getB2BInvoices", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "actionrequired", "in": "query", "description": "Status filter for filtering the invoices. Action_required = Y, fetches the invoices where tax payer need to take action (Accept/Reject). Already accepted or uploaded invoices can be fetched by using action_required=N filter.", "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "ctin", "in": "query", "description": "CTIN of the taxpayer", "schema": { "type": "string" } }, { "name": "fromtime", "in": "query", "description": "From time format DD-MM-YYYY,20-12-2016", "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr4/b2bur": { "get": { "tags": [ "GSTR4" ], "summary": "Get B2B Unregistered Invoice", "description": "Getting all B2B Unregistered Invoice for a return period.", "operationId": "getB2BUnregisteredInvoice", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr4/imps": { "get": { "tags": [ "GSTR4" ], "summary": "Get IMPS", "description": "Get imp of services bills.", "operationId": "getIMPS", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr4/cdnr": { "get": { "tags": [ "GSTR4" ], "summary": "Get CDNR Invoices", "description": "Will call CDN for getting all Credit/Debit notes for a return period.", "operationId": "getCDNInvoices", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "actionrequired", "in": "query", "description": "Status filter for filtering the invoices. Action_required = Y, fetches the invoices where tax payer need to take action (Accept/Reject). Already accepted or uploaded invoices can be fetched by using action_required=N filter.", "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "ctin", "in": "query", "description": "CTIN of the taxpayer", "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr4/cdnur": { "get": { "tags": [ "GSTR4" ], "summary": "API call for getting all Credit/ Debit Notes issued to un-registered persons for a return period.", "description": "API call for getting all Credit/ Debit Notes issued to un-registered persons for a return period.", "operationId": "getCDNUR", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr4/txos": { "get": { "tags": [ "GSTR4" ], "summary": "API call for getting invoices for Tax on Outward Supplies for a return period. ", "description": "API call for getting invoices for Tax on Outward Supplies for a return period. ", "operationId": "getTaxOnOurwardSuppliesInvoice", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr4/at": { "get": { "tags": [ "GSTR4" ], "summary": "Get AT", "description": "Getting advance tax details for a return period.", "operationId": "getAT", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr4/txp": { "get": { "tags": [ "GSTR4" ], "summary": "Get TXP", "description": "Getting tax paid details for a return period.", "operationId": "getTXP", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr4/retsum": { "get": { "tags": [ "GSTR4" ], "summary": "Get GSTR1 Summary", "description": "Get the table wise summary of GSTR1 data.", "operationId": "getGSTRSummary", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr4/retsubmit": { "post": { "tags": [ "GSTR4" ], "summary": "Submit GSTR4 data", "description": "Used to submit entire GSTR4 invoices.", "operationId": "submitGSTR", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/gstr4/tds": { "get": { "tags": [ "GSTR4" ], "summary": "Get TDS", "description": "Get TDS Credit.", "operationId": "getTDS", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr4/retfile": { "post": { "tags": [ "GSTR4" ], "summary": "File GSTR4 data", "description": "Used to file entire GSTR1 invoices.", "operationId": "fileGSTR", "parameters": [ { "name": "email", "in": "query", "description": "API Developer User Email", "required": true, "schema": { "type": "string" } }, { "name": "pan", "in": "query", "description": "PAN Number", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload Format : {\"content\":\"{\"gstin\": \"37ABCDE9552F3Z4\", \"ret_period\": \"072017\",\"chksum\": \"AflJufPlFStqKBZ\",\"summ_typ\": \"L\"}\",\"pkcs7\":\"MIIFrwYJKoZIhvcNAQcCoI==\"}", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "signedcontent" } }, "/gstr4/retevcfile": { "post": { "tags": [ "GSTR4" ], "summary": "File GSTR4 data", "description": "Used to file entire GSTR4 invoices using EVC.", "operationId": "fileGSTR", "parameters": [ { "name": "email", "in": "query", "description": "API Developer User Email", "required": true, "schema": { "type": "string" } }, { "name": "pan", "in": "query", "description": "PAN Number", "required": true, "schema": { "type": "string" } }, { "name": "evcotp", "in": "query", "description": "OTP for EVC", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload Format : \"{\"gstin\": \"37ABCDE9552F3Z4\", \"ret_period\": \"072017\",\"chksum\": \"AflJufPlFStqKBZ\"}", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "content" } }, "/gstr4/retoffset": { "post": { "tags": [ "GSTR4" ], "summary": "API call for offsetting the liabilities and interest from GSTR4", "description": "GSTR3 - Setoff Liability", "operationId": "setoffLiability", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/gstr2a/isd": { "get": { "tags": [ "GSTR2A" ], "summary": "Get ISD Details", "description": "Get ISD Details", "operationId": "getISDDetails", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "ctin", "in": "query", "description": "CTIN of the taxpayer", "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr1/txpa": { "get": { "tags": [ "GSTR1" ], "summary": "Get TXPA", "description": "This API calls to get TXPA invoices for the tax period. ", "operationId": "getTxpa", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr1/einvoice": { "get": { "tags": [ "GSTR1" ], "summary": "Get E-Invoices", "description": "Getting E-invoices for a return period.", "operationId": "getEInvoices", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "sec", "in": "query", "description": "Sec of the Table Name", "required": true, "schema": { "type": "string" } }, { "name": "fromtime", "in": "query", "description": "From time format DD-MM-YYYY,20-12-2016", "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr6/b2ba": { "get": { "tags": [ "GSTR6" ], "summary": "Get B2BA Invoices", "description": "Getting all B2BA invoices for a return period.", "operationId": "getB2BAInvoices", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "actionrequired", "in": "query", "description": "Status filter for filtering the invoices. Action_required = Y, fetches the invoices where tax payer need to take action (Accept/Reject). Already accepted or uploaded invoices can be fetched by using action_required=N filter.", "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "ctin", "in": "query", "description": "CTIN of the taxpayer", "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr6/cdna": { "get": { "tags": [ "GSTR6" ], "summary": "Get CDNRA Invoices", "description": "Will call CDNA for getting all amended Credit/Debit notes for a return period.", "operationId": "getCDNAInvoices", "parameters": [ { "name": "actionrequired", "in": "query", "description": "Status filter for filtering the invoices. Action_required = Y, fetches the invoices where tax payer need to take action (Accept/Reject). Already accepted or uploaded invoices can be fetched by using action_required=N filter.", "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "ctin", "in": "query", "description": "CTIN of the taxpayer", "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr6/isda": { "get": { "tags": [ "GSTR6" ], "summary": "Get Amendment ISD Details", "description": "API call for getting invoices related to Amended ISD credit received for eligibile and ineligible ITC", "operationId": "getISDAInvoices", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "ctin", "in": "query", "description": "CTIN of the taxpayer", "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr5/b2b": { "get": { "tags": [ "GSTR5" ], "summary": "Get B2B Invoices", "description": "Getting all B2B invoices for a return period.", "operationId": "getB2BInvoices", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "ctin", "in": "query", "description": "CTIN of the taxpayer", "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr5/b2ba": { "get": { "tags": [ "GSTR5" ], "summary": "Get B2BA Invoices", "description": "Getting all B2BA invoices for a return period.", "operationId": "getB2BAInvoices", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "ctin", "in": "query", "description": "CTIN of the taxpayer", "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr5/cdn": { "get": { "tags": [ "GSTR5" ], "summary": "Get CDNR Invoices", "description": "Will call CDN for getting all Credit/Debit notes for a return period.", "operationId": "getCDNInvoices", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "ctin", "in": "query", "description": "CTIN of the taxpayer", "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr5/cdna": { "get": { "tags": [ "GSTR5" ], "summary": "Get CDNRA Invoices", "description": "API call CDNA for getting all Credit/Debit notes invoices for a return period.", "operationId": "getCDNAInvoices", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "ctin", "in": "query", "description": "CTIN of the taxpayer", "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr5/impg": { "get": { "tags": [ "GSTR5" ], "summary": "Get IMPG Invoices", "description": "API call for getting invoices related to Import of Goods/Capital for a return period. ", "operationId": "getIMPG", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr5/impga": { "get": { "tags": [ "GSTR5" ], "summary": "Get IMPGA Invoices", "description": "API call for getting invoices related to Import of Goods/Capital Amendment for a return period.", "operationId": "getIMPGA", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr5/retsave": { "put": { "tags": [ "GSTR5" ], "summary": "Save GSTR5 data", "description": "Used to save entire GSTR5 invoices.", "operationId": "saveGSTR", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "type": "object", "properties": { "gstin": { "type": "string", "description": "GSTIN number", "example": "0817GBR00014NRX" }, "fp": { "type": "string", "description": "Fp Type", "example": "082016" }, "b2b": { "type": "array", "items": { "type": "object" } }, "b2cl": { "type": "array", "items": { "type": "object" } }, "b2cs": { "type": "array", "items": { "type": "object" } }, "cdn": { "type": "array", "items": { "type": "object" } }, "cdnur": { "type": "array", "items": { "type": "object" } }, "imp_g": { "type": "array", "items": { "type": "object" } } } } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/gstr5/cdnura": { "get": { "tags": [ "GSTR5" ], "summary": "Get CDNA Unregistered", "description": "API call for getting all Amended Credit/Debit notes for unregistered supplier invoices for a return period.", "operationId": "getCDNURA", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr5/retsum": { "get": { "tags": [ "GSTR5" ], "summary": "Get GSTR5 Summary", "description": "Get the table wise summary of GSTR5 data.", "operationId": "getGSTRSummary", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr5/retsubmit": { "post": { "tags": [ "GSTR5" ], "summary": "Submit", "description": "This API call for submit all the invoices Saved", "operationId": "submitGSTR", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/gstr5/retfile": { "post": { "tags": [ "GSTR5" ], "summary": "File GSTR5", "description": "This API is to submit the GSTR5 return.", "operationId": "fileGSTR", "parameters": [ { "name": "email", "in": "query", "description": "API Developer User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload Format : {\"content\":\"{\"gstin\": \"37ABCDE9552F3Z4\", \"ret_period\": \"072017\",\"chksum\": \"AflJufPlFStqKBZ\",\"summ_typ\": \"L\"}\",\"pkcs7\":\"MIIFrwYJKoZIhvcNAQcCoI==\"}", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "signedcontent" } }, "/gstr5/retevcfile": { "post": { "tags": [ "GSTR5" ], "summary": "File GSTR5 data", "description": "Used to file entire GSTR5 invoices using EVC.", "operationId": "fileGSTR", "parameters": [ { "name": "email", "in": "query", "description": "API Developer User Email", "required": true, "schema": { "type": "string" } }, { "name": "pan", "in": "query", "description": "PAN Number", "required": true, "schema": { "type": "string" } }, { "name": "evcotp", "in": "query", "description": "OTP for EVC", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload Format : \"{\"gstin\": \"37ABCDE9552F3Z4\", \"ret_period\": \"072017\",\"chksum\": \"AflJufPlFStqKBZ\"}", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "content" } }, "/gstr5/b2cl": { "get": { "tags": [ "GSTR5" ], "summary": "Get B2CL Invoices", "description": "Getting all B2C Large invoices for a return period..", "operationId": "getB2CLInvoices", "parameters": [ { "name": "statecd", "in": "query", "description": "State code", "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr5/b2cs": { "get": { "tags": [ "GSTR5" ], "summary": "Get B2CS Invoices", "description": "Will be used for getting all B2C HSN data for a return period.", "operationId": "getB2CSInvoices", "parameters": [ { "name": "statecd", "in": "query", "description": "State code", "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr5/cdnur": { "get": { "tags": [ "GSTR5" ], "summary": "Get CDN Unregistered", "description": "API call for getting all Credit/Debit notes for unregistered supplier invoices for a return period. ", "operationId": "getCDNUR", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr5/ttxli": { "get": { "tags": [ "GSTR5" ], "summary": "Get Tax Liab", "description": "API call for getting all tax liability for a return period. ", "operationId": "getTTXLI", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr5/retoffset": { "put": { "tags": [ "GSTR5" ], "summary": " Offset Liability GSTR5 data", "description": "API call for offsetting the liabilities and interest from GSTR5 ", "operationId": "offsetLiabilityGSTR3B", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/gstr5/b2cla": { "get": { "tags": [ "GSTR5" ], "summary": "Get B2CLA Invoices", "description": "API call for getting all B2CLA invoices for a return period.", "operationId": "getB2CLAInvoices", "parameters": [ { "name": "statecd", "in": "query", "description": "State code", "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr5/b2csa": { "get": { "tags": [ "GSTR5" ], "summary": "Get B2CSA Invoices", "description": "API call for getting all B2CSA invoices for a return period.", "operationId": "getB2CSAInvoices", "parameters": [ { "name": "statecd", "in": "query", "description": "State code", "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr4/b2ba": { "get": { "tags": [ "GSTR4" ], "summary": "Get B2BA Invoices", "description": "Getting all B2BA invoices for a return period.", "operationId": "getB2BAInvoices", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "actionrequired", "in": "query", "description": "Status filter for filtering the invoices. Action_required = Y, fetches the invoices where tax payer need to take action (Accept/Reject). Already accepted or uploaded invoices can be fetched by using action_required=N filter.", "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "ctin", "in": "query", "description": "CTIN of the taxpayer", "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr4/b2bura": { "get": { "tags": [ "GSTR4" ], "summary": "Get B2BUR Amendment", "description": "API call for getting all Amended B2B invoices of Unregistered taxpayer for a return period.", "operationId": "getB2BURAInvoices", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr4/impsa": { "get": { "tags": [ "GSTR4" ], "summary": "Get Imports of Services Amendment", "description": "API call for getting all Amended Imports of services invoices for a return period.", "operationId": "getIMPSA", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr4/cdnra": { "get": { "tags": [ "GSTR4" ], "summary": "Get CDNR Amendment", "description": "API call for getting all Amended Credit/ Debit notes issued to a Registerd taxpayer for a return period.", "operationId": "getCDNRAInvoices", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "actionrequired", "in": "query", "description": "Status filter for filtering the invoices. Action_required = Y, fetches the invoices where tax payer need to take action (Accept/Reject). Already accepted or uploaded invoices can be fetched by using action_required=N filter.", "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr4/cdnura": { "get": { "tags": [ "GSTR4" ], "summary": "Get CDNUR Amendment", "description": "API call for getting all Amended Credit/ Debit notes issued to a Unregisterd taxpayer for a return period.", "operationId": "getCDNURA", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr4/txosa": { "get": { "tags": [ "GSTR4" ], "summary": "Get TXOS Amendment", "description": "API call for getting Amended invoices for Tax on Outward Supplies for a return period.", "operationId": "getTXOSAInvoice", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr4/ata": { "get": { "tags": [ "GSTR4" ], "summary": "Get Advances Paid Amendment", "description": "API call for getting all Amended Advances Paid invoices for a return period. ", "operationId": "getATA", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr4/txpa": { "get": { "tags": [ "GSTR4" ], "summary": "Get Advances Adjusted Amendment", "description": "API call for getting all Amended Advances Adjusted invoices for a return period.", "operationId": "getTxpa", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr4a/b2b": { "get": { "tags": [ "GSTR4A" ], "summary": "Get B2B Invoices", "description": "Getting all B2B invoices for a return period.", "operationId": "getB2BInvoices", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "ctin", "in": "query", "description": "CTIN of the taxpayer", "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr4a/b2ba": { "get": { "tags": [ "GSTR4A" ], "summary": "Get B2BA Invoices", "description": "Getting all B2BA invoices for a return period.", "operationId": "getB2BAInvoices", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "ctin", "in": "query", "description": "CTIN of the taxpayer", "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr4a/cdnr": { "get": { "tags": [ "GSTR4A" ], "summary": "CDNR Invoice", "description": "Getting all CDNR invoices for a return period.", "operationId": "getCDNRInvoices", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "ctin", "in": "query", "description": "CTIN of the taxpayer", "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr4a/cdnra": { "get": { "tags": [ "GSTR4A" ], "summary": "CDNRA Invoice", "description": "Getting all CDNRA invoices for a return period.", "operationId": "getCDNRAInvoices", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "ctin", "in": "query", "description": "CTIN of the taxpayer", "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr4a/tds": { "get": { "tags": [ "GSTR4A" ], "summary": "TDS Details", "description": "Getting all TDS Details for a return period.", "operationId": "getTDSDetails", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "ctin", "in": "query", "description": "CTIN of the taxpayer", "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr4annual/retsave": { "put": { "tags": [ "GSTR4Annual" ], "summary": "Save GSTR4Annual data", "description": "Used to save entire GSTR4Annual invoices.", "operationId": "saveGSTR", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/gstr4annual/tdscmp": { "get": { "tags": [ "GSTR4Annual" ], "summary": "Get tdscmp Invoices", "description": "Getting the CMP 08 and TDSTCS summary data for a return period.", "operationId": "getGSTR4AnnualTDSCMPInvoices", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr4annual/txios": { "get": { "tags": [ "GSTR4Annual" ], "summary": "Get txios Invoices", "description": "Getting overall inward/outward supply data for a return period.", "operationId": "getGSTR4AnnualTXIOSInvoices", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr4annual/validateturnover": { "get": { "tags": [ "GSTR4Annual" ], "summary": "Get validate turnover for GSTR4 Annual form", "description": "Getting validate turnover for GSTR4 Annual form for a return period.", "operationId": "getGSTR4AnnualValidateTurnover", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr4annual/validateliability": { "get": { "tags": [ "GSTR4Annual" ], "summary": "Get validate the liability provided in table 6 for GSTR4 Annual form", "description": "Getting validate the liability provided in table 6 for GSTR4 Annual form for a return period.", "operationId": "getGSTR4AnnualValidateLiability", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr4annual/autopop": { "get": { "tags": [ "GSTR4Annual" ], "summary": "Get autopopulated data for table 4A/4B of GSTR4 Annual form", "description": "Getting autopopulated data for table 4A/4B of GSTR4 Annual form for a return period.", "operationId": "getGSTR4AnnualAutopop", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr4annual/getsum": { "get": { "tags": [ "GSTR4Annual" ], "summary": "Get summary Invoices", "description": "Getting get the overall summary of GSTR4 Annual filing for a return period.", "operationId": "getGSTR4AnnualSummaryInvoices", "parameters": [ { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr4annual/retfile": { "post": { "tags": [ "GSTR4Annual" ], "summary": "File GSTR4Annual data", "description": "Used to file entire GSTR4Annual invoices.", "operationId": "fileGSTR", "parameters": [ { "name": "email", "in": "query", "description": "API Developer User Email", "required": true, "schema": { "type": "string" } }, { "name": "pan", "in": "query", "description": "PAN Number", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload Format : {\"content\":\"{\"gstin\": \"37ABCDE9552F3Z4\", \"ret_period\": \"072017\",\"chksum\": \"AflJufPlFStqKBZ\",\"summ_typ\": \"L\"}\",\"pkcs7\":\"MIIFrwYJKoZIhvcNAQcCoI==\"}", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "signedcontent" } }, "/gstr4annual/retevcfile": { "post": { "tags": [ "GSTR4Annual" ], "summary": "File GSTR4 Annual data", "description": "Used to file entire GSTR4 Annual invoices using EVC.", "operationId": "fileEvcGSTR", "parameters": [ { "name": "email", "in": "query", "description": "API Developer User Email", "required": true, "schema": { "type": "string" } }, { "name": "pan", "in": "query", "description": "PAN Number", "required": true, "schema": { "type": "string" } }, { "name": "evcotp", "in": "query", "description": "OTP for EVC", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload Format : \"{\"gstin\": \"37ABCDE9552F3Z4\", \"ret_period\": \"072017\",\"chksum\": \"AflJufPlFStqKBZ\"}", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "content" } }, "/gstr9/retfile": { "post": { "tags": [ "GSTR9" ], "summary": "File GSTR9", "description": "This API is to File GSTR9", "operationId": "fileGSTR", "parameters": [ { "name": "email", "in": "query", "description": "API Developer User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload Format : {\"content\":\"{\"gstin\": \"37ABCDE9552F3Z4\", \"ret_period\": \"072017\",\"chksum\": \"AflJufPlFStqKBZ\",\"summ_typ\": \"L\"}\",\"pkcs7\":\"MIIFrwYJKoZIhvcNAQcCoI==\"}", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "signedcontent" } }, "/gstr9/retevcfile": { "post": { "tags": [ "GSTR9" ], "summary": "File GSTR9 data", "description": "Used to file entire GSTR9 invoices using EVC.", "operationId": "fileGSTR", "parameters": [ { "name": "email", "in": "query", "description": "API Developer User Email", "required": true, "schema": { "type": "string" } }, { "name": "pan", "in": "query", "description": "PAN Number", "required": true, "schema": { "type": "string" } }, { "name": "evcotp", "in": "query", "description": "OTP for EVC", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload Format : \"{\"gstin\": \"37ABCDE9552F3Z4\", \"ret_period\": \"072017\",\"chksum\": \"AflJufPlFStqKBZ\"}", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "content" } }, "/gstr9/retsave": { "put": { "tags": [ "GSTR9" ], "summary": "Save GSTR9", "description": "This API is to save GSTR9 data", "operationId": "saveGSTR", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "type": "object", "properties": { "gstin": { "type": "string", "description": "GSTIN number", "example": "06GDDPS5083K1Z0" }, "fp": { "type": "string", "description": "Fp Type", "example": "032018" }, "table4": { "type": "object", "properties": { "b2c": { "type": "object", "properties": { "txval": { "type": "number", "description": "Taxable Value", "example": 1000 }, "iamt": { "type": "number", "description": "igst Amount", "example": 20 }, "camt": { "type": "number", "description": "cgst Amount", "example": 20 }, "samt": { "type": "number", "description": "sgst Amount", "example": 20 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 20 } } }, "b2b": { "type": "object", "properties": { "txval": { "type": "number", "description": "Taxable Value", "example": 1000 }, "iamt": { "type": "number", "description": "igst Amount", "example": 20 }, "camt": { "type": "number", "description": "cgst Amount", "example": 20 }, "samt": { "type": "number", "description": "sgst Amount", "example": 20 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 20 } } }, "exp": { "type": "object", "properties": { "txval": { "type": "number", "description": "Taxable Value", "example": 1000 }, "iamt": { "type": "number", "description": "igst Amount", "example": 20 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 20 } } }, "sez": { "type": "object", "properties": { "txval": { "type": "number", "description": "Taxable Value", "example": 1000 }, "iamt": { "type": "number", "description": "igst Amount", "example": 20 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 20 } } }, "deemed": { "type": "object", "properties": { "txval": { "type": "number", "description": "Taxable Value", "example": 1000 }, "iamt": { "type": "number", "description": "igst Amount", "example": 20 }, "camt": { "type": "number", "description": "cgst Amount", "example": 20 }, "samt": { "type": "number", "description": "sgst Amount", "example": 20 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 20 } } }, "at": { "type": "object", "properties": { "txval": { "type": "number", "description": "Taxable Value", "example": 1000 }, "iamt": { "type": "number", "description": "igst Amount", "example": 20 }, "camt": { "type": "number", "description": "cgst Amount", "example": 20 }, "samt": { "type": "number", "description": "sgst Amount", "example": 20 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 20 } } }, "rchrg": { "type": "object", "properties": { "txval": { "type": "number", "description": "Taxable Value", "example": 1000 }, "iamt": { "type": "number", "description": "igst Amount", "example": 20 }, "camt": { "type": "number", "description": "cgst Amount", "example": 20 }, "samt": { "type": "number", "description": "sgst Amount", "example": 20 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 20 } } }, "cr_nt": { "type": "object", "properties": { "txval": { "type": "number", "description": "Taxable Value", "example": 1000 }, "iamt": { "type": "number", "description": "igst Amount", "example": 20 }, "camt": { "type": "number", "description": "cgst Amount", "example": 20 }, "samt": { "type": "number", "description": "sgst Amount", "example": 20 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 20 } } }, "dr_nt": { "type": "object", "properties": { "txval": { "type": "number", "description": "Taxable Value", "example": 1000 }, "iamt": { "type": "number", "description": "igst Amount", "example": 20 }, "camt": { "type": "number", "description": "cgst Amount", "example": 20 }, "samt": { "type": "number", "description": "sgst Amount", "example": 20 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 20 } } }, "amd_pos": { "type": "object", "properties": { "txval": { "type": "number", "description": "Taxable Value", "example": 1000 }, "iamt": { "type": "number", "description": "igst Amount", "example": 20 }, "camt": { "type": "number", "description": "cgst Amount", "example": 20 }, "samt": { "type": "number", "description": "sgst Amount", "example": 20 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 20 } } }, "amd_neg": { "type": "object", "properties": { "txval": { "type": "number", "description": "Taxable Value", "example": 1000 }, "iamt": { "type": "number", "description": "igst Amount", "example": 20 }, "camt": { "type": "number", "description": "cgst Amount", "example": 20 }, "samt": { "type": "number", "description": "sgst Amount", "example": 20 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 20 } } } } }, "table5": { "type": "object", "properties": { "zero_rtd": { "type": "object", "properties": { "txval": { "type": "number", "description": "Taxable Value", "example": 1000 } } }, "sez": { "type": "object", "properties": { "txval": { "type": "number", "description": "Taxable Value", "example": 1000 } } }, "rchrg": { "type": "object", "properties": { "txval": { "type": "number", "description": "Taxable Value", "example": 1000 } } }, "exmt": { "type": "object", "properties": { "txval": { "type": "number", "description": "Taxable Value", "example": 1000 } } }, "nil": { "type": "object", "properties": { "txval": { "type": "number", "description": "Taxable Value", "example": 1000 } } }, "non_gst": { "type": "object", "properties": { "txval": { "type": "number", "description": "Taxable Value", "example": 1000 } } }, "cr_nt": { "type": "object", "properties": { "txval": { "type": "number", "description": "Taxable Value", "example": 1000 } } }, "dr_nt": { "type": "object", "properties": { "txval": { "type": "number", "description": "Taxable Value", "example": 1000 } } }, "amd_pos": { "type": "object", "properties": { "txval": { "type": "number", "description": "Taxable Value", "example": 1000 } } }, "amd_neg": { "type": "object", "properties": { "txval": { "type": "number", "description": "Taxable Value", "example": 1000 } } } } }, "table6": { "type": "object", "properties": { "supp_non_rchrg": { "type": "array", "items": { "type": "object" } }, "supp_rchrg_unreg": { "type": "array", "items": { "type": "object" } }, "supp_rchrg_reg": { "type": "array", "items": { "type": "object" } }, "iog": { "type": "array", "items": { "type": "object" } }, "ios": { "type": "object", "properties": { "iamt": { "type": "number", "description": "igst Amount", "example": 20 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 20 } } }, "isd": { "type": "object", "properties": { "iamt": { "type": "number", "description": "igst Amount", "example": 20 }, "camt": { "type": "number", "description": "cgst Amount", "example": 20 }, "samt": { "type": "number", "description": "sgst Amount", "example": 20 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 20 } } }, "itc_clmd": { "type": "object", "properties": { "iamt": { "type": "number", "description": "igst Amount", "example": 20 }, "camt": { "type": "number", "description": "cgst Amount", "example": 20 }, "samt": { "type": "number", "description": "sgst Amount", "example": 20 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 20 } } }, "tran1": { "type": "object", "properties": { "camt": { "type": "number", "description": "cgst Amount", "example": 20 }, "samt": { "type": "number", "description": "sgst Amount", "example": 20 } } }, "tran2": { "type": "object", "properties": { "camt": { "type": "number", "description": "cgst Amount", "example": 20 }, "samt": { "type": "number", "description": "sgst Amount", "example": 20 } } }, "other": { "type": "object", "properties": { "iamt": { "type": "number", "description": "igst Amount", "example": 20 }, "camt": { "type": "number", "description": "cgst Amount", "example": 20 }, "samt": { "type": "number", "description": "sgst Amount", "example": 20 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 20 } } } } }, "table7": { "type": "object", "properties": { "rule37": { "type": "object", "properties": { "iamt": { "type": "number", "description": "igst Amount", "example": 20 }, "camt": { "type": "number", "description": "cgst Amount", "example": 20 }, "samt": { "type": "number", "description": "sgst Amount", "example": 20 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 20 } } }, "rule39": { "type": "object", "properties": { "iamt": { "type": "number", "description": "igst Amount", "example": 20 }, "camt": { "type": "number", "description": "cgst Amount", "example": 20 }, "samt": { "type": "number", "description": "sgst Amount", "example": 20 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 20 } } }, "rule42": { "type": "object", "properties": { "iamt": { "type": "number", "description": "igst Amount", "example": 20 }, "camt": { "type": "number", "description": "cgst Amount", "example": 20 }, "samt": { "type": "number", "description": "sgst Amount", "example": 20 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 20 } } }, "rule43": { "type": "object", "properties": { "iamt": { "type": "number", "description": "igst Amount", "example": 20 }, "camt": { "type": "number", "description": "cgst Amount", "example": 20 }, "samt": { "type": "number", "description": "sgst Amount", "example": 20 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 20 } } }, "sec17": { "type": "object", "properties": { "iamt": { "type": "number", "description": "igst Amount", "example": 20 }, "camt": { "type": "number", "description": "cgst Amount", "example": 20 }, "samt": { "type": "number", "description": "sgst Amount", "example": 20 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 20 } } }, "revsl_tran1": { "type": "object", "properties": { "camt": { "type": "number", "description": "cgst Amount", "example": 20 }, "samt": { "type": "number", "description": "sgst Amount", "example": 20 } } }, "revsl_tran2": { "type": "object", "properties": { "camt": { "type": "number", "description": "cgst Amount", "example": 20 }, "samt": { "type": "number", "description": "sgst Amount", "example": 20 } } }, "other": { "type": "array", "items": { "type": "object" } } } }, "table8": { "type": "object", "properties": { "itc_inwd_supp": { "type": "object", "properties": { "iamt": { "type": "number", "description": "igst Amount", "example": 20 }, "camt": { "type": "number", "description": "cgst Amount", "example": 20 }, "samt": { "type": "number", "description": "sgst Amount", "example": 20 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 20 } } }, "itc_nt_availd": { "type": "object", "properties": { "iamt": { "type": "number", "description": "igst Amount", "example": 20 }, "camt": { "type": "number", "description": "cgst Amount", "example": 20 }, "samt": { "type": "number", "description": "sgst Amount", "example": 20 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 20 } } }, "itc_nt_eleg": { "type": "object", "properties": { "iamt": { "type": "number", "description": "igst Amount", "example": 20 }, "camt": { "type": "number", "description": "cgst Amount", "example": 20 }, "samt": { "type": "number", "description": "sgst Amount", "example": 20 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 20 } } }, "iog_taxpaid": { "type": "object", "properties": { "iamt": { "type": "number", "description": "igst Amount", "example": 20 }, "camt": { "type": "number", "description": "cgst Amount", "example": 20 }, "samt": { "type": "number", "description": "sgst Amount", "example": 20 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 20 } } } } }, "table9": { "type": "object", "properties": { "iamt": { "type": "object", "properties": { "txpyble": { "type": "number", "description": "Tax Payable", "example": 1000 } } }, "camt": { "type": "object", "properties": { "txpyble": { "type": "number", "description": "Tax Payable", "example": 1000 } } }, "samt": { "type": "object", "properties": { "txpyble": { "type": "number", "description": "Tax Payable", "example": 1000 } } }, "csamt": { "type": "object", "properties": { "txpyble": { "type": "number", "description": "Tax Payable", "example": 1000 } } }, "intr": { "type": "object", "properties": { "txpyble": { "type": "number", "description": "Tax Payable", "example": 1000 } } }, "fee": { "type": "object", "properties": { "txpyble": { "type": "number", "description": "Tax Payable", "example": 1000 } } }, "pen": { "type": "object", "properties": { "txpyble": { "type": "number", "description": "Tax Payable", "example": 1000 } } }, "other": { "type": "object", "properties": { "txpyble": { "type": "number", "description": "Tax Payable", "example": 1000 } } } } }, "table10": { "type": "object", "properties": { "itc_availd": { "type": "object", "properties": { "csamt": { "type": "number", "description": "Cess Amount", "example": 20 }, "samt": { "type": "number", "description": "sgst Amount", "example": 20 }, "camt": { "type": "number", "description": "cgst Amount", "example": 20 }, "iamt": { "type": "number", "description": "igst Amount", "example": 20 } } }, "itc_rvsl": { "type": "object", "properties": { "csamt": { "type": "number", "description": "Cess Amount", "example": 20 }, "samt": { "type": "number", "description": "sgst Amount", "example": 20 }, "camt": { "type": "number", "description": "cgst Amount", "example": 20 }, "iamt": { "type": "number", "description": "igst Amount", "example": 20 } } }, "dbn_amd": { "type": "object", "properties": { "csamt": { "type": "number", "description": "Cess Amount", "example": 20 }, "samt": { "type": "number", "description": "sgst Amount", "example": 20 }, "txval": { "type": "number", "description": "Taxable Value", "example": 1000 }, "camt": { "type": "number", "description": "cgst Amount", "example": 20 }, "iamt": { "type": "number", "description": "igst Amount", "example": 20 } } }, "cdn_amd": { "type": "object", "properties": { "csamt": { "type": "number", "description": "Cess Amount", "example": 20 }, "samt": { "type": "number", "description": "sgst Amount", "example": 20 }, "txval": { "type": "number", "description": "Taxable Value", "example": 1000 }, "camt": { "type": "number", "description": "cgst Amount", "example": 20 }, "iamt": { "type": "number", "description": "igst Amount", "example": 20 } } } } }, "table14": { "type": "object", "properties": { "iamt": { "type": "object", "properties": { "txpyble": { "type": "number", "description": "Tax Payable", "example": 1000 }, "txpaid": { "type": "number", "description": "Tax payed", "example": 1000 } } }, "camt": { "type": "object", "properties": { "txpyble": { "type": "number", "description": "Tax Payable", "example": 1000 }, "txpaid": { "type": "number", "description": "Tax payed", "example": 1000 } } }, "samt": { "type": "object", "properties": { "txpyble": { "type": "number", "description": "Tax Payable", "example": 1000 }, "txpaid": { "type": "number", "description": "Tax payed", "example": 1000 } } }, "csamt": { "type": "object", "properties": { "txpyble": { "type": "number", "description": "Tax Payable", "example": 1000 }, "txpaid": { "type": "number", "description": "Tax payed", "example": 1000 } } }, "intr": { "type": "object", "properties": { "txpyble": { "type": "number", "description": "Tax Payable", "example": 1000 }, "txpaid": { "type": "number", "description": "Tax payed", "example": 1000 } } } } }, "table15": { "type": "object", "properties": { "rfd_clmd": { "type": "object", "properties": { "iamt": { "type": "number", "description": "igst Amount", "example": 20 }, "camt": { "type": "number", "description": "cgst Amount", "example": 20 }, "samt": { "type": "number", "description": "sgst Amount", "example": 20 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 20 } } }, "rfd_sanc": { "type": "object", "properties": { "iamt": { "type": "number", "description": "igst Amount", "example": 20 }, "camt": { "type": "number", "description": "cgst Amount", "example": 20 }, "samt": { "type": "number", "description": "sgst Amount", "example": 20 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 20 } } }, "rfd_rejt": { "type": "object", "properties": { "iamt": { "type": "number", "description": "igst Amount", "example": 20 }, "camt": { "type": "number", "description": "cgst Amount", "example": 20 }, "samt": { "type": "number", "description": "sgst Amount", "example": 20 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 20 } } }, "rfd_pend": { "type": "object", "properties": { "iamt": { "type": "number", "description": "igst Amount", "example": 20 }, "camt": { "type": "number", "description": "cgst Amount", "example": 20 }, "samt": { "type": "number", "description": "sgst Amount", "example": 20 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 20 } } }, "tax_dmnd": { "type": "object", "properties": { "iamt": { "type": "number", "description": "igst Amount", "example": 20 }, "camt": { "type": "number", "description": "cgst Amount", "example": 20 }, "samt": { "type": "number", "description": "sgst Amount", "example": 20 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 20 }, "intr": { "type": "number", "description": "Intra tax", "example": 20 }, "fee": { "type": "number", "description": "Fee amount", "example": 20 }, "pen": { "type": "number", "description": "Pending Amount", "example": 20 } } }, "tax_paid": { "type": "object", "properties": { "iamt": { "type": "number", "description": "igst Amount", "example": 20 }, "camt": { "type": "number", "description": "cgst Amount", "example": 20 }, "samt": { "type": "number", "description": "sgst Amount", "example": 20 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 20 }, "intr": { "type": "number", "description": "Intra tax ", "example": 20 }, "fee": { "type": "number", "description": "Fee amount", "example": 20 }, "pen": { "type": "number", "description": "Pending Amount", "example": 20 } } }, "dmnd_pend": { "type": "object", "properties": { "iamt": { "type": "number", "description": "igst Amount", "example": 20 }, "camt": { "type": "number", "description": "cgst Amount", "example": 20 }, "samt": { "type": "number", "description": "sgst Amount", "example": 20 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 20 }, "intr": { "type": "number", "description": "Intra tax ", "example": 20 }, "fee": { "type": "number", "description": "Fee amount", "example": 20 }, "pen": { "type": "number", "description": "Pending Amount", "example": 20 } } } } }, "table16": { "type": "object", "properties": { "comp_supp": { "type": "object", "properties": { "txval": { "type": "number", "description": "Taxable Value", "example": 1000 } } }, "deemed_supp": { "type": "object", "properties": { "txval": { "type": "number", "description": "Taxable Value", "example": 1000 }, "iamt": { "type": "number", "description": "igst Amount", "example": 20 }, "camt": { "type": "number", "description": "cgst Amount", "example": 20 }, "samt": { "type": "number", "description": "sgst Amount", "example": 20 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 20 } } }, "not_returned": { "type": "object", "properties": { "txval": { "type": "number", "description": "Taxable Value", "example": 1000 }, "iamt": { "type": "number", "description": "igst Amount", "example": 20 }, "camt": { "type": "number", "description": "cgst Amount", "example": 20 }, "samt": { "type": "number", "description": "sgst Amount", "example": 20 }, "csamt": { "type": "number", "description": "Cess Amount", "example": 20 } } } } }, "table17": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object" } } } }, "table18": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object" } } } } } } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/gstr9/getdet": { "get": { "tags": [ "GSTR9" ], "summary": "Get GSTR9 Details", "description": "This API is to get GSTR9 details", "operationId": "getGSTRDetails", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr9/getautocal": { "get": { "tags": [ "GSTR9" ], "summary": "Get GSTR9 Auto Calculated Details", "description": "This API is to get GSTR9 Auto Calculated details", "operationId": "getAutoCalculatedDetails", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr9/get8adetails": { "get": { "tags": [ "GSTR9" ], "summary": "Get GSTR9 8A Details", "description": "This API is to get the invoices and notes part of the GSTR9 8A section", "operationId": "getGSTR98ADetails", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "fy", "in": "query", "description": "Financial Year (YYYY-YY)", "required": true, "schema": { "type": "string" } }, { "name": "docid", "in": "query", "description": "Document Id", "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr9a/retfile": { "post": { "tags": [ "GSTR9A" ], "summary": "File GSTR9A", "description": "This API is to File GSTR9A", "operationId": "fileGSTR", "parameters": [ { "name": "email", "in": "query", "description": "API Developer User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload Format : {\"content\":\"{\"gstin\": \"37ABCDE9552F3Z4\", \"ret_period\": \"072017\",\"chksum\": \"AflJufPlFStqKBZ\",\"summ_typ\": \"L\"}\",\"pkcs7\":\"MIIFrwYJKoZIhvcNAQcCoI==\"}", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "signedcontent" } }, "/gstr9a/retevcfile": { "post": { "tags": [ "GSTR9A" ], "summary": "File GSTR9A data", "description": "Used to file entire GSTR9A invoices using EVC.", "operationId": "fileGSTR", "parameters": [ { "name": "email", "in": "query", "description": "API Developer User Email", "required": true, "schema": { "type": "string" } }, { "name": "pan", "in": "query", "description": "PAN Number", "required": true, "schema": { "type": "string" } }, { "name": "evcotp", "in": "query", "description": "OTP for EVC", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload Format : \"{\"gstin\": \"37ABCDE9552F3Z4\", \"ret_period\": \"072017\",\"chksum\": \"AflJufPlFStqKBZ\"}", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "content" } }, "/gstr9a/retsave": { "put": { "tags": [ "GSTR9A" ], "summary": "Save GSTR9A", "description": "This API is to save GSTR9A data", "operationId": "saveGSTR", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "required": [ "fp", "gstin" ], "type": "object", "properties": { "gstin": { "maxLength": 15, "minLength": 15, "pattern": "^[a-zA-Z0-9._\\s]+$", "type": "string", "description": "Supplier GSTIN", "example": "02SUPHP0001A1ZI" }, "fp": { "maxLength": 6, "minLength": 6, "pattern": "^(0320[0-9]{2})$", "type": "string", "description": "Financial Period", "example": "032018" }, "table5": { "required": [ "gt" ], "type": "object", "properties": { "gt": { "type": "number", "description": "Gross TrunOver", "example": 1000.12 } } }, "table6": { "type": "object", "properties": { "flag": { "type": "string", "description": "Gross TrunOver", "example": "D" }, "tx_trnovr": { "type": "array", "items": { "type": "object" } }, "exmp": { "type": "object", "additionalProperties": false } } }, "table7": { "type": "object", "properties": { "flag": { "type": "string", "description": "Flag for identifying Delete", "example": "D" }, "b2b": { "required": [ "camt", "csamt", "iamt", "samt", "txval" ], "type": "object", "properties": { "txval": { "type": "number", "description": "Taxable Value", "example": 1000 }, "iamt": { "type": "number", "description": "IGST Amount", "example": 20 }, "camt": { "type": "number", "description": "CGST Amount", "example": 20 }, "samt": { "type": "number", "description": "SGST Amount", "example": 20 }, "csamt": { "type": "number", "description": "CESS Amount", "example": 20 } } }, "b2bur": { "type": "object", "additionalProperties": false }, "imps": { "type": "object", "additionalProperties": false } } }, "table8": { "type": "object", "additionalProperties": false }, "table9": { "type": "object", "additionalProperties": false }, "table10": { "type": "object", "additionalProperties": false }, "table14": { "type": "object", "additionalProperties": false }, "table15": { "type": "object", "additionalProperties": false }, "table16": { "type": "object", "additionalProperties": false } } } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/gstr9a/getdet": { "get": { "tags": [ "GSTR9A" ], "summary": "Get GSTR9A Details", "description": "This API is to get GSTR9A details", "operationId": "getGSTRDetails", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr9a/getautocal": { "get": { "tags": [ "GSTR9A" ], "summary": "Get GSTR9A Auto Calculated Details", "description": "This API is to get GSTR9A Auto Calculated details", "operationId": "getAutoCalculatedDetails", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr9c/retfile": { "post": { "tags": [ "GSTR9C" ], "summary": "File GSTR9C", "description": "This API is to File GSTR9C", "operationId": "fileGSTR", "parameters": [ { "name": "email", "in": "query", "description": "API Developer User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload Format : {\"content\":\"{\"gstin\": \"37ABCDE9552F3Z4\", \"ret_period\": \"072017\",\"chksum\": \"AflJufPlFStqKBZ\",\"summ_typ\": \"L\"}\",\"pkcs7\":\"MIIFrwYJKoZIhvcNAQcCoI==\"}", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "signedcontent" } }, "/gstr9c/retevcfile": { "post": { "tags": [ "GSTR9C" ], "summary": "File GSTR9C data", "description": "Used to file entire GSTR9C invoices using EVC.", "operationId": "fileGSTR", "parameters": [ { "name": "email", "in": "query", "description": "API Developer User Email", "required": true, "schema": { "type": "string" } }, { "name": "pan", "in": "query", "description": "PAN Number", "required": true, "schema": { "type": "string" } }, { "name": "evcotp", "in": "query", "description": "OTP for EVC", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload Format : \"{\"gstin\": \"37ABCDE9552F3Z4\", \"ret_period\": \"072017\",\"chksum\": \"AflJufPlFStqKBZ\"}", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "content" } }, "/gstr9c/retsave": { "put": { "tags": [ "GSTR9C" ], "summary": "Save GSTR9C", "description": "This API is to save GSTR9C data", "operationId": "saveGSTR", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "type": "object", "properties": { "gstr9cdata": { "type": "object", "properties": { "audited_data": { "type": "object", "properties": { "gstin": { "type": "string", "description": "GSTIN number", "example": "12AVVVH1234HA1X" }, "fp": { "type": "string", "description": "Fp Type", "example": "032019" }, "act_name": { "type": "string", "description": "Act Name", "example": "Trade Unions Act, 1926 " }, "isauditor": { "type": "string", "description": "Auditor", "example": "Y" }, "table5": { "type": "object", "properties": { "turnovr": { "type": "number", "description": "Turnover", "example": 9999999999999.99 }, "unbil_rev_beg": { "type": "number", "description": "UNBIL", "example": 9999999999999.99 }, "unadj_adv_end": { "type": "number", "description": "UNADJ", "example": 9999999999999.99 }, "dmd_sup": { "type": "number", "description": "DMD", "example": 9999999999999.99 }, "crd_nts_issued": { "type": "number", "description": "Card not Issued", "example": 9999999999999.99 }, "trd_dis": { "type": "number", "description": "Trade", "example": 9999999999999.99 }, "turnovr_apr_jun": { "type": "number", "description": "Turnover", "example": -9999999999999.99 }, "unbil_rev_end": { "type": "number", "description": "UNBIL", "example": 9999999999999.99 }, "unadj_adv_beg": { "type": "number", "description": "UNADJ", "example": 9999999999999.99 }, "crd_note_acc": { "type": "number", "description": "Card Note", "example": 9999999999999.99 }, "adj_dta": { "type": "number", "description": "Data", "example": 9999999999999.99 }, "turnovr_comp": { "type": "number", "description": "Turnover", "example": 9999999999999.99 }, "adj_turn_sec": { "type": "number", "description": "Turnover", "example": -9999999999999.99 }, "adj_turn_fef": { "type": "number", "description": "Turnover", "example": -9999999999999.99 }, "adj_turn_othrsn": { "type": "number", "description": "Turnover", "example": -9999999999999.99 }, "annul_turn_adj": { "type": "number", "description": "Annual Turnover", "example": -1000000000000000 }, "annul_turn_decl": { "type": "number", "description": "Annual Turnover Decline", "example": -1000000000000000 }, "unrec_turnovr": { "type": "number", "description": "Unrecord Turnover", "example": -1000000000000000 } } }, "table6": { "type": "object", "properties": { "rsn": { "type": "array", "items": { "type": "object" } } } }, "table7": { "type": "object", "properties": { "annul_turn_adj": { "type": "number", "description": "Annual Turnover", "example": -1000000000000000 }, "othr_turnovr": { "type": "number", "description": "Other Turnover", "example": -9999999999999.99 }, "zero_sup": { "type": "number", "description": "Zero Supply", "example": -9999999999999.99 }, "rev_sup": { "type": "number", "description": "Reverse Supply", "example": -9999999999999.99 }, "tax_turn_annul": { "type": "number", "description": "Tax Turn Yearly", "example": -1000000000000000 }, "tax_turn_adj": { "type": "number", "description": "Tax Turn", "example": -1000000000000000 }, "unrec_tax_turn": { "type": "number", "description": "Unrecord Tax Turn", "example": -1000000000000000 } } }, "table8": { "type": "object", "properties": { "rsn": { "type": "array", "items": { "type": "object" } } } }, "table9": { "type": "object", "properties": { "rate": { "type": "array", "items": { "type": "object" } }, "inter": { "type": "object", "properties": { "cgst": { "type": "number", "description": "Taxable Amount", "example": 9999999999999.99 }, "sgst": { "type": "number", "description": "Taxable Amount", "example": 9999999999999.99 }, "igst": { "type": "number", "description": "Taxable Amount", "example": 9999999999999.99 }, "cess": { "type": "number", "description": "CESS", "example": 9999999999999.99 } } }, "late_fee": { "type": "object", "properties": { "cgst": { "type": "number", "description": "Taxable Amount", "example": 9999999999999.99 }, "sgst": { "type": "number", "description": "Taxable Amount", "example": 9999999999999.99 }, "igst": { "type": "number", "description": "Taxable Amount", "example": 9999999999999.99 }, "cess": { "type": "number", "description": "CESS", "example": 9999999999999.99 } } }, "pen": { "type": "object", "properties": { "cgst": { "type": "number", "description": "Taxable Amount", "example": 9999999999999.99 }, "sgst": { "type": "number", "description": "Taxable Amount", "example": 9999999999999.99 }, "igst": { "type": "number", "description": "Taxable Amount", "example": 9999999999999.99 }, "cess": { "type": "number", "description": "CESS", "example": 9999999999999.99 } } }, "oth": { "type": "object", "properties": { "cgst": { "type": "number", "description": "Taxable Amount", "example": 9999999999999.99 }, "sgst": { "type": "number", "description": "Taxable Amount", "example": 9999999999999.99 }, "igst": { "type": "number", "description": "Taxable Amount", "example": 9999999999999.99 }, "cess": { "type": "number", "description": "CESS", "example": 9999999999999.99 } } }, "tot_amt_payable": { "type": "object", "properties": { "cgst": { "type": "number", "description": "Taxable Amount", "example": 1000000000000000 }, "sgst": { "type": "number", "description": "Taxable Amount", "example": 1000000000000000 }, "igst": { "type": "number", "description": "Taxable Amount", "example": 1000000000000000 }, "cess": { "type": "number", "description": "CESS", "example": 1000000000000000 } } }, "unrec_amt": { "type": "object", "properties": { "cgst": { "type": "number", "description": "Taxable Amount", "example": 1000000000000000 }, "sgst": { "type": "number", "description": "Taxable Amount", "example": 1000000000000000 }, "igst": { "type": "number", "description": "Taxable Amount", "example": 1000000000000000 }, "cess": { "type": "number", "description": "CESS", "example": 1000000000000000 } } }, "tot_amt_paid": { "type": "object", "properties": { "cgst": { "type": "number", "description": "Taxable Amount", "example": 1000000000000000 }, "sgst": { "type": "number", "description": "Taxable Amount", "example": 1000000000000000 }, "igst": { "type": "number", "description": "Taxable Amount", "example": 1000000000000000 }, "cess": { "type": "number", "description": "CESS", "example": 1000000000000000 } } } } }, "table10": { "type": "object", "properties": { "rsn": { "type": "array", "items": { "type": "object" } } } }, "table11": { "type": "object", "properties": { "rate": { "type": "array", "items": { "type": "object" } }, "inter": { "type": "object", "properties": { "cgst": { "type": "number", "description": "Taxable Amount", "example": 9999999999999.99 }, "sgst": { "type": "number", "description": "Taxable Amount", "example": 9999999999999.99 }, "igst": { "type": "number", "description": "Taxable Amount", "example": 9999999999999.99 }, "cess": { "type": "number", "description": "CESS", "example": 9999999999999.99 } } }, "late_fee": { "type": "object", "properties": { "cgst": { "type": "number", "description": "Taxable Amount", "example": 9999999999999.99 }, "sgst": { "type": "number", "description": "Taxable Amount", "example": 9999999999999.99 }, "igst": { "type": "number", "description": "Taxable Amount", "example": 9999999999999.99 }, "cess": { "type": "number", "description": "CESS", "example": 9999999999999.99 } } }, "pen": { "type": "object", "properties": { "cgst": { "type": "number", "description": "Taxable Amount", "example": 9999999999999.99 }, "sgst": { "type": "number", "description": "Taxable Amount", "example": 9999999999999.99 }, "igst": { "type": "number", "description": "Taxable Amount", "example": 9999999999999.99 }, "cess": { "type": "number", "description": "CESS", "example": 9999999999999.99 } } }, "oth": { "type": "object", "properties": { "cgst": { "type": "number", "description": "Taxable Amount", "example": 9999999999999.99 }, "sgst": { "type": "number", "description": "Taxable Amount", "example": 9999999999999.99 }, "igst": { "type": "number", "description": "Taxable Amount", "example": 9999999999999.99 }, "cess": { "type": "number", "description": "CESS", "example": 9999999999999.99 } } } } }, "table12": { "type": "object", "properties": { "itc_avail": { "type": "number", "description": "ITC Avail", "example": 9999999999999.99 }, "itc_book_earl": { "type": "number", "description": "ITC Book", "example": 9999999999999.99 }, "itc_book_curr": { "type": "number", "description": "ITC Book", "example": 9999999999999.99 }, "itc_avail_audited": { "type": "number", "description": "ITC Audited", "example": 1000000000000000 }, "itc_claim": { "type": "number", "description": "ITC Claim", "example": -1000000000000000 }, "unrec_itc": { "type": "number", "description": "ITC Unrecord", "example": -1000000000000000 } } }, "table13": { "type": "object", "properties": { "rsn": { "type": "array", "items": { "type": "object" } } } }, "table14": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object" } }, "tot_elig_itc": { "type": "object", "properties": { "itc_avail": { "type": "number", "description": "ITC Avail", "example": 1000000000000000 } } }, "itc_claim": { "type": "object", "properties": { "itc_avail": { "type": "number", "description": "ITC Avail", "example": 1000000000000000 } } }, "unrec_itc": { "type": "object", "properties": { "itc_avail": { "type": "number", "description": "ITC Avail", "example": -1000000000000000 } } } } }, "table15": { "type": "object", "properties": { "rsn": { "type": "array", "items": { "type": "object" } } } }, "table16": { "type": "object", "properties": { "cgst": { "type": "number", "description": "Taxable Amount", "example": 9999999999999.99 }, "sgst": { "type": "number", "description": "Taxable Amount", "example": 9999999999999.99 }, "igst": { "type": "number", "description": "Taxable Amount", "example": 9999999999999.99 }, "cess": { "type": "number", "description": "CESS", "example": 9999999999999.99 }, "inter": { "type": "number", "description": "INTER", "example": 9999999999999.99 }, "pen": { "type": "number", "description": "PEN", "example": 9999999999999.99 } } }, "add_liab": { "type": "object", "properties": { "tax_pay": { "type": "array", "items": { "type": "object" } }, "place": { "type": "string", "description": "Description", "example": "Bangalore" }, "signatory": { "type": "string", "description": "Description", "example": "Akhil kumar" }, "mem_no": { "type": "string", "description": "Description", "example": "12345678" }, "date": { "type": "string", "description": "Description", "example": "21/12/2121" }, "audit_addr": { "type": "object", "properties": { "bno": { "type": "string", "description": "number", "example": "121" }, "fno": { "type": "string", "description": "number", "example": "45455" }, "building": { "type": "string", "description": "building name", "example": "dream paradise" }, "road": { "type": "string", "description": "road name", "example": "basapura" }, "city": { "type": "string", "description": "city", "example": "Bangalore" }, "district": { "type": "string", "description": "district", "example": "Bangalore" }, "state": { "type": "string", "description": "state", "example": "karnataka" }, "pin_code": { "type": "number", "description": "pin code", "example": 560100 } } }, "pan_no": { "type": "string", "description": "pan number", "example": "DMGPT7813B" } } } } }, "certificate": { "type": "object", "properties": { "cert_data": { "type": "object", "properties": { "pronoun": { "type": "string", "description": "pronoun", "example": "We" }, "bal_sheet_date": { "type": "string", "description": "balance sheet date", "example": "21/12/2121" }, "acc_typ": { "type": "string", "description": "account type", "example": "profit and loss account" }, "beg_date": { "type": "string", "description": "begin date", "example": "21/12/2121" }, "end_date": { "type": "string", "description": "end date", "example": "21/12/2121" }, "cash_from_date": { "type": "string", "description": "cash from date", "example": "21/12/2121" }, "cash_to_date": { "type": "string", "description": "cash to date", "example": "21/12/2121" }, "taxpayer_name": { "type": "string", "description": "taxpayer name", "example": "anil kumar" }, "addr": { "type": "object", "properties": { "bno": { "type": "string", "description": "number", "example": "121" }, "fno": { "type": "string", "description": "number", "example": "dfgs1545" }, "building": { "type": "string", "description": "building name", "example": "121" }, "road": { "type": "string", "description": "road name", "example": "neeladri" }, "city": { "type": "string", "description": "city", "example": "Bangalore" }, "district": { "type": "string", "description": "district", "example": "Bangalore" }, "state": { "type": "string", "description": "state", "example": "Karnataka" }, "pin_code": { "type": "number", "description": "pin code", "example": 560100 } } }, "doc_stat": { "type": "string", "description": "Document Status", "example": "has maintained the books of accounts, records and documents" }, "place": { "type": "string", "description": "place", "example": "Bangalore" }, "signatory": { "type": "string", "description": "signatory", "example": "Ankit Arora" }, "mem_no": { "type": "string", "description": "number", "example": "12345678" }, "date": { "type": "string", "description": "Date", "example": "21/12/2121" }, "audit_addr": { "type": "object", "properties": { "bno": { "type": "string", "description": "number", "example": "121" }, "fno": { "type": "string", "description": "number", "example": "dfgs1545" }, "building": { "type": "string", "description": "building name", "example": "121" }, "road": { "type": "string", "description": "road name", "example": "neeladri" }, "city": { "type": "string", "description": "city", "example": "Bangalore" }, "district": { "type": "string", "description": "district", "example": "Bangalore" }, "state": { "type": "string", "description": "state", "example": "Karnataka" }, "pin_code": { "type": "number", "description": "pin code", "example": 560100 } } }, "cert_textpartb1": { "type": "object", "properties": { "qualifications": { "type": "array", "items": { "type": "object" } }, "gstin": { "type": "string", "description": "GSTIN number", "example": "12AVVVH1234HA1X" }, "principal_addr": { "type": "object", "properties": { "bno": { "type": "string", "description": "number", "example": "121" }, "fno": { "type": "string", "description": "number", "example": "dfgs1545" }, "building": { "type": "string", "description": "building name", "example": "121" }, "road": { "type": "string", "description": "road name", "example": "neeladri" }, "city": { "type": "string", "description": "city", "example": "Bangalore" }, "district": { "type": "string", "description": "district", "example": "Bangalore" }, "state": { "type": "string", "description": "state", "example": "Karnataka" }, "pin_code": { "type": "number", "description": "pin code", "example": 560100 } } }, "add_addr": { "type": "object", "properties": { "bno": { "type": "string", "description": "number", "example": "121" }, "fno": { "type": "string", "description": "number", "example": "dfgs1545" }, "building": { "type": "string", "description": "building name", "example": "121" }, "road": { "type": "string", "description": "road name", "example": "neeladri" }, "city": { "type": "string", "description": "city", "example": "Bangalore" }, "district": { "type": "string", "description": "district", "example": "Bangalore" }, "state": { "type": "string", "description": "state", "example": "Karnataka" }, "pin_code": { "type": "number", "description": "pin code", "example": 560100 } } }, "ishave": { "type": "string", "description": "have", "example": "have been" }, "isagree": { "type": "string", "description": "agreed", "example": "in agreement" }, "info_stat": { "type": "string", "description": "information", "example": "was partially provided" } } }, "cert_textpartb2": { "type": "object", "properties": { "qualifications": { "type": "array", "items": { "type": "object" } }, "audit_typ": { "type": "string", "description": "Audit Type", "example": "Institute of Chartered Accountants of India" }, "audit_date": { "type": "string", "description": "Audit Date", "example": "21/12/2121" }, "member_no": { "type": "string", "description": "Member number", "example": "456784" }, "conducted_by": { "type": "object", "properties": { "name": { "type": "string", "description": "name", "example": "Krishna devan" }, "addr": { "type": "object", "properties": { "bno": { "type": "string", "description": "number", "example": "121" }, "fno": { "type": "string", "description": "number", "example": "dfgs1545" }, "building": { "type": "string", "description": "building name", "example": "building" }, "road": { "type": "string", "description": "road name", "example": "neeladri" }, "city": { "type": "string", "description": "city", "example": "Bangalore" }, "district": { "type": "string", "description": "district", "example": "Bangalore" }, "state": { "type": "string", "description": "state", "example": "Karnataka" }, "pin_code": { "type": "number", "description": "pin code", "example": 560100 } } } } } } } } }, "cert_text": { "type": "object", "properties": { "cert_text_partb1": { "type": "object", "properties": { "section1": { "type": "object", "properties": { "line0": { "type": "string", "description": "line", "example": "1. I have examined the-" }, "line1": { "type": "string", "description": "line", "example": "(a) balance sheet as on 10/01/2019" }, "line2": { "type": "string", "description": "line", "example": "(b) the profit and loss account for the period beginning from 01/01/2019 to ending on 07/01/2019 and" }, "line3": { "type": "string", "description": "line", "example": "(c) the cash flow statement for the period beginning: from 01/01/2019 to ending on 07/01/2019,attached herewith, of M/s. Rachel (Name), A101, 1st, Royal Apartments, Electronics city phase1, Bengaluru, Bengaluru, Karnataka, 560100 (Address), 09SSAUP0014A1ZR (GSTIN)." } } }, "section2": { "type": "object", "properties": { "line0": { "type": "string", "description": "line", "example": "2. Based on our audit I report that the said registered person-" }, "line1": { "type": "string", "description": "line", "example": "has not maintained books of accounts/records/documents specified below as required by the IGST/CGST/<<>>GST Act, 2017 and the rules/notifications made/issued thereunder:" } } }, "section3": { "type": "object", "properties": { "sec_3a": { "type": "object", "properties": { "line0": { "type": "string", "description": "line", "example": "3.(a) I report the following observations/ comments / discrepancies /inconsistencies; if any:" } } }, "sec_3b": { "type": "object", "properties": { "line0": { "type": "string", "description": "line", "example": "3.(b) I further report that-," }, "line1": { "type": "string", "description": "line", "example": "(A) I have obtained all the information and explanations which, to the best of my knowledge and belief, were necessary for the purpose of the audit/ information and explanations which, to the best of my knowledge and belief, were necessary for the purpose of the audit were not provided/partially provided to us." }, "line2": { "type": "string", "description": "line", "example": "(B) In my opinion, proper books of account have not been kept by the registered person so far as appears from my examination of the books." }, "line3": { "type": "string", "description": "line", "example": "(C) I certify that the balance sheet, the profit and loss account and the cash flow Statement are in agreement with the books of account maintained at the Principal place of business at B52, 1st, Salarpuria, Electronics city phase1, Bengaluru, Bengaluru, Karnataka, 560100 and B30, 1st, Infosys, Electronics city phase1, Bengaluru, Bengaluru, Karnataka, 560100 additional place of business within the State." } } } } }, "section4": { "type": "object", "properties": { "line0": { "type": "string", "description": "line", "example": "4. The documents required to be furnished under section 35 (5) of the CGST Act and Reconciliation Statement required to be furnished under section 44(2) of the CGST Act is annexed herewith in Form No. GSTR-9C" } } }, "section5": { "type": "object", "properties": { "line0": { "type": "string", "description": "line", "example": "5. In my opinion and to the best of my information and according to explanations given to me, the particulars given in the said Form No.GSTR-9C are true and correct subject to following observations/qualifications, if any:" } } }, "qualifications": { "type": "array", "items": { "type": "object" } }, "signature": { "type": "object", "properties": { "line0": { "type": "string", "description": "line", "example": "(Signature and stamp/Seal of the Auditor)" }, "place": { "type": "string", "description": "Place", "example": "Bengaluru" }, "nameOfTheSignatory": { "type": "string", "description": "Name Of The Signatory", "example": "Mr. Ashok" }, "membershipNo": { "type": "string", "description": "Membership No", "example": "12345678" }, "date": { "type": "string", "description": "Date", "example": "10/01/2019" }, "fullAddress": { "type": "string", "description": "Full Address", "example": "B30, 1st, Infosys, Electronics city phase1, Bengaluru, Bengaluru, Karnataka, 560100" } } } } }, "cert_text_partb2": { "type": "object", "properties": { "section1": { "type": "object", "properties": { "line0": { "type": "string", "description": "line", "example": "I report that the audit of the books of accounts and the financial statements of M/s. Rachel (Name), A101, 1st, Royal Apartments, Electronics city phase1, Bengaluru, Bengaluru, Karnataka, 560100 (Name and address of the assessee with GSTIN) was conducted by M/s. Monica (Name), A101, 1st, Paradise Apartments, Electronics city phase2, Bengaluru, Bengaluru, Karnataka, 560100 (full name and address of auditor along with status), bearing membership number in pursuance of the provisions of the Institute of Chartered Accountants of India Act, and I annex hereto a copy of their audit report dated 10/01/2018 along with a copy of each of :-" }, "line1": { "type": "string", "description": "line", "example": "(a) balance sheet as on 10/01/2019" }, "line2": { "type": "string", "description": "line", "example": "(b) the profit and loss account for the period beginning from 01/01/2019 to ending on 07/01/2019" }, "line3": { "type": "string", "description": "line", "example": "(c) the cash flow statement for the period beginning from 01/01/2019 to ending on 07/01/2019 and" }, "line4": { "type": "string", "description": "line", "example": "(d) documents declared by the said Act to be part of, or annexed to, the %23$s and balance sheet." } } }, "section2": { "type": "object", "properties": { "line0": { "type": "string", "description": "line", "example": "2. I report that the said registered person—" }, "line1": { "type": "string", "description": "line", "example": "has not maintained books of accounts/records/documents specified below as required by the IGST/CGST/<<>>GST Act, 2017 and the rules/notifications made/issued thereunder" } } }, "section3": { "type": "object", "properties": { "line0": { "type": "string", "description": "line", "example": "3. The documents required to be furnished under section 35 (5) of the CGST Act and Reconciliation Statement required to be furnished under section 44(2) of the CGST Act is annexed herewith in Form No.GSTR-9C." } } }, "section4": { "type": "object", "properties": { "line0": { "type": "string", "description": "line", "example": "4. In my opinion and to the best of my information and according to examination of books of account including other relevant documents and explanations given to me, the particulars given in the said Form No.9C are true and correct subject to the following observations/qualifications, if any:" } } }, "qualifications": { "type": "array", "items": { "type": "object" } }, "signature": { "type": "object", "properties": { "line0": { "type": "string", "description": "line", "example": "(Signature and stamp/Seal of the Auditor)" }, "place": { "type": "string", "description": "Place", "example": "Bengaluru" }, "nameOfTheSignatory": { "type": "string", "description": "Name Of The Signatory", "example": "Mr.Ashok" }, "membershipNo": { "type": "string", "description": "Membership No", "example": "12345678" }, "date": { "type": "string", "description": "Date", "example": "10/01/2019" }, "fullAddress": { "type": "string", "description": "Full Address", "example": "B44, 1st, SJR Equinox, Electronics city phase2, Bengaluru, Bengaluru, Karnataka, 560100" } } } } } } } } }, "audited_sign": { "type": "string", "description": "audited sign", "example": "sign of audited_data json and certificate json " } } }, "dcupdtls": { "type": "object", "properties": { "balance_sheet": { "type": "array", "items": { "type": "object" } }, "profitloss": { "type": "array", "items": { "type": "object" } }, "otherdoc1": { "type": "array", "items": { "type": "object" } }, "otherdoc2": { "type": "array", "items": { "type": "object" } } } } } } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/gstr9c/retsum": { "get": { "tags": [ "GSTR9C" ], "summary": "Get GSTR9C Summary", "description": "Get the table wise summary of GSTR9C data.", "operationId": "getGSTRSummary", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr9c/getrecds": { "get": { "tags": [ "GSTR9C" ], "summary": "Get 9 Records for GSTR9C", "description": "Get the GSTR9 Records for GSTR9C", "operationId": "getRecordsFor9C", "parameters": [ { "name": "gstin", "in": "query", "description": "GSTIN of the taxpayer", "required": true, "schema": { "type": "string" } }, { "name": "retperiod", "in": "query", "description": "Return Period format MMYYYY", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } } } }, "/gstr9c/genhash": { "put": { "tags": [ "GSTR9C" ], "summary": "Hash Generator", "description": "This API is to generate hash of GSTR9C data", "operationId": "hashGenerator", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } }, "/gstr9c/gencert": { "put": { "tags": [ "GSTR9C" ], "summary": "Generate Certificate", "description": "This API is to Generate Certificate", "operationId": "generateCertificate", "parameters": [ { "name": "email", "in": "query", "description": "User Email", "required": true, "schema": { "type": "string" } }, { "name": "gstin", "in": "header", "description": "GST Number", "required": true, "schema": { "type": "string" } }, { "name": "ret_period", "in": "header", "description": "Return Period (MMYYYY)", "required": true, "schema": { "type": "string" } }, { "name": "gst_username", "in": "header", "description": "GST UserName", "required": true, "schema": { "type": "string" } }, { "name": "state_cd", "in": "header", "description": "State Code", "required": true, "schema": { "type": "string" } }, { "name": "ip_address", "in": "header", "description": "IP Address", "required": true, "schema": { "type": "string" } }, { "name": "txn", "in": "header", "description": "Transaction", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "header", "description": "Client ID", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "header", "description": "Client Secret", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "404": { "description": "Not Found. If requested entity is not found or if requested API is not found." }, "500": { "description": "Internal server error" } }, "x-codegen-request-body-name": "body" } } }, "components": { "schemas": { "Error Payload": { "required": [ "code", "desc", "error_cd", "message" ], "type": "object", "properties": { "message": { "type": "string", "description": "Error Message" }, "error_cd": { "type": "string", "description": "Error Code" }, "code": { "type": "string", "description": "Server Error Code" }, "desc": { "type": "string", "description": "Server Error Description" } }, "description": "If anything goes wrong error payload will be return" }, "Response": { "required": [ "header", "status_cd", "status_desc" ], "type": "object", "properties": { "status_cd": { "type": "string", "description": "Status Code" }, "status_desc": { "type": "string", "description": "Status Description" }, "error": { "$ref": "#/components/schemas/Error Payload" }, "header": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Header Map" }, "data": { "type": "string", "description": "GST response data" } }, "description": "Response which contains status code and header and data" } } }, "externalDocs": { "description": "GST API developer documentation", "url": "https://whitebooks.in/api/gst-api-for-developers" } }