Entity Delinquency Request

4 min

Introduction

This API is used for retrieving information related to Goods and Services Tax (GST) delinquencies for a particular patron. The API allows you to access important information related to GST returns and their status for a given GSTIN (Goods and Services Tax Identification Number). To access the API, you will need to provide your Patron ID, Access Token, and the necessary parameters related to your request. One of the API's features is the GSTR Delinquencies endpoint, which allows businesses to check for any outstanding tax liabilities or late filings for their GST registration.

Sample CURL

curl --request POST \
  --url http://signzy.tech/api/v2/patrons/..your-patron-id../gstrdelinquencies \
  --header 'Accept: */*' \
  --header 'Accept-Language: en-US,en;q=0.8' \
  --header 'Authorization: <Access-Token>' \
  --header 'content-type: application/json' \
  --data '{"essentials":{"gstin":"...gstin...","username":"...username...","sek":"...sek...","appKey":"...appKey...","authToken":"...authToken...","retPeriod":"...retPeriod..."}}'

Parameter	Type	Description
url	String	The URL of the API endpoint, which includes the patron ID of the user making the request.
request	String	The HTTP request method being used, which in this case is POST.
Accept	String	The media type(s) that the client is willing to accept in the response, which is set to / in this request.
Accept-Language	String	The preferred natural language of the client, which is set to en-US,en;q=0.8.
Authorization	String	The access token that the client uses to authenticate itself with the API.
content-type	String	The media type of the request payload, which is application/json in this request.
gstin	String	The GSTIN (Goods and Services Tax Identification Number) of the business that is being queried for delinquencies.
username	String	The username of the business that is being queried for delinquencies.
sek	String	The Security Encryption Key of the business that is being queried for delinquencies.
appKey	String	The application key of the business that is being queried for delinquencies.
authToken	String	The authentication token of the business that is being queried for delinquencies.
retPeriod	String	The return period for which the business wants to check for delinquencies.

Sample API Response

{
    "essentials": {
        "gstin": "..gstin..",
        "username": "..username..",
        "authToken": "..authToken..",
        "appKey": "..appKey..",
        "sek": "..sek..",
        "retPeriod": "..retPeriod.."
    },
    "id": "...accessToken...",
    "patronId": "...patronId...",
    "result":{
        "interest" : "..interest..",
        "lateFee" : "..lateFee..",
        "penalty" : "..penalty..",
        "status" : "..status..."


        }
      }

Parameter	Description
essentials	An object containing the essentials of the business that was queried for delinquencies.
id	The access token of the API request.
patronId	The patron ID of the user that made the API request.
result	An object containing information about any delinquencies that were found for the business.
interest	The interest amount that the business owes for any outstanding tax liabilities.
lateFee	The late fee that the business owes for any late filings of GST returns.
penalty	The penalty amount that the business owes for any non-compliance with GST regulations.
status	The overall compliance status of the business, which can be "Compliant" or "Non-Compliant" depending on whether any delinquencies were found or not.