GSTR2A GET B2B TRANSACTIONS
Introduction
The given curl command is an HTTP request to the Signzy API endpoint for generating the GSTR-2A statement. GSTR-2A is a return form that captures the details of inward supplies of goods or services, as auto-populated from the supplier's GSTR-1, and serves as a ready-to-use input tax credit statement for the buyer. The API endpoint requires a POST request method and the necessary parameters in the request body to generate the statement. The request must also include an access token for authentication.
Sample Curl
curl --request POST \
--url http://signzy.tech/api/v2/patrons/..your-patron-id../gstr2as \
--header 'Accept: */*' \
--header 'Accept-Language: en-US,en;q=0.8' \
--header 'Authorization: <Access-Token>' \
--header 'content-type: application/json' \
--data '{"task":"b2b","essentials":{"gstin":"...gstin...","username":"...username...","sek":"...sek...","appKey":"...appKey...","authToken":"...authToken...","retPeriod":"...retPeriod..."}}'
Parameter Name | Type | Description |
|---|---|---|
url | String | The URL of the API endpoint for generating GSTR-2A statement |
request method | String | The request method to be used for making the API call (POST in this case) |
Accept | String | The media type(s) that are acceptable for the response. "*" indicates that any media type is acceptable |
Accept-Language | String | The preferred natural language of the client |
Authorization | String | An access token for authentication purposes |
content-type | String | The media type of the request body |
task | String | A string that specifies the type of task to be performed (in this case, "b2b" for business-to-business transactions) |
gstin | String | The GST Identification Number of the businss |
username | String | The username of the Signzy account |
sek | String | A secret encryption key for the Signzy account |
appKey | String | A unique application key for the Signzy account |
authToken | String | An authentication token for the Signzy account |
retPeriod | String | The return period for which the GSTR-2A statement is to be generated/ |
Sample Response
{
"result": {
"message": "Returns fetched successfully",
"data": [{
"invoiceDetails": [{
"invoiceChecksumValue": "..invoiceChecksumValue..",
"supplierInvoiceNumber": "..supplierInvoiceNumber..",
"supplierInvoiceDate": "..supplierInvoiceDate..",
"supplierInvoiceValue": "..supplierInvoiceValue..",
"placeOfSupply": "..placeOfSupply..",
"reverseCharge": "..reverseCharge..",
"invoiceType": "..invoiceType..",
"items": [{
"number": "..number..",
"details": {
"taxableValue": "..taxableValue..",
"igstAmount": "..igstAmount..",
"cgstAmount": "..cgstAmount..",
"sgstAmount": "..sgstAmount..",
"cessAmount": "..cessAmount..",
"taxRate": "..taxRate.."
}
}]
}],
"counterPartyFillingStatus": "..counterPartyFillingStatus..",
"ctin": "..ctin.."
}]
}
}
Parameter | Description |
|---|---|
message | Indicates whether the data was fetched successfully or not |
data | An array containing the invoice details |
invoiceChecksumValue | A unique value used to verify the authenticity of the invoice |
supplierInvoiceNumber | The invoice number assigned by the supplier |
supplierInvoiceDate | The date on which the invoice was issued |
supplierInvoiceValue | The total value of the invoice |
placeOfSupply | The location where the goods/services were supplied |
reverseCharge | Whether the reverse charge mechanism was applied or not |
invoiceType | The type of invoice (e.g. GST, commercial) |
items | An array containing the details of the items in the invoice |
number | The item number |
taxableValue | The value of the item on which tax is calculated |
igstAmount | The Integrated Goods and Services Tax amount |
cgstAmount | The Central Goods and Services Tax amount |
sgstAmount | The State Goods and Services Tax amount |
cessAmount | The Cess amount |
taxRate | The applicable tax rate |