> ## 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 Invoice Status > Take actions and save new status for invoices in different sections on the IMS. #### Request body schema ## OpenAPI ````yaml api-reference/gst/compliance/openapi.json POST /gst/compliance/tax-payer/invoices/status/save 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/save: post: tags: - Taxpayer - Returns - Invoice Management System summary: Save Invoice Status operationId: saveInvoiceStatus parameters: - 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/SaveInvoiceStatusRequest' examples: 200 Invoice status save initiated: value: rtin: 24SHUBH3221U1Z1 reqtyp: SAVE invdata: b2b: - stin: 24MAYAS0100J1JD inum: b1 inv_typ: R action: A srcform: R1 rtnprd: '012023' idt: 23-01-2023 val: 1000 pos: '24' txval: 100 iamt: 20 camt: 20 samt: 20 cess: 0 prev_status: A remarks: Business to business changes b2ba: - oinum: ab2 oidt: 24-02-2023 stin: 24MAYAS0100J1JD rtnprd: '012023' inum: b1a action: A inv_typ: R srcform: R1 idt: 24-02-2023 val: 1000 pos: '07' txval: 100 iamt: 20 camt: 20 samt: 20 cess: 0 prev_status: A itcRedReq: 'Y' declIgst: 2000 declSgst: 500 declCgst: 500 declCess: 100 remarks: Business to business ammendment changes b2bdn: - stin: 24MAYAS0100J1JD nt_num: dn2 action: A inv_typ: R srcform: R1 rtnprd: '012023' nt_dt: 24-02-2023 val: 1000.1 pos: '07' txval: 1000.1 iamt: 20 camt: 20 samt: 20 cess: 0 prev_status: A remarks: Business to business debit changes b2bdna: - stin: 24MAYAS0100J1JD ont_num: ca2 ont_dt: 24-02-2023 nt_num: dn2 action: A inv_typ: R srcform: R1 rtnprd: '012023' nt_dt: 24-02-2023 val: 1000.1 pos: '07' txval: 1000.1 iamt: 20 camt: 20 samt: 20 cess: 0 prev_status: A itcRedReq: 'Y' declIgst: 2000 declSgst: 500 declCgst: 500 declCess: 100 remarks: Business to business debit ammendment changes b2bcn: - stin: 24MAYAS0100J1JD nt_num: dn2 action: A inv_typ: R srcform: R1 rtnprd: '012023' nt_dt: 24-02-2023 val: 1000.1 pos: '07' txval: 1000.1 iamt: 20 camt: 20 samt: 20 cess: 0 prev_status: A itcRedReq: 'Y' declIgst: 2000 declSgst: 500 declCgst: 500 declCess: 100 remarks: Business to business credit changes b2bcna: - stin: 24MAYAS0100J1JD ont_num: ca2 ont_dt: 24-02-2023 nt_num: dn2 action: A inv_typ: R srcform: R1 rtnprd: '012023' nt_dt: 24-02-2023 val: 1000.1 pos: '07' txval: 1000.1 iamt: 20 camt: 20 samt: 20 cess: 0 prev_status: A itcRedReq: 'Y' declIgst: 2000 declSgst: 500 declCgst: 500 declCess: 100 remarks: Business to business credit ammendment changes ecom: - stin: 24MAYAS0100J1JD rtnprd: '012023' inum: sd3 action: A srcform: R1 idt: 24-02-2023 val: 1000 pos: '07' txval: 1000 iamt: 20 camt: 20 samt: 20 cess: 0 prev_status: A remarks: E-com operator changes ecoma: - stin: 24MAYAS0100J1JD oinum: get5 oidt: 24-02-2023 rtnprd: '012023' inum: sd3 action: A srcform: R1 idt: 24-02-2023 val: 1000 pos: '07' txval: 1000 iamt: 20 camt: 20 samt: 20 cess: 0 prev_status: A itcRedReq: 'Y' declIgst: 2000 declSgst: 500 declCgst: 500 declCess: 100 remarks: E-com operator changes ammendment changes summary: 200 Invoice status save initiated required: true responses: '200': description: 200 Invoice status save initiated content: application/json: schema: $ref: '#/components/schemas/SaveInvoiceStatusResponse' examples: 200 Invoice status save initiated: summary: 200 Invoice status save initiated value: code: 200 data: status_cd: '1' data: reference_id: 0032e479bcb644c timestamp: 1763446641000 transaction_id: 0f7f60a2-862c-4a1b-b6b4-baa76c6faae6 headers: Connection: required: false description: '' schema: type: string example: keep-alive Content-Length: required: false description: '' schema: type: string example: '243' Date: required: false description: '' schema: type: string example: Tue, 06 May 2025 11:28:52 GMT X-RateLimit-Limit: required: false description: '' schema: type: string example: '120' X-RateLimit-Remaining: required: false description: '' schema: type: string example: '119' X-RateLimit-Reset: required: false description: '' schema: type: string example: '1746530992' access-control-allow-origin: required: false description: '' schema: type: string example: '*' vary: required: false description: '' schema: type: string example: Accept-Encoding x-amz-apigw-id: required: false description: '' schema: type: string example: KJLSHEcvhcwFWYg= x-amzn-Remapped-Connection: required: false description: '' schema: type: string example: keep-alive x-amzn-Remapped-Content-Length: required: false description: '' schema: type: string example: '243' x-amzn-Remapped-Date: required: false description: '' schema: type: string example: Tue, 06 May 2025 11:28:52 GMT x-amzn-RequestId: required: false description: '' schema: type: string example: 5036e263-b47c-472f-88a4-b6834a7a267a x-srv-span: required: false description: '' schema: type: string example: v=1;s=d2574faf86433da7 x-srv-trace: required: false description: '' schema: type: string example: v=1;t=eccaeff8c5f07e7f deprecated: false security: [] components: schemas: SaveInvoiceStatusRequest: type: object description: Public request body for Save Invoice Status. properties: rtin: type: string description: The rtin value provided in the request. reqtyp: type: string description: The reqtyp value provided in the request. invdata: type: object description: The invdata value provided in the request. properties: b2b: type: array description: The b2b value provided in the request. items: type: object properties: stin: type: string description: The stin value provided in the request. inum: type: string description: The inum value provided in the request. inv_typ: type: string description: The inv typ value provided in the request. action: type: string description: The action value provided in the request. srcform: type: string description: The srcform value provided in the request. rtnprd: type: string description: The rtnprd value provided in the request. idt: type: string description: The idt value provided in the request. val: type: integer description: The val value provided in the request. pos: type: string description: The pos value provided in the request. txval: type: integer description: The txval value provided in the request. iamt: type: integer description: The iamt value provided in the request. camt: type: integer description: The camt value provided in the request. samt: type: integer description: The samt value provided in the request. cess: type: integer description: The cess value provided in the request. prev_status: type: string description: The prev status value provided in the request. remarks: type: string description: The remarks value provided in the request. b2ba: type: array description: The b2ba value provided in the request. items: type: object properties: oinum: type: string description: The oinum value provided in the request. oidt: type: string description: The oidt value provided in the request. stin: type: string description: The stin value provided in the request. rtnprd: type: string description: The rtnprd value provided in the request. inum: type: string description: The inum value provided in the request. action: type: string description: The action value provided in the request. inv_typ: type: string description: The inv typ value provided in the request. srcform: type: string description: The srcform value provided in the request. idt: type: string description: The idt value provided in the request. val: type: integer description: The val value provided in the request. pos: type: string description: The pos value provided in the request. txval: type: integer description: The txval value provided in the request. iamt: type: integer description: The iamt value provided in the request. camt: type: integer description: The camt value provided in the request. samt: type: integer description: The samt value provided in the request. cess: type: integer description: The cess value provided in the request. prev_status: type: string description: The prev status value provided in the request. itcRedReq: type: string description: The itc Red Req value provided in the request. declIgst: type: integer description: The decl Igst value provided in the request. declSgst: type: integer description: The decl Sgst value provided in the request. declCgst: type: integer description: The decl Cgst value provided in the request. declCess: type: integer description: The decl Cess value provided in the request. remarks: type: string description: The remarks value provided in the request. b2bdn: type: array description: The b2bdn value provided in the request. items: type: object properties: stin: type: string description: The stin value provided in the request. nt_num: type: string description: The nt num value provided in the request. action: type: string description: The action value provided in the request. inv_typ: type: string description: The inv typ value provided in the request. srcform: type: string description: The srcform value provided in the request. rtnprd: type: string description: The rtnprd value provided in the request. nt_dt: type: string description: The nt dt value provided in the request. val: type: number description: The val value provided in the request. pos: type: string description: The pos value provided in the request. txval: type: number description: The txval value provided in the request. iamt: type: integer description: The iamt value provided in the request. camt: type: integer description: The camt value provided in the request. samt: type: integer description: The samt value provided in the request. cess: type: integer description: The cess value provided in the request. prev_status: type: string description: The prev status value provided in the request. remarks: type: string description: The remarks value provided in the request. b2bdna: type: array description: The b2bdna value provided in the request. items: type: object properties: stin: type: string description: The stin value provided in the request. ont_num: type: string description: The ont num value provided in the request. ont_dt: type: string description: The ont dt value provided in the request. nt_num: type: string description: The nt num value provided in the request. action: type: string description: The action value provided in the request. inv_typ: type: string description: The inv typ value provided in the request. srcform: type: string description: The srcform value provided in the request. rtnprd: type: string description: The rtnprd value provided in the request. nt_dt: type: string description: The nt dt value provided in the request. val: type: number description: The val value provided in the request. pos: type: string description: The pos value provided in the request. txval: type: number description: The txval value provided in the request. iamt: type: integer description: The iamt value provided in the request. camt: type: integer description: The camt value provided in the request. samt: type: integer description: The samt value provided in the request. cess: type: integer description: The cess value provided in the request. prev_status: type: string description: The prev status value provided in the request. itcRedReq: type: string description: The itc Red Req value provided in the request. declIgst: type: integer description: The decl Igst value provided in the request. declSgst: type: integer description: The decl Sgst value provided in the request. declCgst: type: integer description: The decl Cgst value provided in the request. declCess: type: integer description: The decl Cess value provided in the request. remarks: type: string description: The remarks value provided in the request. b2bcn: type: array description: The b2bcn value provided in the request. items: type: object properties: stin: type: string description: The stin value provided in the request. nt_num: type: string description: The nt num value provided in the request. action: type: string description: The action value provided in the request. inv_typ: type: string description: The inv typ value provided in the request. srcform: type: string description: The srcform value provided in the request. rtnprd: type: string description: The rtnprd value provided in the request. nt_dt: type: string description: The nt dt value provided in the request. val: type: number description: The val value provided in the request. pos: type: string description: The pos value provided in the request. txval: type: number description: The txval value provided in the request. iamt: type: integer description: The iamt value provided in the request. camt: type: integer description: The camt value provided in the request. samt: type: integer description: The samt value provided in the request. cess: type: integer description: The cess value provided in the request. prev_status: type: string description: The prev status value provided in the request. itcRedReq: type: string description: The itc Red Req value provided in the request. declIgst: type: integer description: The decl Igst value provided in the request. declSgst: type: integer description: The decl Sgst value provided in the request. declCgst: type: integer description: The decl Cgst value provided in the request. declCess: type: integer description: The decl Cess value provided in the request. remarks: type: string description: The remarks value provided in the request. b2bcna: type: array description: The b2bcna value provided in the request. items: type: object properties: stin: type: string description: The stin value provided in the request. ont_num: type: string description: The ont num value provided in the request. ont_dt: type: string description: The ont dt value provided in the request. nt_num: type: string description: The nt num value provided in the request. action: type: string description: The action value provided in the request. inv_typ: type: string description: The inv typ value provided in the request. srcform: type: string description: The srcform value provided in the request. rtnprd: type: string description: The rtnprd value provided in the request. nt_dt: type: string description: The nt dt value provided in the request. val: type: number description: The val value provided in the request. pos: type: string description: The pos value provided in the request. txval: type: number description: The txval value provided in the request. iamt: type: integer description: The iamt value provided in the request. camt: type: integer description: The camt value provided in the request. samt: type: integer description: The samt value provided in the request. cess: type: integer description: The cess value provided in the request. prev_status: type: string description: The prev status value provided in the request. itcRedReq: type: string description: The itc Red Req value provided in the request. declIgst: type: integer description: The decl Igst value provided in the request. declSgst: type: integer description: The decl Sgst value provided in the request. declCgst: type: integer description: The decl Cgst value provided in the request. declCess: type: integer description: The decl Cess value provided in the request. remarks: type: string description: The remarks value provided in the request. ecom: type: array description: The ecom value provided in the request. items: type: object properties: stin: type: string description: The stin value provided in the request. rtnprd: type: string description: The rtnprd value provided in the request. inum: type: string description: The inum value provided in the request. action: type: string description: The action value provided in the request. srcform: type: string description: The srcform value provided in the request. idt: type: string description: The idt value provided in the request. val: type: integer description: The val value provided in the request. pos: type: string description: The pos value provided in the request. txval: type: integer description: The txval value provided in the request. iamt: type: integer description: The iamt value provided in the request. camt: type: integer description: The camt value provided in the request. samt: type: integer description: The samt value provided in the request. cess: type: integer description: The cess value provided in the request. prev_status: type: string description: The prev status value provided in the request. remarks: type: string description: The remarks value provided in the request. ecoma: type: array description: The ecoma value provided in the request. items: type: object properties: stin: type: string description: The stin value provided in the request. oinum: type: string description: The oinum value provided in the request. oidt: type: string description: The oidt value provided in the request. rtnprd: type: string description: The rtnprd value provided in the request. inum: type: string description: The inum value provided in the request. action: type: string description: The action value provided in the request. srcform: type: string description: The srcform value provided in the request. idt: type: string description: The idt value provided in the request. val: type: integer description: The val value provided in the request. pos: type: string description: The pos value provided in the request. txval: type: integer description: The txval value provided in the request. iamt: type: integer description: The iamt value provided in the request. camt: type: integer description: The camt value provided in the request. samt: type: integer description: The samt value provided in the request. cess: type: integer description: The cess value provided in the request. prev_status: type: string description: The prev status value provided in the request. itcRedReq: type: string description: The itc Red Req value provided in the request. declIgst: type: integer description: The decl Igst value provided in the request. declSgst: type: integer description: The decl Sgst value provided in the request. declCgst: type: integer description: The decl Cgst value provided in the request. declCess: type: integer description: The decl Cess value provided in the request. remarks: type: string description: The remarks value provided in the request. SaveInvoiceStatusResponse: oneOf: - $ref: '#/components/schemas/SaveInvoiceStatusSuccessResponse' - $ref: '#/components/schemas/GstnBusinessErrorResponse' description: >- A GSTN success or GSTN business-failure response. Both variants use HTTP 200. SaveInvoiceStatusSuccessResponse: 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/SaveInvoiceStatusSuccessPayload' 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 SaveInvoiceStatusSuccessPayload: type: object description: Successful GSTN payload for Save Invoice Status. properties: reference_id: type: string description: The reference id value returned by GSTN. example: 0032e479bcb644c 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. ````