> ## 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. # Get Invoices > Fetch the invoices for different sections with their respective status in real time. #### Response body schema ## OpenAPI ````yaml api-reference/gst/compliance/openapi.json GET /gst/compliance/tax-payer/invoices openapi: 3.0.1 info: title: in-co-sandbox-gst-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: get: tags: - Taxpayer - Returns - Invoice Management System summary: Get Invoices operationId: getInvoices parameters: - name: section in: query description: >- Section of the transaction. Possible values: B2B, B2BA, CN, CNA, DN, DNA, ECOM, ECOMA required: true schema: type: string default: b2b example: '{{section}}' - name: status in: query description: >- Optional filter to fetch invoices of specific status. Possible values: accepted, rejected, pending, no_action_taken required: false schema: type: string example: no_action_taken - 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 B2B Invoices / 200 B2B Accepted Invoices content: application/json: schema: $ref: '#/components/schemas/GetInvoicesResponse' examples: 200 B2B Accepted Invoices: summary: 200 B2B Accepted Invoices value: code: 200 data: status_cd: '1' data: b2b: - action: A camt: 10883.91 cess: 0 hash: >- dbd0f1c65631f9fdbfd3ab8d56c2949c3354b688ea53dee44e42768c07b676e2 iamt: 0 idt: 05-11-2024 inum: AO2SA2425002517 inv_typ: R ispendactblocked: 'N' pos: '24' rtnprd: '112024' samt: 10883.91 srcfilstatus: Not Filed srcform: R1 stin: 24ABCCU0123M1YZ txval: 120932.18 val: 142700 timestamp: 1763446641000 transaction_id: fd976f56-b9a9-4012-9504-a351b1f2b7fa 200 B2B Invoices: summary: 200 B2B Invoices value: code: 200 data: status_cd: '1' data: b2b: - action: 'N' camt: 0 cess: 0 hash: >- 5614d4073380ec8b4ed4613846b18d18d5ee7ce4727e5f5a4d238fe96aaf8600 iamt: 288 idt: 02-11-2024 inum: '1024250260344' inv_typ: R ispendactblocked: 'N' pos: '24' rtnprd: '112024' samt: 0 srcfilstatus: Not Filed srcform: R1 stin: 33ABCCZ0123M2YZ txval: 1600 val: 1888 - action: 'N' camt: 0 cess: 0 hash: >- c5e0ba76b757d78b441a6b419118b44f0777cfe939abe5559fe3d088ce715d1e iamt: 397.44 idt: 31-10-2024 inum: '5096411148' inv_typ: R ispendactblocked: 'N' pos: '24' rtnprd: '102024' samt: 0 srcfilstatus: Filed srcform: R1 stin: 06ABCCG0123D1YZ txval: 2208 val: 2605.44 - action: 'N' camt: 30.59 cess: 0 hash: >- 9662a16203363ad199a8ed76bd90601002438db7927350c4cd8a715c1d76b674 iamt: 0 idt: 16-10-2024 inum: AMD2-1463535 inv_typ: R ispendactblocked: 'N' pos: '24' rtnprd: '102024' samt: 30.59 srcfilstatus: Filed srcform: R1 stin: 24ABCCC0123E1YZ txval: 339.84 val: 401.02 - action: 'N' camt: 258.6 cess: 0 hash: >- ab52176cfb3c7ea983838c9f9cf702752b37851b699825785b135d62f00e9aba iamt: 0 idt: 13-11-2024 inum: AMD2-3993079 inv_typ: R ispendactblocked: 'N' pos: '24' rtnprd: '112024' samt: 258.6 srcfilstatus: Not Filed srcform: R1 stin: 24ABCCR0123M1YZ txval: 2873.53 val: 3390.73 - action: A camt: 10883.91 cess: 0 hash: >- dbd0f1c65631f9fdbfd3ab8d56c2949c3354b688ea53dee44e42768c07b676e2 iamt: 0 idt: 05-11-2024 inum: AO2SA2425002517 inv_typ: R ispendactblocked: 'N' pos: '24' rtnprd: '112024' samt: 10883.91 srcfilstatus: Not Filed srcform: R1 stin: 24ABCCU0123M1YZ txval: 120932.18 val: 142700 - action: 'N' camt: 648.16 cess: 0 hash: >- 907abd1862e141926d6c8dfa2df1b5c8be3120bc71eebfcbdb26d8b08b4bb0bd iamt: 0 idt: 05-11-2024 inum: C24E242500143276 inv_typ: R ispendactblocked: 'N' pos: '24' rtnprd: '112024' samt: 648.16 srcfilstatus: Not Filed srcform: R1 stin: 24ABCCI0123G1YZ txval: 7201.8 val: 8498.12 - action: 'N' camt: 0 cess: 0 hash: >- c4b056cd71d63c2984da8f5f85f35e6532978d8bce1381a2ef9958ce7002bc95 iamt: 18.76 idt: 13-11-2024 inum: IN-21576 inv_typ: R ispendactblocked: 'N' pos: '24' rtnprd: '112024' samt: 0 srcfilstatus: Not Filed srcform: R1 stin: 08ABCPP0123E2YZ txval: 375.24 val: 394 - action: 'N' camt: 198.31 cess: 0 hash: >- 4355e6c758ea876ea7981ccf2fe4d7de4546ad63cfcc2f7f04779583d4bb207b iamt: 0 idt: 08-11-2024 inum: IT/24-25/978 inv_typ: R ispendactblocked: 'N' pos: '24' rtnprd: '112024' samt: 198.31 srcfilstatus: Not Filed srcform: R1 stin: 24ABCFI0123L1YZ txval: 2203.39 val: 2600 - action: 'N' camt: 0 cess: 0 hash: >- 4ce89032a00c068641b9e188c2a041be1416adb0c145d2a53a3af401a4bce95a iamt: 27 idt: 19-11-2024 inum: LE/25/1/07976 inv_typ: R ispendactblocked: 'N' pos: '24' rtnprd: '112024' samt: 0 srcfilstatus: Not Filed srcform: R1 stin: 06ABCCG0123M1YZ txval: 150 val: 177 - action: 'N' camt: 0 cess: 0 hash: >- 4562950e81948d6c2a295d8a83f3f3c4687fe5e53fef4eba0a4390d6f24744b6 iamt: 49.36 idt: 16-10-2024 inum: OI-30587/24-25 inv_typ: R ispendactblocked: 'N' pos: '24' rtnprd: '102024' samt: 0 srcfilstatus: Filed srcform: R1 stin: 32ABCPM0123R1YZ txval: 408.79 val: 458.15 - action: 'N' camt: 2181.36 cess: 0 hash: >- bfb71f250650a449db0073b838f9e821c26c87f67f91dd03c85c2b9656d96b9f iamt: 0 idt: 17-10-2024 inum: PRN-1050 inv_typ: R ispendactblocked: 'N' pos: '24' rtnprd: '102024' samt: 2181.36 srcfilstatus: Filed srcform: R1 stin: 24ABCFG0123H1YZ txval: 24237.29 val: 28600 - action: 'N' camt: 152.54 cess: 0 hash: >- 8d0187738366d5a26d81ac75a716d293d4ab799d51aafea7af57348715b0b265 iamt: 0 idt: 25-10-2024 inum: PRN-1094 inv_typ: R ispendactblocked: 'N' pos: '24' rtnprd: '102024' samt: 152.54 srcfilstatus: Filed srcform: R1 stin: 24ABCFG0123H1YZ txval: 1694.92 val: 2000 timestamp: 1763446641000 transaction_id: 661cc68b-0e48-4d39-a744-9afd56895340 headers: {} deprecated: false security: [] components: schemas: GetInvoicesResponse: oneOf: - $ref: '#/components/schemas/GetInvoicesSuccessResponse' - $ref: '#/components/schemas/GstnBusinessErrorResponse' description: >- A GSTN success or GSTN business-failure response. Both variants use HTTP 200. GetInvoicesSuccessResponse: 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/GetInvoicesSuccessPayload' 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 GetInvoicesSuccessPayload: type: object description: Successful GSTN payload for Get Invoices. properties: b2b: type: array description: The b2b value returned by GSTN. items: type: object properties: stin: type: string description: GSTIN of supplier minLength: 15 maxLength: 15 rtnprd: type: string description: Return period of invoice srcform: type: string description: Invoice source form enum: - R1 - R1A - IFF inum: type: string description: Invoice Number minLength: 1 maxLength: 16 idt: type: string description: Invoice Date minLength: 1 inv_typ: type: string description: Invoice Type enum: - R - DE - SEWP - SEWOP - CBW action: type: string description: Action taken by recipient enum: - A - R - P - 'N' pos: type: string description: Place of Supply minLength: 2 maxLength: 2 ispendactblocked: type: string description: Is pending action allowed for recipient enum: - 'N' - 'Y' srcfilstatus: type: string description: Supplier filing status enum: - Filed - Not Filed hash: type: string description: Check sum of the invoice minLength: 1 maxLength: 64 val: type: number description: Invoice Value minimum: 0 maximum: 9999999999999.99 txval: type: number description: Taxable value minimum: 0 maximum: 99999999999.99 iamt: type: number description: iamt minimum: 0 maximum: 99999999999.99 camt: type: number description: camt minimum: 0 maximum: 99999999999.99 samt: type: number description: samt minimum: 0 maximum: 99999999999.99 cess: type: number description: cess minimum: 0 maximum: 99999999999.99 b2ba: type: array description: The b2ba value returned by GSTN. items: type: object properties: stin: type: string description: GSTIN of supplier minLength: 15 maxLength: 15 rtnprd: type: string description: Return period of invoice srcform: type: string description: Invoice source form enum: - R1 - R1A - IFF inum: type: string description: Invoice Number minLength: 1 maxLength: 16 oinum: type: string description: original invoice number minLength: 1 maxLength: 16 idt: type: string description: Invoice Date minLength: 1 oidt: type: string description: original invoice date minLength: 1 inv_typ: type: string description: Invoice Type enum: - R - DE - SEWP - SEWOP - CBW action: type: string description: Action taken by recipient enum: - A - R - P - 'N' pos: type: string description: Place of Supply minLength: 2 maxLength: 2 srcfilstatus: type: string description: Supplier filing status enum: - Filed - Not Filed hash: type: string description: Check sum of the invoice minLength: 1 maxLength: 64 ispendactblocked: type: string description: Is pending action allowed for recipient enum: - 'N' - 'Y' val: type: number description: Invoice Value minimum: 0 maximum: 9999999999999.99 txval: type: number description: Taxable value minimum: 0 maximum: 99999999999.99 iamt: type: number description: iamt minimum: 0 maximum: 99999999999.99 camt: type: number description: camt minimum: 0 maximum: 99999999999.99 samt: type: number description: samt minimum: 0 maximum: 99999999999.99 cess: type: number description: cess minimum: 0 maximum: 99999999999.99 b2bdn: type: array description: The b2bdn value returned by GSTN. items: type: object properties: stin: type: string description: GSTIN of supplier minLength: 15 maxLength: 15 rtnprd: type: string description: Return period of invoice srcform: type: string description: Invoice source form enum: - R1 - R1A - IFF nt_num: type: string description: Note Number minLength: 1 maxLength: 16 nt_dt: type: string description: Note Date minLength: 1 inv_typ: type: string description: Invoice Type enum: - R - DE - SEWP - SEWOP - CBW action: type: string description: Action taken by recipient enum: - A - R - P - 'N' pos: type: string description: Place of Supply minLength: 2 maxLength: 2 srcfilstatus: type: string description: Supplier filing status enum: - Filed - Not Filed hash: type: string description: Check sum of the invoice minLength: 1 maxLength: 64 ispendactblocked: type: string description: Is pending action allowed for recipient enum: - 'N' - 'Y' val: type: number description: Invoice Value minimum: 0 maximum: 9999999999999.99 txval: type: number description: Taxable value minimum: 0 maximum: 99999999999.99 iamt: type: number description: iamt minimum: 0 maximum: 99999999999.99 camt: type: number description: camt minimum: 0 maximum: 99999999999.99 samt: type: number description: samt minimum: 0 maximum: 99999999999.99 cess: type: number description: cess minimum: 0 maximum: 99999999999.99 b2bdna: type: array description: The b2bdna value returned by GSTN. items: type: object properties: stin: type: string description: GSTIN of supplier minLength: 15 maxLength: 15 rtnprd: type: string description: Return period of invoice srcform: type: string description: Invoice source form enum: - R1 - R1A - IFF nt_num: type: string description: Note Number minLength: 1 maxLength: 16 ont_num: type: string description: old note number minLength: 1 maxLength: 16 nt_dt: type: string description: Note Date minLength: 1 ont_dt: type: string description: old note date minLength: 1 inv_typ: type: string description: Invoice Type enum: - R - DE - SEWP - SEWOP - CBW pos: type: string description: Place of Supply minLength: 2 maxLength: 2 srcfilstatus: type: string description: Supplier filing status enum: - Filed - Not Filed hash: type: string description: Check sum of the invoice minLength: 1 maxLength: 64 ispendactblocked: type: string description: Is pending action allowed for recipient enum: - 'N' - 'Y' action: type: string description: Action taken by recipient enum: - A - R - P - 'N' val: type: number description: Invoice Value minimum: 0 maximum: 9999999999999.99 txval: type: number description: Taxable value minimum: 0 maximum: 99999999999.99 iamt: type: number description: iamt minimum: 0 maximum: 99999999999.99 camt: type: number description: camt minimum: 0 maximum: 99999999999.99 samt: type: number description: samt minimum: 0 maximum: 99999999999.99 cess: type: number description: cess minimum: 0 maximum: 99999999999.99 b2bcn: type: array description: The b2bcn value returned by GSTN. items: type: object properties: stin: type: string description: GSTIN of supplier minLength: 15 maxLength: 15 rtnprd: type: string description: Return period of invoice srcform: type: string description: Invoice source form enum: - R1 - R1A - IFF nt_num: type: string description: Note Number minLength: 1 maxLength: 16 nt_dt: type: string description: Note Date minLength: 1 inv_typ: type: string description: Invoice Type enum: - R - DE - SEWP - SEWOP - CBW action: type: string description: Action taken by recipient enum: - A - R - P - 'N' pos: type: string description: Place of Supply minLength: 2 maxLength: 2 srcfilstatus: type: string description: Supplier filing status enum: - Filed - Not Filed hash: type: string description: Check sum of the invoice minLength: 1 maxLength: 64 ispendactblocked: type: string description: Is pending action allowed for recipient enum: - 'N' - 'Y' val: type: number description: Invoice Value minimum: 0 maximum: 9999999999999.99 txval: type: number description: Taxable value minimum: 0 maximum: 99999999999.99 iamt: type: number description: iamt minimum: 0 maximum: 99999999999.99 camt: type: number description: camt minimum: 0 maximum: 99999999999.99 samt: type: number description: samt minimum: 0 maximum: 99999999999.99 cess: type: number description: cess minimum: 0 maximum: 99999999999.99 b2bcna: type: array description: The b2bcna value returned by GSTN. items: type: object properties: stin: type: string description: GSTIN of supplier minLength: 15 maxLength: 15 rtnprd: type: string description: Return period of invoice srcform: type: string description: Invoice source form enum: - R1 - R1A - IFF nt_num: type: string description: Note Number minLength: 1 maxLength: 16 ont_num: type: string description: old note number minLength: 1 maxLength: 16 nt_dt: type: string description: Note Date minLength: 1 ont_dt: type: string description: old note date minLength: 1 inv_typ: type: string description: Invoice Type enum: - R - DE - SEWP - SEWOP - CBW pos: type: string description: Place of Supply minLength: 2 maxLength: 2 srcfilstatus: type: string description: Supplier filing status enum: - Filed - Not Filed hash: type: string description: Check sum of the invoice minLength: 1 maxLength: 64 ispendactblocked: type: string description: Is pending action allowed for recipient enum: - 'N' - 'Y' action: type: string description: Action taken by recipient enum: - A - R - P - 'N' val: type: number description: Invoice Value minimum: 0 maximum: 9999999999999.99 txval: type: number description: Taxable value minimum: 0 maximum: 99999999999.99 iamt: type: number description: iamt minimum: 0 maximum: 99999999999.99 camt: type: number description: camt minimum: 0 maximum: 99999999999.99 samt: type: number description: samt minimum: 0 maximum: 99999999999.99 cess: type: number description: cess minimum: 0 maximum: 99999999999.99 ecom: type: array description: The ecom value returned by GSTN. items: type: object properties: stin: type: string description: GSTIN of supplier minLength: 15 maxLength: 15 rtnprd: type: string description: Return period of invoice srcform: type: string description: Invoice source form enum: - R1 - R1A - IFF inum: type: string description: Document Number minLength: 1 maxLength: 16 idt: type: string description: Document Date minLength: 1 pos: type: string description: Place of Supply minLength: 2 maxLength: 2 srcfilstatus: type: string description: Supplier filing status enum: - Filed - Not Filed hash: type: string description: Check sum of the invoice minLength: 1 maxLength: 64 ispendactblocked: type: string description: Is pending action allowed for recipient enum: - 'N' - 'Y' action: type: string description: Action taken by recipient enum: - A - R - P - 'N' val: type: number description: Document Value minimum: 0 maximum: 9999999999999.99 txval: type: number description: Taxable value minimum: 0 maximum: 99999999999.99 iamt: type: number description: iamt minimum: 0 maximum: 99999999999.99 camt: type: number description: camt minimum: 0 maximum: 99999999999.99 samt: type: number description: samt minimum: 0 maximum: 99999999999.99 cess: type: number description: cess minimum: 0 maximum: 99999999999.99 ecoma: type: array description: The ecoma value returned by GSTN. items: type: object properties: stin: type: string description: GSTIN of supplier minLength: 15 maxLength: 15 rtnprd: type: string description: Return period of invoice srcform: type: string description: Invoice source form enum: - R1 - R1A - IFF inum: type: string description: Document Number minLength: 1 maxLength: 16 oinum: type: string description: old document number minLength: 1 maxLength: 16 idt: type: string description: Document Date minLength: 1 oidt: type: string description: old document date minLength: 1 pos: type: string description: Place of Supply minLength: 2 maxLength: 2 srcfilstatus: type: string description: Supplier filing status enum: - Filed - Not Filed hash: type: string description: Check sum of the invoice minLength: 1 maxLength: 64 action: type: string description: Action taken by recipient enum: - A - R - P - 'N' ispendactblocked: type: string description: Is pending action allowed for recipient enum: - 'N' - 'Y' val: type: number description: Document Value minimum: 0 maximum: 9999999999999.99 txval: type: number description: Taxable value minimum: 0 maximum: 99999999999.99 iamt: type: number description: iamt minimum: 0 maximum: 99999999999.99 camt: type: number description: camt minimum: 0 maximum: 99999999999.99 samt: type: number description: samt minimum: 0 maximum: 99999999999.99 cess: type: number description: cess minimum: 0 maximum: 99999999999.99 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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.