Get Max ITC Results

You can check the recon status by sending the workflow_id in a GET request.

Request Method

GET

Request URL

{{BASE_URL}}/integration/v1/maxItc/getWorkflowStatus/{workflow_id}

Request Headers

Parameter

Data Type

Field Validations

Description

x-cleartax-auth-token

String

Cannot be empty

Mandatory. User auth token.

Request Path Params

Parameter

Data Type

Field Validations

Description

workflow_id

String

Mandatory. Workflow ID returned by trigger Max ITC API to poll status

Request Query Params

There are no query parameters for this API

Request Body

There is no request body for this API

Sample Request Body

Response Status Codes

HTTP Status Code

Description

200

401

If the user is not authenticated for the operation.

Response Schema

Parameter

Data Type

Field Validations

Description

workflowId

String

Workflow Id of the workflow.

status

String

Enum: WORKFLOW_IN_PROGRESS, WORKFLOW_COMPLETED, WORKFLOW_FAILED

Workflow Status.

fileErrors

List

Array of input file error objects. If there are no errors, then this will be an empty list.

gstinStats

List

Array of GSTIN statistics objects. GSTIN wise statistics of documents uploaded and processed.

pullStatus

String

Govt Pull status.

reconStatus

JSON

Reconciliation status object.

File Errors Object

Parameter

Data Type

Field Validations

Description

inputFileName

String

PR input filename

status

String

Enum: DATA_VALIDATION_ERROR

FILE_ERROR

PR File status.

errorFileUrl

String

URL to download the file containing errors.

errors

List

Array of error objects.

GSTIN Statistics Object

Parameter

Data Type

Field Validations

Description

gstin

String

GSTIN

totalDocumentCount

Number

Total documents present in the uploaded file for the given GSTIN.

validRows

Number

Number of valid documents out of the total documents present.

invalidRows

Number

Number of invalid documents out of the total documents present.

Recon Status Object

Parameter

Data Type

Field Validations

Description

status

String

Enum: PENDING, SUCCESS, FAILURE

Reconciliation Status

reconResultsFileUrl

String

URL of the reconciliation result.

reconResultsVendorFileUrl

String

URL of the reconciliation vendor report.

errors

List

Array of error objects.

Error Object

Parameter

Data Type

Field Validations

Description

errorCode

String

Enum for File Error:

FILE_CORRUPTED

FILE_SIZE_EXCEED_LIMIT

HEADER_DUPLICATION_ERROR

EMPTY_FILES

MANDATORY_HEADER_MISSING

Enum for Recon Error:

NOT_AUTHENTICATED

LICENSE_EXPIRED

QUOTA_EXCEEDED

PERMISSION_DENIED

INVALID_WORKFLOW_ID

GSTIN_TOKEN_INACTIVE

GOVT_PULL_FAILURE

RECON_FAILURE

INTERNAL_ERROR

Error Code

errorMessage

String

Error Message

errorField

String

Error Field

errorValues

String

Error Field values

errorResolution

String

Error corrective action

Sample Response (Success)

200 : OK

{
    "workflowId": "b970aa72-1be6-4be6-a2a3-6ba5c0b57165",
    "status": "WORKFLOW_COMPLETED",
    "gstinStats": [
        {
            "gstin": "06AAFCD5862R017",
            "totalDocumentCount": 2,
            "validRows": 1,
            "invalidRows": 1
        }
    ],
    "reconStatus": {
        "status": "SUCCESS",
        "reconResultsFileUrl": "https://storage.clear.in/v1/ap-south-1/matching-service-sandbox/report-recon/307a6331-df8b-4bdd-a05a-d18812da0340/GSTR_2A_Vs_PR_c0ff666b-134e-4c1b-9a56-8acbc0c78911.gz?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEBAaCmFwLXNvdXRoLTEiSDBGAiEA22eQ2SZRftWwZOnNYgheyUIl9dZSkz%2Bq0BYjg3HDRNgCIQD%2B2F2xbmmEDwk02aerBEog3DKtD0NZTdYCRfiZN9eu9SqCBQgpEAUaDDIxOTM0MTkwNzk4MyIMB6LA6tSnbwPpOr82Kt8E20JQsJmNgrl6LNcKJVbdJCkPmrYLHdmUFIIJEmubss8kQrYoAsNefsXrJdFGDWqHnYihyf4TxR6L3vk%2Buj1Wu0aUXIQhcgQ3vgfsMdzyKbwMFMBEf3eC0QdECFydP3kV%2B2gtSVb6eQar6%2BL2wQk3fmP0R11kd%2FdJs9wV7ltvzLNnQ1EK7QvLpyk%2BTWY9g5gjbJu2olPVP0ltIr2b1iXFps6JAc5vaG1sbgUmxFPGizlM4zXF72n6IMdBfRiT2%2FQrQjkNLR9vs%2BQrBVKFvtb2K5UIZymAx0YaUEbjAK2qaxwJ2ycpG85%2Fh%2FC1H8tOMih5Fl1zAHXIdRukX27VSldnWWeHJruXOfV%2FVAp0W%2B4A7PMuENaNQgb9AI0K1JLKiZrekH26bLMx2VIwpvF8eu2U3ArfXch9PeMLc%2FrVlqGprSHYn8m8ZfSOILA1LPOiUfDdxQl0cLOMtE0vvuMDBgECeJEYcMdGQSXDZFn6N6JrJyLZutoXWv3YdfVpLlS%2FNm25bD98gJVsOTYzk3T798rKfX87Vu%2FGmGqsyvZsSaDKSjV7g14PMLHRAfGdNL3WA02QP94VUntCUEyBa%2FG%2Bsc3W2go3ql2x4XpdjTv2ykX3b3JNb%2FcmJl2zL9ua7R0w36c8L62okpW2el3RyjGGLT43Xf7M%2FzbOoQn4fWfeYrVqLnS%2FwmdFFIJlBIOVW%2FrUkfP2RMwnL6yeyECbZbDPsergNwVAH2h0nNRRHEO%2BRi7FOLrKSCDwXHhQe9eYS31UtR%2F8n0DPAoVINfDTXA%2F4j%2FH6GPVpu0Oditrlio6jOPIUAjC49aOpBjqZAcOCMibSUY7uxy7UuBPzCe9vnPU45wnB3leGBV9OwFnNzRQj1V8l6XThEWFkTtMJrdJ43qyuvH7VErS7pXyvGHWH%2Fyg5IobA5W2qzuseU%2BO8zVWXJM6YGvaX22%2BmRkDOEUwCxMgGfB%2BkpnJ2zpxsikudP5OJIC6dYi3Sf9PG6pLd3ki9tukLaRcxF8u3zWrSkYggTaoCb4uspg%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20231013T082916Z&X-Amz-SignedHeaders=host&X-Amz-Expires=36000&X-Amz-Credential=ASIATGEOL5AHXDYS72EB%2F20231013%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Signature=f39e34fa460131522096587a3fe804823fc176dad8771ac2cf9e0ff044bf4cb6",
        "reconResultsVendorFileUrl": "https://storage.clear.in/v1/ap-south-1/matching-service-sandbox/report-recon/307a6331-df8b-4bdd-a05a-d18812da0340/GSTR_2A_Vs_PR_e15f2201-eb3f-40f3-95f8-d5cc4d7418c4.gz?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEBAaCmFwLXNvdXRoLTEiSDBGAiEA22eQ2SZRftWwZOnNYgheyUIl9dZSkz%2Bq0BYjg3HDRNgCIQD%2B2F2xbmmEDwk02aerBEog3DKtD0NZTdYCRfiZN9eu9SqCBQgpEAUaDDIxOTM0MTkwNzk4MyIMB6LA6tSnbwPpOr82Kt8E20JQsJmNgrl6LNcKJVbdJCkPmrYLHdmUFIIJEmubss8kQrYoAsNefsXrJdFGDWqHnYihyf4TxR6L3vk%2Buj1Wu0aUXIQhcgQ3vgfsMdzyKbwMFMBEf3eC0QdECFydP3kV%2B2gtSVb6eQar6%2BL2wQk3fmP0R11kd%2FdJs9wV7ltvzLNnQ1EK7QvLpyk%2BTWY9g5gjbJu2olPVP0ltIr2b1iXFps6JAc5vaG1sbgUmxFPGizlM4zXF72n6IMdBfRiT2%2FQrQjkNLR9vs%2BQrBVKFvtb2K5UIZymAx0YaUEbjAK2qaxwJ2ycpG85%2Fh%2FC1H8tOMih5Fl1zAHXIdRukX27VSldnWWeHJruXOfV%2FVAp0W%2B4A7PMuENaNQgb9AI0K1JLKiZrekH26bLMx2VIwpvF8eu2U3ArfXch9PeMLc%2FrVlqGprSHYn8m8ZfSOILA1LPOiUfDdxQl0cLOMtE0vvuMDBgECeJEYcMdGQSXDZFn6N6JrJyLZutoXWv3YdfVpLlS%2FNm25bD98gJVsOTYzk3T798rKfX87Vu%2FGmGqsyvZsSaDKSjV7g14PMLHRAfGdNL3WA02QP94VUntCUEyBa%2FG%2Bsc3W2go3ql2x4XpdjTv2ykX3b3JNb%2FcmJl2zL9ua7R0w36c8L62okpW2el3RyjGGLT43Xf7M%2FzbOoQn4fWfeYrVqLnS%2FwmdFFIJlBIOVW%2FrUkfP2RMwnL6yeyECbZbDPsergNwVAH2h0nNRRHEO%2BRi7FOLrKSCDwXHhQe9eYS31UtR%2F8n0DPAoVINfDTXA%2F4j%2FH6GPVpu0Oditrlio6jOPIUAjC49aOpBjqZAcOCMibSUY7uxy7UuBPzCe9vnPU45wnB3leGBV9OwFnNzRQj1V8l6XThEWFkTtMJrdJ43qyuvH7VErS7pXyvGHWH%2Fyg5IobA5W2qzuseU%2BO8zVWXJM6YGvaX22%2BmRkDOEUwCxMgGfB%2BkpnJ2zpxsikudP5OJIC6dYi3Sf9PG6pLd3ki9tukLaRcxF8u3zWrSkYggTaoCb4uspg%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20231013T082916Z&X-Amz-SignedHeaders=host&X-Amz-Expires=36000&X-Amz-Credential=ASIATGEOL5AHXDYS72EB%2F20231013%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Signature=6c579e2adb1137c87caf06d6a52b2564db9ac3043a9208e11758ae20b7a9dbeb",
        "errors": []
    },
    "fileErrors": [
        {
            "inputFileName": "Purchase_Invoice.XLSX",
            "status": "DATA_VALIDATION_ERROR",
            "errorFileUrl": "https://storage.clear.in/v1/ap-south-1/ingestionv2-staging/My%20Organis_PR_ae849fa75c5c4663ae52c78da5bedf06_2023-10-13T07%3A33%3A24.543126786.csv?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEBAaCmFwLXNvdXRoLTEiSDBGAiEA22eQ2SZRftWwZOnNYgheyUIl9dZSkz%2Bq0BYjg3HDRNgCIQD%2B2F2xbmmEDwk02aerBEog3DKtD0NZTdYCRfiZN9eu9SqCBQgpEAUaDDIxOTM0MTkwNzk4MyIMB6LA6tSnbwPpOr82Kt8E20JQsJmNgrl6LNcKJVbdJCkPmrYLHdmUFIIJEmubss8kQrYoAsNefsXrJdFGDWqHnYihyf4TxR6L3vk%2Buj1Wu0aUXIQhcgQ3vgfsMdzyKbwMFMBEf3eC0QdECFydP3kV%2B2gtSVb6eQar6%2BL2wQk3fmP0R11kd%2FdJs9wV7ltvzLNnQ1EK7QvLpyk%2BTWY9g5gjbJu2olPVP0ltIr2b1iXFps6JAc5vaG1sbgUmxFPGizlM4zXF72n6IMdBfRiT2%2FQrQjkNLR9vs%2BQrBVKFvtb2K5UIZymAx0YaUEbjAK2qaxwJ2ycpG85%2Fh%2FC1H8tOMih5Fl1zAHXIdRukX27VSldnWWeHJruXOfV%2FVAp0W%2B4A7PMuENaNQgb9AI0K1JLKiZrekH26bLMx2VIwpvF8eu2U3ArfXch9PeMLc%2FrVlqGprSHYn8m8ZfSOILA1LPOiUfDdxQl0cLOMtE0vvuMDBgECeJEYcMdGQSXDZFn6N6JrJyLZutoXWv3YdfVpLlS%2FNm25bD98gJVsOTYzk3T798rKfX87Vu%2FGmGqsyvZsSaDKSjV7g14PMLHRAfGdNL3WA02QP94VUntCUEyBa%2FG%2Bsc3W2go3ql2x4XpdjTv2ykX3b3JNb%2FcmJl2zL9ua7R0w36c8L62okpW2el3RyjGGLT43Xf7M%2FzbOoQn4fWfeYrVqLnS%2FwmdFFIJlBIOVW%2FrUkfP2RMwnL6yeyECbZbDPsergNwVAH2h0nNRRHEO%2BRi7FOLrKSCDwXHhQe9eYS31UtR%2F8n0DPAoVINfDTXA%2F4j%2FH6GPVpu0Oditrlio6jOPIUAjC49aOpBjqZAcOCMibSUY7uxy7UuBPzCe9vnPU45wnB3leGBV9OwFnNzRQj1V8l6XThEWFkTtMJrdJ43qyuvH7VErS7pXyvGHWH%2Fyg5IobA5W2qzuseU%2BO8zVWXJM6YGvaX22%2BmRkDOEUwCxMgGfB%2BkpnJ2zpxsikudP5OJIC6dYi3Sf9PG6pLd3ki9tukLaRcxF8u3zWrSkYggTaoCb4uspg%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20231013T082916Z&X-Amz-SignedHeaders=host&X-Amz-Expires=36000&X-Amz-Credential=ASIATGEOL5AHXDYS72EB%2F20231013%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Signature=7901ea331533f363dc738448ec55e21434e3c38800a8b5adf456633576498923",
            "errors": []
        }
    ],
    "pullStatus": "FAILED"
}

Sample Response (Error)

{
    "workflowId": "8e55a104-05b3-4a38-ac8c-e72d087dfd5b",
    "status": "WORKFLOW_FAILED",
    "gstinStats": [
        {
            "gstin": "29AAFCD5862R000",
            "totalDocumentCount": 8,
            "validRows": 0,
            "invalidRows": 8
        }
    ],
    "reconStatus": {
        "status": "FAILURE",
        "reconResultsFileUrl": null,
        "reconResultsVendorFileUrl": null,
        "errors": [
            {
                "errorCode": "RECON_ALREADY_IN_PROGRESS_FOR_THIS_PAN",
                "errorMessage": "A recon triggered from UI is already in progress for this PAN. Please try after some time.",
                "errorField": null,
                "errorValues": null,
                "errorResolution": null
            }
        ]
    },
    "fileErrors": [
        {
            "inputFileName": "PR_V0_20230315_175920.xlsx",
            "status": "DATA_VALIDATION_ERROR",
            "errorFileUrl": "https://storage.clear.in/v1/ap-south-1/ingestionv2-staging/My%20Organis_PR_9c40e681c09d45a5a576d85c40f7be13_2023-03-15T14%3A29%3A03.293441.csv?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEDYaCmFwLXNvdXRoLTEiRzBFAiAxB%2BsOgz94s%2BUypY3Brn6bECoJ%2Fk33MXdb51Te0y8kOAIhAN03ORwQafvK5%2BWLpz7Vau9AfOnH%2FO0%2BBCbWnqhNV8I3KogFCO%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEQBRoMMjE5MzQxOTA3OTgzIgw1fEr3auf6RAIe3wcq3ARFHe0xK3q%2F515JRm2C8aKUVy2DZ%2B9ViK6AN%2FOb%2F7np27gq%2FJErf7T8XwlvwGUxpkyPrvHqd78mjWuxxdfn0wZuEjYSFY0YPv1MWnWhtoWqGId7KqTT4HNh8Xf45bzBxpcdurMMgTXUuEyhIFyxtt10EH1X5R3Jk%2FyHLh13eHPXEOX7CcJLdH5c4NeSdL06AhgSjCeJ1DMbhVfzmZuA6xECCHGEslLG51AYvuY0yaFC0JP%2Bov%2BNagnvmwyU7M66zznJ2FDtccEwNblkxbfPkPUtpI3oqbov%2B60nhAIWDLoLwe%2BGgTvQU8I8kbLf4hB3v24v9Xbe2d5KsEh1YHeGI0Xo0a%2FMw0WUdImSGvS1cIc4mG4bcex9FAEX0mIEOS3ypJZ3kTgpVX6s%2FvdiQ%2FwBkGqyhvdbkAQGKmleMk8FjMIpRnYOxWfISid3OqYiVpSof4gi%2FtZ9j8fK8Qh%2FLuAdRaSuDpem0C2fY%2FefVemE5Y4BVEi8CsEaIDtfu8qUPL5CcFv91gdLGPe%2B5X2pzlncySGwiNTg24oh%2B0o5Wqk2Vr4d8zGmVdabngJvm9oalNZh868OhJBpJF0%2B4x0XVtokFWW60Vz6gtd2k6yO2tyo6IfGIcD9GwLxTHFNt57dkvhFMQIdlTB%2FviYhOYwxNgvytj76fjGEVojiShemJLtSApnpTXZSkMX2IuzM7lRHILPuptKTzKxBbMxvvpcti2t%2FCjM950%2FpWUj3eGKo25gQda%2FHz9%2BaT5gLUchyKK4UA%2FL0QEP%2BoRduSSZc6gSWnXYUDkcYc3OonYaO2cR9SiAnMJyjx6AGOpoBnkAlzdzZBqRWzTeXi2sTgK2bkFf%2BLndkMY21QbIDvTVBtD%2FwDiUKALUYeIfXG18bzeNM1tbBur6t7r1q6PjBpuaagS4vz%2BOqLqyLrCOsR5ObcQ7Pd1ax1XxsaX6715iMacKHoLW3dcjc5hXcnEWRQk3HoxFnC%2FnAnbGVnjUpVuj4GaY%2BREkMf3cuhcLWtJvZn%2Bs9Rfc0Vpyz3Q%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230315T145456Z&X-Amz-SignedHeaders=host&X-Amz-Expires=36000&X-Amz-Credential=ASIATGEOL5AHTZNCNWVC%2F20230315%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Signature=107009968348c5f18fca2215cdcb21bce2df7c59ccc87d8466b0fac187937eab",
            "errors": []
        }
    ],
    "pullStatus": "FAILED"
}

API Validations

Currently there are no known validations.

API Constraints

Currently there are no known constraints.

PreviousTrigger Max ITC Workflow NextPostman Collection

Last updated 1 year ago

Was this helpful?