> ## 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.

# Save GSTR-3B

> Authenticated tax payer can save entire GSTR-3B by uploading json to GST portal

#### Request body schema

<Card title="View request body schema" icon="file-spreadsheet" href="https://raw.githubusercontent.com/in-co-sandbox/in-co-sandbox-docs/refs/heads/main/data/gst/schema/workbook/taxpayer/gstr-3b/save-v6.0.xlsx" arrow="true" horizontal />


## OpenAPI

````yaml api-reference/gst/compliance/openapi.json POST /gst/compliance/tax-payer/gstrs/gstr-3b/{year}/{month}
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/gstrs/gstr-3b/{year}/{month}:
    post:
      tags:
        - Taxpayer
        - Returns
        - File GSTR-3B
      summary: Save GSTR-3B
      description: >-
        Authenticated tax payer can save entire GSTR-3B by uploading json to GST
        portal
      operationId: saveGstr3b
      parameters:
        - name: year
          in: path
          description: ''
          required: true
          example: ''
          schema:
            type: string
        - name: month
          in: path
          description: ''
          required: true
          example: ''
          schema:
            type: string
        - 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-version
          in: header
          description: API version
          required: false
          example: ''
          schema:
            type: string
            default: 1.0.0
        - name: x-api-key
          in: header
          description: API key for identification
          required: true
          example: ''
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SaveGstr3bRequest'
            examples:
              200 Success:
                value:
                  inward_sup:
                    isup_details:
                      - intra: 0
                        ty: GST
                        inter: 0
                      - intra: 0
                        ty: NONGST
                        inter: 0
                  sup_details:
                    osup_nil_exmp:
                      txval: 0
                    osup_nongst:
                      txval: 0
                    osup_zero:
                      csamt: 0
                      iamt: 0
                      txval: 0
                    osup_det:
                      samt: 0
                      csamt: 0
                      camt: 0
                      iamt: 0
                      txval: 0
                    isup_rev:
                      samt: 0
                      csamt: 0
                      camt: 0
                      iamt: 0
                      txval: 0
                  intr_ltfee:
                    intr_details:
                      csamt: 0
                      samt: 0
                      camt: 0
                      iamt: 0
                  inter_sup:
                    comp_details: []
                    uin_details: []
                    unreg_details: []
                  itc_elg:
                    itc_avl:
                      - samt: 0
                        csamt: 0
                        camt: 0
                        ty: IMPG
                        iamt: 0
                      - samt: 0
                        csamt: 0
                        camt: 0
                        ty: IMPS
                        iamt: 0
                      - samt: 0
                        csamt: 0
                        camt: 0
                        ty: ISRC
                        iamt: 0
                      - samt: 0
                        csamt: 0
                        camt: 0
                        ty: ISD
                        iamt: 0
                      - samt: 0
                        csamt: 0
                        camt: 0
                        ty: OTH
                        iamt: 0
                    itc_rev:
                      - csamt: 0
                        samt: 0
                        camt: 0
                        ty: RUL
                        iamt: 0
                      - csamt: 0
                        samt: 0
                        camt: 0
                        ty: OTH
                        iamt: 0
                    itc_net:
                      csamt: 0
                      samt: 0
                      camt: 0
                      iamt: 0
                    itc_inelg:
                      - csamt: 0
                        samt: 0
                        camt: 0
                        ty: RUL
                        iamt: 0
                      - csamt: 0
                        samt: 0
                        camt: 0
                        ty: OTH
                        iamt: 0
                summary: 200 Success
              RT-R3BQ1004 GSTR-1 not filed:
                value:
                  inward_sup:
                    isup_details:
                      - intra: 0
                        ty: GST
                        inter: 0
                      - intra: 0
                        ty: NONGST
                        inter: 0
                  sup_details:
                    osup_nil_exmp:
                      txval: 0
                    osup_nongst:
                      txval: 0
                    osup_zero:
                      csamt: 0
                      iamt: 0
                      txval: 0
                    osup_det:
                      samt: 0
                      csamt: 0
                      camt: 0
                      iamt: 0
                      txval: 0
                    isup_rev:
                      samt: 0
                      csamt: 0
                      camt: 0
                      iamt: 0
                      txval: 0
                  intr_ltfee:
                    intr_details:
                      csamt: 0
                      samt: 0
                      camt: 0
                      iamt: 0
                  inter_sup:
                    comp_details: []
                    uin_details: []
                    unreg_details: []
                  itc_elg:
                    itc_avl:
                      - samt: 0
                        csamt: 0
                        camt: 0
                        ty: IMPG
                        iamt: 0
                      - samt: 0
                        csamt: 0
                        camt: 0
                        ty: IMPS
                        iamt: 0
                      - samt: 0
                        csamt: 0
                        camt: 0
                        ty: ISRC
                        iamt: 0
                      - samt: 0
                        csamt: 0
                        camt: 0
                        ty: ISD
                        iamt: 0
                      - samt: 0
                        csamt: 0
                        camt: 0
                        ty: OTH
                        iamt: 0
                    itc_rev:
                      - csamt: 0
                        samt: 0
                        camt: 0
                        ty: RUL
                        iamt: 0
                      - csamt: 0
                        samt: 0
                        camt: 0
                        ty: OTH
                        iamt: 0
                    itc_net:
                      csamt: 0
                      samt: 0
                      camt: 0
                      iamt: 0
                    itc_inelg:
                      - csamt: 0
                        samt: 0
                        camt: 0
                        ty: RUL
                        iamt: 0
                      - csamt: 0
                        samt: 0
                        camt: 0
                        ty: OTH
                        iamt: 0
                summary: RT-R3BQ1004 GSTR-1 not filed
        required: true
      responses:
        '200':
          description: 200 Success / RT-R3BQ1004 GSTR-1 not filed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SaveGstr3bResponse'
              examples:
                200 Success:
                  summary: 200 Success
                  value:
                    code: 200
                    data:
                      status_cd: '1'
                      data:
                        reference_id: ab2b2eae-974d-40e2-a721-8c4987af92d0
                    timestamp: 1763446641000
                    transaction_id: a43cfcd6-9a48-4be9-82fd-0816070999db
                RT-R3BQ1004 GSTR-1 not filed:
                  summary: RT-R3BQ1004 GSTR-1 not filed
                  value:
                    code: 200
                    data:
                      status_cd: '0'
                      error:
                        error_cd: RT-R3BQ1004
                        message: >-
                          You have not filed GSTR-1 of the selected tax period.
                          Please file the same to enable filing of GSTR-3B.
                    timestamp: 1763446641000
                    transaction_id: b830e36f-696a-445f-bece-d0a0be5e8c02
          headers: {}
      deprecated: false
      security: []
components:
  schemas:
    SaveGstr3bRequest:
      type: object
      description: JSON raw body
      properties:
        inward_sup:
          type: object
          description: The inward sup value provided in the request.
          properties:
            isup_details:
              type: array
              description: The isup details value provided in the request.
              items:
                type: object
                properties:
                  intra:
                    type: integer
                    description: The intra value provided in the request.
                  ty:
                    type: string
                    description: The ty value provided in the request.
                  inter:
                    type: integer
                    description: The inter value provided in the request.
        sup_details:
          type: object
          description: The sup details value provided in the request.
          properties:
            osup_nil_exmp:
              type: object
              description: The osup nil exmp value provided in the request.
              properties:
                txval:
                  type: integer
                  description: The txval value provided in the request.
            osup_nongst:
              type: object
              description: The osup nongst value provided in the request.
              properties:
                txval:
                  type: integer
                  description: The txval value provided in the request.
            osup_zero:
              type: object
              description: The osup zero value provided in the request.
              properties:
                csamt:
                  type: integer
                  description: The csamt value provided in the request.
                iamt:
                  type: integer
                  description: The iamt value provided in the request.
                txval:
                  type: integer
                  description: The txval value provided in the request.
            osup_det:
              type: object
              description: The osup det value provided in the request.
              properties:
                samt:
                  type: integer
                  description: The samt value provided in the request.
                csamt:
                  type: integer
                  description: The csamt value provided in the request.
                camt:
                  type: integer
                  description: The camt value provided in the request.
                iamt:
                  type: integer
                  description: The iamt value provided in the request.
                txval:
                  type: integer
                  description: The txval value provided in the request.
            isup_rev:
              type: object
              description: The isup rev value provided in the request.
              properties:
                samt:
                  type: integer
                  description: The samt value provided in the request.
                csamt:
                  type: integer
                  description: The csamt value provided in the request.
                camt:
                  type: integer
                  description: The camt value provided in the request.
                iamt:
                  type: integer
                  description: The iamt value provided in the request.
                txval:
                  type: integer
                  description: The txval value provided in the request.
        intr_ltfee:
          type: object
          description: The intr ltfee value provided in the request.
          properties:
            intr_details:
              type: object
              description: The intr details value provided in the request.
              properties:
                csamt:
                  type: integer
                  description: The csamt value provided in the request.
                samt:
                  type: integer
                  description: The samt value provided in the request.
                camt:
                  type: integer
                  description: The camt value provided in the request.
                iamt:
                  type: integer
                  description: The iamt value provided in the request.
        inter_sup:
          type: object
          description: The inter sup value provided in the request.
          properties:
            comp_details:
              type: array
              description: >-
                A list that can be empty; record fields depend on the return
                section.
              items:
                $ref: '#/components/schemas/Gstr3bInterStateSupply'
            uin_details:
              type: array
              description: >-
                A list that can be empty; record fields depend on the return
                section.
              items:
                $ref: '#/components/schemas/Gstr3bInterStateSupply'
            unreg_details:
              type: array
              description: >-
                A list that can be empty; record fields depend on the return
                section.
              items:
                $ref: '#/components/schemas/Gstr3bInterStateSupply'
        itc_elg:
          type: object
          description: The itc elg value provided in the request.
          properties:
            itc_avl:
              type: array
              description: The itc avl value provided in the request.
              items:
                type: object
                properties:
                  samt:
                    type: integer
                    description: The samt value provided in the request.
                  csamt:
                    type: integer
                    description: The csamt value provided in the request.
                  camt:
                    type: integer
                    description: The camt value provided in the request.
                  ty:
                    type: string
                    description: The ty value provided in the request.
                  iamt:
                    type: integer
                    description: The iamt value provided in the request.
            itc_rev:
              type: array
              description: The itc rev value provided in the request.
              items:
                type: object
                properties:
                  samt:
                    type: integer
                    description: The samt value provided in the request.
                  csamt:
                    type: integer
                    description: The csamt value provided in the request.
                  camt:
                    type: integer
                    description: The camt value provided in the request.
                  ty:
                    type: string
                    description: The ty value provided in the request.
                  iamt:
                    type: integer
                    description: The iamt value provided in the request.
            itc_net:
              type: object
              description: The itc net value provided in the request.
              properties:
                csamt:
                  type: integer
                  description: The csamt value provided in the request.
                samt:
                  type: integer
                  description: The samt value provided in the request.
                camt:
                  type: integer
                  description: The camt value provided in the request.
                iamt:
                  type: integer
                  description: The iamt value provided in the request.
            itc_inelg:
              type: array
              description: The itc inelg value provided in the request.
              items:
                type: object
                properties:
                  samt:
                    type: integer
                    description: The samt value provided in the request.
                  csamt:
                    type: integer
                    description: The csamt value provided in the request.
                  camt:
                    type: integer
                    description: The camt value provided in the request.
                  ty:
                    type: string
                    description: The ty value provided in the request.
                  iamt:
                    type: integer
                    description: The iamt value provided in the request.
    SaveGstr3bResponse:
      oneOf:
        - $ref: '#/components/schemas/SaveGstr3bSuccessResponse'
        - $ref: '#/components/schemas/GstnBusinessErrorResponse'
      description: >-
        A GSTN success or GSTN business-failure response. Both variants use HTTP
        200.
    Gstr3bInterStateSupply:
      type: object
      description: Inter-state supply totals for a place of supply.
      properties:
        pos:
          type: string
          description: Place-of-supply state or Union Territory code.
        txval:
          type: number
          description: Taxable value.
        iamt:
          type: number
          description: Integrated tax amount.
    SaveGstr3bSuccessResponse:
      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/SaveGstr3bSuccessPayload'
    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
    SaveGstr3bSuccessPayload:
      type: object
      description: Successful GSTN payload for Save Gstr3b.
      properties:
        reference_id:
          type: string
          description: The reference id value returned by GSTN.
          example: ab2b2eae-974d-40e2-a721-8c4987af92d0
    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.

````