{ "openapi": "3.1.0", "info": { "title": "Octa GST API", "version": "1.0.0", "description": "# Octa – API Integration\n\nOcta GST is a cloud-based, high-performance, and scalable GST compliance platform. It provides a rich set of APIs that\nenable ERPs and other systems to seamlessly integrate and automate a wide range of GST interactions and operations.\n\nThe following APIs are available for ERP integration:\n\n- [GSTR-2A APIs](https://octagst.com/octa/docs/api/gstr2a/introduction)\n- [GSTR-2B APIs](https://octagst.com/octa/docs/api/gstr2b/introduction)\n- [GSTR-3B APIs](https://octagst.com/octa/docs/api/gstr3b/introduction)\n- [Robot APIs](https://octagst.com/octa/docs/api/robot/introduction)\n- [E-Invoice & E-Waybill APIs](https://octagst.com/octa/docs/api/einvoice/introduction)\n\nThe Octa API provides secure, JSON-based REST endpoints that allow seamless integration with any modern programming\nlanguage or framework. Designed for flexibility and scalability, it enables developers to connect directly with Octa GST\nservices for tasks such as generating e-invoices & e-waybills, getting GSTIN registration information, retrieving\nreturns data and compliance data. With a single base URL and consistent request/response formats, the Octa API ensures a\nsimple, reliable, and developer-friendly experience.\n\nAll APIs can be accessed using the following base URL:\n\n```\nhttps://cloud.octagst.com/api/...\n```\n\nA machine-readable description of these APIs is available as an\n[OpenAPI specification](https://octagst.com/openapi.json).\n\n## Authentication\n\nAPI authentication is done using the http `basic` authentication. This is done using the `Authorization` http header in\nthe request. This header can be constructed as follows:\n\n- The **Key Id** and **Key Secret** are combined with a single colon `:`\n- The resulting string is encoded in byte array using UTF-8 encoding\n- The resulting string is encoded in base64 string\n- The resulting string is prefixed with the authorization method `Basic`\n\nFor example, consider the following **Key Id** and **Key Secret**:\n\n| | |\n| ---------- | ---------------------- |\n| Key Id | `z639031917648473675` |\n| Key Secret | `jTr7QLiwleNqMuiQaDtz` |\n\nHeader Value = Base64(`z639031917648473675:jTr7QLiwleNqMuiQaDtz`) \nHeader Value = `ejYzOTAzMTkxNzY0ODQ3MzY3NTpqVHI3UUxpd2xlTnFNdWlRYUR0eg==`\n\nTherefore, the `Authorization` http header would be:\n\n```\nAuthorization: Basic ejYzOTAzMTkxNzY0ODQ3MzY3NTpqVHI3UUxpd2xlTnFNdWlRYUR0eg==\n```\n\nRefer to the next section for instructions on how to generate your **Key Id** and **Key Secret**.\n\n## Generate API Key\n\n- Login to [Octa GST](https://cloud.octagst.com)\n- Go to the **API Keys** page (check the buttons on the top).\n- Click on **New Key** button, accept the confirmation. This will generate a new API Key and display on screen. This key\n will be displayed only once. So please copy the **Key Id** and **Key Secret** shown on the screen.\n- This **Key Id** and **Key Secret** can be configured in the ERP (or any other external system) to access Octa APIs.\n\n## Using an API\n\nDepending on the endpoint, the Octa API supports either `GET` or `POST` HTTP methods. All requests follow standard HTTP\nconventions. For authentication, every request must include the `Authorization` header. Additional headers may be\nrequired based on the specific API being called, as detailed in the documentation for each endpoint.\n\n## Error Handling\n\nWhen an API request cannot be processed successfully, Octa provides a clear error response to help you diagnose and fix\nthe issue quickly.\n\n- Standard HTTP status codes: Any code in the 4xx or 5xx range indicates an error.\n- Octa-specific error details: Additional information is returned in the response headers:\n - `Octa-ErrorCode`: A unique code identifying the type of error. (Refer\n [Octa Error Codes](https://octagst.com/octa/docs/api/overview/error-codes))\n - `Octa-ErrorMessage`: A descriptive message explaining the reason for the failure.\n\n## Fair Use\n\nTo protect Octa GST from abuse and ensure fair usage, the system may enforce rate limits. When a rate limit is exceeded,\nthe API will respond with the HTTP status code:\n\n```\n429 Too Many Requests\n```\n\nIn this case, clients should implement **delays with exponential back-off** before retrying the request. This helps\nprevent repeated failures and ensures compliance with Octa’s fair use policy.\n\n## Check API Usage\n\nYou can check the summary of your API usage and current API balance anytime on Octa app:\n\n- Login to [Octa GST](https://cloud.octagst.com)\n- Go to the **API Usage** page (check the buttons on the top).\n- Select a month to check the API usage summary in that month.\n- Your current API balance will be displayed in the top.", "termsOfService": "https://octagst.com/terms-of-use", "contact": { "name": "Octa GST Support", "url": "https://octagst.com/contact", "email": "support@octagst.com" } }, "externalDocs": { "description": "Octa GST API documentation", "url": "https://octagst.com/octa/docs/api" }, "servers": [ { "url": "https://cloud.octagst.com" } ], "security": [ { "basicAuth": [] } ], "tags": [ { "name": "Public", "description": "This API is used to get details of GSTIN.", "externalDocs": { "url": "https://octagst.com/octa/docs/api/public/get-gstin" } }, { "name": "GSTR-2A", "description": "This section introduces the JSON-based APIs provided by Octa for automating workflows with **GSTR-2A data**. These APIs\nallow you to seamlessly fetch the latest data from the Government portal, export it, and download updated GSTR-2A\nrecords, enabling faster, more reliable, and fully automated compliance processes.\n\n## Company Header\n\nAll GSTR-2A APIs require the following HTTP header to identify the company you want to work on.\n\n```\nOcta-Company: \n```\n\n`Company-ID` must be specified exactly as displayed in Octa (e.g. `oc-xxx`).\n\n## How to find Company ID?\n\nYou can use the following steps to find your company ID:\n\n- Login to [Octa GST](https://cloud.octagst.com)\n- On the home page, find the company you want to use for APIs\n- Click on the **Information** button, this will display company information\n- Check the **Company ID**", "externalDocs": { "url": "https://octagst.com/octa/docs/api/gstr2a/introduction" } }, { "name": "GSTR-2B", "description": "This section introduces the JSON-based APIs provided by Octa for automating workflows with **GSTR-2B data**. These APIs\nallow you to fetch the latest data from the Government portal, export it, and download updated GSTR-2B records,\nenabling faster, more reliable, and fully automated compliance processes.\n\n## Company Header\n\nAll GSTR-2B APIs require the following HTTP header to identify the company you want to work on.\n\n```\nOcta-Company: \n```\n\n`Company-ID` must be specified exactly as displayed in Octa (e.g. `oc-xxx`).\n\n## How to find Company ID?\n\nYou can use the following steps to find your company ID:\n\n- Login to [Octa GST](https://cloud.octagst.com)\n- On the home page, find the company you want to use for APIs\n- Click on the **Information** button, this will display company information\n- Check the **Company ID**", "externalDocs": { "url": "https://octagst.com/octa/docs/api/gstr2b/introduction" } }, { "name": "GSTR-3B", "description": "This section introduces the JSON-based APIs provided by Octa for automating workflows with **GSTR-3B data**. These APIs\nallow you to fetch filed GSTR-3B data from the Government portal, export it, and download the resulting Excel file,\nenabling faster and more reliable compliance workflows.\n\n## Company Header\n\nAll GSTR-3B APIs require the following HTTP header to identify the company you want to work on.\n\n```\nOcta-Company: \n```\n\n`Company-ID` must be specified exactly as displayed in Octa (e.g. `oc-xxx`).\n\n## How to find Company ID?\n\nYou can use the following steps to find your company ID:\n\n- Login to [Octa GST](https://cloud.octagst.com)\n- On the home page, find the company you want to use for APIs\n- Click on the **Information** button, this will display company information\n- Check the **Company ID**", "externalDocs": { "url": "https://octagst.com/octa/docs/api/gstr3b/introduction" } }, { "name": "Robot", "description": "This section describes the JSON-based APIs provided by Octa for monitoring background jobs. Using these APIs, you can\ntrack the progress of a job and download the results once it has completed.\n\nThe following APIs are available in this section:\n\n- [JobStatus](https://octagst.com/octa/docs/api/robot/job-status)", "externalDocs": { "url": "https://octagst.com/octa/docs/api/robot/introduction" } }, { "name": "E-Invoice & E-WayBills", "description": "This section outlines the JSON-based APIs provided by Octa to help you automate your e-invoicing workflows, including\nthe generation, retrieval, and cancellation of e-invoices & e-waybills.\n\n## Abbreviations & References\n\n| Term | Description |\n| -------------------------------------------------------------------- | ---------------------------------------------------------------------------- |\n| IRN | Invoice Reference Number |\n| IRP | Invoice Registration Portal |\n| [Base64 encoding](https://en.wikipedia.org/wiki/Base64) | Method of encoding binary data in printable string |\n| [Base64 URL encoding](https://tools.ietf.org/html/rfc4648#section-5) | Method of encoding binary data in printable string using URL safe characters |\n| [e-Invoice Sandbox (NIC)](https://einv-apisandbox.nic.in) | NIC portal of e-invoice application development |\n\n## Configuration\n\nBefore using the e-invoice and e-waybill APIs, you must complete a one-time account configuration:\n\n1. Generate API credentials from the NIC e-Invoice Portal.\n2. Configure these credentials in your Octa account.\n\nOnce this setup is complete, you can begin using Octa’s e-invoicing and e-waybill APIs.\n\n Keep your NIC API credentials secure. These credentials are directly linked to your GSTIN, and any misuse could impact\n your compliance obligations.\n\n### Step-1: Create API users on Govt e-Invoice Portal\n\n **OTP Required**: Govt e-Invoice Portal will send an OTP to the registered mobile number. This OTP is required to\n generate the API username/password. You will get the OTP on the mobile number which is registered on Govt GST Portal.\n\n- Login to [Govt e-invoice portal](https://einvoice1.gst.gov.in)\n- Goto **API Registration** → **User Credentials** → **Create API User**. System will send an OTP to registered mobile\n number. Enter the OTP to continue.\n- Select the option **Through GSP**\n- Select GSP: **Blowbits Solutions LLP**\n- Select the API username and password\n- Click **Submit**\n- Repeat the process for **Alankit Limited** GSP also.\n\n **Service Availability**: We are configuring two API users so that even if one GSP is down, e-invoice services can\n continue without any interruptions.\n\n### Step-2: Configure API users in Octa\n\n- Login to [Octa GST](https://cloud.octagst.com). If you don't have an account, please contact us for your account\n creation.\n- Open the company/GSTIN you want to use for e-invoicing/e-waybills. If the company is not available in Octa, you can\n add it on the **Home** page. Simply click on the **Add Company** button, enter your GSTIN and create the company.\n- Click on the **Settings** button in the left bar (in the bottom left corner).\n- In the **GSTIN Settings** section:\n - Click on the **E-Invoice Configuration** button and enter the company details.\n - Click on the **E-Invoice Credentials** button and add the API credentials you generated on Govt E-Invoice Portal\n (generated in Step-1).\n\nThis document defines the error codes returned e-invoice APIs payload.\n\n## NIC Error Codes\n\nPlease visit NIC developer sites to know more about API errors.\n\n[NIC e-Invoice Developer Portal →](https://einv-apisandbox.nic.in/api-error-codes-list.html)\n\n[NIC e-WayBill Developer Portal →](https://docs.ewaybillgst.gov.in/apidocs/api-error-codes-list.html)\n\n## Octa Error Codes\n\n| Error Code | Description |\n| ---------- | -------------------------------------------------- |\n| OCTA-001 | Invalid seller GSTIN |\n| OCTA-002 | Invalid seller legal name |\n| OCTA-003 | Invalid seller trade name |\n| OCTA-004 | Invalid seller address-1 |\n| OCTA-005 | Invalid seller address-2 |\n| OCTA-006 | Invalid seller location |\n| OCTA-007 | Invalid seller pincode |\n| OCTA-008 | Invalid seller state code |\n| OCTA-009 | Invalid Seller phone no |\n| OCTA-010 | Invalid Seller email |\n| OCTA-011 | Invalid tax scheme |\n| OCTA-012 | Invalid supply type |\n| OCTA-013 | Invalid document type |\n| OCTA-014 | Invalid document no |\n| OCTA-015 | Invalid document date |\n| OCTA-016 | Invalid reverse charge |\n| OCTA-017 | Invalid place of supply |\n| OCTA-018 | Invalid IGST on intra state supply |\n| OCTA-019 | Invalid E-commerce GSTIN |\n| OCTA-020 | Invalid remarks |\n| OCTA-021 | Invalid buyer GSTIN |\n| OCTA-022 | Invalid buyer legal name |\n| OCTA-023 | Invalid buyer trade name |\n| OCTA-024 | Invalid buyer address-1 |\n| OCTA-025 | Invalid buyer address-2 |\n| OCTA-026 | Invalid buyer location |\n| OCTA-027 | Invalid buyer pincode |\n| OCTA-028 | Invalid buyer state code |\n| OCTA-029 | Invalid buyer phone no |\n| OCTA-030 | Invalid buyer email |\n| OCTA-031 | Invalid dispatch entity name |\n| OCTA-032 | Invalid dispatch address-1 |\n| OCTA-033 | Invalid dispatch address-2 |\n| OCTA-034 | Invalid dispatch location |\n| OCTA-035 | Invalid dispatch pincode |\n| OCTA-036 | Invalid dispatch state code |\n| OCTA-037 | Invalid ShipTo GSTIN |\n| OCTA-038 | Invalid ShipTo legal name |\n| OCTA-039 | Invalid ShipTo trade name |\n| OCTA-040 | Invalid ShipTo address-1 |\n| OCTA-041 | Invalid ShipTo address-2 |\n| OCTA-042 | Invalid ShipTo location |\n| OCTA-043 | Invalid ShipTo pincode |\n| OCTA-044 | Invalid ShipTo state code |\n| OCTA-045 | Invalid shipping bill no |\n| OCTA-046 | Invalid shipping bill date |\n| OCTA-047 | Invalid port code |\n| OCTA-048 | Invalid country code |\n| OCTA-049 | Invalid currency code |\n| OCTA-050 | Invalid document value in foreign currency |\n| OCTA-051 | Invalid claim refund |\n| OCTA-052 | Invalid discount |\n| OCTA-053 | Invalid other charges |\n| OCTA-054 | Invalid round off amount |\n| OCTA-055 | Invalid document value |\n| OCTA-056 | Invalid item no |\n| OCTA-057 | Invalid item description |\n| OCTA-058 | Invalid HSN |\n| OCTA-059 | Invalid quantity |\n| OCTA-060 | Invalid free quantity |\n| OCTA-061 | Invalid unit price |\n| OCTA-062 | Invalid item gross value |\n| OCTA-063 | Invalid item discount |\n| OCTA-064 | Invalid pre tax value |\n| OCTA-065 | Invalid item taxable value |\n| OCTA-066 | Invalid GST rate |\n| OCTA-067 | Invalid item IGST |\n| OCTA-068 | Invalid item CGST |\n| OCTA-069 | Invalid item SGST |\n| OCTA-070 | Invalid cess rate |\n| OCTA-071 | Invalid cess amount |\n| OCTA-072 | Invalid Cess Non Advol |\n| OCTA-073 | Invalid state cess rate |\n| OCTA-074 | Invalid state cess amount |\n| OCTA-075 | Invalid state Cess Non Advol |\n| OCTA-076 | Invalid item other charges |\n| OCTA-077 | Invalid item total |\n| OCTA-078 | Invalid barcode |\n| OCTA-079 | Invalid product serial no |\n| OCTA-080 | Invalid order line reference |\n| OCTA-081 | Invalid origin country |\n| OCTA-082 | Invalid item attributes |\n| OCTA-083 | Invalid batch name/number |\n| OCTA-084 | Invalid batch expiry date |\n| OCTA-085 | Invalid batch warranty date |\n| OCTA-086 | Invalid transporter id |\n| OCTA-087 | Invalid transporter name |\n| OCTA-088 | Invalid distance |\n| OCTA-089 | Invalid transport mode |\n| OCTA-090 | Invalid transport document no |\n| OCTA-091 | Invalid transport document date |\n| OCTA-092 | Invalid vehicle number |\n| OCTA-093 | Invalid vehicle type |\n| OCTA-094 | Invalid payee name |\n| OCTA-095 | Invalid bank account no |\n| OCTA-096 | Invalid branch IFSC code |\n| OCTA-097 | Invalid payment mode |\n| OCTA-098 | Invalid payment terms |\n| OCTA-099 | Invalid payment instructions |\n| OCTA-100 | Invalid credit transfer terms |\n| OCTA-101 | Invalid direct debit terms |\n| OCTA-102 | Invalid credit days |\n| OCTA-103 | Invalid amount paid |\n| OCTA-104 | Invalid amount due |\n| OCTA-105 | Invalid document period start date |\n| OCTA-106 | Invalid document period end date |\n| OCTA-107 | Invalid preceding document no |\n| OCTA-108 | Invalid preceding document date |\n| OCTA-109 | Invalid preceding document other reference |\n| OCTA-110 | Invalid receipt advice no |\n| OCTA-111 | Invalid receipt advice date |\n| OCTA-112 | Invalid contract reference no |\n| OCTA-113 | Invalid tender batch/lot reference no |\n| OCTA-114 | Invalid other reference no |\n| OCTA-115 | Invalid project reference no |\n| OCTA-116 | Invalid PO reference no |\n| OCTA-117 | Invalid PO reference date |\n| OCTA-118 | Invalid supporting document URL |\n| OCTA-119 | Invalid supporting document contents |\n| OCTA-120 | Invalid supporting document additional information |\n| OCTA-121 | Invalid UQC (unit quantity code) |\n| OCTA-151 | Business GSTIN not found |\n| OCTA-152 | Invalid GSTIN |\n| OCTA-153 | Invalid IRN |\n| OCTA-154 | IRN already cancelled |\n| OCTA-155 | e-Waybill not allowed |\n| OCTA-156 | Active e-Waybill found |\n| OCTA-157 | Invalid e-Waybill no |\n| OCTA-158 | e-Waybill not found |\n| OCTA-159 | Invalid reason code |\n| OCTA-200 | API account not configured |\n| OCTA-201 | Network session failed |\n| OCTA-202 | Http session error |\n| OCTA-203 | Application error |\n| OCTA-204 | GSP error |\n| OCTA-205 | GSTN error |\n| OCTA-206 | GSTN IRP error |\n| OCTA-207 | GSTN e-Waybill error |\n| OCTA-208 | Network error |\n| OCTA-209 | Account blocked |\n| OCTA-210 | Low wallet balance |\n| OCTA-211 | Service disabled |\n| OCTA-300 | Invalid request |\n| OCTA-301 | Record not found |\n| OCTA-302 | Subscription expired |", "externalDocs": { "url": "https://octagst.com/octa/docs/api/einvoice/introduction" } } ], "paths": { "/api/octa/gst/getgstin": { "get": { "operationId": "publicGetGstin", "summary": "Get GSTIN", "description": "This API is used to get details of GSTIN.", "tags": [ "Public" ], "externalDocs": { "url": "https://octagst.com/octa/docs/api/public/get-gstin" }, "parameters": [ { "name": "gstin", "in": "query", "required": true, "description": "GSTIN whose details to be fetched", "schema": { "type": "string" } } ], "responses": { "200": { "description": "**GSTIN Registration Types**\n\n- Regular\n- Composition\n- SEZ Developer\n- SEZ Unit\n- Tax Collector (Electronic Commerce Operator)\n- Tax Deductor\n- Input Service Distributor (ISD)\n- Casual Taxable Person\n- Consulate or Embassy of Foreign Country\n- United Nation Body\n- Non Resident Online Services Provider\n- Non Resident Taxable Person\n- Other Notified Person\n- Other Notified Persons\n- Temporary\n\n**GSTIN Status**\n\n- Active\n- Active pending Verification\n- Suspended\n- Cancelled\n- Inactive\n- Provisional\n\nResponse payload will contains the success status along with GSTIN information.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean", "description": "`true` in case of success, `false` if failure" }, "Gstin": { "type": "string" }, "Pan": { "type": "string" }, "TradeName": { "type": "string" }, "LegalName": { "type": "string" }, "RegistrationDate": { "type": "string" }, "BizEntityType": { "type": "string" }, "TaxPayerType": { "type": "string" }, "TaxPayerStatus": { "type": "string" }, "StateJurisdictionCode": { "type": "string" }, "StateJurisdiction": { "type": "string" }, "CenterJurisdictionCode": { "type": "string" }, "CenterJurisdiction": { "type": "string" }, "BusinessActivities": { "type": "array", "items": { "type": "string" } }, "EinvoiceStatus": { "type": "string" }, "LastUpdateDate": { "type": "string" }, "PrincipalAddr": { "type": "object", "properties": { "DoorNo": { "type": "string" }, "FloorNo": { "type": "string" }, "BuildingName": { "type": "string" }, "Street": { "type": "string" }, "Location": { "type": "string" }, "District": { "type": "string" }, "StateName": { "type": "string" }, "StateCode": { "type": "string" }, "PinCode": { "type": "string" }, "GeoCodeLevel": { "type": "string" }, "Longitude": { "type": "string" }, "Lattitude": { "type": "string" } } }, "AdditionalAddr": { "type": "array", "items": { "type": "object", "properties": { "DoorNo": { "type": "string" }, "BuildingName": { "type": "string" }, "Street": { "type": "string" }, "Locality": { "type": "string" }, "Location": { "type": "string" }, "District": { "type": "string" }, "StateName": { "type": "string" }, "StateCode": { "type": "string" }, "PinCode": { "type": "string" }, "GeoCodeLevel": { "type": "string" }, "Longitude": { "type": "string" }, "Lattitude": { "type": "string" }, "BusinessActivities": { "type": "string" }, "FloorNo": { "type": "string" } } } }, "Result": { "type": "object", "properties": { "Gstin": { "type": "string", "description": "Taxpayer GSTIN" }, "Pan": { "type": "string", "description": "Taxpayer PAN" }, "LegalName": { "type": "string", "description": "Legal Name of Business" }, "TradeName": { "type": "string", "description": "Trade Name" }, "RegistrationDate": { "type": "string", "description": "Date of registration `YYYY-MM-DD`" }, "BizEntityType": { "type": "string", "description": "Business entity type" }, "TaxPayerType": { "type": "string", "description": "Tax Payer Type – Refer GSTIN Registration Types" }, "TaxPayerStatus": { "type": "string", "description": "Tax Payer Status – Refer GSTIN Status" }, "CancellationDate": { "type": "string", "description": "Cancellation date `YYYY-MM-DD`" }, "StateJurisdictionCode": { "type": "string", "description": "State jurisdiction Code" }, "StateJurisdiction": { "type": "string", "description": "State jurisdiction details" }, "CenterJurisdictionCode": { "type": "string", "description": "Center Jurisdiction Code" }, "CenterJurisdiction": { "type": "string", "description": "Center jurisdiction details" }, "BusinessActivities": { "type": "array", "items": { "type": "string" }, "description": "List of business activities" }, "EinvoiceStatus": { "type": "string", "description": "Status of e-invoice enablement" }, "LastUpdateDate": { "type": "string", "description": "Last update date of GSTIN record `YYYY-MM-DD`" }, "PrincipalAddr": { "type": "object", "properties": { "DoorNo": { "type": "string", "description": "Door number" }, "FloorNo": { "type": "string", "description": "Floor No" }, "BuildingName": { "type": "string", "description": "Building name" }, "Street": { "type": "string", "description": "Street name" }, "Landmark": { "type": "string", "description": "Landmark" }, "Locality": { "type": "string", "description": "Area Locality" }, "Location": { "type": "string", "description": "Location" }, "City": { "type": "string", "description": "City name" }, "District": { "type": "string", "description": "District name" }, "StateName": { "type": "string", "description": "State name" }, "StateCode": { "type": "string", "description": "State code" }, "PinCode": { "type": "string", "description": "Pin Code" }, "GeoCodeLevel": { "type": "string", "description": "Level of geo coding of address" }, "Longitude": { "type": "string", "description": "Longitude" }, "Lattitude": { "type": "string", "description": "Lattitude" }, "BusinessActivities": { "type": "string", "description": "Nature of business activities on this address" } }, "description": "This object contains the primary address of business entity" }, "AdditionalAddr": { "type": "array", "items": { "type": "object", "properties": { "DoorNo": { "type": "string", "description": "Door number" }, "FloorNo": { "type": "string", "description": "Floor No" }, "BuildingName": { "type": "string", "description": "Building name" }, "Street": { "type": "string", "description": "Street name" }, "Landmark": { "type": "string", "description": "Landmark" }, "Locality": { "type": "string", "description": "Area Locality" }, "Location": { "type": "string", "description": "Location" }, "City": { "type": "string", "description": "City name" }, "District": { "type": "string", "description": "District name" }, "StateName": { "type": "string", "description": "State name" }, "StateCode": { "type": "string", "description": "State code" }, "PinCode": { "type": "string", "description": "Pin Code" }, "GeoCodeLevel": { "type": "string", "description": "Level of geo coding of address" }, "Longitude": { "type": "string", "description": "Longitude" }, "Lattitude": { "type": "string", "description": "Lattitude" }, "BusinessActivities": { "type": "string", "description": "Nature of business activities on this address" } } }, "description": "List of additional addresses" } }, "description": "Contains information of GSTIN – in case of success" }, "Errors": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string", "description": "Error code" }, "Message": { "type": "string", "description": "Error message" } } }, "description": "Contains information of errors – in case of failure" }, "Suggestions": { "type": "array", "items": { "type": "object", "properties": { "Gstin": { "type": "string", "description": "Taxpayer GSTIN" }, "LegalName": { "type": "string", "description": "Legal Name of Business" }, "TradeName": { "type": "string", "description": "Trade Name" }, "StateName": { "type": "string", "description": "State Name" }, "StateCode": { "type": "string", "description": "State Code" } } }, "description": "Contains suggestions - in case of failure" } } }, "example": { "Success": true, "Gstin": "19AAACN0757G1ZI", "Pan": "AAACN0757G", "TradeName": "NESTLE INDIA LTD", "LegalName": "NESTLE INDIA LIMITED", "RegistrationDate": "2017-07-01", "BizEntityType": "Public Limited Company", "TaxPayerType": "Regular", "TaxPayerStatus": "Active", "StateJurisdictionCode": "WB065", "StateJurisdiction": "LARGE TAXPAYER UNIT", "CenterJurisdictionCode": "WA1006", "CenterJurisdiction": "RANGE-VI", "BusinessActivities": [ "Warehouse / Depot", "Office / Sale Office" ], "EinvoiceStatus": "Yes", "LastUpdateDate": "2025-12-08", "PrincipalAddr": { "DoorNo": "Tower-A, Block-AF", "FloorNo": "9th Floor", "BuildingName": "RDB Primarc Techno Park LLP", "Street": "8, Major Arterial Road", "Location": "New Town", "District": "North Twenty Four Parganas", "StateName": "West Bengal", "StateCode": "19", "PinCode": "700163", "GeoCodeLevel": "Building", "Longitude": "88.448403775692", "Lattitude": "22.583213533074986" }, "AdditionalAddr": [ { "DoorNo": "Khatian No. 371 Daag No. 338 -551 New- J.L.No.- 057", "FloorNo": "Marda Marketing Services", "BuildingName": "Premises at- Maa Ambe Infrastructure Pvt. Ltd.", "Street": "Mouza Nemai Khaprail Road", "Location": "Matigara", "District": "Darjeeling", "StateName": "West Bengal", "StateCode": "19", "PinCode": "734010", "GeoCodeLevel": "NA", "BusinessActivities": "Warehouse / Depot" }, { "DoorNo": "Daag Nos. 3097, 3098, 3099 & 3100", "FloorNo": "A/C. ProConnect Supply Chain Solutions Ltd.", "BuildingName": "Shivshambho Construction P Ltd &Sanatanaya Warehousing P Ltd", "Street": "Mouza Belumilki Jl no 7, PS - Serampore", "Location": "Belumilki", "District": "Hooghly", "StateName": "West Bengal", "StateCode": "19", "PinCode": "712223", "GeoCodeLevel": "pincode", "Longitude": "88.289052", "Lattitude": "22.788999", "BusinessActivities": "Office / Sale Office, Warehouse / Depot" }, { "DoorNo": "L.R Plot No.168, L.R Khatian No.2075", "BuildingName": "Premises at- Maa Ambe Infrastructure Pvt. Ltd.", "Street": "Mouza Nemai, J.L No.57", "Locality": "Matigara", "Location": "Siliguri", "District": "Darjeeling", "StateName": "West Bengal", "StateCode": "19", "PinCode": "734010", "GeoCodeLevel": "pincode", "Longitude": "88.3856960000001", "Lattitude": "26.71995", "BusinessActivities": "Warehouse / Depot" } ] } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "default": { "description": "The request failed. See the Octa-ErrorCode and Octa-ErrorMessage headers and the response body, if any.\n\nIf API request fails for some reason, response payload will contain:\n\n- The failure status (`Success` will be `false`)\n- List of errors\n- Suggestions (Similar GSTINs)", "headers": { "Octa-ErrorCode": { "$ref": "#/components/headers/OctaErrorCode" }, "Octa-ErrorMessage": { "$ref": "#/components/headers/OctaErrorMessage" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean" }, "Errors": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string" }, "Message": { "type": "string" } } } }, "Suggestions": { "type": "array", "items": { "type": "object", "properties": { "Gstin": { "type": "string" }, "TradeName": { "type": "string" }, "LegalName": { "type": "string" }, "StateName": { "type": "string" }, "StateCode": { "type": "string" } } } } } }, "example": { "Success": false, "Errors": [ { "Code": "OCTA-152", "Message": "Invalid GSTIN" } ], "Suggestions": [ { "Gstin": "19AAACN0757G1ZI", "TradeName": "NESTLE INDIA LTD", "LegalName": "NESTLE INDIA LIMITED", "StateName": "West Bengal", "StateCode": "19" }, { "Gstin": "02AAACN0757G1ZX", "TradeName": "NESTLE INDIA LIMITED", "LegalName": "NESTLE INDIA LIMITED", "StateName": "Himachal Pradesh", "StateCode": "02" }, { "Gstin": "16AAACN0757G1ZO", "TradeName": "Nestle India Ltd.", "LegalName": "NESTLE INDIA LIMITED", "StateName": "Tripura", "StateCode": "16" }, { "Gstin": "13AAACN0757G1ZU", "TradeName": "M/S NESTLE INDIA LTD.", "LegalName": "NESTLE INDIA LIMITED", "StateName": "Nagaland", "StateCode": "13" }, { "Gstin": "14AAACN0757G1ZS", "TradeName": "M/S Nestle India Ltd", "LegalName": "NESTLE INDIA LIMITED", "StateName": "Manipur", "StateCode": "14" } ] } } } } } } }, "/api/octa/gstr2a/pull": { "post": { "operationId": "gstr2aPullGstr2a", "summary": "Pull", "description": "This API is used to pull latest GSTR-2A data from Govt Portal. This API supports pulling the data of one GSTIN and one\nreturn period at a time. To pull GSTR-2A of multiple GSTINs or multiple periods, you can use this API multiple times.", "tags": [ "GSTR-2A" ], "externalDocs": { "url": "https://octagst.com/octa/docs/api/gstr2a/pull-gstr2a" }, "parameters": [ { "$ref": "#/components/parameters/OctaCompany" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "gstin": { "type": "string", "description": "Company GSTIN" }, "returnPeriod": { "type": "string", "description": "Period in `YYYY-MM` format" } }, "required": [ "gstin", "returnPeriod" ] }, "example": { "gstin": "08AASFB9647G1ZU", "returnPeriod": "2025-05" } } } }, "responses": { "200": { "description": "Since pulling data from the Government Portal can take time, Octa processes the request asynchronously. When you\ninitiate a data pull, Octa immediately returns a JobId and begins fetching the data in the background. You can then\ntrack the progress and retrieve results by calling the [Robot-JobStatus](https://octagst.com/octa/docs/api/robot/job-status) API.\n\n```\nHTTP/1.1 200 OK\nContent-Type: application/json\n```", "content": { "application/json": { "schema": { "type": "object", "properties": { "jobId": { "type": "string" } } }, "example": { "jobId": "6492341" } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "default": { "description": "The request failed. See the Octa-ErrorCode and Octa-ErrorMessage headers and the response body, if any.\n\nIf the HTTP status code in the response is in the error range (4xx or 5xx), it indicates that the API request has failed\nand Octa has not started pulling data from the Government Portal. To identify the exact issue, check the response\nheaders `Octa-ErrorCode` and `Octa-ErrorMessage`, which provide detailed error information.\n\nFor example, if a GSTIN is not connected to the Government Portal via OTP, the response will look like this:\n\n```\nHTTP/1.1 400 Bad Request\nOcta-ErrorCode: 2000\nOcta-ErrorMessage: Not connected to GST System\n```", "headers": { "Octa-ErrorCode": { "$ref": "#/components/headers/OctaErrorCode" }, "Octa-ErrorMessage": { "$ref": "#/components/headers/OctaErrorMessage" } } } } } }, "/api/octa/gstr2a/export": { "post": { "operationId": "gstr2aExportGstr2a", "summary": "Export", "description": "This API allows you to export the currently available GSTR-2A data from Octa into Excel format. It supports exporting\ndata for multiple GSTINs and multiple periods in a single request, making it easier to generate consolidated reports\nefficiently.", "tags": [ "GSTR-2A" ], "externalDocs": { "url": "https://octagst.com/octa/docs/api/gstr2a/export-gstr2a" }, "parameters": [ { "$ref": "#/components/parameters/OctaCompany" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "gstins": { "type": "array", "items": { "type": "string" }, "description": "Company GSTINs" }, "startReturnPeriod": { "type": "string", "description": "Start period in `YYYY-MM` format" }, "endReturnPeriod": { "type": "string", "description": "End period in `YYYY-MM` format" }, "reportType": { "type": "integer", "description": "Report format – Default: **100**\nValues:\n- `100`: **Full** - All documents in one sheet, one row for each GST rate in invoices\n- `101`: **Smart** - All documents in one sheet, one row for each invoice, with net value for amendments" } }, "required": [ "gstins", "startReturnPeriod", "endReturnPeriod" ] }, "example": { "gstins": [ "08AASFB9647G1ZU" ], "startReturnPeriod": "2024-04", "endReturnPeriod": "2025-03", "reportType": 101 } } } }, "responses": { "200": { "description": "Since exporting data for multiple GSTINs and periods may take time, Octa processes the request asynchronously. When you\ninitiate an export, Octa immediately returns a JobId and begins generating the export in the background. You can monitor\nthe progress and download the results by calling the [Robot-JobStatus](https://octagst.com/octa/docs/api/robot/job-status) API.\n\n```\nHTTP/1.1 200 OK\nContent-Type: application/json\n```", "content": { "application/json": { "schema": { "type": "object", "properties": { "jobId": { "type": "string" } } }, "example": { "jobId": "6492390" } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "default": { "description": "The request failed. See the Octa-ErrorCode and Octa-ErrorMessage headers and the response body, if any.\n\nIf the HTTP status code in the response is in the error range (4xx or 5xx), it indicates that the API request has failed\nand Octa will not export any data. To identify the exact issue, check the response headers `Octa-ErrorCode` and\n`Octa-ErrorMessage`, which provide detailed error information.\n\nFor example, if the return period range is too long, the response will look like this:\n\n```\nHTTP/1.1 400 Bad Request\nOcta-ErrorCode: 100\nOcta-ErrorMessage: Maximum 24 month data can be exported\n```", "headers": { "Octa-ErrorCode": { "$ref": "#/components/headers/OctaErrorCode" }, "Octa-ErrorMessage": { "$ref": "#/components/headers/OctaErrorMessage" } } } } } }, "/api/octa/gstr2b/pull": { "post": { "operationId": "gstr2bPullGstr2b", "summary": "Pull", "description": "This API is used to pull the latest GSTR-2B data from the Government Portal. It supports pulling data for one GSTIN and\none return period at a time. To pull GSTR-2B data for multiple GSTINs or periods, call this API once for each\nGSTIN-period combination.", "tags": [ "GSTR-2B" ], "externalDocs": { "url": "https://octagst.com/octa/docs/api/gstr2b/pull-gstr2b" }, "parameters": [ { "$ref": "#/components/parameters/OctaCompany" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "gstin": { "type": "string", "description": "Company GSTIN" }, "returnPeriod": { "type": "string", "description": "Period in `YYYY-MM` format" } }, "required": [ "gstin", "returnPeriod" ] }, "example": { "gstin": "08AASFB9647G1ZU", "returnPeriod": "2025-05" } } } }, "responses": { "200": { "description": "Since pulling data from the Government Portal can take time, Octa processes the request asynchronously. When you\ninitiate a data pull, Octa immediately returns a JobId and begins fetching the data in the background. You can then\ntrack the progress and retrieve results by calling the [Robot-JobStatus](https://octagst.com/octa/docs/api/robot/job-status) API.\n\n```\nHTTP/1.1 200 OK\nContent-Type: application/json\n```", "content": { "application/json": { "schema": { "type": "object", "properties": { "jobId": { "type": "string" } } }, "example": { "jobId": "6492341" } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "default": { "description": "The request failed. See the Octa-ErrorCode and Octa-ErrorMessage headers and the response body, if any.\n\nIf the HTTP status code in the response is in the error range (4xx or 5xx), it indicates that the API request has failed\nand Octa has not started pulling data from the Government Portal. To identify the exact issue, check the response\nheaders `Octa-ErrorCode` and `Octa-ErrorMessage`, which provide detailed error information.\n\nFor example, if a GSTIN is not connected to the Government Portal via OTP, the response will look like this:\n\n```\nHTTP/1.1 400 Bad Request\nOcta-ErrorCode: 2000\nOcta-ErrorMessage: Not connected to GST System\n```", "headers": { "Octa-ErrorCode": { "$ref": "#/components/headers/OctaErrorCode" }, "Octa-ErrorMessage": { "$ref": "#/components/headers/OctaErrorMessage" } } } } } }, "/api/octa/gstr2b/export": { "post": { "operationId": "gstr2bExportGstr2b", "summary": "Export", "description": "This API allows you to export the currently available GSTR-2B data from Octa into Excel format. It supports exporting\ndata for multiple GSTINs and multiple periods in a single request, making it easier to generate consolidated reports.", "tags": [ "GSTR-2B" ], "externalDocs": { "url": "https://octagst.com/octa/docs/api/gstr2b/export-gstr2b" }, "parameters": [ { "$ref": "#/components/parameters/OctaCompany" } ], "requestBody": { "description": "The return-period range cannot exceed 24 months.", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "gstins": { "type": "array", "items": { "type": "string" }, "description": "Company GSTINs" }, "startReturnPeriod": { "type": "string", "description": "Start period in `YYYY-MM` format" }, "endReturnPeriod": { "type": "string", "description": "End period in `YYYY-MM` format" }, "reportType": { "type": "integer", "description": "Report format – Default: **100**\nValues:\n- `100`: **Full** - All documents in one sheet, one row for each GST rate in invoices\n- `101`: **Smart** - All documents in one sheet, one row for each invoice, with net value for amendments" } }, "required": [ "gstins", "startReturnPeriod", "endReturnPeriod" ] }, "example": { "gstins": [ "08AASFB9647G1ZU" ], "startReturnPeriod": "2024-04", "endReturnPeriod": "2025-03", "reportType": 101 } } } }, "responses": { "200": { "description": "Since exporting data for multiple GSTINs and periods may take time, Octa processes the request asynchronously. When you\ninitiate an export, Octa immediately returns a JobId and begins generating the export in the background. You can monitor\nthe progress and download the result by calling the [Robot-JobStatus](https://octagst.com/octa/docs/api/robot/job-status) API.\n\n```\nHTTP/1.1 200 OK\nContent-Type: application/json\n```", "content": { "application/json": { "schema": { "type": "object", "properties": { "jobId": { "type": "string" } } }, "example": { "jobId": "6492390" } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "default": { "description": "The request failed. See the Octa-ErrorCode and Octa-ErrorMessage headers and the response body, if any.\n\nIf the HTTP status code in the response is in the error range (4xx or 5xx), it indicates that the API request has failed\nand Octa will not export any data. To identify the exact issue, check the response headers `Octa-ErrorCode` and\n`Octa-ErrorMessage`, which provide detailed error information.\n\nFor example, if the return-period range is too long, the response will look like this:\n\n```\nHTTP/1.1 400 Bad Request\nOcta-ErrorCode: 100\nOcta-ErrorMessage: Maximum 24 months data can be exported.\n```", "headers": { "Octa-ErrorCode": { "$ref": "#/components/headers/OctaErrorCode" }, "Octa-ErrorMessage": { "$ref": "#/components/headers/OctaErrorMessage" } } } } } }, "/api/octa/gstr3b/pull": { "post": { "operationId": "gstr3bPullGstr3b", "summary": "Pull", "description": "This API is used to pull the latest filed GSTR-3B data from the Government Portal. It supports pulling data for one\nGSTIN and one return period at a time. To pull GSTR-3B data for multiple GSTINs or periods, call this API once for each\nGSTIN-period combination.", "tags": [ "GSTR-3B" ], "externalDocs": { "url": "https://octagst.com/octa/docs/api/gstr3b/pull-gstr3b" }, "parameters": [ { "$ref": "#/components/parameters/OctaCompany" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "gstin": { "type": "string", "description": "Company GSTIN" }, "returnPeriod": { "type": "string", "description": "Period in `YYYY-MM` format" } }, "required": [ "gstin", "returnPeriod" ] }, "example": { "gstin": "08AASFB9647G1ZU", "returnPeriod": "2025-05" } } } }, "responses": { "200": { "description": "Since pulling data from the Government Portal can take time, Octa processes the request asynchronously. When you\ninitiate a data pull, Octa immediately returns a JobId and begins fetching the data in the background. You can then\ntrack the progress and retrieve results by calling the [Robot-JobStatus](https://octagst.com/octa/docs/api/robot/job-status) API.\n\n```\nHTTP/1.1 200 OK\nContent-Type: application/json\n```", "content": { "application/json": { "schema": { "type": "object", "properties": { "jobId": { "type": "string" } } }, "example": { "jobId": "6492341" } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "default": { "description": "The request failed. See the Octa-ErrorCode and Octa-ErrorMessage headers and the response body, if any.\n\nIf the HTTP status code in the response is in the error range (4xx or 5xx), it indicates that the API request has failed\nand Octa has not started pulling data from the Government Portal. To identify the exact issue, check the response\nheaders `Octa-ErrorCode` and `Octa-ErrorMessage`, which provide detailed error information.\n\nFor example, if a GSTIN is not connected to the Government Portal via OTP, the response will look like this:\n\n```\nHTTP/1.1 400 Bad Request\nOcta-ErrorCode: 2000\nOcta-ErrorMessage: Not connected to GST System\n```", "headers": { "Octa-ErrorCode": { "$ref": "#/components/headers/OctaErrorCode" }, "Octa-ErrorMessage": { "$ref": "#/components/headers/OctaErrorMessage" } } } } } }, "/api/octa/gstr3b/export": { "post": { "operationId": "gstr3bExportGstr3b", "summary": "Export", "description": "This API allows you to export the currently available filed GSTR-3B data from Octa into Excel format. Each request\nexports one GSTIN and one return period.", "tags": [ "GSTR-3B" ], "externalDocs": { "url": "https://octagst.com/octa/docs/api/gstr3b/export-gstr3b" }, "parameters": [ { "$ref": "#/components/parameters/OctaCompany" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "gstin": { "type": "string", "description": "Company GSTIN" }, "returnPeriod": { "type": "string", "description": "Period in `YYYY-MM` format" } }, "required": [ "gstin", "returnPeriod" ] }, "example": { "gstin": "08AASFB9647G1ZU", "returnPeriod": "2025-05" } } } }, "responses": { "200": { "description": "Octa processes the export asynchronously. When you initiate an export, Octa immediately returns a JobId and begins\ngenerating the Excel file in the background. You can monitor the progress and download the result by calling the\n[Robot-JobStatus](https://octagst.com/octa/docs/api/robot/job-status) API.\n\n```\nHTTP/1.1 200 OK\nContent-Type: application/json\n```", "content": { "application/json": { "schema": { "type": "object", "properties": { "jobId": { "type": "string" } } }, "example": { "jobId": "6492390" } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "default": { "description": "The request failed. See the Octa-ErrorCode and Octa-ErrorMessage headers and the response body, if any.\n\nIf the HTTP status code in the response is in the error range (4xx or 5xx), it indicates that the API request has failed\nand Octa will not export any data. To identify the exact issue, check the response headers `Octa-ErrorCode` and\n`Octa-ErrorMessage`, which provide detailed error information.\n\nFor example, if required request fields are missing, the response will look like this:\n\n```\nHTTP/1.1 400 Bad Request\nOcta-ErrorCode: 1000\nOcta-ErrorMessage: Missing/Invalid field values in request.\n```", "headers": { "Octa-ErrorCode": { "$ref": "#/components/headers/OctaErrorCode" }, "Octa-ErrorMessage": { "$ref": "#/components/headers/OctaErrorMessage" } } } } } }, "/api/robot/jobstatus/{jobId}": { "get": { "operationId": "robotJobStatus", "summary": "Job Status", "description": "This API enables you to track the current status of a background job. When the job is complete, the response also\nincludes a download link for the generated result/output.", "tags": [ "Robot" ], "externalDocs": { "url": "https://octagst.com/octa/docs/api/robot/job-status" }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "description": "The `jobId` must be included as the final segment of the URL path when making this request.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "If the response includes a download URL, the client should retrieve the data immediately. Please note that all\n download links are time-bound and will automatically expire after a predefined period.", "content": { "application/json": { "schema": { "type": "object", "properties": { "jobStatus": { "type": "integer", "description": "Status of the job\nValues:\n- `0`: **Waiting** - Job is waiting in queue\n- `1`: **Working** - Job is in progress\n- `100`: **Success** - Job is complete\n- `101`: **Failed** - An error occurred while executing the job" }, "error": { "type": "string", "description": "Error message - present only if job failed" }, "url": { "type": "string", "description": "Download URL - if job has completed and it has downloadable data" } }, "required": [ "jobStatus" ] } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "default": { "description": "The request failed. See the Octa-ErrorCode and Octa-ErrorMessage headers and the response body, if any.", "headers": { "Octa-ErrorCode": { "$ref": "#/components/headers/OctaErrorCode" }, "Octa-ErrorMessage": { "$ref": "#/components/headers/OctaErrorMessage" } } } } } }, "/api/octa/einvoice/generateirn": { "post": { "operationId": "einvoiceGenerateIrn", "summary": "Generate IRN", "description": "This API is used to register the invoice, credit note and debit note and get the Invoice Registration Number (IRN).", "tags": [ "E-Invoice & E-WayBills" ], "externalDocs": { "url": "https://octagst.com/octa/docs/api/einvoice/generate-irn" }, "parameters": [ { "name": "qrcode", "in": "query", "required": false, "description": "Include QR Code image in response", "schema": { "type": "string", "enum": [ "yes", "no" ], "default": "no" } }, { "name": "qrcodeformat", "in": "query", "required": false, "description": "QR code image format", "schema": { "type": "string", "enum": [ "PNG", "JPEG", "GIF" ], "default": "PNG" } }, { "name": "qrcodequality", "in": "query", "required": false, "description": "QR code image quality", "schema": { "type": "string", "enum": [ "standard", "high" ], "default": "high" } }, { "name": "pdf", "in": "query", "required": false, "description": "Include e-invoice pdf and e-waybill pdf in response", "schema": { "type": "string", "enum": [ "yes", "no" ], "default": "no" } } ], "requestBody": { "description": "**Master Codes**\n\nPlease visit NIC eInvoice portal to get masters defined for State Codes, UQC, Currency codes, Country codes, Port codes,\nHSN, PIN codes.\n\n[Master Codes on NIC Portal →](https://einvoice1.gst.gov.in/Others/MasterCodes)", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "Version": { "type": "string", "maxLength": 6, "description": "Schema version – Use `1.1` for this specification" }, "TranDtls": { "type": "object", "properties": { "TaxSch": { "type": "string", "maxLength": 10, "description": "Tax Scheme\n`GST`" }, "SupTyp": { "type": "string", "maxLength": 10, "description": "Supply Type\n`B2B`: B2B Supply\n`SEZWP`: SEZ supply with payment of IGST\n`SEZWOP`: SEZ supply without payment of IGST\n`EXPWP`: Export with payment of IGST\n`EXPWOP`: Export without payment of IGST\n`DEXP`: Deemed Export\n`B2C`: B2C Supply" }, "RegRev": { "type": "string", "description": "Reverse Charge\n`Y`: Yes\n`N`: No" }, "EcmGstin": { "type": [ "string", "null" ], "maxLength": 15, "description": "GSTIN of E-Commerce operator" }, "IgstOnIntra": { "type": "string", "maxLength": 1, "description": "IGST on Intrastate Supply\n`Y`: Yes\n`N`: No" } }, "required": [ "TaxSch", "SupTyp" ], "description": "Top level transaction details such as type of supply & reverse charge" }, "DocDtls": { "type": "object", "properties": { "Typ": { "type": "string", "description": "Document Type\n`INV`: Invoice\n`CRN`: Credit Note\n`DBN`-Debit Note" }, "No": { "type": "string", "maxLength": 16, "description": "Document No\n`A-Z`, `0-9`, `/`, `-`" }, "Dt": { "type": "string", "maxLength": 10, "description": "Document Date\n`DD/MM/YYYY`" } }, "required": [ "Typ", "No", "Dt" ], "description": "Document details such as type of document, doc number, doc date" }, "SellerDtls": { "type": "object", "properties": { "Gstin": { "type": "string", "maxLength": 15, "description": "GSTIN" }, "LglNm": { "type": "string", "maxLength": 100, "description": "Legal Name as appearing in PAN" }, "TrdNm": { "type": "string", "maxLength": 100, "description": "Trade name, if available. (Business Name, other than legal name)" }, "Addr1": { "type": "string", "maxLength": 100, "description": "Address-1" }, "Addr2": { "type": "string", "maxLength": 100, "description": "Address-2" }, "Loc": { "type": "string", "maxLength": 100, "description": "Location (City/Town/Village)" }, "Pin": { "type": "number", "description": "Pin code\nData type: Number(6)" }, "Stcd": { "type": "string", "maxLength": 2, "description": "State Code" }, "Ph": { "type": "string", "maxLength": 12, "description": "Phone No" }, "Em": { "type": "string", "maxLength": 100, "description": "Email" } }, "required": [ "Gstin", "LglNm", "Addr1", "Loc", "Pin", "Stcd" ], "description": "Seller details like GSTIN, Trade name, Address etc" }, "BuyerDtls": { "type": "object", "properties": { "Gstin": { "type": "string", "maxLength": 15, "description": "Buyer GSTIN, required for B2B invoices" }, "LglNm": { "type": "string", "maxLength": 100, "description": "Legal Name as appearing in PAN" }, "TrdNm": { "type": "string", "maxLength": 100, "description": "Trade name, if available. (Business Name, other than legal name)" }, "Pos": { "type": "string", "maxLength": 2, "description": "Place of supply (State Code)" }, "Addr1": { "type": "string", "maxLength": 100, "description": "Address-1" }, "Addr2": { "type": "string", "maxLength": 100, "description": "Address-2" }, "Loc": { "type": "string", "maxLength": 100, "description": "Location (City/Town/Village)" }, "Pin": { "type": "number", "description": "Pin code\nData type: Number(6)" }, "Stcd": { "type": "string", "maxLength": 2, "description": "State Code" }, "Ph": { "type": "string", "maxLength": 12, "description": "Phone No" }, "Em": { "type": "string", "maxLength": 100, "description": "Email" } }, "required": [ "LglNm", "Pos", "Addr1", "Loc" ], "description": "Buyer details like GSTIN, Trade name, Address etc" }, "DispDtls": { "type": "object", "properties": { "Nm": { "type": "string", "maxLength": 100, "description": "Business entity name" }, "Addr1": { "type": "string", "maxLength": 100, "description": "Address-1" }, "Addr2": { "type": "string", "maxLength": 100, "description": "Address-2" }, "Loc": { "type": "string", "maxLength": 100, "description": "Location (City/Town/Village)" }, "Pin": { "type": "number", "description": "Pin code\nData type: Number(6)" }, "Stcd": { "type": "string", "maxLength": 2, "description": "State Code" } }, "required": [ "Nm", "Addr1", "Loc", "Pin", "Stcd" ], "description": "Dispatch details like business name, Address etc" }, "ShipDtls": { "type": "object", "properties": { "Gstin": { "type": "string", "maxLength": 15, "description": "GSTIN" }, "LglNm": { "type": "string", "maxLength": 100, "description": "Legal Name as appearing in PAN" }, "TrdNm": { "type": "string", "maxLength": 100, "description": "Trade name, if available. (Business Name, other than legal name)" }, "Addr1": { "type": "string", "maxLength": 100, "description": "Address-1" }, "Addr2": { "type": "string", "maxLength": 100, "description": "Address-2" }, "Loc": { "type": "string", "maxLength": 100, "description": "Location (City/Town/Village)" }, "Pin": { "type": "number", "description": "Pin code\nData type: Number(6)" }, "Stcd": { "type": "string", "maxLength": 2, "description": "State Code" } }, "required": [ "LglNm", "Addr1", "Loc", "Pin", "Stcd" ], "description": "Ship To details like GSTIN, Trade name, Address etc" }, "ItemList": { "type": "array", "items": { "type": "object", "properties": { "SlNo": { "type": "string", "maxLength": 6, "description": "Serial no of line item. Only digits are allowed." }, "IsServc": { "type": "string", "maxLength": 1, "description": "Whether line item is good or service\n`Y`: Yes\n`N`: No" }, "PrdDesc": { "type": "string", "maxLength": 300, "description": "Product/Item" }, "HsnCd": { "type": "string", "maxLength": 8, "description": "HSN Code" }, "Barcde": { "type": [ "number", "string" ], "description": "Bar code\nData type: Number(12,2)" }, "BchDtls": { "type": "object", "properties": { "Nm": { "type": "string" }, "Expdt": { "type": "string" }, "wrDt": { "type": "string" } } }, "Qty": { "type": "number", "description": "Quantity\nData type: Number(10,3)" }, "FreeQty": { "type": "number", "description": "Free quantity\nData type: Number(10,3)" }, "Unit": { "type": "string", "maxLength": 3, "description": "UQC" }, "UnitPrice": { "type": "number", "description": "Unit price\nData type: Number(12,2)" }, "TotAmt": { "type": "number", "description": "Item gross amount (Qty \\* UnitPrice)\nData type: Number(12,2)\nTotal Item Value (TaxableValue + IGST Amount + CGST Amount + SGST Amount + Cess Amount + Cess Nonadvol + State cess amount + State Cess Non advol + Other charges)\nData type: Number(12,2)" }, "Discount": { "type": "number", "description": "Discount\nData type: Number(12,2)" }, "PreTaxVal": { "type": "number", "description": "Pre Taxable Value\nData type: Number(12,2)" }, "AssAmt": { "type": "number", "description": "Item Taxable Value (Total Amount - Discount)\nData type: Number(12,2)" }, "GstRt": { "type": "number", "description": "GST Rate\nData type: Number(3,3)" }, "SgstAmt": { "type": "number", "description": "SGST Amount\nData type: Number(12,2)" }, "IgstAmt": { "type": "number", "description": "IGST Amount\nData type: Number(12,2)" }, "CgstAmt": { "type": "number", "description": "CGST Amount\nData type: Number(12,2)" }, "CesRt": { "type": "number", "description": "Cess Rate\nData type: Number(3,3)" }, "CesAmt": { "type": "number" }, "CesNonAdvlAmt": { "type": "number", "description": "Cess Non-advol Amount\nData type: Number(12,2)" }, "StateCesRt": { "type": "number", "description": "State Cess Rate\nData type: Number(3,3)" }, "StateCesAmt": { "type": "number", "description": "State Cess Amount\nData type: Number(12,2)" }, "StateCesNonAdvlAmt": { "type": "number", "description": "State Cess Non-advol Amount\nData type: Number(12,2)" }, "OthChrg": { "type": "number", "description": "Other charges\nData type: Number(12,2)" }, "TotItemVal": { "type": "number" }, "OrdLineRef": { "type": "string", "maxLength": 50, "description": "Order line Reference" }, "OrgCntry": { "type": "string", "maxLength": 2, "description": "Origin Country" }, "PrdSlNo": { "type": "string" }, "AttribDtls": { "type": "array", "items": { "type": "object", "properties": { "Nm": { "type": "string", "maxLength": 100, "description": "Attribute Name" }, "Val": { "type": "string", "maxLength": 100, "description": "Attribute value" } }, "required": [ "Nm", "Val" ] }, "description": "This object contains details of item attributes" }, "CessAmt": { "type": "number", "description": "Cess Amount\nData type: Number(12,2)" }, "OthSerialNumber": { "type": "string", "maxLength": 20, "description": "Product Serial Number" }, "BchDtl": { "type": "object", "properties": { "Nm": { "type": "string", "maxLength": 20, "description": "Batch Name/Number" }, "ExpDt": { "type": "string", "maxLength": 10, "description": "Batch Expiry Date\n`DD/MM/YYYY`" }, "WrDt": { "type": "string", "maxLength": 10, "description": "Batch Warranty Date\n`DD/MM/YYYY`" } }, "required": [ "Nm" ], "description": "This object contains details of batch" } }, "required": [ "HsnCd", "Unit", "UnitPrice", "GstRt" ] }, "description": "List of line items" }, "ValDtlss": { "type": "object", "properties": { "AssVal": { "type": "number" }, "CgstVal": { "type": "integer" }, "SgstVal": { "type": "integer" }, "IgstVal": { "type": "number" }, "CesVal": { "type": "number" }, "StCesVal": { "type": "number" }, "Discount": { "type": "integer" }, "OthChrg": { "type": "integer" }, "RndOffAmt": { "type": "number" }, "TotInvVal": { "type": "integer" }, "TotInvValFc": { "type": "number" } } }, "PayDtls": { "type": "object", "properties": { "Nm": { "type": "string", "maxLength": 100, "description": "Payee Name" }, "Accdet": { "type": "string" }, "Mode": { "type": "string", "maxLength": 18, "description": "Mode of Payment" }, "Fininsbr": { "type": "string" }, "Payterm": { "type": "string" }, "Payinstr": { "type": "string" }, "Crtrn": { "type": "string" }, "Dirdr": { "type": "string" }, "Crday": { "type": "integer" }, "Paidamt": { "type": "integer" }, "Paymtdue": { "type": "integer" }, "FinInsBr": { "type": "string", "maxLength": 11, "description": "Branch or IFSC Code" }, "PayTerm": { "type": "string", "maxLength": 100, "description": "Payment Term" }, "PayInstr": { "type": "string", "maxLength": 100, "description": "Payment Instruction" }, "CrTrn": { "type": "string", "maxLength": 100, "description": "Credit Transfer" }, "DirDr": { "type": "string", "maxLength": 100, "description": "Direct Debit" }, "CrDay": { "type": "number", "description": "Credit Days\nData type: Number(4)" }, "PaidAmt": { "type": "number", "description": "Paid Amount\nData type: Number(14,2)" }, "PaymtDue": { "type": "number", "description": "Payment Due\nData type: Number(14,2)" }, "AccDet": { "type": "string", "maxLength": 18, "description": "Bank Account Details" } }, "description": "Payment details" }, "RefDtls": { "type": "object", "properties": { "InvRm": { "type": "string" }, "DocPerdDtls": { "type": "object", "properties": { "InvStDt": { "type": "string" }, "InvEndDt": { "type": "string" } } }, "PrecDocDtls": { "type": "array", "items": { "type": "object", "properties": { "InvNo": { "type": "string" }, "InvDt": { "type": "string" }, "OthRefNo": { "type": "string" } } } }, "ContrDtls": { "type": "array", "items": { "type": "object", "properties": { "RecAdvRefr": { "type": "string" }, "RecAdvDt": { "type": "string" }, "Tendrefr": { "type": "string" }, "Contrrefr": { "type": "string" }, "Extrefr": { "type": "string" }, "Projrefr": { "type": "string" }, "Porefr": { "type": "string" }, "PoRefDt": { "type": "string" } } } } } }, "AddlDocDtls": { "type": "array", "items": { "type": "object", "properties": { "Url": { "type": "string" }, "Docs": { "type": "string" }, "Info": { "type": "string" } } } }, "ExpDtls": { "type": "object", "properties": { "ShipBNo": { "type": "string" }, "ShipBDt": { "type": "string" }, "Port": { "type": "string" }, "RefClm": { "type": "string" }, "ForCur": { "type": "string" }, "CntCode": { "type": "string" } } }, "EwbDtls": { "type": "object", "properties": { "Transid": { "type": "string" }, "Transname": { "type": "string" }, "Distance": { "type": "number", "description": "Distance\nData type: Number(4)" }, "Transdocno": { "type": "string" }, "TransdocDt": { "type": "string" }, "Vehno": { "type": "string" }, "Vehtype": { "type": "string" }, "TransMode": { "type": "string", "maxLength": 1, "description": "Transport Mode\n`1`: Road\n`2`: Rail\n`3`: Air\n`4`: Ship" }, "TransId": { "type": "string", "maxLength": 15, "description": "Transporter Id" }, "TransName": { "type": "string", "maxLength": 100, "description": "Transport Name" }, "TransDocNo": { "type": "string", "maxLength": 15, "description": "Transporter Doc No" }, "TransDocDt": { "type": "string", "maxLength": 10, "description": "Transporter Doc Date\n`DD/MM/YYYY`" }, "VehNo": { "type": "string", "maxLength": 20, "description": "Vehicle No" }, "VehType": { "type": "string", "maxLength": 1, "description": "Vehicle Type\n`R`: Regular\n`O`: Over-Dimensional Cargo (ODC)" } }, "required": [ "Distance" ], "description": "EWaybill details" }, "ValDtls": { "type": "object", "properties": { "AssVal": { "type": "number", "description": "Total taxable value.\nData type: Number(14,2)" }, "IgstVal": { "type": "number", "description": "Total IGST Amount\nData type: Number(14,2)" }, "CgstVal": { "type": "number", "description": "Total CGST Amount\nData type: Number(14,2)" }, "SgstVal": { "type": "number", "description": "Total SGST Amount\nData type: Number(14,2)" }, "CesVal": { "type": "number", "description": "Total Cess Amount\nData type: Number(14, 2)" }, "StCesVal": { "type": "number", "description": "Total State Cess Amount\nData type: Number(14,2)" }, "Discount": { "type": "number", "description": "Invoice Discount\nData type: Number(14,2)" }, "OthChrg": { "type": "number", "description": "Invoice Other charges\nData type: Number(14,2)" }, "RndOffAmt": { "type": "number", "description": "Round off Amount\nData type: Number(2,2)" }, "TotInvVal": { "type": "number", "description": "Total document value\nData type: Number(14,2)" }, "TotInvValFc": { "type": "number", "description": "Total document value in foreign currency\nData type: Number(14,2)" } }, "description": "Details of document totals" }, "RefDtl": { "type": "object", "properties": { "InvRm": { "type": "string", "maxLength": 100, "description": "Document Remarks" }, "InvStDt": { "type": "string", "maxLength": 10, "description": "Invoice Period Start Date\n`DD/MM/YYYY`" }, "InvEndDt": { "type": "string", "maxLength": 10, "description": "Invoice Period End Date\n`DD/MM/YYYY`" } }, "required": [ "InvStDt", "InvEndDt" ], "description": "Reference details" }, "PrecDocDtls": { "type": "array", "items": { "type": "object", "properties": { "InvNo": { "type": "string", "maxLength": 16, "description": "Preceding Invoice Number" }, "InvDt": { "type": "string", "maxLength": 10, "description": "Preceding Invoice Date\n`DD/MM/YYYY`" }, "OthRefNo": { "type": "string", "maxLength": 20, "description": "Other Reference" } }, "required": [ "InvNo", "InvDt" ] }, "description": "Preceding issued documents" }, "ContrDtls": { "type": "array", "items": { "type": "object", "properties": { "RecAdvRefr": { "type": "string", "maxLength": 20, "description": "Receipt Advice No" }, "RecAdvDt": { "type": "string", "maxLength": 10, "description": "Receipt Advice Date\n`DD/MM/YYYY`" }, "TendRefr": { "type": "string", "maxLength": 20, "description": "Lot/Batch Reference No" }, "ContrRefr": { "type": "string", "maxLength": 20, "description": "Contract Reference Number" }, "ExtRefr": { "type": "string", "maxLength": 20, "description": "Any Other Reference" }, "ProjRefr": { "type": "string", "maxLength": 20, "description": "Project Reference" }, "PORefr": { "type": "string", "maxLength": 20, "description": "PO Reference Number" }, "PORefDt": { "type": "string", "maxLength": 10, "description": "PO Reference Date\n`DD/MM/YYYY`" } } }, "description": "Details of contract reference documents" }, "AddlDtls": { "type": "array", "items": { "type": "object", "properties": { "Url": { "type": "string", "maxLength": 100, "description": "Additional supporting documents URL" }, "Docs": { "type": "string", "maxLength": 1000, "description": "Additional supporting documents in base64" }, "Info": { "type": "string", "maxLength": 1000, "description": "Additional information" } } }, "description": "Details of additional documents" }, "ExpDtl": { "type": "object", "properties": { "ShipBNo": { "type": "string", "maxLength": 20, "description": "Shipping Bill No" }, "ShipBDt": { "type": "string", "maxLength": 10, "description": "Shipping Bill Date\n`DD/MM/YYYY`" }, "Port": { "type": "string", "maxLength": 10, "description": "Port Code" }, "RefClm": { "type": "string", "maxLength": 1, "description": "Refund Claim\n`Y`: Yes\n`N`: No" }, "ForCur": { "type": "string", "maxLength": 16, "description": "Foreign Currency" }, "CntCode": { "type": "string", "maxLength": 2, "description": "Country Code" }, "ExpDuty": { "type": "number", "description": "Export Duty\nData type: Number(12,2)" } }, "description": "Details of export invoice" } }, "required": [ "Version", "TranDtls", "DocDtls", "SellerDtls", "BuyerDtls", "ItemList" ] }, "example": { "Version": "1.1", "TranDtls": { "TaxSch": "GST", "SupTyp": "B2B", "RegRev": "Y", "EcmGstin": null, "IgstOnIntra": "N" }, "DocDtls": { "Typ": "INV", "No": "MAHI/10", "Dt": "08/08/2020" }, "SellerDtls": { "Gstin": "29AABCT1332L000", "LglNm": "ABC company pvt ltd", "TrdNm": "NIC Industries", "Addr1": "5th block, kuvempu layout", "Addr2": "kuvempu layout", "Loc": "GANDHINAGAR", "Pin": 560001, "Stcd": "29", "Ph": "9000000000", "Em": "abc@gmail.com" }, "BuyerDtls": { "Gstin": "29AWGPV7107B1Z1", "LglNm": "XYZ company pvt ltd", "TrdNm": "XYZ Industries", "Pos": "37", "Addr1": "7th block, kuvempu layout", "Addr2": "kuvempu layout", "Loc": "GANDHINAGAR", "Pin": 560004, "Stcd": "29", "Ph": "9000000000", "Em": "abc@gmail.com" }, "DispDtls": { "Nm": "ABC company pvt ltd", "Addr1": "7th block, kuvempu layout", "Addr2": "kuvempu layout", "Loc": "Banagalore", "Pin": 518360, "Stcd": "37" }, "ShipDtls": { "Gstin": "29AWGPV7107B1Z1", "LglNm": "CBE company pvt ltd", "TrdNm": "kuvempu layout", "Addr1": "7th block, kuvempu layout", "Addr2": "kuvempu layout", "Loc": "Banagalore", "Pin": 518360, "Stcd": "37" }, "ItemList": [ { "SlNo": "1", "IsServc": "N", "PrdDesc": "Rice", "HsnCd": "1001", "Barcde": "123456", "BchDtls": { "Nm": "123456", "Expdt": "01/08/2020", "wrDt": "01/09/2020" }, "Qty": 100.345, "FreeQty": 10, "Unit": "NOS", "UnitPrice": 99.545, "TotAmt": 9988.84, "Discount": 10, "PreTaxVal": 1, "AssAmt": 9978.84, "GstRt": 12, "SgstAmt": 0, "IgstAmt": 1197.46, "CgstAmt": 0, "CesRt": 5, "CesAmt": 498.94, "CesNonAdvlAmt": 10, "StateCesRt": 12, "StateCesAmt": 1197.46, "StateCesNonAdvlAmt": 5, "OthChrg": 10, "TotItemVal": 12897.7, "OrdLineRef": "3256", "OrgCntry": "AG", "PrdSlNo": "12345", "AttribDtls": [ { "Nm": "Rice", "Val": "10000" } ] } ], "ValDtlss": { "AssVal": 9978.84, "CgstVal": 0, "SgstVal": 0, "IgstVal": 1197.46, "CesVal": 508.94, "StCesVal": 1202.46, "Discount": 10, "OthChrg": 20, "RndOffAmt": 0.3, "TotInvVal": 12908, "TotInvValFc": 12897.7 }, "PayDtls": { "Nm": "ABCDE", "Accdet": "5697389713210", "Mode": "Cash", "Fininsbr": "SBIN11000", "Payterm": "100", "Payinstr": "Gift", "Crtrn": "test", "Dirdr": "test", "Crday": 100, "Paidamt": 10000, "Paymtdue": 5000 }, "RefDtls": { "InvRm": "TEST", "DocPerdDtls": { "InvStDt": "01/08/2020", "InvEndDt": "01/09/2020" }, "PrecDocDtls": [ { "InvNo": "DOC/002", "InvDt": "01/08/2020", "OthRefNo": "123456" } ], "ContrDtls": [ { "RecAdvRefr": "DOC/002", "RecAdvDt": "01/08/2020", "Tendrefr": "Abc001", "Contrrefr": "Co123", "Extrefr": "Yo456", "Projrefr": "Doc-456", "Porefr": "Doc-789", "PoRefDt": "01/08/2020" } ] }, "AddlDocDtls": [ { "Url": "https://einv-apisandbox.nic.in", "Docs": "Test Doc", "Info": "Document Test" } ], "ExpDtls": { "ShipBNo": "A-248", "ShipBDt": "01/08/2020", "Port": "INABG1", "RefClm": "N", "ForCur": "AED", "CntCode": "AE" }, "EwbDtls": { "Transid": "12AWGPV7107B1Z1", "Transname": "XYZ EXPORTS", "Distance": 100, "Transdocno": "DOC01", "TransdocDt": "01/08/2020", "Vehno": "ka123456", "Vehtype": "R", "TransMode": "1" } } } } }, "responses": { "200": { "description": "Response payload will contain the success status along with IRN information.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean", "description": "`true` in case of success" }, "AckNo": { "type": "string", "description": "Acknowledgement number" }, "AckTime": { "type": "string", "description": "Acknowledgement Date & time\n`DD/MM/YYYY HH:MM:SS`" }, "IrnStatus": { "type": "string", "description": "IRN Status\n`ACT`: Active\n`CNL`: Cancelled" }, "Irn": { "type": "string", "description": "Invoice reference number generated" }, "SignedInvoice": { "type": "string", "contentEncoding": "base64url", "description": "Signed invoice data as received from IRP\nData type: String (Binary data in Base64 URL encoding)" }, "SignedQRCode": { "type": "string", "contentEncoding": "base64url", "description": "Signed QR code as received from IRP\nData type: String (Binary data in Base64 URL encoding)" }, "EwbStatus": { "type": "string", "description": "EWB Status\n`ACT`: Active\n`CNL`: Cancelled" }, "EwbNo": { "type": "string", "description": "e-waybill Number(present only if e-waybill is generated along with e-invoice)" }, "EwbTime": { "type": "string", "description": "e-waybill generation Date & time\n`DD/MM/YYYY HH:MM:SS`" }, "EwbValidTill": { "type": "string", "description": "e-waybill validity Date & time\n`DD/MM/YYYY HH:MM:SS`" }, "QRCodeImagePng": { "type": "string", "contentEncoding": "base64", "description": "e-Invoice QR code PNG image\nData type: String (Binary data in Base64 encoding)" }, "QRCodeImageJpeg": { "type": [ "string", "null" ], "contentEncoding": "base64", "description": "e-Invoice QR code JPEG image\nData type: String (Binary data in Base64 encoding)" }, "QRCodeImageGif": { "type": [ "string", "null" ], "contentEncoding": "base64", "description": "e-Invoice QR code GIF image\nData type: String (Binary data in Base64 encoding)" }, "EinvoicePdf": { "type": "string", "contentEncoding": "base64", "description": "e-Invoice PDF file\nData type: String (Binary data in Base64 encoding)" }, "EwbPdf": { "type": "string", "contentEncoding": "base64", "description": "e-waybill PDF file\nData type: String (Binary data in Base64 encoding)" }, "Errors": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string", "description": "Error Code" }, "Message": { "type": "string", "description": "Error message" } } }, "description": "List of errors, will be present only when Success is `false`" } } }, "example": { "Success": true, "AckNo": "112010000002315", "AckTime": "27/11/2020 17:23:45", "IrnStatus": "ACT", "Irn": "11f8ef741fe294d4a14aad0b12457e62775d0fdc41a0dcf05b74fbb2ddc47acb", "SignedInvoice": "eyJhbGc...gumxIpg", "SignedQRCode": "eyJhbGc...oOZvxpw", "EwbStatus": "ACT", "EwbNo": "191008688443", "EwbTime": "27/11/2020 17:23:45", "EwbValidTill": "29/11/2020 17:23:45", "QRCodeImagePng": "gy72zt...3AAAAAElFTkSuQmCC", "QRCodeImageJpeg": null, "QRCodeImageGif": null, "EinvoicePdf": "i7gahsd...GY899RfTkSueba781Fg", "EwbPdf": "utwf19...34566AAAElFTkSuQmCC" } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "default": { "description": "The request failed. See the Octa-ErrorCode and Octa-ErrorMessage headers and the response body, if any.\n\nIf the API request fails for some reasons, the response payload will contain the failure status and a list of errors.", "headers": { "Octa-ErrorCode": { "$ref": "#/components/headers/OctaErrorCode" }, "Octa-ErrorMessage": { "$ref": "#/components/headers/OctaErrorMessage" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean" }, "Errors": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string" }, "Message": { "type": "string" } } } } } }, "example": { "Success": false, "Errors": [ { "Code": "ERR_CODE_1", "Message": "ERR MESSAGE 1" }, { "Code": "ERR_CODE_n", "Message": "ERR MESSAGE n" } ] } } } } } } }, "/api/octa/einvoice/cancelirn": { "post": { "operationId": "einvoiceCancelIrn", "summary": "Cancel IRN", "description": "This API is used to cancel IRN.", "tags": [ "E-Invoice & E-WayBills" ], "externalDocs": { "url": "https://octagst.com/octa/docs/api/einvoice/cancel-irn" }, "parameters": [ { "name": "gstin", "in": "query", "required": true, "description": "It specifies GSTIN of seller", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "Irn": { "type": "string", "maxLength": 64, "description": "Invoice reference number" }, "CnlRsn": { "type": "string", "maxLength": 1, "description": "Cancel reason\n`1`: Duplicate\n`2`: Data entry mistake" }, "CnlRem": { "type": "string", "maxLength": 100, "description": "Cancel remarks" } }, "required": [ "Irn", "CnlRsn", "CnlRem" ] }, "example": { "Irn": "34e60bdd02a8bdee4be4a4bc8d510ae0b8cc248b02009e5b875aced4fda57c76", "CnlRsn": "2", "CnlRem": "Wrong HSN codes reported" } } } }, "responses": { "200": { "description": "Response payload will contain the success status along with IRN information.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean", "description": "`true` in case of success" }, "Irn": { "type": "string", "description": "Invoice reference number which is cancelled" }, "CancelTime": { "type": "string", "description": "IRN cancellation time\n`DD/MM/YYYY HH:MM:SS`" } } }, "example": { "Success": true, "Irn": "a5c12dca80e743321740b001fd70953e8738d109865d28ba4013750f2046f229", "CancelTime": "29/11/2020 09:34:11" } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "default": { "description": "The request failed. See the Octa-ErrorCode and Octa-ErrorMessage headers and the response body, if any.\n\nIf API request fails for some reason, response payload will contain the failure status and a list of errors.", "headers": { "Octa-ErrorCode": { "$ref": "#/components/headers/OctaErrorCode" }, "Octa-ErrorMessage": { "$ref": "#/components/headers/OctaErrorMessage" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean" }, "Errors": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string" }, "Message": { "type": "string" } } } } } }, "example": { "Success": false, "Errors": [ { "Code": "ERR_CODE_1", "Message": "ERR MESSAGE 1" }, { "Code": "ERR_CODE_n", "Message": "ERR MESSAGE n" } ] } } } } } } }, "/api/octa/einvoice/getirn": { "get": { "operationId": "einvoiceGetIrn", "summary": "Get IRN", "description": "This API is used to get details of e-Invoice for a given IRN.", "tags": [ "E-Invoice & E-WayBills" ], "externalDocs": { "url": "https://octagst.com/octa/docs/api/einvoice/get-irn" }, "parameters": [ { "name": "gstin", "in": "query", "required": true, "description": "It specifies GSTIN of seller GSTIN", "schema": { "type": "string" } }, { "name": "irn", "in": "query", "required": true, "description": "It specifies Invoice reference number", "schema": { "type": "string" } }, { "name": "qrcode", "in": "query", "required": false, "description": "Specify `yes` to include QR Code image in response", "schema": { "type": "string", "enum": [ "yes", "no" ], "default": "no" } }, { "name": "qrcodeformat", "in": "query", "required": false, "description": "Specify QR code image format", "schema": { "type": "string", "enum": [ "PNG", "JPEG", "GIF" ], "default": "PNG" } }, { "name": "qrcodequality", "in": "query", "required": false, "description": "Specify QR code image quality", "schema": { "type": "string", "enum": [ "standard", "high" ], "default": "high" } }, { "name": "pdf", "in": "query", "required": false, "description": "Specify `yes` to include e-invoice pdf and e-waybill pdf in response", "schema": { "type": "string", "enum": [ "yes", "no" ], "default": "no" } } ], "responses": { "200": { "description": "Response payload will contain the success status along with IRN information.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean" }, "AckNo": { "type": "string" }, "AckTime": { "type": "string" }, "IrnStatus": { "type": "string" }, "Irn": { "type": "string" }, "SignedInvoice": { "type": "string" }, "SignedQRCode": { "type": "string" }, "EwbStatus": { "type": "string" }, "EwbNo": { "type": "string" }, "EwbTime": { "type": "string" }, "EwbValidTill": { "type": "string" }, "QRCodeImagePng": { "type": "string" }, "QRCodeImageJpeg": {}, "QRCodeImageGif": {}, "EinvoicePdf": { "type": "string" }, "EwbPdf": { "type": "string" } } }, "example": { "Success": true, "AckNo": "112010000002315", "AckTime": "27/11/2020 17:23:45", "IrnStatus": "ACT", "Irn": "11f8ef741fe294d4a14aad0b12457e62775d0fdc41a0dcf05b74fbb2ddc47acb", "SignedInvoice": "eyJhbGc...gumxIpg", "SignedQRCode": "eyJhbGc...oOZvxpw", "EwbStatus": "ACT", "EwbNo": "191008688443", "EwbTime": "27/11/2020 17:23:45", "EwbValidTill": "29/11/2020 17:23:45", "QRCodeImagePng": "gy72zt...3AAAAAElFTkSuQmCC", "QRCodeImageJpeg": null, "QRCodeImageGif": null, "EinvoicePdf": "i7gahsd...GY899RfTkSueba781Fg", "EwbPdf": "utwf19...34566AAAElFTkSuQmCC" } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "default": { "description": "The request failed. See the Octa-ErrorCode and Octa-ErrorMessage headers and the response body, if any.\n\nIf API request fails for some reason, response payload will contain the failure status and a list of errors.", "headers": { "Octa-ErrorCode": { "$ref": "#/components/headers/OctaErrorCode" }, "Octa-ErrorMessage": { "$ref": "#/components/headers/OctaErrorMessage" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean" }, "Errors": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string" }, "Message": { "type": "string" } } } } } }, "example": { "Success": false, "Errors": [ { "Code": "ERR_CODE_1", "Message": "ERR MESSAGE 1" }, { "Code": "ERR_CODE_n", "Message": "ERR MESSAGE n" } ] } } } } } } }, "/api/octa/einvoice/getirnbydoc": { "get": { "operationId": "einvoiceGetIrnByDoc", "summary": "Get IRN by Doc", "description": "This API is used to get details of e-Invoice for given document.", "tags": [ "E-Invoice & E-WayBills" ], "externalDocs": { "url": "https://octagst.com/octa/docs/api/einvoice/get-irn-by-doc" }, "parameters": [ { "name": "gstin", "in": "query", "required": true, "description": "It specifies GSTIN of seller GSTIN", "schema": { "type": "string" } }, { "name": "doctype", "in": "query", "required": true, "description": "It specifies document type\n`INV`: Invoice\n`CRN`: Credit note\n`DBN`: Debit note", "schema": { "type": "string", "enum": [ "INV", "CRN", "DBN" ] } }, { "name": "docno", "in": "query", "required": true, "description": "It specifies document number", "schema": { "type": "string" } }, { "name": "docdate", "in": "query", "required": true, "description": "It specifies document date\nFormat: `DD/MM/YYYY`", "schema": { "type": "string" } }, { "name": "qrcode", "in": "query", "required": false, "description": "Specify `yes` to include QR Code image in response", "schema": { "type": "string", "enum": [ "yes", "no" ], "default": "no" } }, { "name": "qrcodeformat", "in": "query", "required": false, "description": "Specify QR code image format", "schema": { "type": "string", "enum": [ "PNG", "JPEG", "GIF" ], "default": "PNG" } }, { "name": "qrcodequality", "in": "query", "required": false, "description": "Specify QR code image quality", "schema": { "type": "string", "enum": [ "standard", "high" ], "default": "high" } }, { "name": "pdf", "in": "query", "required": false, "description": "Specify `yes` to include e-invoice pdf and e-waybill pdf in response", "schema": { "type": "string", "enum": [ "yes", "no" ], "default": "no" } } ], "responses": { "200": { "description": "Response payload will contain the success status along with IRN information.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean" }, "AckNo": { "type": "string" }, "AckTime": { "type": "string" }, "IrnStatus": { "type": "string" }, "Irn": { "type": "string" }, "SignedInvoice": { "type": "string" }, "SignedQRCode": { "type": "string" }, "EwbStatus": { "type": "string" }, "EwbNo": { "type": "string" }, "EwbTime": { "type": "string" }, "EwbValidTill": { "type": "string" }, "QRCodeImagePng": { "type": "string" }, "QRCodeImageJpeg": {}, "QRCodeImageGif": {}, "EinvoicePdf": { "type": "string" }, "EwbPdf": { "type": "string" } } }, "example": { "Success": true, "AckNo": "112010000002315", "AckTime": "27/11/2020 17:23:45", "IrnStatus": "ACT", "Irn": "11f8ef741fe294d4a14aad0b12457e62775d0fdc41a0dcf05b74fbb2ddc47acb", "SignedInvoice": "eyJhbGc...gumxIpg", "SignedQRCode": "eyJhbGc...oOZvxpw", "EwbStatus": "ACT", "EwbNo": "191008688443", "EwbTime": "27/11/2020 17:23:45", "EwbValidTill": "29/11/2020 17:23:45", "QRCodeImagePng": "gy72zt...3AAAAAElFTkSuQmCC", "QRCodeImageJpeg": null, "QRCodeImageGif": null, "EinvoicePdf": "i7gahsd...GY899RfTkSueba781Fg", "EwbPdf": "utwf19...34566AAAElFTkSuQmCC" } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "default": { "description": "The request failed. See the Octa-ErrorCode and Octa-ErrorMessage headers and the response body, if any.\n\nIf API request fails for some reason, response payload will contain the failure status and a list of errors.", "headers": { "Octa-ErrorCode": { "$ref": "#/components/headers/OctaErrorCode" }, "Octa-ErrorMessage": { "$ref": "#/components/headers/OctaErrorMessage" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean" }, "Errors": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string" }, "Message": { "type": "string" } } } } } }, "example": { "Success": false, "Errors": [ { "Code": "ERR_CODE_1", "Message": "ERR MESSAGE 1" }, { "Code": "ERR_CODE_n", "Message": "ERR MESSAGE n" } ] } } } } } } }, "/api/octa/einvoice/generateewbbyirn": { "post": { "operationId": "einvoiceGenerateEwaybillByIrn", "summary": "Generate E-Waybill by IRN", "description": "This API is used to generate e-waybill for a given IRN.", "tags": [ "E-Invoice & E-WayBills" ], "externalDocs": { "url": "https://octagst.com/octa/docs/api/einvoice/generate-ewaybill-by-irn" }, "parameters": [ { "name": "gstin", "in": "query", "required": true, "description": "It specifies GSTIN of seller GSTIN", "schema": { "type": "string" } }, { "name": "pdf", "in": "query", "required": false, "description": "It specifies whether to include eWayBill pdf in response or not", "schema": { "type": "string", "enum": [ "yes", "no" ], "default": "no" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "Irn": { "type": "string", "maxLength": 64, "description": "E-Invoice IRN" }, "TransId": { "type": "string", "maxLength": 15, "description": "Transporter Id" }, "TransName": { "type": "string", "maxLength": 100, "description": "Transport Name" }, "TransMode": { "type": "string", "maxLength": 1, "description": "Transport Mode\n`1`: Road\n`2`: Rail\n`3`: Air\n`4`: Ship" }, "Distance": { "type": "number", "description": "Distance\nData type: Number(4)" }, "TransDocNo": { "type": "string", "maxLength": 15, "description": "Transporter Doc No" }, "TransDocDt": { "type": "string", "maxLength": 10, "description": "Transporter Doc Date\n`DD/MM/YYYY`" }, "VehNo": { "type": "string", "maxLength": 20, "description": "Vehicle No" }, "VehType": { "type": "string", "maxLength": 1, "description": "Vehicle Type\n`R`: Regular\n`O`: Over-Dimensional Cargo (ODC)" }, "ExpShipDtls": { "type": "object", "properties": { "Addr1": { "type": "string", "maxLength": 100, "description": "Address-1" }, "Addr2": { "type": "string", "maxLength": 100, "description": "Address-2" }, "Loc": { "type": "string", "maxLength": 100, "description": "Location (City/Town/Village)" }, "Pin": { "type": "number", "description": "Pin code\nData type: Number(6)" }, "Stcd": { "type": "string", "maxLength": 2, "description": "State Code" } }, "description": "This object contains the shiping details\nIf the dispatching address and/or shipping address have not been passed during generation of IRN, then the respective addresses can be passed here.", "required": [ "Addr1", "Loc", "Pin", "Stcd" ] } }, "required": [ "Irn", "Distance" ] }, "example": { "Irn": "eb68a55abbf1a31ae19a6c9d82a0b22ba37785b6b76949585e5f928fea4042cb", "TransId": "24ACPPM5624F1ZK", "TransName": "Golden Transport", "TransMode": "1", "Distance": 300, "TransDocNo": "RS021", "TransDocDt": "29/11/2020", "VehNo": "RJ016789", "VehType": "R", "ExpShipDtls": { "Addr1": "Sidiginamola Village", "Addr2": "Ballari", "Loc": "Ballari", "Pin": 583138, "Stcd": "29" } } } } }, "responses": { "200": { "description": "Response payload will contain the success status along with e-waybill information.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean", "description": "`true` in case of success" }, "EwbStatus": { "type": "string" }, "EwbNo": { "type": "string", "description": "e-waybill Number(present only if e-waybill is generated along with e-invoice)" }, "EwbTime": { "type": "string", "description": "e-waybill generation Date & time\n`DD/MM/YYYY HH:MM:SS`" }, "EwbValidTill": { "type": "string", "description": "e-waybill validity Date & time\n`DD/MM/YYYY HH:MM:SS`" }, "EwbPdf": { "type": "string", "contentEncoding": "base64", "description": "e-waybill PDF file\nData type: String (Binary data in Base64 encoding)" }, "EwbStstus": { "type": "string", "description": "EWB Status\n`ACT`: Active\n`CNL`: Cancelled`" } } }, "example": { "Success": true, "EwbStatus": "ACT", "EwbNo": "191008688443", "EwbTime": "27/11/2020 17:23:45", "EwbValidTill": "29/11/2020 17:23:45", "EwbPdf": "utwf19...34566AAAElFTkSuQmCC" } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "default": { "description": "The request failed. See the Octa-ErrorCode and Octa-ErrorMessage headers and the response body, if any.\n\nIf API request fails for some reason, response payload will contain the failure status and a list of errors.", "headers": { "Octa-ErrorCode": { "$ref": "#/components/headers/OctaErrorCode" }, "Octa-ErrorMessage": { "$ref": "#/components/headers/OctaErrorMessage" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean" }, "Errors": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string" }, "Message": { "type": "string" } } } } } }, "example": { "Success": false, "Errors": [ { "Code": "ERR_CODE_1", "Message": "ERR MESSAGE 1" }, { "Code": "ERR_CODE_n", "Message": "ERR MESSAGE n" } ] } } } } } } }, "/api/octa/einvoice/getewbbyirn": { "get": { "operationId": "einvoiceGetEwaybillByIrn", "summary": "Get E-Waybill by IRN", "description": "This API is used to get details of e-waybill for a given IRN.", "tags": [ "E-Invoice & E-WayBills" ], "externalDocs": { "url": "https://octagst.com/octa/docs/api/einvoice/get-ewaybill-by-irn" }, "parameters": [ { "name": "gstin", "in": "query", "required": true, "description": "It specifies GSTIN of seller GSTIN", "schema": { "type": "string" } }, { "name": "irn", "in": "query", "required": true, "description": "It specifies Invoice reference number", "schema": { "type": "string" } }, { "name": "pdf", "in": "query", "required": false, "description": "It specifies whether to include eWayBill pdf in response or not", "schema": { "type": "string", "enum": [ "yes", "no" ], "default": "no" } } ], "responses": { "200": { "description": "Response payload will contains the success status along with e-Waybill information.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean" }, "EwbStatus": { "type": "string" }, "EwbNo": { "type": "string" }, "EwbTime": { "type": "string" }, "EwbValidTill": { "type": "string" }, "EwbPdf": { "type": "string" } } }, "example": { "Success": true, "EwbStatus": "ACT", "EwbNo": "191008688443", "EwbTime": "27/11/2020 17:23:45", "EwbValidTill": "29/11/2020 17:23:45", "EwbPdf": "utwf19...34566AAAElFTkSuQmCC" } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "default": { "description": "The request failed. See the Octa-ErrorCode and Octa-ErrorMessage headers and the response body, if any.\n\nIf API request fails for some reason, response payload will contain the failure status and a list of errors.", "headers": { "Octa-ErrorCode": { "$ref": "#/components/headers/OctaErrorCode" }, "Octa-ErrorMessage": { "$ref": "#/components/headers/OctaErrorMessage" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean" }, "Errors": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string" }, "Message": { "type": "string" } } } } } }, "example": { "Success": false, "Errors": [ { "Code": "ERR_CODE_1", "Message": "ERR MESSAGE 1" }, { "Code": "ERR_CODE_n", "Message": "ERR MESSAGE n" } ] } } } } } } }, "/api/octa/einvoice/generateewaybill": { "post": { "operationId": "einvoiceGenerateEwaybill", "summary": "Generate E-Waybill", "description": "This API is used to generate e-waybill for outward and inward supplies where IRN is not required.", "tags": [ "E-Invoice & E-WayBills" ], "externalDocs": { "url": "https://octagst.com/octa/docs/api/einvoice/generate-ewaybill" }, "parameters": [ { "name": "gstin", "in": "query", "required": true, "description": "It specifies GSTIN of requester", "schema": { "type": "string" } } ], "requestBody": { "description": "Please visit NIC eWayBill portal to know about field validations and get masters defined for State Codes, supply type, document types, UQC,\nHSN, etc.\n\n[Validations on NIC Portal →](https://docs.ewaybillgst.gov.in/apidocs/version1.03/generate-eway-bill.html#validations)\n\n[State Codes on NIC Portal →](https://docs.ewaybillgst.gov.in/apidocs/state-code.html)\n\n[Master Codes on NIC Portal →](https://docs.ewaybillgst.gov.in/apidocs/master-codes-list.html)\n\n[Supply-Doc Type Mapping on NIC Portal →](https://docs.ewaybillgst.gov.in/apidocs/sub-docType-mapping.html)", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "supplyType": { "type": "string", "maxLength": 1, "description": "Supply Type\n`O`:Outward Supply\n`I`: Inward Supply" }, "subSupplyType": { "type": "string", "maxLength": 2, "description": "Sub Supply Type\n`1`: Supply\n`2`: Import\n`3`: Export\n`4`: Job Work\n`5`: For Own Use\n`6`: Job Work Returns\n`7`: Sales Return\n`8`: Others\n`9`: SKD/CKD\n`10`: Line Sales\n`11`: Recipient Not Known\n`12`: Exhibition or Fairs" }, "subSupplyDesc": {}, "docType": { "type": "string", "maxLength": 3, "description": "Document Type\n`INV`: Invoice\n`BIL`: Bill of Supply\n`BOE`: Bill of Entry\n`CHL`: Delivery Challan\n`OTH`: Others" }, "docNo": { "type": "string", "maxLength": 16, "description": "Document No\n`A-Z`, `0-9`, `/`, `-`" }, "docDate": { "type": "string", "maxLength": 10, "description": "Document Date\n`DD/MM/YYYY`" }, "fromGstin": { "type": "string", "maxLength": 15, "description": "GSTIN of the supplier/consignor" }, "fromTrdName": { "type": "string", "maxLength": 100, "description": "Legal/Trade Name of supplier/consignor" }, "fromAddr1": { "type": "string", "maxLength": 120, "description": "Address of supplier/consignor - Line 1" }, "fromAddr2": { "type": "string", "maxLength": 120, "description": "Address of supplier/consignor - Line 2" }, "fromPlace": { "type": "string", "maxLength": 50, "description": "Place of supplier/consignor (City/Town/Village)" }, "fromPincode": { "type": "number", "description": "Pincode of supplier/consignor\nData type: Number(6)" }, "actFromStateCode": { "type": "number", "description": "Dispatch from State code of supply\nData type: Number(2)" }, "fromStateCode": { "type": "number", "description": "State code of supplier/consignor\nData type: Number(2)" }, "toGstin": { "type": "string", "maxLength": 15, "description": "GSTIN of the recipient/consignee" }, "toTrdName": { "type": "string", "maxLength": 100, "description": "Legal/Trade Name of recipient/consignee" }, "toAddr1": { "type": "string", "maxLength": 120, "description": "Address of recipient/consignee - Line 1" }, "toAddr2": { "type": "string", "maxLength": 120, "description": "Address of recipient/consignee - Line 2" }, "toPlace": { "type": "string", "maxLength": 50, "description": "Place of recipient/consignee (City/Town/Village)" }, "toPincode": { "type": "number", "description": "Pincode of recipient/consignee\nData type: Number(6)" }, "actToStateCode": { "type": "number", "description": "ShipTo state code of supply\nData type: Number(2)" }, "toStateCode": { "type": "number", "description": "State code of recipient/consignee\nData type: Number(2)" }, "transactionType": { "type": "number", "description": "Document Type\n`1`: Regular\n`2`: Bill To - Ship To\n`3`: Bill From - Dispatch From\n`4`: Combinationn of 2 and 3\nData type: Number(1)" }, "otherValue": { "type": "number", "description": "Other charges\nData type: Number(18,2)" }, "totalValue": { "type": "number", "description": "Total taxable value.\nData type: Number(18,2)" }, "igstValue": { "type": "number", "description": "Total IGST Amount\nData type: Number(18,2)" }, "cgstValue": { "type": "number", "description": "Total CGST Amount\nData type: Number(18,2)" }, "sgstValue": { "type": "number", "description": "Total SGST Amount\nData type: Number(18,2)" }, "cessValue": { "type": "number", "description": "Total Cess Amount\nData type: Number(18, 2)" }, "cessNonAdvolValue": { "type": "number", "description": "Total Cess Non Advol Amount\nData type: Number(18,2)" }, "totInvValue": { "type": "number", "description": "Total document value\nData type: Number(18,2)" }, "transporterId": { "type": "string", "maxLength": 15, "description": "Transporter Id" }, "transporterName": { "type": [ "string", "null" ], "maxLength": 100, "description": "Transport Name" }, "transDocNo": { "type": [ "string", "null" ], "maxLength": 15, "description": "Transporter Doc No" }, "transMode": { "type": "string", "maxLength": 1, "description": "Transport Mode\n`1`: Road\n`2`: Rail\n`3`: Air\n`4`: Ship" }, "transDistance": { "type": "number", "description": "Distance\nData type: Number(4)" }, "transDocDate": { "type": [ "string", "null" ], "maxLength": 10, "description": "Transporter Doc Date\n`DD/MM/YYYY`" }, "vehicleNo": { "type": "string", "maxLength": 15, "description": "Vehicle No" }, "vehicleType": { "type": "string", "maxLength": 1, "description": "Vehicle Type\n`R`: Regular\n`O`: Over-Dimensional Cargo (ODC)" }, "itemList": { "type": "array", "items": { "type": "object", "properties": { "productName": { "type": "string", "maxLength": 100, "description": "Product name" }, "productDesc": { "type": "string", "maxLength": 100, "description": "Product/Item description" }, "hsnCode": { "type": [ "string", "integer" ], "maxLength": 8, "description": "HSN Code" }, "quantity": { "type": "number", "description": "Quantity\nData type: Number(8,2)" }, "qtyUnit": { "type": "string", "maxLength": 3, "description": "UQC" }, "taxableAmount": { "type": "number", "description": "Item Taxable Value\nData type: Number(18,2)" }, "igstRate": { "type": "number", "description": "IGST Rate\nData type: Number(6,3)" }, "cgstRate": { "type": "number", "description": "CGST Rate\nData type: Number(6,3)" }, "sgstRate": { "type": "number", "description": "SGST Rate\nData type: Number(6,3)" }, "cessRate": { "type": "number", "description": "Cess Rate\nData type: Number(6,3)" }, "cessNonadvol": { "type": "number", "description": "Cess Rate- Nonadvol\nData type: Number(6,3)" } }, "description": "This object contains details of line item", "required": [ "hsnCode", "taxableAmount" ] }, "description": "This object contains list of line items." }, "subSypplyDesc": { "type": "string", "maxLength": 20, "description": "Sub Supply Description if selected “Others” in subSupplyType" }, "shipToGstin": { "type": "string", "maxLength": 15, "description": "GSTIN of Ship To Party" }, "shipToTrdName": { "type": "string", "maxLength": 100, "description": "Legal/Trade Name of Ship To Party" } }, "required": [ "supplyType", "subSupplyType", "docType", "docNo", "docDate", "fromGstin", "fromPincode", "fromStateCode", "actFromStateCode", "toGstin", "toPincode", "toStateCode", "actToStateCode", "transactionType", "transDistance", "itemList" ] }, "example": { "supplyType": "O", "subSupplyType": "1", "subSupplyDesc": null, "docType": "INV", "docNo": "7001-8", "docDate": "15/12/2020", "fromGstin": "29AKLPM8755F1Z2", "fromTrdName": "Galaxy Mobile World Limited", "fromAddr1": "2ND CROSS NO 59 19 A", "fromAddr2": "GROUND FLOOR OSBORNE ROAD", "fromPlace": "Bangalore", "fromPincode": 560090, "actFromStateCode": 29, "fromStateCode": 29, "toGstin": "27EHFPS5910D2Z0", "toTrdName": "ABC India Limited", "toAddr1": "Shree Nilaya", "toAddr2": "Dasarahosahalli", "toPlace": "Thane", "toPincode": 560090, "actToStateCode": 27, "toStateCode": 27, "transactionType": 0, "otherValue": 0, "totalValue": 5000, "igstValue": 900, "cgstValue": 0, "sgstValue": 0, "cessValue": 0, "cessNonAdvolValue": 0, "totInvValue": 5900, "transporterId": "29AASFB9647G1ZU", "transporterName": null, "transDocNo": null, "transMode": "1", "transDistance": 1300, "transDocDate": null, "vehicleNo": "KA271C4869", "vehicleType": "R", "itemList": [ { "productName": "Delta G10B", "productDesc": "Delta 4G Phone with 2M Camera", "hsnCode": 851712, "quantity": 1, "qtyUnit": "NOS", "taxableAmount": 5000, "igstRate": 18, "cgstRate": 0, "sgstRate": 0, "cessRate": 0, "cessNonadvol": 0 } ] } } } }, "responses": { "200": { "description": "Response payload will contain the success status along with eWayBill information.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean", "description": "`true` in case of success" }, "EwbStatus": { "type": "string", "description": "EWB Status\n`ACT`: Active\n`CNL`: Cancelled" }, "EwbNo": { "type": "string", "description": "e-waybill Number(present only if e-waybill is generated along with e-invoice)" }, "EwbTime": { "type": "string", "description": "e-waybill generation Date & time\n`DD/MM/YYYY HH:MM:SS`" }, "EwbValidTill": { "type": "string", "description": "e-waybill validity Date & time\n`DD/MM/YYYY HH:MM:SS`" }, "Errors": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string", "description": "Error Code" }, "Message": { "type": "string", "description": "Error message" } } }, "description": "List of errors, will be present only when Success is `false`" } } }, "example": { "Success": true, "EwbStatus": "ACT", "EwbNo": "191008688443", "EwbTime": "27/11/2020 17:23:45", "EwbValidTill": "29/11/2020 17:23:45" } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "default": { "description": "The request failed. See the Octa-ErrorCode and Octa-ErrorMessage headers and the response body, if any.\n\nIf the API request fails for some reasons, the response payload will contain the failure status and a list of errors.", "headers": { "Octa-ErrorCode": { "$ref": "#/components/headers/OctaErrorCode" }, "Octa-ErrorMessage": { "$ref": "#/components/headers/OctaErrorMessage" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean" }, "Errors": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string" }, "Message": { "type": "string" } } } } } }, "example": { "Success": false, "Errors": [ { "Code": "ERR_CODE_1", "Message": "ERR MESSAGE 1" }, { "Code": "ERR_CODE_n", "Message": "ERR MESSAGE n" } ] } } } } } } }, "/api/octa/einvoice/cancelewb": { "post": { "operationId": "einvoiceCancelEwaybill", "summary": "Cancel E-Waybill", "description": "This API is used to cancel ewayBill.", "tags": [ "E-Invoice & E-WayBills" ], "externalDocs": { "url": "https://octagst.com/octa/docs/api/einvoice/cancel-ewaybill" }, "parameters": [ { "name": "gstin", "in": "query", "required": true, "description": "It specifies GSTIN of seller", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ewbNo": { "type": "string", "maxLength": 20, "description": "e-Waybill number" }, "cancelRsnCode": { "type": "string", "maxLength": 1, "description": "Cancel reason\n`1`: Duplicate\n`2`: Order Cancelled\n`3`: Data entry mistake\n`4`: Others" }, "cancelRmrk": { "type": "string", "maxLength": 100, "description": "Cancel remarks" } }, "required": [ "ewbNo", "cancelRsnCode", "cancelRmrk" ] }, "example": { "ewbNo": "791008693652", "cancelRsnCode": "2", "cancelRmrk": "Wrong HSN codes reported" } } } }, "responses": { "200": { "description": "Response payload will contain the success status.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean", "description": "`true` in case of success" }, "CancelTime": { "type": "string", "description": "EWB cancellation time\n`DD/MM/YYYY HH:MM:SS`" } } }, "example": { "Success": true, "CancelTime": "29/11/2020 09:34:11" } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "default": { "description": "The request failed. See the Octa-ErrorCode and Octa-ErrorMessage headers and the response body, if any.\n\nIf API request fails for some reason, response payload will contain the failure status and a list of errors.", "headers": { "Octa-ErrorCode": { "$ref": "#/components/headers/OctaErrorCode" }, "Octa-ErrorMessage": { "$ref": "#/components/headers/OctaErrorMessage" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean" }, "Errors": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string" }, "Message": { "type": "string" } } } } } }, "example": { "Success": false, "Errors": [ { "Code": "ERR_CODE_1", "Message": "ERR MESSAGE 1" }, { "Code": "ERR_CODE_n", "Message": "ERR MESSAGE n" } ] } } } } } } }, "/api/octa/einvoice/closeewb": { "post": { "operationId": "einvoiceCloseEwaybill", "summary": "Close E-Waybill", "description": "This API is used to close ewayBill.", "tags": [ "E-Invoice & E-WayBills" ], "externalDocs": { "url": "https://octagst.com/octa/docs/api/einvoice/close-ewaybill" }, "parameters": [ { "name": "gstin", "in": "query", "required": true, "description": "It specifies GSTIN of seller", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ewbNo": { "type": "string", "maxLength": 20, "description": "e-Waybill number" }, "closureDate": { "type": "string", "description": "e-Waybill closure date\n`DD/MM/YYYY`" }, "remarks": { "type": "string", "maxLength": 100, "description": "Reason for closing eway bill" } }, "required": [ "ewbNo", "closureDate", "remarks" ] }, "example": { "ewbNo": "791008693652", "closureDate": "21/07/2026", "remarks": "Material delivered " } } } }, "responses": { "200": { "description": "Response payload will contain the success status.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean", "description": "`true` in case of success" }, "ClosureAckTime": { "type": "string", "description": "e-Waybill closure acknowledgement time\n`DD/MM/YYYY HH:MM:SS`" } } }, "example": { "Success": true, "ClosureAckTime": "21/07/20206 09:34:11" } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "default": { "description": "The request failed. See the Octa-ErrorCode and Octa-ErrorMessage headers and the response body, if any.\n\nIf API request fails for some reason, response payload will contain the failure status and a list of errors.", "headers": { "Octa-ErrorCode": { "$ref": "#/components/headers/OctaErrorCode" }, "Octa-ErrorMessage": { "$ref": "#/components/headers/OctaErrorMessage" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean" }, "Errors": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string" }, "Message": { "type": "string" } } } } } }, "example": { "Success": false, "Errors": [ { "Code": "ERR_CODE_1", "Message": "ERR MESSAGE 1" }, { "Code": "ERR_CODE_n", "Message": "ERR MESSAGE n" } ] } } } } } } }, "/api/octa/einvoice/getewaybillgeneratedbyconsigner": { "get": { "operationId": "einvoiceGetEwaybillGeneratedByConsigner", "summary": "Get E-Waybill Generated By Consigner", "description": "This API is used to get details of e-waybill generated by consigner for a given document.", "tags": [ "E-Invoice & E-WayBills" ], "externalDocs": { "url": "https://octagst.com/octa/docs/api/einvoice/get-ewaybill-generated-by-consigner" }, "parameters": [ { "name": "gstin", "in": "query", "required": true, "description": "It specifies GSTIN of requester", "schema": { "type": "string" } }, { "name": "doctype", "in": "query", "required": true, "description": "It specifies document type\n`INV`: Invoice\n`BIL`: Bill of Supply\n`BOE`: Bill of Entry\n`CHL`: Delivery Challan\n`OTH`: Others", "schema": { "type": "string", "enum": [ "INV", "BIL", "BOE", "CHL", "OTH" ] } }, { "name": "docno", "in": "query", "required": true, "description": "It specifies document number", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response payload will contains the success status along with e-Waybill information.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean" }, "EwbStatus": { "type": "string" }, "EwbNo": { "type": "string" }, "EwbTime": { "type": "string" }, "EwbValidTill": { "type": "string" } } }, "example": { "Success": true, "EwbStatus": "ACT", "EwbNo": "191008688443", "EwbTime": "27/11/2020 17:23:45", "EwbValidTill": "29/11/2020 17:23:45" } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "default": { "description": "The request failed. See the Octa-ErrorCode and Octa-ErrorMessage headers and the response body, if any.\n\nIf API request fails for some reason, response payload will contain the failure status and a list of errors.", "headers": { "Octa-ErrorCode": { "$ref": "#/components/headers/OctaErrorCode" }, "Octa-ErrorMessage": { "$ref": "#/components/headers/OctaErrorMessage" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean" }, "Errors": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string" }, "Message": { "type": "string" } } } } } }, "example": { "Success": false, "Errors": [ { "Code": "ERR_CODE_1", "Message": "ERR MESSAGE 1" }, { "Code": "ERR_CODE_n", "Message": "ERR MESSAGE n" } ] } } } } } } }, "/api/octa/einvoice/getewaybillsofotherparty": { "get": { "operationId": "einvoiceGetEwaybillsOtherParty", "summary": "Get E-Waybill Generated By Other Party", "description": "This API is used to get details of e-waybill generated by other party on your GSTIN.", "tags": [ "E-Invoice & E-WayBills" ], "externalDocs": { "url": "https://octagst.com/octa/docs/api/einvoice/get-ewaybills-other-party" }, "parameters": [ { "name": "gstin", "in": "query", "required": true, "description": "It specifies GSTIN of requester", "schema": { "type": "string" } }, { "name": "date", "in": "query", "required": true, "description": "I It specifies E-way bill generated Date\nFormat: `DD/MM/YYYY`", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response payload will contains the success status along with e-Waybill information.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean" }, "Response": { "type": "array", "items": { "type": "object", "properties": { "ewbNo": { "type": "integer" }, "ewayBillDate": { "type": "string" }, "genGstin": { "type": "string" }, "docNo": { "type": "string" }, "docDate": { "type": "string" }, "fromGstin": { "type": "string" }, "fromTradeName": { "type": "string" }, "toGstin": { "type": "string" }, "toTradeName": { "type": "string" }, "totInvValue": { "type": "integer" }, "hsnCode": { "type": "integer" }, "hsnDesc": { "type": "string" }, "status": { "type": "string" }, "rejectStatus": { "type": "string" }, "genMode": { "type": "string" }, "fromgstin": { "type": "string" }, "fromTradename": { "type": "string" }, "togstin": { "type": "string" }, "toTradename": { "type": "string" }, "hsncode": { "type": "integer" }, "hsndesc": { "type": "string" } } } } } }, "example": { "Success": true, "Response": [ { "ewbNo": 151000256262, "ewayBillDate": "10/12/2017 10:45:00", "genMode": "API", "genGstin": "29AMRPV8729L1Z1", "docNo": "TA119", "docDate": "22/09/2017", "fromgstin": "29AAAAX1234S1ZN", "fromTradename": "XYZ Enterprises", "togstin": "29YYYXX1234S1ZN", "toTradename": "ABC Enterprises", "totInvValue": 1234556, "hsncode": 12, "hsndesc": "Mobile Phones", "status": "ACT", "rejectStatus": "Y" }, { "ewbNo": 121000359898, "ewayBillDate": "10/12/2017 10:45:00", "genGstin": "29AAECP2371C1ZL", "docNo": "TA120", "docDate": "20/09/2017", "fromGstin": "29AAAAX1234S1ZN", "fromTradeName": "XYZ Enterprises", "toGstin": "29YYYXX1234S1ZN", "toTradeName": "ABC Enterprises", "totInvValue": 1234556, "hsnCode": 12, "hsnDesc": "Wheat & other grains", "status": "ACT", "rejectStatus": "Y" } ] } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "default": { "description": "The request failed. See the Octa-ErrorCode and Octa-ErrorMessage headers and the response body, if any.\n\nIf API request fails for some reason, response payload will contain the failure status and a list of errors.", "headers": { "Octa-ErrorCode": { "$ref": "#/components/headers/OctaErrorCode" }, "Octa-ErrorMessage": { "$ref": "#/components/headers/OctaErrorMessage" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean" }, "Errors": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string" }, "Message": { "type": "string" } } } } } }, "example": { "Success": false, "Errors": [ { "Code": "ERR_CODE_1", "Message": "ERR MESSAGE 1" }, { "Code": "ERR_CODE_n", "Message": "ERR MESSAGE n" } ] } } } } } } }, "/api/octa/einvoice/getewaybillsbydate": { "get": { "operationId": "einvoiceGetEwaybillsByDate", "summary": "Get E-Waybill By Date", "description": "This API is used to get list of e-waybill generated on specific date.", "tags": [ "E-Invoice & E-WayBills" ], "externalDocs": { "url": "https://octagst.com/octa/docs/api/einvoice/get-ewaybills-by-date" }, "parameters": [ { "name": "gstin", "in": "query", "required": true, "description": "It specifies GSTIN of requester", "schema": { "type": "string" } }, { "name": "date", "in": "query", "required": true, "description": "I It specifies E-way bill generated Date\nFormat: `DD/MM/YYYY`", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response payload will contains the success status along with e-Waybill information.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean" }, "Response": { "type": "array", "items": { "type": "object", "properties": { "ewbNo": { "type": "integer" }, "ewbDate": { "type": "string" }, "status": { "type": "string" }, "genGstin": { "type": "string" }, "docNo": { "type": "string" }, "docDate": { "type": "string" }, "delPinCode": { "type": "integer" }, "delStateCode": { "type": "integer" }, "delPlace": { "type": "string" }, "validUpto": { "type": "string" }, "extendedTimes": { "type": "integer" }, "rejectStatus": { "type": "string" } } } } } }, "example": { "Success": true, "Response": [ { "ewbNo": 141001634831, "ewbDate": "22/03/2019 12:59:00", "status": "ACT", "genGstin": "29AKLPM8755F1Z2", "docNo": "INV0001", "docDate": "15/02/2019", "delPinCode": 560090, "delStateCode": 29, "delPlace": "Bangalore", "validUpto": "23/03/2019 11:59:00", "extendedTimes": 0, "rejectStatus": "N" }, { "ewbNo": 141001634789, "ewbDate": "22/03/2019 14:27:00", "status": "ACT", "genGstin": "1029AKLPM8755F1Z2", "docNo": "INV0002", "docDate": "15/02/2019", "delPinCode": 560090, "delStateCode": 29, "delPlace": "Bangalore", "validUpto": "26/03/2019 11:59:00", "extendedTimes": 0, "rejectStatus": "N" } ] } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "default": { "description": "The request failed. See the Octa-ErrorCode and Octa-ErrorMessage headers and the response body, if any.\n\nIf API request fails for some reason, response payload will contain the failure status and a list of errors.", "headers": { "Octa-ErrorCode": { "$ref": "#/components/headers/OctaErrorCode" }, "Octa-ErrorMessage": { "$ref": "#/components/headers/OctaErrorMessage" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean" }, "Errors": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string" }, "Message": { "type": "string" } } } } } }, "example": { "Success": false, "Errors": [ { "Code": "ERR_CODE_1", "Message": "ERR MESSAGE 1" }, { "Code": "ERR_CODE_n", "Message": "ERR MESSAGE n" } ] } } } } } } }, "/api/octa/einvoice/getewaybill": { "get": { "operationId": "einvoiceGetEwaybill", "summary": "Get E-Waybill", "description": "This API is used to get details of e-waybill for a given EWaybill number.", "tags": [ "E-Invoice & E-WayBills" ], "externalDocs": { "url": "https://octagst.com/octa/docs/api/einvoice/get-ewaybill" }, "parameters": [ { "name": "gstin", "in": "query", "required": true, "description": "It specifies GSTIN of requester", "schema": { "type": "string" } }, { "name": "ewbNo", "in": "query", "required": true, "description": "It specifies EWaybill number", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response payload will contains the success status along with e-Waybill details.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean" }, "Response": { "type": "object", "properties": { "ewbNo": { "type": "integer" }, "ewayBillDate": { "type": "string" }, "genMode": { "type": "string" }, "userGstin": { "type": "string" }, "supplyType": { "type": "string" }, "subSupplyType": { "type": "string" }, "docType": { "type": "string" }, "docNo": { "type": "string" }, "docDate": { "type": "string" }, "fromGstin": { "type": "string" }, "fromTrdName": { "type": "string" }, "fromAddr1": { "type": "string" }, "fromAddr2": { "type": "string" }, "fromPlace": { "type": "string" }, "fromPincode": { "type": "integer" }, "fromStateCode": { "type": "integer" }, "toGstin": { "type": "string" }, "toTrdName": { "type": "string" }, "toAddr1": { "type": "string" }, "toAddr2": { "type": "string" }, "toPlace": { "type": "string" }, "toPincode": { "type": "integer" }, "toStateCode": { "type": "integer" }, "totalValue": { "type": "integer" }, "totInvValue": { "type": "integer" }, "cgstValue": { "type": "integer" }, "sgstValue": { "type": "integer" }, "igstValue": { "type": "integer" }, "cessValue": { "type": "number" }, "transporterId": {}, "transporterName": {}, "status": { "type": "string" }, "actualDist": { "type": "integer" }, "noValidDays": { "type": "integer" }, "validUpto": { "type": "string" }, "extendedTimes": { "type": "integer" }, "rejectStatus": { "type": "string" }, "actFromStateCode": { "type": "integer" }, "actToStateCode": { "type": "integer" }, "vehicleType": { "type": "string" }, "transactionType": { "type": "integer" }, "otherValue": { "type": "integer" }, "cessNonAdvolValue": { "type": "integer" }, "itemList": { "type": "array", "items": { "type": "object", "properties": { "itemNo": { "type": "integer" }, "productId": { "type": "integer" }, "productName": { "type": "string" }, "productDesc": { "type": [ "string", "null" ] }, "hsnCode": { "type": "integer" }, "quantity": { "type": "integer" }, "qtyUnit": { "type": "string" }, "cgstRate": { "type": "number" }, "sgstRate": { "type": "number" }, "igstRate": { "type": "integer" }, "cessRate": { "type": "integer" }, "cessNonAdvol": { "type": "integer" }, "taxableAmount": { "type": "integer" } } } }, "VehiclListDetails": { "type": "array", "items": { "type": "object", "properties": { "updMode": { "type": "string" }, "vehicleNo": { "type": "string" }, "fromPlace": { "type": "string" }, "fromState": { "type": "integer" }, "tripshtNo": { "type": "integer" }, "userGSTINTransin": { "type": "string" }, "enteredDate": { "type": "string" }, "transMode": { "type": "string" }, "transDocNo": { "type": "string" }, "transDocDate": { "type": [ "string", "null" ] }, "vehicleType": { "type": "string" }, "groupNo": { "type": "string" } } } } } } } }, "example": { "Success": true, "Response": { "ewbNo": 131001298692, "ewayBillDate": "26/09/2018 02:40:00", "genMode": "API", "userGstin": "29AKLPM8755F1Z2", "supplyType": "O", "subSupplyType": "1", "docType": "INV", "docNo": "7007-8", "docDate": "10/09/2018", "fromGstin": "29AKLPM8755F1Z2", "fromTrdName": "welton", "fromAddr1": "4556", "fromAddr2": "hulimavu", "fromPlace": "bannargatta", "fromPincode": 560090, "fromStateCode": 29, "toGstin": "02EHFPS5910D2Z0", "toTrdName": "test2", "toAddr1": "Shree Nilaya", "toAddr2": "Dasarahosahalli", "toPlace": "Beml Nagar", "toPincode": 560090, "toStateCode": 29, "totalValue": 56099, "totInvValue": 68358, "cgstValue": 1, "sgstValue": 1, "igstValue": 0, "cessValue": 400.56, "transporterId": null, "transporterName": null, "status": "ACT", "actualDist": 2500, "noValidDays": 25, "validUpto": "27/09/2018 17:59:00", "extendedTimes": 0, "rejectStatus": "N", "actFromStateCode": 29, "actToStateCode": 29, "vehicleType": "R", "transactionType": 4, "otherValue": -10, "cessNonAdvolValue": 400, "itemList": [ { "itemNo": 1, "productId": 0, "productName": "CEMENT", "productDesc": null, "hsnCode": 25210010, "quantity": 2, "qtyUnit": "BOX", "cgstRate": 0.05, "sgstRate": 0.05, "igstRate": 0, "cessRate": 3, "cessNonAdvol": 0, "taxableAmount": 56 }, { "itemNo": 2, "productId": 0, "productName": "steel", "productDesc": "steel rods", "hsnCode": 2402, "quantity": 4, "qtyUnit": "NOS", "cgstRate": 10, "sgstRate": 10, "igstRate": 0, "cessRate": 3, "cessNonAdvol": 0, "taxableAmount": 0 } ], "VehiclListDetails": [ { "updMode": "API", "vehicleNo": "PQR1234", "fromPlace": "Bengaluru", "fromState": 29, "tripshtNo": 1810002031, "userGSTINTransin": "29AKLPM8755F1Z2", "enteredDate": "26/09/2018 02:40:00", "transMode": "1 ", "transDocNo": "1234", "transDocDate": "03/05/2018", "groupNo": "1" }, { "updMode": "API", "vehicleNo": "PQR1234", "fromPlace": "Bengaluru", "fromState": 29, "tripshtNo": 1110002030, "userGSTINTransin": "29AKLPM8755F1Z2", "enteredDate": "26/09/2018 02:40:00", "transMode": "1", "transDocNo": "1234", "transDocDate": "03/05/2018", "vehicleType": "", "groupNo": "0" }, { "updMode": "API", "vehicleNo": "KA25AB3456", "fromPlace": "BANGALORE SOUTH", "fromState": 29, "tripshtNo": 1510002029, "userGSTINTransin": "29AKLPM8755F1Z2", "enteredDate": "26/09/2018 02:40:00", "transMode": "1", "transDocNo": "1234", "transDocDate": "12/10/2017", "vehicleType": "", "groupNo": "0" }, { "updMode": "API", "vehicleNo": "KA25AB3456", "fromPlace": "BANGALORE SOUTH", "fromState": 29, "tripshtNo": 1810002028, "userGSTINTransin": "29AKLPM8755F1Z2", "enteredDate": "26/09/2018 02:40:00", "transMode": "1 ", "transDocNo": "1234", "transDocDate": "12/10/2017", "vehicleType": "", "groupNo": "0" }, { "updMode": "API", "vehicleNo": "RJ191G5024", "fromPlace": "bannargatta", "fromState": 29, "tripshtNo": 0, "userGSTINTransin": "29AKLPM8755F1Z2", "enteredDate": "26/09/2018 02:40:00", "transMode": "1 ", "transDocNo": "12345", "transDocDate": null, "vehicleType": "R", "groupNo": "0" } ] } } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "default": { "description": "The request failed. See the Octa-ErrorCode and Octa-ErrorMessage headers and the response body, if any.\n\nIf API request fails for some reason, response payload will contain the failure status and a list of errors.", "headers": { "Octa-ErrorCode": { "$ref": "#/components/headers/OctaErrorCode" }, "Octa-ErrorMessage": { "$ref": "#/components/headers/OctaErrorMessage" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean" }, "Errors": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string" }, "Message": { "type": "string" } } } } } }, "example": { "Success": false, "Errors": [ { "Code": "ERR_CODE_1", "Message": "ERR MESSAGE 1" }, { "Code": "ERR_CODE_n", "Message": "ERR MESSAGE n" } ] } } } } } } }, "/api/octa/einvoice/getgstin": { "get": { "operationId": "einvoiceGetGstin", "summary": "Get GSTIN", "description": "This API is used to get details of GSTIN.", "tags": [ "E-Invoice & E-WayBills" ], "externalDocs": { "url": "https://octagst.com/octa/docs/api/einvoice/get-gstin" }, "parameters": [ { "name": "gstin", "in": "query", "required": true, "description": "It specifies GSTIN of seller GSTIN", "schema": { "type": "string" } }, { "name": "partygstin", "in": "query", "required": true, "description": "It specifies GSTIN whose details to be fetched", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response payload will contains the success status along with GSTIN information.\n\n`Status` will have values as 'ACT' (Active) or 'CNL' (Cancelled) or 'INA' (Inactive) or 'PRO' (Provision).\n\nThe `blkStatus` indicates the status of blocking of generation of E Way Bill and will have following values\n\n- `U` or `null` for Unblocked\n- `B` for blocked\n\n E-Waybill generation is blocked for tax payers who have not filed the returns for last two months.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean" }, "Gstin": { "type": "string" }, "TradeName": { "type": "string" }, "LegalName": { "type": "string" }, "AddrBnm": { "type": "string" }, "AddrBno": { "type": "string" }, "AddrFlno": { "type": "string" }, "AddrSt": { "type": "string" }, "AddrLoc": { "type": "string" }, "StateCode": { "type": "integer" }, "AddrPncd": { "type": "integer" }, "TxpType": { "type": "string" }, "Status": { "type": "string" }, "BlkStatus": {} } }, "example": { "Success": true, "Gstin": "24ACPPM5624F1ZK", "TradeName": "SHASTRI TROLLY WORKS", "LegalName": "MANHARBHAI VISHNUBHAI MISTRI", "AddrBnm": "TALUKDARI HOSTEL", "AddrBno": "SHASTRI TROLLY WORKS", "AddrFlno": "", "AddrSt": "ASHRAM ROAD", "AddrLoc": "NADIAD", "StateCode": 24, "AddrPncd": 387002, "TxpType": "REG", "Status": "ACT", "BlkStatus": null } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "default": { "description": "The request failed. See the Octa-ErrorCode and Octa-ErrorMessage headers and the response body, if any.\n\nIf API request fails for some reason, response payload will contain the failure status and a list of errors.", "headers": { "Octa-ErrorCode": { "$ref": "#/components/headers/OctaErrorCode" }, "Octa-ErrorMessage": { "$ref": "#/components/headers/OctaErrorMessage" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean" }, "Errors": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string" }, "Message": { "type": "string" } } } } } }, "example": { "Success": false, "Errors": [ { "Code": "ERR_CODE_1", "Message": "ERR MESSAGE 1" }, { "Code": "ERR_CODE_n", "Message": "ERR MESSAGE n" } ] } } } } } } }, "/api/octa/einvoice/getdocirninfo": { "get": { "operationId": "einvoiceGetDocIrnInfo", "summary": "Get Doc IRN Info", "description": "This API is used to get IRN details of already generated e-invoice.", "tags": [ "E-Invoice & E-WayBills" ], "externalDocs": { "url": "https://octagst.com/octa/docs/api/einvoice/get-doc-irn-info" }, "parameters": [ { "name": "gstin", "in": "query", "required": true, "description": "It specifies GSTIN of seller GSTIN", "schema": { "type": "string" } }, { "name": "doctype", "in": "query", "required": true, "description": "It specifies document type\n`INV`: Invoice\n`CRN`: Credit note\n`DBN`: Debit note", "schema": { "type": "string", "enum": [ "INV", "CRN", "DBN" ] } }, { "name": "docno", "in": "query", "required": true, "description": "It specifies document number", "schema": { "type": "string" } }, { "name": "docdate", "in": "query", "required": true, "description": "It specifies document date\nFormat: `DD/MM/YYYY`", "schema": { "type": "string" } }, { "name": "qrcode", "in": "query", "required": false, "description": "Specify `yes` to include QR Code image in response", "schema": { "type": "string", "enum": [ "yes", "no" ], "default": "no" } }, { "name": "pdf", "in": "query", "required": false, "description": "Specify `yes` to include e-invoice pdf and e-waybill pdf in response", "schema": { "type": "string", "enum": [ "yes", "no" ], "default": "no" } } ], "responses": { "200": { "description": "Response payload will contain the success status along with IRN information.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean" }, "AckNo": { "type": "string" }, "AckTime": { "type": "string" }, "IrnStatus": { "type": "string" }, "Irn": { "type": "string" }, "SignedInvoice": { "type": "string" }, "SignedQRCode": { "type": "string" }, "EwbStatus": { "type": "string" }, "EwbNo": { "type": "string" }, "EwbTime": { "type": "string" }, "EwbValidTill": { "type": "string" }, "QRCodeImagePng": { "type": "string" }, "EinvoicePdf": { "type": "string" }, "EwbPdf": { "type": "string" } } }, "example": { "Success": true, "AckNo": "112010000002315", "AckTime": "27/11/2020 17:23:45", "IrnStatus": "ACT", "Irn": "11f8ef741fe294d4a14aad0b12457e62775d0fdc41a0dcf05b74fbb2ddc47acb", "SignedInvoice": "eyJhbGc...gumxIpg", "SignedQRCode": "eyJhbGc...oOZvxpw", "EwbStatus": "ACT", "EwbNo": "191008688443", "EwbTime": "27/11/2020 17:23:45", "EwbValidTill": "29/11/2020 17:23:45", "QRCodeImagePng": "gy72zt...3AAAAAElFTkSuQmCC", "EinvoicePdf": "i7gahsd...GY899RfTkSueba781Fg", "EwbPdf": "utwf19...34566AAAElFTkSuQmCC" } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "default": { "description": "The request failed. See the Octa-ErrorCode and Octa-ErrorMessage headers and the response body, if any.\n\nIf API request fails for some reason, response payload will contain the failure status and a list of errors.", "headers": { "Octa-ErrorCode": { "$ref": "#/components/headers/OctaErrorCode" }, "Octa-ErrorMessage": { "$ref": "#/components/headers/OctaErrorMessage" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean" }, "Errors": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string" }, "Message": { "type": "string" } } } } } }, "example": { "Success": false, "Errors": [ { "Code": "ERR_CODE_1", "Message": "ERR MESSAGE 1" }, { "Code": "ERR_CODE_n", "Message": "ERR MESSAGE n" } ] } } } } } } }, "/api/octa/einvoice/generatepaymentqrcode": { "post": { "operationId": "einvoiceGeneratePaymentQrcode", "summary": "Generate Payment QR Code", "description": "This API is used to generate the dynamic QR code for B2C invoices to support online UPI payment.", "tags": [ "E-Invoice & E-WayBills" ], "externalDocs": { "url": "https://octagst.com/octa/docs/api/einvoice/generate-payment-qrcode" }, "parameters": [ { "name": "qrcode", "in": "query", "required": false, "description": "Specify `yes` to include QR Code image in response", "schema": { "type": "string", "enum": [ "yes", "no" ], "default": "no" } }, { "name": "qrcodeformat", "in": "query", "required": false, "description": "Specify QR code image format", "schema": { "type": "string", "enum": [ "PNG", "JPEG", "GIF" ], "default": "PNG" } }, { "name": "qrcodequality", "in": "query", "required": false, "description": "Specify QR code image quality", "schema": { "type": "string", "enum": [ "standard", "high" ], "default": "high" } }, { "name": "pdf", "in": "query", "required": false, "description": "Specify `yes` to include e-invoice pdf and e-waybill pdf in response", "schema": { "type": "string", "enum": [ "yes", "no" ], "default": "no" } } ], "requestBody": { "description": "Request payload should contain the JSON encoded invoice data. This payload is similar to the `Generate IRN` API with the\nonly difference of supply type which has to be set to `B2C`.", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "TranDtls": { "type": "object", "properties": { "SupTyp": { "type": "string" } } }, "BuyerDtls": { "type": "object", "properties": { "Gstin": {} } } } }, "example": { "TranDtls": { "SupTyp": "B2C" }, "BuyerDtls": { "Gstin": null } } } } }, "responses": { "200": { "description": "Response payload will contain the success status along with IRN information.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean", "description": "`true` in case of success" }, "QRCodeImagePng": { "type": "string", "contentEncoding": "base64", "description": "e-Invoice QR code PNG image\nData type: String (Binary data in Base64 encoding)" }, "PaymentQrCode": { "type": "string", "contentEncoding": "base64", "description": "Contents of dynamic QR code\nData type: String (Binary data in Base64 encoding)" }, "QRCodeImageJpeg": { "type": "string", "contentEncoding": "base64", "description": "e-Invoice QR code JPEG image\nData type: String (Binary data in Base64 encoding)" }, "QRCodeImageGif": { "type": "string", "contentEncoding": "base64", "description": "e-Invoice QR code GIF image\nData type: String (Binary data in Base64 encoding)" }, "Errors": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string", "description": "Error Code" }, "Message": { "type": "string", "description": "Error message" } } }, "description": "List of errors, will be present only when Success is `false`" } } }, "example": { "Success": true, "QRCodeImagePng": "iVBORw0KGgoAAAANSUhEUgAAAHIAAAB...IPwEIVCUYnlSs/gAAAABJRU5ErkJggg==", "PaymentQrCode": "upi://pay?pa=blowbits@ybl&pn=BLOWBITS%20SOLUTIONS%20LLP&tn=SELLER:08AASFB9647G1ZU%20NO:B2C1617260496%20DT:01-04-2021%20Taxable:%e2%82%b95000%20IGST:%e2%82%b9900&am=5900&cu=INR&mode=01" } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "default": { "description": "The request failed. See the Octa-ErrorCode and Octa-ErrorMessage headers and the response body, if any.\n\nIf the API request fails for some reasons, the response payload will contain the failure status and a list of errors.", "headers": { "Octa-ErrorCode": { "$ref": "#/components/headers/OctaErrorCode" }, "Octa-ErrorMessage": { "$ref": "#/components/headers/OctaErrorMessage" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean" }, "Errors": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string" }, "Message": { "type": "string" } } } } } }, "example": { "Success": false, "Errors": [ { "Code": "ERR_CODE_1", "Message": "ERR MESSAGE 1" }, { "Code": "ERR_CODE_n", "Message": "ERR MESSAGE n" } ] } } } } } } } }, "components": { "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic", "description": "HTTP Basic authentication. Use your API Key Id as the username and Key Secret as the password.\n\nTo build the header yourself:\n1. Join the Key Id and Key Secret with a single colon: `KeyId:KeySecret`\n2. Encode the result as UTF-8 bytes, then as a Base64 string.\n3. Send it with the `Basic` prefix: `Authorization: Basic `\n\nGenerate keys on the API Keys page of the Octa GST app. Details and a worked example: https://octagst.com/octa/docs/api/overview/getting-started" } }, "parameters": { "OctaCompany": { "name": "Octa-Company", "in": "header", "required": true, "description": "ID of the company to work on, exactly as displayed in Octa (for example, oc-xxx).", "schema": { "type": "string" } } }, "headers": { "OctaErrorCode": { "description": "Code identifying the type of error.\n\nThis document defines the error codes returned by Octa APIs.\n\n## Octa Error Codes\n\n| Error Code | Description |\n| ---------- | ---------------------------------------------------- |\n| 0 | None |\n| 1 | Record Locked |\n| 2 | Duplicate Records |\n| 3 | Record Not Found |\n| 4 | Multiple Records Found |\n| 5 | Child Records Exist |\n| 6 | Internal Database Error |\n| 7 | Internal Application Error |\n| 51 | Operation Not Supported |\n| 52 | Access Denied |\n| 53 | Operation Not Allowed |\n| 54 | Record Changed |\n| 55 | Operation in Progress |\n| 56 | Same request is already in progress |\n| 57 | Data Not Available |\n| 100 | Invalid Request |\n| 101 | OTP Expired |\n| 102 | OTP Not Found |\n| 103 | Email OTP Incorrect |\n| 104 | Account Already Registered |\n| 105 | Account Inactive |\n| 106 | Account Blocked |\n| 107 | Password Incorrect |\n| 108 | Order Not Found |\n| 109 | Order Expired |\n| 110 | Order Payment Reference Already Created |\n| 111 | Invalid Payment Status |\n| 112 | Payment Order Not Found |\n| 113 | Order Mismatch |\n| 114 | Trial Already Used in Account |\n| 115 | Trial Already Used on Machine |\n| 116 | Subscription Not Found |\n| 117 | Subscription of Other Account |\n| 118 | Subscription Key of Other Product |\n| 119 | Subscription Not in Use |\n| 120 | Subscription Active on Other Machine |\n| 121 | Subscription Disabled |\n| 122 | Maximum Activation Count Exceeded |\n| 123 | Unknown Machine |\n| 124 | Activation ID Does Not Match |\n| 125 | Account Not Found |\n| 126 | Single User License |\n| 127 | Multi User License |\n| 128 | Single GSTIN License |\n| 129 | Other GSTIN Linked to Subscription |\n| 130 | License Manager Not Activated |\n| 131 | Subscription Limit Reached |\n| 132 | Machine Not Found in Subscription |\n| 133 | Product Version Not Supported |\n| 134 | Account Not Allowed |\n| 135 | Discount Code Not Found |\n| 136 | Discount Code Inactive |\n| 137 | Discount Code Expired |\n| 138 | Discount Code Usage Exceeded |\n| 139 | Discount Code Invalid |\n| 140 | Low Wallet Balance |\n| 141 | GSTN API Client Error |\n| 142 | GSTN API GSP Error |\n| 143 | Service Disabled by User |\n| 144 | Captcha Code Invalid |\n| 145 | Captcha Code Expired |\n| 146 | Email Address Already Used |\n| 147 | Mobile Number Already Used |\n| 148 | Subscription Expired |\n| 149 | PAN Mismatch |\n| 150 | GSTIN Group Mismatch |\n| 151 | Upstream Service Error |\n| 152 | Link Expired |\n| 153 | API Account Not Configured |\n| 154 | Mobile OTP Incorrect |\n| 155 | TOTP Required |\n| 156 | TOTP Incorrect |\n| 157 | No Commission Accumulated |\n| 158 | Company Limit Reached |\n| 159 | GSTIN Limit Reached |\n| 160 | PAN Limit Reached |\n| 161 | URL Not Active |\n| 162 | Upstream Service Not Available |\n| 163 | API Limit Reached |\n| 1000 | Invalid Input |\n| 1001 | Input State Changed |\n| 1002 | Invalid Username or Password |\n| 1003 | Password Expired |\n| 2000 | Not Connected to GST System |\n| 2001 | Period Not Applicable |\n| 2002 | Period Not Available Yet |\n| 2003 | Data Already Available |\n| 2004 | Recent Data Already Available (Fetch Limit Exceeded) |\n| 2005 | Reconciliation Pending |\n| 2006 | E-Invoice Already Configured |\n| 2007 | E-Invoice Not Enabled |\n| 2008 | IRN Status Changed |\n| 2009 | EWB Status Changed |\n| 2010 | Validation Issues |\n| 2011 | B2C Supply Not Allowed |\n| 100000 | Government Portal Error (Start) |\n| 100001 | Unexpected Response from Govt Portal |\n| 100002 | Timeout from Govt Portal |", "schema": { "type": "string" } }, "OctaErrorMessage": { "description": "Descriptive message explaining the reason for the failure.", "schema": { "type": "string" } } }, "responses": { "TooManyRequests": { "description": "Rate limit exceeded. Retry with delays and exponential back-off." } } } }