Entity Gross Profit

4 min

Introduction

This API allows you to retrieve the summary of the GSTR-3B returns filed for a specified GSTIN number and return period. To access this API, you need to provide the required authentication credentials and the details of the GST returns that you want to retrieve.

Sample CURL

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

Parameter Name	Data Type	Description
task	string	Required. Specifies the task for which the GSTR3B report is being generated. Possible values are "summary", "invoices", "hsn" and "payments".
essentials	object	Required. Contains essential information about the request.
gstin	string	Required. The GST identification number of the taxpayer.
username	string	Required. The username of the taxpayer.
sek	string	Required. The signature encryption key of the taxpayer.
appKey	string	Required. The application key provided by the API.
authToken	string	Required. The authentication token obtained from the API.
retPeriod	string	Required. The return period for which the GSTR3B report is being generated in the format "MMYYYY".

Sample API Response

{
  "result": {
      "message": "..message..",
      "data": {
          "gstin": "..gstin..",
          "retPeriod": "..retPeriod..",
          "supplyDetails": {
              "outwardTaxableSuppliesNonZero": {
                  "totalTaxableValue": "..totalTaxableValue..",
                  "integratedTax": "..integratedTax..",
                  "centralTax": "..centralTax..",
                  "stateTax": "..centralTax..",
                  "cess": "..cess.."
              },
              "outwardTaxableSuppliesZero": {
                  "totalTaxableValue": "..totalTaxableValue..",
                  "integratedTax": "..integratedTax..",
                  "centralTax": "..centralTax..",
                  "stateTax": "..centralTax..",
                  "cess": "..cess.."
              },
              "otherOutwardSupplies": {
                  "totalTaxableValue": "..totalTaxableValue..",
                  "integratedTax": "..integratedTax..",
                  "centralTax": "..centralTax..",
                  "stateTax": "..centralTax..",
                  "cess": "..cess.."
              },
              "inwardSuppliesReverseCharge": {
                  "totalTaxableValue": "..totalTaxableValue..",
                  "integratedTax": "..integratedTax..",
                  "centralTax": "..centralTax..",
                  "stateTax": "..centralTax..",
                  "cess": "..cess.."
              },
              "outwardSuppliesNonGst": {
                  "totalTaxableValue": "..totalTaxableValue..",
                  "integratedTax": "..integratedTax..",
                  "centralTax": "..centralTax..",
                  "stateTax": "..centralTax..",
                  "cess": "..cess.."
              }
          },
          "interStateSupplies": {
              "unregisteredPersonSupplyDetails": ["..unregisteredPersonSupplyDetails..."],
              "compositionPersonSupplyDetails": ["..compositionPersonSupplyDetails.."],
              "uinHolderSupplydetails": ["..uinHolderSupplydetails..."]
          },
          "inputTaxCreditEligible": {
              "inputTaxCreditAvailable": [{
                  "type": "..type...",
                  "integratedTax": "..integratedTax..",
                  "centralTax": "..centralTax..",
                  "stateTax": "..stateTax..",
                  "cess": "..cess.."
              }],
              "inputTaxCreditReversed": [{
                  "type": "..type...",
                  "integratedTax": "..integratedTax..",
                  "centralTax": "..centralTax..",
                  "stateTax": "..stateTax..",
                  "cess": "..cess.."
              }],
              "inputTaxCreditNet": [{
                  "integratedTax": "..integratedTax..",
                  "centralTax": "..centralTax..",
                  "stateTax": "..stateTax..",
                  "cess": "..cess.."
              }],
              "inputTaxCreditIneligible": [{
                  "type": "..type...",
                  "integratedTax": "..integratedTax..",
                  "centralTax": "..centralTax..",
                  "stateTax": "..stateTax..",
                  "cess": "..cess.."
              }]
          },
          "inwardSupplies": {
              "inwardSuppliesDetails": [{
                  "type": "..type..",
                  "interStateSupplies": "..interStateSupplies..",
                  "intraStateSupplies": "..intraStateSupplies.."
              }]
          },
          "interestLateFeePayable": {
              "interestDetails": {
                  "integratedTax": "..integratedTax..",
                  "centralTax": "..centralTax..",
                  "stateTax": "..stateTax..",
                  "cess": "..cess.."
              },
              "latefeeDetails": {
                  "integratedTax": "..integratedTax..",
                  "centralTax": "..centralTax..",
                  "stateTax": "..stateTax..",
                  "cess": "..cess.."
              }
          },
          "taxPayment": {
              "taxPayable": [{
                  "transactionDescription": "..transactionDescription...",
                  "liabilityLedgerId": "..liabilityLedgerId...",
                  "transactionType": "..transactionType..",
                  "igst": {
                      "taxPayable": "...taxPayable...",
                      "interestPayable": "..interestPayable...",
                      "fee": "..fee.."
                  },
                  "cgst": {
                      "taxPayable": "...taxPayable...",
                      "interestPayable": "..interestPayable...",
                      "fee": "..fee.."
                  },
                  "sgst": {
                      "taxPayable": "...taxPayable...",
                      "interestPayable": "..interestPayable...",
                      "fee": "..fee.."
                  },
                  "cess": {
                      "taxPayable": "...taxPayable...",
                      "interestPayable": "..interestPayable...",
                      "fee": "..fee.."
                  }
              }],
              "paidThroughCash": [{
                  "liabilityLedgerId": "..liabilityLedgerId...",
                  "transType": "..transType...",
                  "igstPaid": "..igstPaid..",
                  "cgstPaid": "..cgstPaid..",
                  "sgstPaid": "..sgstPaid..",
                  "cessPaid": "..cessPaid..",
                  "interestPaidAgainstIGST": "..interestPaidAgainstIGST..",
                  "interestPaidAgainstCGST": "..interestPaidAgainstCGST..",
                  "interestPaidAgainstSGST": "..interestPaidAgainstSGST..",
                  "interestPaidAgainstCess": "..interestPaidAgainstCess..",
                  "lateFeePaidAgainstIGST": "..lateFeePaidAgainstIGST..",
                  "lateFeePaidAgainstCGST": "..lateFeePaidAgainstCGST..",
                  "lateFeePaidAgainstSGST": "..lateFeePaidAgainstSGST..",
                  "lateFeePaidAgainstCESS": "..lateFeePaidAgainstCESS.."
              }],
              "paidThroughCredit": {
                  "liabilityLedgerId": "..liabilityLedgerId...",
                  "transType": "..transType..",
                  "igstPaidusingIgst": "..igstPaidusingIgst...",
                  "igstPaidusingCgst": "..igstPaidusingCgst..",
                  "igstPaidusingSgst": "..igstPaidusingSgst..",
                  "cgstPaidusingIgst": "..cgstPaidusingIgst..",
                  "cgstPaidusingCgst": "..cgstPaidusingCgst..",
                  "sgstPaidusingIgst": "..sgstPaidusingIgst..",
                  "sgstPaidusingSgst": "..sgstPaidusingSgst..",
                  "cessPaidusingCess": "..cessPaidusingCess.."
              }
          }
      }
  }
}

Parameter	Description
message	A message regarding the result of the request.
gstin	The Goods and Services Taxpayer Identification Number (GSTIN) of the taxpayer.
retPeriod	The tax period for which the GST return is filed.
outwardTaxableSuppliesNonZero	Details of taxable supplies made with non-zero tax rates.
totalTaxableValue	The total taxable value of the outward taxable supplies made with non-zero tax rates.
integratedTax	The total Integrated Goods and Services Tax (IGST) paid on the outward taxable supplies made with non-zero tax rates.
centralTax	The total Central Goods and Services Tax (CGST) paid on the outward taxable supplies made with non-zero tax rates.
stateTax	The total State Goods and Services Tax (SGST) paid on the outward taxable supplies made with non-zero tax rates.
cess	The total amount of cess paid on the outward taxable supplies made with non-zero tax rates.
outwardTaxableSuppliesZero	Details of taxable supplies made with zero tax rates.
otherOutwardSupplies	Details of other taxable supplies made.
inwardSuppliesReverseCharge	Details of taxable supplies received under reverse charge.
outwardSuppliesNonGst	Details of taxable supplies made with no GST applied.
unregisteredPersonSupplyDetails	Details of inter-state taxable supplies made to unregistered persons.
compositionPersonSupplyDetails	Details of inter-state taxable supplies made to composition scheme taxpayers.
uinHolderSupplydetails	Details of inter-state taxable supplies made to UIN holders.
inputTaxCreditEligible	Details of input tax credit (ITC) available, reversed, ineligible, and net.
inputTaxCreditAvailable	Details of ITC available on inward supplies.
inputTaxCreditReversed	Details of ITC reversed or claimed as a refund.
inputTaxCreditNet	Details of net ITC available for utilization.
inputTaxCreditIneligible	Details of ITC that are not eligible for claim.
inwardSupplies	Details of inward supplies received.
type	The type of inward supply.
interStateSupplies	The total inter-state supplies received.
intraStateSupplies	The total intra-state supplies received.
interestLateFeePayable	Details of interest and late fee payable.
interestDetails	The total amount of interest payable.
latefeeDetails	The total amount of late fee payable.
taxPayment	Details of tax payable and tax paid through cash.
transactionDescription	Description of the transaction.
liabilityLedgerId	The liability ledger ID.
transactionType	The type of transaction.
igst	Details of IGST payable and paid.
cgst	Details of CGST payable and paid.
sgst	Details of SGST payable and paid.
cess	Details of cess payable and paid.
paidThroughCash	Details of tax paid through cash.
transType	The type of transaction.