> ## Documentation Index > Fetch the complete documentation index at: https://developer.sandbox.co.in/llms.txt > Use this file to discover all available pages before exploring further. # Check Invoice Status > Fetch the status for save or reset invoice status action in real time. #### Response body schema ## OpenAPI ````yaml api-reference/gst/compliance/openapi.json GET /gst/compliance/tax-payer/invoices/status openapi: 3.0.1 info: title: compliance description: >- **GST Compliance API** enables businesses to automate compliance requirements like [Taxpayer verification](https://developer.sandbox.co.in/reference/search-gstin-api), [GSTR Filing](https://developer.sandbox.co.in/reference/gst-taxpayer-authentication), [Generating E-Invoices](https://developer.sandbox.co.in/reference/e-invoice-authentication-api), and [E-Way Bills](https://developer.sandbox.co.in/reference/e-way-bill-authentication-api).We provide these APIs from GSTN-authorised GST Suvidha Providers, handling the encryption-decryption and signing so you don't have to handle the complexities. version: 1.0.0 servers: - url: https://api.sandbox.co.in - url: https://test-api.sandbox.co.in security: [] tags: - name: Public - name: Taxpayer - name: Taxpayer Auth - name: Returns - name: GSTR-1 Documents - name: File GSTR-1 - name: GSTR-2A Documents - name: GSTR-2B Document - name: File GSTR-3B - name: GSTR-4 - name: File GSTR-9 - name: Invoice Management System - name: GSTR-1A Documents - name: File GSTR-1A - name: Ledgers - name: e-Invoice - name: Sales e-Invoices for return period - name: Purchase e-Invoices for return period - name: Front Office Notices - name: Front Office - name: AATO - name: e-Invoice1 - name: Authentication - name: e-Invoice12 - name: E-Way Bill - name: E-Way Bill1 - name: Authentication1 - name: Consignor - name: Consolidated E-Way Bill - name: Multi-Vehicle Movement - name: Consignee - name: Transporter - name: Consolidated E-Way Bill1 - name: Multi-vehicle Movement - name: Common paths: /gst/compliance/tax-payer/invoices/status: get: tags: - Taxpayer - Returns - Invoice Management System summary: Check Invoice Status operationId: checkInvoiceStatus parameters: - name: reference_id in: query description: Pass the reference id on taking Save or Reset action required: true schema: type: string example: '{{reference_id}}' - name: authorization in: header description: >- GST taxpayer access token. For token-generation steps, refer to the [Generate Taxpayer Session](/recipes/gst/authentication/generate_tax_payer_session) recipe, then pass the token in the authorization header. required: true example: '' schema: type: string - name: x-api-key in: header description: API key for identification required: true example: '' schema: type: string - name: x-api-version in: header description: API version required: false example: '' schema: type: string default: 1.0.0 responses: '200': description: >- 200 Save invoice status processed / 200 Save invoice status processed with error / IMSSAV005 Schema validation failure content: application/json: schema: $ref: '#/components/schemas/CheckInvoiceStatusResponse' examples: 200 Save invoice status processed: summary: 200 Save invoice status processed value: code: 200 data: status_cd: '1' data: err_cd: '' err_msg: '' proc_cnt: '8' status_cd: P transTypCd: SAV timestamp: 1763446641000 transaction_id: 619ed667-3bc3-4fc2-954c-340174e52a53 200 Save invoice status processed with error: summary: 200 Save invoice status processed with error value: code: 200 data: status_cd: '1' data: err_cd: '' err_cnt: '2' err_msg: '' error_report: b2b: - error_cd: IMSSAV0010 error_msg: >- Either previous action is incorrect/ invoice might have edited by supplier inv: - inum: invoice-b2b rtnprd: '042023' stin: 32TAAOA2947A1Z7 dn: - error_cd: IMSSAV0010 error_msg: >- Either previous action is incorrect/ invoice might have edited by supplier inv: - inum: invoice-dn rtnprd: '042023' stin: 32TAAOA2947A1Z7 proc_cnt: '10' status_cd: PE transTypCd: SAV timestamp: 1763446641000 transaction_id: 91e86ca1-c7eb-4ea4-b168-0932e56a1afc IMSSAV005 Schema validation failure: summary: IMSSAV005 Schema validation failure value: code: 200 data: status_cd: '1' data: err_cd: IMSSAV005 err_cnt: '0' err_msg: Schema validation failure proc_cnt: '0' status_cd: ER transTypCd: SAV timestamp: 1747049950040 transaction_id: 3f6a5200-d137-4ec3-a72d-b386e0efd166 headers: {} deprecated: false security: [] components: schemas: CheckInvoiceStatusResponse: oneOf: - $ref: '#/components/schemas/CheckInvoiceStatusSuccessResponse' - $ref: '#/components/schemas/GstnBusinessErrorResponse' description: >- A GSTN success or GSTN business-failure response. Both variants use HTTP 200. CheckInvoiceStatusSuccessResponse: allOf: - $ref: '#/components/schemas/TaxpayerResponseMetadata' - type: object required: - data properties: data: type: object description: The GSTN success wrapper. required: - status_cd - data properties: status_cd: type: string enum: - '1' description: GSTN success status. example: '1' data: $ref: '#/components/schemas/CheckInvoiceStatusSuccessPayload' GstnBusinessErrorResponse: type: object description: HTTP 200 response containing a GSTN business failure. required: - code - timestamp - transaction_id - data properties: code: type: integer description: The HTTP status code reported in the response body. enum: - 200 example: 200 timestamp: type: integer format: int64 description: The response timestamp in Unix epoch milliseconds. example: 1763446641000 transaction_id: type: string description: The transaction identifier used to trace the request. example: 41bb8041-fb83-4654-8d75-85a19f329158 data: type: object description: The GSTN business-failure wrapper. required: - status_cd - error properties: status_cd: type: string enum: - '0' description: GSTN business-failure status. example: '0' error: $ref: '#/components/schemas/GstnBusinessError' TaxpayerResponseMetadata: type: object description: Fields included in every taxpayer endpoint response. required: - code - timestamp - transaction_id properties: code: type: integer description: The HTTP status code reported in the response body. enum: - 200 example: 200 timestamp: type: integer format: int64 description: The response timestamp in Unix epoch milliseconds. example: 1763446641000 transaction_id: type: string description: The transaction identifier used to trace the request. example: 41bb8041-fb83-4654-8d75-85a19f329158 CheckInvoiceStatusSuccessPayload: type: object description: Successful GSTN payload for Check Invoice Status. properties: status_cd: type: string description: Status of the request transTypCd: type: string description: Transaction type code proc_cnt: type: string description: Count of processed records minimum: 0 err_cnt: type: string description: Count of errored records minimum: 0 err_cd: type: string description: Error code err_msg: type: string description: Error message error_report: type: object description: The error report value returned by GSTN. properties: b2b: type: array description: The b2b value returned by GSTN. items: type: object properties: stin: type: string description: The stin value returned by GSTN. error_cd: type: string description: The error cd value returned by GSTN. error_msg: type: string description: The error msg value returned by GSTN. inv: type: array description: The inv value returned by GSTN. items: type: object properties: inum: type: string description: The inum value returned by GSTN. rtnprd: type: string description: The rtnprd value returned by GSTN. b2ba: type: array description: The b2ba value returned by GSTN. items: type: object properties: stin: type: string description: The stin value returned by GSTN. error_cd: type: string description: The error cd value returned by GSTN. error_msg: type: string description: The error msg value returned by GSTN. inv: type: array description: The inv value returned by GSTN. items: type: object properties: inum: type: string description: The inum value returned by GSTN. rtnprd: type: string description: The rtnprd value returned by GSTN. b2bdn: type: array description: The b2bdn value returned by GSTN. items: type: object properties: stin: type: string description: The stin value returned by GSTN. error_cd: type: string description: The error cd value returned by GSTN. error_msg: type: string description: The error msg value returned by GSTN. inv: type: array description: The inv value returned by GSTN. items: type: object properties: inum: type: string description: The inum value returned by GSTN. rtnprd: type: string description: The rtnprd value returned by GSTN. b2bdna: type: array description: The b2bdna value returned by GSTN. items: type: object properties: stin: type: string description: The stin value returned by GSTN. error_cd: type: string description: The error cd value returned by GSTN. error_msg: type: string description: The error msg value returned by GSTN. inv: type: array description: The inv value returned by GSTN. items: type: object properties: inum: type: string description: The inum value returned by GSTN. rtnprd: type: string description: The rtnprd value returned by GSTN. b2bcn: type: array description: The b2bcn value returned by GSTN. items: type: object properties: stin: type: string description: The stin value returned by GSTN. error_cd: type: string description: The error cd value returned by GSTN. error_msg: type: string description: The error msg value returned by GSTN. inv: type: array description: The inv value returned by GSTN. items: type: object properties: inum: type: string description: The inum value returned by GSTN. rtnprd: type: string description: The rtnprd value returned by GSTN. b2bcna: type: array description: The b2bcna value returned by GSTN. items: type: object properties: stin: type: string description: The stin value returned by GSTN. error_cd: type: string description: The error cd value returned by GSTN. error_msg: type: string description: The error msg value returned by GSTN. inv: type: array description: The inv value returned by GSTN. items: type: object properties: inum: type: string description: The inum value returned by GSTN. rtnprd: type: string description: The rtnprd value returned by GSTN. ecom: type: array description: The ecom value returned by GSTN. items: type: object properties: stin: type: string description: The stin value returned by GSTN. error_cd: type: string description: The error cd value returned by GSTN. error_msg: type: string description: The error msg value returned by GSTN. inv: type: array description: The inv value returned by GSTN. items: type: object properties: inum: type: string description: The inum value returned by GSTN. rtnprd: type: string description: The rtnprd value returned by GSTN. ecoma: type: array description: The ecoma value returned by GSTN. items: type: object properties: stin: type: string description: The stin value returned by GSTN. error_cd: type: string description: The error cd value returned by GSTN. error_msg: type: string description: The error msg value returned by GSTN. inv: type: array description: The inv value returned by GSTN. items: type: object properties: inum: type: string description: The inum value returned by GSTN. rtnprd: type: string description: The rtnprd value returned by GSTN. dn: type: array description: The dn value returned by GSTN. example: - error_cd: IMSSAV0010 error_msg: >- Either previous action is incorrect/ invoice might have edited by supplier inv: - inum: invoice-dn rtnprd: '042023' stin: 32TAAOA2947A1Z7 items: type: object properties: error_cd: type: string description: The error cd value returned by GSTN. example: IMSSAV0010 error_msg: type: string description: The error msg value returned by GSTN. example: >- Either previous action is incorrect/ invoice might have edited by supplier inv: type: array description: The inv value returned by GSTN. example: - inum: invoice-dn rtnprd: '042023' items: type: object properties: inum: type: string description: The inum value returned by GSTN. example: invoice-dn rtnprd: type: string description: The rtnprd value returned by GSTN. example: '042023' stin: type: string description: The stin value returned by GSTN. example: 32TAAOA2947A1Z7 GstnBusinessError: type: object description: A business error returned by GSTN. required: - error_cd - message properties: error_cd: type: string description: The GSTN business error code. example: RET11416 message: type: string description: A human-readable description of the GSTN business error. example: No records found. ````