GST Data Reader

Reads GST-related information from uploaded invoice documents and returns extracted records for review.

API Details

Method: POST

Endpoint: /gst-recon/read

Base URL: https://uatapi.wowpe.in/api/api/api-module

Authentication

Include the following headers in your request.

HeaderTypeDescription
X-Client-IdStringClient ID provided by WowPe.
X-Client-SecretStringClient secret provided by WowPe.

Request Parameters

Content-Type: multipart/form-data

ParameterTypeMandatoryDescription
filesFileYesInvoice document(s) to process. Repeat this field for multiple files.

Sample Request

curl --request POST 'https://uatapi.wowpe.in/api/api/api-module/gst-recon/read' \
  --header 'X-Client-Id: YOUR_CLIENT_ID' \
  --header 'X-Client-Secret: YOUR_CLIENT_SECRET' \
  --form '[email protected]'

Sample Response

{
  "reviewRequired": true,
  "files": [
    {
      "fileName": "invoice.pdf",
      "success": true,
      "rows": [
        {
          "sourceFile": "invoice.pdf",
          "sourcePages": "1",
          "beneficiaryName": "",
          "uniqueRefNo": "0007",
          "gstin": "29BBBBBO0O00B1Z5",
          "taxableValue": 1000.0,
          "cgst": 90.0,
          "sgst": 90.0,
          "igst": 0.0,
          "gstAmount": 180.0,
          "reviewed": false,
          "warnings": [
            "BeneficiaryName not found; review source."
          ]
        }
      ]
    }
  ]
}

Note: This is a representative UAT response. Not every field is guaranteed to appear in every response.

Response Parameters

ParameterTypeDescription
reviewRequiredBooleanIndicates whether the extracted data requires review.
filesArrayContains processing results for uploaded files.
fileNameStringName of the uploaded file.
successBooleanIndicates the observed file-processing result.
rowsArrayContains extracted invoice records.
sourceFileStringSource document name, where returned.
sourcePagesStringSource page information, where returned.
beneficiaryNameStringExtracted supplier or beneficiary name.
uniqueRefNoStringInvoice or reference number.
gstinStringExtracted GST identification number.
taxableValueNumber / NullExtracted taxable amount.
cgstNumber / NullCentral GST amount.
sgstNumber / NullState GST amount.
igstNumber / NullIntegrated GST amount.
gstAmountNumber / NullReported GST amount.
reviewedBooleanReview status of the record.
warningsArrayWarnings associated with the extracted record.

Important Notes

  • The API's captured UAT responses may contain missing fields, warnings or conflicting document information.
  • Verify supplier identity, GSTIN, invoice reference, document date and tax amounts against the original invoice.
  • Preserve missing values as unknown. Do not automatically replace them with zero.
  • Multiple invoices or supporting pages may not always be grouped correctly.
  • An all-page OCR fix has been tested locally, but its deployment to UAT has not been confirmed.

What's Next

Review the extracted invoice data and resolve any missing or incorrect values before using the records for reconciliation.