{
"openapi": "3.1.0",
"info": {
"title": "Vayana API Documentation",
"version": "1.0.0",
"description": "To integrate these APIs please follow documentation"
},
"servers": [
{
"url": "https://s.api.one.vayana.com",
"description": "Sandbox Server"
}
],
"paths": {
"/atlas/v1/gstin/{gstin}": {
"get": {
"tags": [
"Verification Suite"
],
"summary": "GSTIN Verification",
"description": "Search Taxpayer Detail API fetches all public information available with GSTN portal. This information was given during the time of GST Registration of the Taxpayer. All you need to check out the latest version which GSTN has released for the api for an environment (ie production and sandbox).",
"operationId": "eas_basic_v1_gstn_search_gstin",
"_peer-api": "/basic/gstn/v3.0/commonapi/v0.3/search?gstin=33AOZPD0347J5ZO&action=TP",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/2"
},
{
"name": "X-FLYNN-N-GSTN-GSP-CODE",
"in": "header",
"required": true,
"description": "GSP Identifier",
"schema": {
"type": "string",
"enum": [
"vay"
]
}
},
{
"required": true,
"schema": {
"type": "string",
"maxLength": 15,
"example": "29HJKPS9689A8Z5"
},
"description": "GSTIN to search",
"name": "gstin",
"in": "path"
}
],
"responses": {
"200": {
"description": "Successful Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status",
"example": "1"
},
"data": {
"type": "object",
"properties": {
"adadr": {
"items": {
"properties": {
"addr": {
"properties": {
"bnm": {
"type": "string",
"description": "Building Name",
"example": "ELPHINSTONE BUILDING"
},
"bno": {
"type": "string",
"description": "Building Number",
"example": "10"
},
"flno": {
"type": "string",
"description": "Floor number",
"example": "1ST FLOOR"
},
"lg": {
"type": "string",
"description": "longitude",
"example": "27.0238"
},
"loc": {
"type": "string",
"description": "location",
"example": "FORT"
},
"lt": {
"type": "string",
"description": "lattitude",
"example": "74.2179"
},
"pncd": {
"type": "string",
"description": "Pincode",
"example": "400001"
},
"st": {
"type": "string",
"description": "Street Name",
"example": "10, VEER NARIMAN ROAD"
},
"stcd": {
"type": "string",
"description": "State Name",
"example": "Rajasthan"
}
},
"type": "object"
},
"ntr": {
"items": {
"type": "string",
"description": "Nature of Additional place of business",
"example": " Wholesale Business"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
},
"pradr": {
"properties": {
"addr": {
"properties": {
"bnm": {
"type": "string",
"description": "Building Name",
"example": "KATGARA HOUSE"
},
"bno": {
"type": "string",
"description": "Building Number",
"example": "5"
},
"flno": {
"type": "string",
"description": "Floor Number",
"example": "4TH FLOOR"
},
"lg": {
"type": "string",
"description": "longitude",
"example": "27.0238"
},
"loc": {
"type": "string",
"description": "Location",
"example": "MALABAR HILL"
},
"lt": {
"type": "string",
"description": "lattitude",
"example": "74.2179"
},
"pncd": {
"type": "string",
"description": "Pincode",
"example": "400006"
},
"st": {
"type": "string",
"description": "Street Name",
"example": " 15, L JAGMOHANDAS MARG"
},
"stcd": {
"type": "string",
"description": "State Name",
"example": "Maharashtra"
}
},
"type": "object"
},
"ntr": {
"items": {
"type": "string",
"description": "Nature of pricipal place of Business",
"example": " Wholesale Business"
},
"type": "array"
}
},
"type": "object"
},
"ctb": {
"type": "string",
"description": "Constitution of Business",
"example": "sole "
},
"ctj": {
"type": "string",
"description": "Center Jurisdiction",
"example": "Delhi"
},
"ctjCd": {
"type": "string",
"description": "Center Jurisdiction Code",
"example": "AP004"
},
"cxdt": {
"type": "string",
"description": "Date Of Cancellation",
"example": "NA"
},
"dty": {
"type": "string",
"description": "TaxPayer type",
"example": "Casual"
},
"gstin": {
"type": "string",
"description": "GST Identification Number",
"example": "27ASJPC0786C3C7"
},
"einvoiceStatus": {
"type": "string",
"description": "eInvoice enablement status for GSTIN",
"example": "Yes"
},
"lgnm": {
"type": "string",
"description": "Legal name of the business",
"example": "Vay Network Services Pvt Ltd"
},
"nba": {
"type": [
"array",
"null"
],
"description": "Nature of Business Activity",
"items": {
"type": "string"
},
"example": [
"Bonded Warehouse",
"Factory / Manufacturing",
"Input Service Distributor (ISD)",
"Office / Sale Office"
]
},
"rgdt": {
"type": "string",
"description": "Date of Registration",
"example": "5/5/2017"
},
"stj": {
"type": "string",
"description": "State Jurisdiction",
"example": "Karnataka"
},
"stjCd": {
"type": "string",
"description": "State Jurisdiction Code",
"example": "AP003"
},
"sts": {
"type": "string",
"description": "GSTN status",
"example": "Active"
},
"lstupdt": {
"type": "string",
"format": "Date",
"pattern": "DD/MM/YYYY",
"description": "Lst Updated Date",
"example": "5/1/2017"
},
"tradeNam": {
"type": "string",
"description": "trade Name",
"example": "GSTN"
}
}
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"example": null
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"data"
]
}
}
}
},
"400": {
"description": "Failure Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status"
},
"data": {
"type": "null"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"type": "object"
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"error"
]
}
}
}
},
"403": {
"description": "Authorization information is missing or invalid.",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/403/content/application~1json/schema"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/gcs/bulk": {
"post": {
"tags": [
"Verification Suite"
],
"summary": "GCS Generate",
"description": "The Generate Good Compliance Score (GCS) API supports bulk score generation for multiple GSTINs (Max upto 50 GSTIN in single request). This is an asynchronous API and returns a `task-id` in the response upon successful submission. Use the returned task ID to track processing status via the [Status API](#/Support%20Suite/eas_enriched_v1_task_status). Once the task completes, retrieve the result using the [Get Result](#/Support%20Suite/eas_enriched_v1_result_task/example/0) API.\n\nA successful Get Result response is shown below:\n\n```json\n{\n \"status\": \"1\",\n \"data\": {\n \"gstin\": \"29AAACT2727Q1ZS\",\n \"score\": 462.5\n },\n \"error\": null,\n \"info\": null,\n \"additionalInfo\": null,\n \"alert\": null\n}\n```",
"operationId": "eas_enriched_v1_gcs_generate",
"_peer-api": "/enriched/gcs/v1.0/generate",
"parameters": [
{
"name": "X-ATLAS-ORG-ID",
"description": "Organization (ID) on behalf of which the request is made",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "ba4cf3fa-f0da-4764-b108-eca22098e7cb"
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"schema": {
"type": "string",
"example": "application/json"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"schema": {
"type": "string",
"example": "application/json"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"gstins": {
"type": "array",
"items": {
"type": "string",
"minLength": 15,
"maxLength": 15,
"pattern": "([0-9]{2}[0-9A-Z]{13})",
"example": "26ABCMH0791G9ZI"
},
"example": [
"26ABCMH0791G9ZI",
"29AAACT2744Q1ZS"
]
}
},
"required": [
"gstins"
],
"example": {
"gstins": [
"26ABCMH0791G9ZI",
"29AAACT2744Q1ZS"
]
}
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"headers": {
"X-ATLAS-CALL-ID": {
"name": "X-ATLAS-CALL-ID",
"description": "A unique Identifier for your request",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"X-CALL-ID": {
"name": "X-CALL-ID",
"in": "header",
"required": true,
"description": "unique id",
"schema": {
"type": "string",
"example": "395b8578-7439-44e9-a51a-c5e23b8e01b5"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status",
"example": "1"
},
"data": {
"type": [
"object"
],
"properties": {
"task-id": {
"type": "string",
"format": "uuid"
}
}
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"example": null
},
"info": {
"example": null,
"type": [
"object",
"null"
]
},
"additionalInfo": {
"example": null,
"type": [
"object",
"null"
],
"properties": {
"key": {
"type": [
"object",
"null"
]
},
"pdf": {
"type": [
"string",
"null"
]
},
"details": {
"type": [
"object",
"null"
]
}
}
},
"alert": {
"example": null,
"type": [
"string",
"null"
]
}
},
"required": [
"status",
"data"
]
}
}
}
},
"400": {
"description": "Failure Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Status indicates positive(1) or error response(0)",
"enum": [
"0",
"1"
]
},
"data": {
"type": "null"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"type": "object"
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"error"
]
}
}
}
},
"403": {
"description": "Authorization information is missing or invalid.",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status"
},
"data": {
"type": "null",
"example": "null"
},
"error": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "Authorization"
},
"message": {
"type": "string",
"example": "err-invalid-org"
},
"args": {
"type": [
"object",
"null"
]
}
}
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"error"
]
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/gstin/{gstin}/returns-track/fy/{fy}": {
"get": {
"tags": [
"Compliance Suite"
],
"summary": "Get View And Track Returns",
"description": "View and Track Return API fetches public information on return filing of a particular GSTIN. You need to provide the financial year (FY) along with the GSTIN to fetch the results (return filings) done during that FY.",
"operationId": "eas_basic_v1_gstn_view_returns",
"_peer-api": "/basic/gstn/v3.0/commonapi/v1.0/returns?gstin=29HJKPS9689A8Z5&fy=2020-21&action=RETTRACK&type=R1",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/2"
},
{
"$ref": "#/paths/~1atlas~1v1~1gstin~1%7Bgstin%7D/get/parameters/3"
},
{
"name": "gstin",
"required": true,
"schema": {
"type": "string",
"maxLength": 15,
"example": "29HJKPS9689A8Z5"
},
"description": "GSTIN to search",
"in": "path"
},
{
"name": "fy",
"required": true,
"schema": {
"type": "string",
"example": "2017-18"
},
"description": "format = YYYY-YY
min-value = 2017-18 ",
"in": "path"
},
{
"name": "action",
"required": true,
"schema": {
"type": "string",
"example": "RETTRACK"
},
"in": "query"
}
],
"responses": {
"200": {
"description": "Successful Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status",
"example": "1"
},
"data": {
"type": "object",
"properties": {
"EFiledlist": {
"description": "List of Electronically filed returns",
"type": "array",
"items": {
"type": "object",
"properties": {
"valid": {
"type": "boolean",
"examples": true
},
"mof": {
"type": "string",
"examples": [
"ONLINE"
]
},
"dof": {
"type": "string",
"examples": [
"16-01-2018"
]
},
"ret_prd": {
"type": "string",
"examples": [
"062017"
]
},
"rtntype": {
"type": "string",
"examples": [
"GSTR3B"
]
},
"arn": {
"type": "string",
"examples": [
"AA080617000247D"
]
},
"status": {
"type": "string",
"examples": [
"Filed"
]
}
}
}
}
}
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"example": null
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"data"
]
}
}
}
},
"400": {
"description": "Failure Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"status",
"error"
],
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status"
},
"data": {
"type": "null"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"type": "object"
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
}
}
}
}
},
"403": {
"description": "Authorization information is missing or invalid.",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/403/content/application~1json/schema"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/irp/{irp}/einvoice/bulk": {
"post": {
"tags": [
"Compliance Suite"
],
"summary": "Create Bulk einvoice",
"description": "Generate IRN(s) API supports creation of bulk e-invoices, as opposed to its basic counterpart. Create e-invoice in bulk is an asynchronous API, hence will give a task ID in response. Given a task ID, you could fetch the task status using Status API. In order to download the result, you would need to use Download API.",
"operationId": "eas_enriched_v1_generate_invoices",
"_peer-api": "/enriched/einv/v3.0/ni1/invoices",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/2"
},
{
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice/post/parameters/3"
},
{
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice/post/parameters/4"
},
{
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice/post/parameters/5"
},
{
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice/post/parameters/6"
},
{
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice/post/parameters/7"
},
{
"required": true,
"schema": {
"type": "string",
"enum": [
"ni1",
"ni2"
]
},
"description": "IRP Provider as per GST registration for e-invoicing",
"name": "irp",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"payload": {
"type": "array",
"items": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice/post/requestBody/content/application~1json/schema"
}
},
"meta": {
"type": [
"object",
"null"
],
"properties": {
"pdf": {
"type": "string",
"enum": [
"Y",
"N"
],
"example": "Y"
},
"emailRecipientList": {
"type": "array",
"items": {
"type": "string",
"example": "abc@@gmail.com"
}
}
}
}
},
"required": [
"payload"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status",
"example": "1"
},
"data": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/data"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"example": null
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"data"
]
}
}
},
"links": {
"CheckTaskStatus": {
"operationId": "eas_enriched_v1_task_status",
"parameters": {
"task-id": "$response.body#/data/task-id"
}
}
}
},
"400": {
"description": "Failure Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status"
},
"data": {
"type": "null"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"type": "object"
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"error"
]
}
}
}
},
"403": {
"description": "Authorization information is missing or invalid.",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/403/content/application~1json/schema"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/eas-task/{task-id}": {
"get": {
"tags": [
"Support Suite"
],
"summary": "Get Task Status",
"description": "This API is used to fetch the current status of the long-running-tasks.",
"operationId": "eas_enriched_v1_task_status",
"_peer-api": "enriched/tasks/v1.0/status/2e9f6d17-ffcb-4395-8d0c-3fa8c5d08d95",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/2"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/1"
},
{
"name": "task-id",
"description": "Reference ID provided in the response of a long-running operation",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status",
"example": "1"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "2e9f6d17-ffcb-4395-8d0c-3fa8c5d08d95"
},
"status": {
"type": "string",
"example": "completed"
},
"jobs": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"example": 1
},
"pending": {
"type": "integer",
"example": 0
}
}
}
}
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"example": null
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"data"
]
}
}
}
},
"400": {
"description": "Failure Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status"
},
"data": {
"type": "null"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"type": "object"
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"error"
]
}
}
}
},
"403": {
"description": "Authorization information is missing or invalid.",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/403/content/application~1json/schema"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/eas-task/{task-id}/download": {
"get": {
"tags": [
"Support Suite"
],
"summary": "Get Download File",
"description": "This API is used to download the processed response of the long-running-tasks. Download API response is unique for each API. Check out for detailed-documentation in the respective APIs.",
"operationId": "eas_enriched_v1_download_task",
"_peer-api": "enriched/tasks/v1.0/download/1872585f-4397-4e96-81d9-649f3b25aa2b",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/2"
},
{
"name": "accept",
"in": "header",
"required": true,
"schema": {
"type": "string",
"example": "application/zip"
}
},
{
"required": true,
"schema": {
"type": "string"
},
"name": "task-id",
"description": "The task-id obtained by hitting async api",
"in": "path"
}
],
"responses": {
"200": {
"description": "Successful Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
},
"Content-Encoding": {
"name": "Content-Encoding",
"description": "A Encoding Algorithm used for encoding response",
"in": "header",
"schema": {
"type": "gzip"
}
}
},
"content": {
"application/zip": {
"schema": {
"type": "string",
"contentEncoding": "gzip"
}
}
}
},
"400": {
"description": "Failure Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status"
},
"data": {
"type": "null"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"type": "object"
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"error"
]
}
}
}
},
"403": {
"description": "Authorization information is missing or invalid.",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/403/content/application~1json/schema"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/eas-task/{task-id}/result": {
"get": {
"tags": [
"Support Suite"
],
"summary": "Get Result",
"description": "This API is used to fetch the result of the long-running-tasks. The `data` depends on which API created the `task-id` (see Examples dropdown on 200). Full schemas are also documented on each originating API.",
"operationId": "eas_enriched_v1_result_task",
"_peer-api": "enriched/tasks/v1.0/result/1872585f-4397-4e96-81d9-649f3b25aa2b",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/2"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/1"
},
{
"name": "task-id",
"description": "Reference ID provided in the response of a long-running operation",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status",
"example": "1"
},
"data": {
"description": "Varies by the API that created the task-id.",
"oneOf": [
{
"title": "GCS Generate Result",
"type": "object",
"description": "Result for a task created by GCS Generate.",
"properties": {
"gstin": {
"type": "string",
"minLength": 15,
"maxLength": 15,
"pattern": "([0-9]{2}[0-9A-Z]{13})",
"example": "29AAACT2727Q1ZS"
},
"score": {
"type": "number",
"example": 462.5
}
},
"required": [
"gstin",
"score"
],
"example": {
"gstin": "29AAACT2727Q1ZS",
"score": 462.5
}
}
]
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"example": null
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"data"
]
},
"examples": {
"GCS Generate": {
"summary": "Result when task-id comes from GCS Generate",
"value": {
"status": "1",
"data": [
{
"status": "1",
"data": {
"gstin": "26ABCMH0791G9ZI",
"score": 450
},
"error": null,
"info": null,
"additionalInfo": null,
"alert": null
},
{
"status": "0",
"data": null,
"error": {
"type": "Runtime",
"message": "err-gcs-generation-failed",
"args": {
"gstin": "29AAACT2744Q1ZS"
}
},
"info": null,
"additionalInfo": null,
"alert": null
}
],
"error": null,
"info": null,
"additionalInfo": null,
"alert": null
}
}
}
}
}
},
"400": {
"description": "Failure Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status"
},
"data": {
"type": "null"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"type": "object"
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"error"
]
}
}
}
},
"403": {
"description": "Authorization information is missing or invalid.",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/403/content/application~1json/schema"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/irp/{irp}/einvoice": {
"post": {
"tags": [
"Compliance Suite"
],
"summary": "Generate E-Invoice",
"description": "Generate IRN offers single e-invoice generation",
"operationId": "eas_basic_v1_generate_invoice",
"_peer-api": "/basic/einv/v3.0/ni1/eicore/v1.03/Invoice",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/2"
},
{
"name": "X-FLYNN-N-IRP-GSP-CODE",
"in": "header",
"required": true,
"description": "GSP Identifier",
"schema": {
"type": "string",
"enum": [
"vay"
]
}
},
{
"name": "X-FLYNN-N-IRP-GSTIN",
"in": "header",
"required": true,
"description": "GSTIN of the taxpayer",
"schema": {
"maxLength": 15,
"example": "29HJKPS9689A8Z5"
}
},
{
"name": "X-FLYNN-N-IRP-USERNAME",
"in": "header",
"required": true,
"description": "Portal username associated with taxpayer GSTIN for the GSP, Non-sensitive",
"schema": {
"type": "string",
"example": "test_24_001"
}
},
{
"name": "X-FLYNN-N-IRP-PWD",
"in": "header",
"required": false,
"description": "Portal password associated with GSTIN and Username for the GSP, Non-Sensitive.
Provide either `X-FLYNN-N-IRP-PWD` or `X-FLYNN-S-IRP-PWD`",
"schema": {
"type": "string",
"example": "Trial63$value"
}
},
{
"name": "X-FLYNN-S-IRP-PWD",
"in": "header",
"required": false,
"description": "Portal password associated with GSTIN and Username for the GSP encrypted, Non-Sensitive.
Provide either `X-FLYNN-N-IRP-PWD` or `X-FLYNN-S-IRP-PWD`
for encryption details see S-REK",
"schema": {
"type": "string",
"example": "Trial63$value"
}
},
{
"name": "irp",
"in": "path",
"required": true,
"schema": {
"type": "string",
"enum": [
"ni1",
"ni2"
],
"example": "ni1"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"Title": "GST-India Invoice Document ",
"Description": "GST Invoice format for IRN Generation in INDIA",
"properties": {
"Version": {
"type": "string",
"minLength": 1,
"maxLength": 6,
"example": "1.1"
},
"Irn": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"example": ""
},
"TranDtls": {
"type": "object",
"properties": {
"TaxSch": {
"type": "string",
"minLength": 3,
"maxLength": 10,
"enum": [
"GST"
],
"pattern": "^(GST)$",
"example": "GST"
},
"SupTyp": {
"type": "string",
"minLength": 3,
"maxLength": 10,
"enum": [
"B2B",
"SEZWP",
"SEZWOP",
"EXPWP",
"EXPWOP",
"DEXP"
],
"pattern": "(?i)^((B2B)|(SEZWP)|(SEZWOP)|(EXPWP)|(EXPWOP)|(DEXP))$",
"example": "B2B"
},
"RegRev": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"enum": [
"Y",
"N"
],
"pattern": "^([Y|N]{1})$",
"example": "N"
},
"EcmGstin": {
"type": "string",
"minLength": 15,
"maxLength": 15,
"pattern": "^([0-9]{2}[0-9A-Z]{13})$",
"example": null
},
"IgstOnIntra": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"enum": [
"Y",
"N"
],
"pattern": "^([Y|N]{1})$",
"example": "N"
}
},
"required": [
"TaxSch",
"SupTyp"
]
},
"DocDtls": {
"type": "object",
"properties": {
"Typ": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"enum": [
"INV",
"CRN",
"DBN"
],
"pattern": "(?i)^((INV)|(CRN)|(DBN))$",
"example": "INV"
},
"No": {
"type": "string",
"minLength": 1,
"maxLength": 16,
"pattern": "^([a-zA-Z1-9]{1}[a-zA-Z0-9/-]{0,15})$",
"example": "DOC/INV-ATS/001"
},
"Dt": {
"type": "string",
"minLength": 10,
"maxLength": 10,
"pattern": "^[0-3][0-9]/[0-1][0-9]/[2][0][1-2][0-9]$",
"example": "24/09/2023"
}
},
"required": [
"Typ",
"No",
"Dt"
]
},
"SellerDtls": {
"type": "object",
"properties": {
"Gstin": {
"type": "string",
"minLength": 15,
"maxLength": 15,
"pattern": "([0-9]{2}[0-9A-Z]{13})",
"example": "27AAAPI3182M002"
},
"LglNm": {
"type": "string",
"minLength": 3,
"maxLength": 100,
"pattern": "^([^\\\"])*$",
"example": "NIC company pvt ltd"
},
"TrdNm": {
"type": "string",
"minLength": 3,
"maxLength": 100,
"pattern": "^([^\\\"])*$",
"example": "NIC Industries"
},
"Addr1": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^([^\\\"])*$",
"example": "5th block, kuvempu layout"
},
"Addr2": {
"type": "string",
"minLength": 3,
"maxLength": 100,
"pattern": "^([^\\\"])*$",
"example": "kuvempu layout"
},
"Loc": {
"type": "string",
"minLength": 3,
"maxLength": 50,
"pattern": "^([^\\\"])*$",
"example": "Maharastra"
},
"Pin": {
"type": "number",
"minimum": 100000,
"maximum": 999999,
"example": 400049
},
"Stcd": {
"type": "string",
"minLength": 1,
"maxLength": 2,
"pattern": "^(?!0+$)([0-9]{1,2})$",
"example": "27"
},
"Ph": {
"type": "String",
"minLength": 6,
"maxLength": 12,
"pattern": "^([0-9]{6,12})$",
"example": "9000000000"
},
"Em": {
"type": "string",
"minLength": 6,
"maxLength": 100,
"pattern": "^[a-zA-Z0-9+_.-]+@[a-zA-Z0-9.-]+$",
"example": "abc@gmail.com"
}
},
"required": [
"Gstin",
"LglNm",
"Addr1",
"Loc",
"Pin",
"Stcd"
]
},
"BuyerDtls": {
"type": "object",
"properties": {
"Gstin": {
"type": "string",
"minLength": 3,
"maxLength": 15,
"pattern": "^(([0-9]{2}[0-9A-Z]{13})|URP)$",
"example": "19AAAPI3182M007"
},
"LglNm": {
"type": "string",
"minLength": 3,
"maxLength": 100,
"pattern": "^([^\\\"])*$",
"example": "XYZ company pvt ltd"
},
"TrdNm": {
"type": "string",
"minLength": 3,
"maxLength": 100,
"pattern": "^([^\\\"])*$",
"example": "XYZ Industries"
},
"Pos": {
"type": "string",
"minLength": 1,
"maxLength": 2,
"pattern": "^(?!0+$)([0-9]{1,2})$",
"example": "19"
},
"Addr1": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^([^\\\"])*$",
"example": "7th block, kuvempu layout"
},
"Addr2": {
"type": "string",
"minLength": 3,
"maxLength": 100,
"pattern": "^([^\\\"])*$",
"example": "kuvempu layout"
},
"Loc": {
"type": "string",
"minLength": 3,
"maxLength": 100,
"pattern": "^([^\\\"])*$",
"example": "Kolkata"
},
"Pin": {
"type": " number",
"minimum": 100000,
"maximum": 999999,
"example": 722144
},
"Stcd": {
"type": "string",
"minLength": 1,
"maxLength": 2,
"pattern": "^(?!0+$)([0-9]{1,2})$",
"example": 19
},
"Ph": {
"type": "String",
"minLength": 6,
"maxLength": 12,
"pattern": "^([0-9]{6,12})$",
"example": "91111111111"
},
"Em": {
"type": "string",
"minLength": 6,
"maxLength": 100,
"pattern": "^[a-zA-Z0-9+_.-]+@[a-zA-Z0-9.-]+$",
"example": "xyz@yahoo.com"
}
},
"required": [
"Gstin",
"LglNm",
"Pos",
"Addr1",
"Loc",
"Stcd"
]
},
"DispDtls": {
"type": "object",
"properties": {
"Nm": {
"type": "string",
"minLength": 3,
"maxLength": 100,
"pattern": "^([^\\\"])*$",
"example": "ABC company pvt ltd"
},
"Addr1": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^([^\\\"])*$",
"example": "7th block, kuvempu layout"
},
"Addr2": {
"type": "string",
"minLength": 3,
"maxLength": 100,
"pattern": "^([^\\\"])*$",
"example": "kuvempu layout"
},
"Loc": {
"type": "string",
"minLength": 3,
"maxLength": 100,
"pattern": "^([^\\\"])*$",
"example": "Maharastra"
},
"Pin": {
"type": "number",
"minimum": 100000,
"maximum": 999999,
"example": "400049"
},
"Stcd": {
"type": "string",
"minLength": 1,
"maxLength": 2,
"pattern": "^(?!0+$)([0-9]{1,2})$",
"example": "27"
}
},
"required": [
"Nm",
"Addr1",
"Loc",
"Pin",
"Stcd"
]
},
"ShipDtls": {
"type": "object",
"properties": {
"Gstin": {
"type": "string",
"maxLength": 15,
"minLength": 3,
"pattern": "^(([0-9]{2}[0-9A-Z]{13})|URP)$",
"example": "27ACBPN2353E1ZX"
},
"LglNm": {
"type": "string",
"minLength": 3,
"maxLength": 100,
"pattern": "^([^\\\"])*$",
"example": "CBE company pvt ltd"
},
"TrdNm": {
"type": "string",
"minLength": 3,
"maxLength": 100,
"pattern": "^([^\\\"])*$",
"example": "kuvempu layout"
},
"Addr1": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^([^\\\"])*$",
"example": "7th block, kuvempu layout"
},
"Addr2": {
"type": "string",
"minLength": 3,
"maxLength": 100,
"pattern": "^([^\\\"])*$",
"example": "kuvempu layout"
},
"Loc": {
"type": "string",
"minLength": 3,
"maxLength": 100,
"pattern": "^([^\\\"])*$",
"example": "ABC"
},
"Pin": {
"type": "number",
"minimum": 100000,
"maximum": 999999,
"example": "400049"
},
"Stcd": {
"type": "string",
"minLength": 1,
"maxLength": 2,
"pattern": "^(?!0+$)([0-9]{1,2})$",
"example": "27"
}
},
"required": [
"LglNm",
"Addr1",
"Loc",
"Pin",
"Stcd"
]
},
"ItemList": {
"type": "array",
"items": {
"type": "object",
"properties": {
"SlNo": {
"type": "string",
"minLength": 1,
"maxLength": 6,
"pattern": "^([0-9]{1,6})$",
"example": "1"
},
"PrdDesc": {
"type": "string",
"minLength": 3,
"maxLength": 300,
"pattern": "^([^\\\"])*$",
"example": "Rice"
},
"IsServc": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"enum": [
"Y",
"N"
],
"pattern": "^([Y|N]{1})$",
"example": "N"
},
"HsnCd": {
"type": "string",
"minLength": 4,
"maxLength": 8,
"pattern": "^(?!0+$)([0-9]{4}|[0-9]{6}|[0-9]{8})$",
"example": "1001"
},
"Barcde": {
"type": "string",
"minLength": 3,
"maxLength": 30,
"pattern": "^([^\\\"])*$",
"example": "123456"
},
"Qty": {
"type": "number",
"minimum": 0,
"maximum": 9999999999.999,
"example": 100.345
},
"FreeQty": {
"type": "number",
"minimum": 0,
"maximum": 9999999999.999,
"example": 10
},
"Unit": {
"type": "string",
"minLength": 3,
"maxLength": 8,
"pattern": "^([A-Z|a-z]{3,8})$",
"example": "BAG"
},
"UnitPrice": {
"type": "number",
"minimum": 0,
"maximum": 999999999999.999,
"example": 99.545
},
"TotAmt": {
"type": "number",
"minimum": 0,
"maximum": 999999999999.99,
"example": 9988.84
},
"Discount": {
"type": "number",
"minimum": 0,
"maximum": 999999999999.99,
"example": 10
},
"PreTaxVal": {
"type": "number",
"minimum": 0,
"maximum": 999999999999.99,
"example": 1
},
"AssAmt": {
"type": "number",
"minimum": 0,
"maximum": 999999999999.99,
"example": 9978.84
},
"GstRt": {
"type": "number",
"minimum": 0,
"maximum": 999.999,
"example": 12
},
"IgstAmt": {
"type": "number",
"minimum": 0,
"maximum": 999999999999.99,
"example": 1197.84
},
"CgstAmt": {
"type": "number",
"minimum": 0,
"maximum": 999999999999.99,
"example": 0
},
"SgstAmt": {
"type": "number",
"minimum": 0,
"maximum": 999999999999.99,
"example": 0
},
"CesRt": {
"type": "number",
"minimum": 0,
"maximum": 999.999,
"example": 5
},
"CesAmt": {
"type": "number",
"minimum": 0,
"maximum": 999999999999.99,
"example": 498.94
},
"CesNonAdvlAmt": {
"type": "number",
"minimum": 0,
"maximum": 999999999999.99,
"example": 10
},
"StateCesRt": {
"type": "number",
"minimum": 0,
"maximum": 999.999,
"example": 12
},
"StateCesAmt": {
"type": "number",
"minimum": 0,
"maximum": 999999999999.99,
"example": 1197.46
},
"StateCesNonAdvlAmt": {
"type": "number",
"minimum": 0,
"maximum": 999999999999.99,
"example": 5
},
"OthChrg": {
"type": "number",
"minimum": 0,
"maximum": 999999999999.99,
"example": 10
},
"TotItemVal": {
"type": "number",
"minimum": 0,
"maximum": 999999999999.99,
"example": 12897.7
},
"OrdLineRef": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"pattern": "^([^\\\"])*$",
"example": "3256"
},
"OrgCntry": {
"type": "string",
"minLength": 2,
"maxLength": 2,
"pattern": "^([A-Z|a-z]{2})$",
"example": "AG"
},
"PrdSlNo": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"pattern": "^([^\\\"])*$",
"example": "12345"
},
"BchDtls": {
"type": "object",
"properties": {
"Nm": {
"type": "string",
"minLength": 3,
"maxLength": 20,
"pattern": "^([^\\\"])*$",
"example": "123456"
},
"ExpDt": {
"type": "string",
"maxLength": 10,
"minLength": 10,
"pattern": "^[0-3][0-9]/[0-1][0-9]/[2][0][1-2][0-9]$",
"example": "24/10/2023"
},
"WrDt": {
"type": "string",
"maxLength": 10,
"minLength": 10,
"pattern": "^[0-3][0-9]/[0-1][0-9]/[2][0][1-2][0-9]$",
"example": "24/09/2020"
}
},
"required": [
"Nm"
]
},
"AttribDtls": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Nm": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^([^\\\"])*$",
"example": "Rice"
},
"Val": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^([^\\\"])*$",
"example": "10000"
}
}
}
}
},
"required": [
"SlNo",
"IsServc",
"HsnCd",
"UnitPrice",
"TotAmt",
"AssAmt",
"GstRt",
"TotItemVal"
]
}
},
"ValDtls": {
"type": "object",
"properties": {
"AssVal": {
"type": "number",
"minimum": 0,
"maximum": 99999999999999.98,
"example": 9978.84
},
"CgstVal": {
"type": "number",
"maximum": 99999999999999.98,
"minimum": 0,
"example": 0
},
"SgstVal": {
"type": "number",
"minimum": 0,
"maximum": 99999999999999.98,
"example": 0
},
"IgstVal": {
"type": "number",
"minimum": 0,
"maximum": 99999999999999.98,
"example": 1197.46
},
"CesVal": {
"type": "number",
"minimum": 0,
"maximum": 99999999999999.98,
"example": 508.94
},
"StCesVal": {
"type": "number",
"minimum": 0,
"maximum": 99999999999999.98,
"example": 1202.46
},
"Discount": {
"type": "number",
"minimum": 0,
"maximum": 99999999999999.98,
"example": 10
},
"OthChrg": {
"type": "number",
"minimum": 0,
"maximum": 99999999999999.98,
"example": 20
},
"RndOffAmt": {
"type": "number",
"minimum": -99.99,
"maximum": 99.99,
"example": 0.3
},
"TotInvVal": {
"type": "number",
"minimum": 0,
"maximum": 99999999999999.98,
"example": 12908
},
"TotInvValFc": {
"type": "number",
"minimum": 0,
"maximum": 99999999999999.98,
"example": 12897.7
}
},
"required": [
"AssVal",
"TotInvVal"
]
},
"PayDtls": {
"type": "object",
"properties": {
"Nm": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^([^\\\"])*$",
"example": "ABCDE"
},
"AccDet": {
"type": "string",
"minLength": 1,
"maxLength": 18,
"pattern": "^([^\\\"])*$",
"example": "5697389713210"
},
"Mode": {
"type": "string",
"minLength": 1,
"maxLength": 18,
"pattern": "^([^\\\"])*$",
"example": "Cash"
},
"FinInsBr": {
"type": "string",
"minLength": 1,
"maxLength": 11,
"pattern": "^([^\\\"])*$",
"example": "SBIN11000"
},
"PayTerm": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^([^\\\"])*$",
"example": "100"
},
"PayInstr": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^([^\\\"])*$",
"description": "Payment Instruction",
"example": "Gift"
},
"CrTrn": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^([^\\\"])*$",
"example": "test"
},
"DirDr": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^([^\\\"])*$",
"description": "Direct Debit",
"example": "test"
},
"CrDay": {
"type": "number",
"minimum": 0,
"maximum": 9999,
"description": "Credit Days",
"example": 100
},
"PaidAmt": {
"type": "number",
"minimum": 0,
"maximum": 99999999999999.98,
"example": 10000
},
"PaymtDue": {
"type": "number",
"minimum": 0,
"maximum": 99999999999999.98,
"example": 5000
}
}
},
"RefDtls": {
"type": "object",
"properties": {
"InvRm": {
"type": "string",
"maxLength": 100,
"minLength": 3,
"pattern": "^([^\\\"])*$",
"example": "TEST"
},
"DocPerdDtls": {
"type": "object",
"properties": {
"InvStDt": {
"type": "string",
"maxLength": 10,
"minLength": 10,
"pattern": "^[0-3][0-9]/[0-1][0-9]/[2][0][1-2][0-9]$",
"example": "24/09/2023"
},
"InvEndDt": {
"type": "string",
"maxLength": 10,
"minLength": 10,
"pattern": "^[0-3][0-9]/[0-1][0-9]/[2][0][1-2][0-9]$",
"example": "26/09/2023"
}
},
"required": [
" InvStDt ",
" InvEndDt "
]
},
"PrecDocDtls": {
"type": "array",
"items": {
"type": "object",
"properties": {
"InvNo": {
"type": "string",
"minLength": 1,
"maxLength": 16,
"pattern": "^[1-9a-zA-Z]{1}[0-9a-zA-Z/-]{1,15}$",
"example": "DOC/002"
},
"InvDt": {
"type": "string",
"maxLength": 10,
"minLength": 10,
"pattern": "^[0-3][0-9]/[0-1][0-9]/[2][0][1-2][0-9]$",
"example": "23/09/2023"
},
"OthRefNo": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"pattern": "^([^\\\"])*$",
"example": "123456"
}
},
"required": [
"InvNo",
"InvDt"
]
}
},
"ContrDtls": {
"type": "array",
"items": {
"type": "object",
"properties": {
"RecAdvRefr": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"pattern": "^([^\\\"])*$",
"example": "Doc/006"
},
"RecAdvDt": {
"type": "string",
"minLength": 10,
"maxLength": 10,
"pattern": "^[0-3][0-9]/[0-1][0-9]/[2][0][1-2][0-9]$",
"example": "24/09/2020"
},
"TendRefr": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"pattern": "^([^\\\"])*$",
"example": "Abc001"
},
"ContrRefr": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"pattern": "^([^\\\"])*$",
"example": "Co123"
},
"ExtRefr": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"pattern": "^([^\\\"])*$",
"example": "Yo456"
},
"ProjRefr": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"pattern": "^([^\\\"])*$",
"example": "Doc-456"
},
"PORefr": {
"type": "string",
"minLength": 1,
"maxLength": 16,
"pattern": "^([^\\\"])*$",
"example": "Doc-789"
},
"PORefDt": {
"type": "string",
"minLength": 10,
"maxLength": 10,
"pattern": "^[0-3][0-9]/[0-1][0-9]/[2][0][1-2][0-9]$",
"example": "24/09/2023"
}
}
}
}
}
},
"AddlDocDtls": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Url": {
"type ": "string",
"minLength": 3,
"maxLength": 100,
"pattern": "^([^\\\"])*$",
"example": "https://einv-apisandbox.nic.in"
},
"Docs": {
"type ": "string",
"minLength ": 3,
"maxLength ": 1000,
"pattern": "^([^\\\"])*$",
"example": "Test Doc"
},
"Info": {
"type": "string",
"minLength": 3,
"maxLength": 1000,
"pattern": "^([^\\\"])*$",
"example": "Document Test"
}
}
}
},
"ExpDtls": {
"type": "object",
"properties": {
"ShipBNo": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"pattern": "^([^\\\"])*$",
"example": "A-248"
},
"ShipBDt": {
"type": "string",
"minLength": 10,
"maxLength": 10,
"pattern": "^[0-3][0-9]/[0-1][0-9]/[2][0][1-2][0-9]$",
"example": "24/09/2023"
},
"Port": {
"type": "string",
"minLength": 2,
"maxLength": 10,
"pattern": "^[0-9|A-Z|a-z]{2,10}$",
"example": "INABG1"
},
"RefClm": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^([Y|N]{1})$",
"example": "N"
},
"ForCur": {
"type": "string",
"minLength": 3,
"maxLength": 16,
"pattern": "^[A-Z|a-z]{3,16}$",
"example": "AED"
},
"CntCode": {
"type": "string",
"minLength": 2,
"maxLength": 2,
"pattern": "^([A-Z]{2})$",
"example": "AE"
},
"ExpDuty": {
"type": "number",
"minimum": 0,
"maximum": 999999999999.99,
"example": null
}
}
},
"EwbDtls": {
"type": "object",
"properties": {
"TransId": {
"type": "string",
"minLength": 15,
"maxLength": 15,
"pattern": "^([0-9]{2}[0-9A-Z]{13})$",
"description": "Transin/GSTIN",
"example": "03AAAPI3182M002"
},
"TransName": {
"type": "string",
"minLength": 3,
"maxLength": 100,
"pattern": "^([^\\\"])*$",
"example": "XYZ EXPORTS"
},
"TransMode": {
"type": "string",
"maxLength": 1,
"minLength": 1,
"enum": [
"1",
"2",
"3",
"4"
],
"pattern": "^([1-4]{1})?$",
"example": "1"
},
"Distance": {
"type": "number",
"minimum": 0,
"maximum": 4000,
"example": 100
},
"TransDocNo": {
"type": "string",
"minLength": 1,
"maxLength": 15,
"pattern": "^([a-zA-Z0-9/-]{1,15})$",
"example": "DOC01"
},
"TransDocDt": {
"type": "string",
"minLength": 10,
"maxLength": 10,
"pattern": "^[a-zA-Z0-9]{1}[a-zA-Z0-9-/]*$",
"example": "24/09/2023"
},
"VehNo": {
"type": "string",
"minLength": 4,
"maxLength": 20,
"pattern": "^([A-Z|a-z|0-9]{4,20})$",
"example": "ka123456"
},
"VehType": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"enum": [
"O",
"R"
],
"pattern": "^([O|R]{1})$",
"example": "R"
}
},
"required": [
"Distance"
]
}
},
"required": [
"Version",
"TranDtls",
"DocDtls",
"SellerDtls",
"BuyerDtls",
"ItemList",
"ValDtls"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status",
"example": "1"
},
"data": {
"type": "object",
"properties": {
"AckNo": {
"description": "Transaction number",
"type": "string",
"example": "162310048427387"
},
"AckDt": {
"description": "Date and time on which invoice is registered(Date format is 'yyyy-MM-dd HH:mm:ss ').",
"type": "string",
"example": "2023-07-06 16:42:38"
},
"Irn": {
"description": "SHA256 hash of Gstin, DocDtls.No, DocDtls.Typ, financial year of DoctDtls.Dt",
"type": "string",
"example": "9a36c874d574eda42385fd2796463577dbd66692e3b28a5301c88a1fe9429b91"
},
"SignedInvoice": {
"description": "Complete e-Invoice data digitally signed using JSON Web Token(JWT) and JSON Web Signature (JWS) with 'SHA256RSA' algorithm",
"type": "string",
"example": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjE1MTNCODIxRUU0NkM3NDlBNjNCODZFMzE4QkY3MTEwOTkyODdEMUYiLCJ4NXQiOiJGUk80SWU1R3gwbW1PNGJqR0w5eEVKa29mUjgiLCJ0eXAiOiJKV1QifQ.eyJkYXRhIjoie1wiQWNrTm9cIjoxNjIzMTAwNDg0MjczODcsXCJBY2tEdFwiOlwiMjAyMy0wNy0wNiAxNjo0MjozOFwiLFwiSXJuXCI6XCI5YTM2Yzg3NGQ1NzRlZGE0MjM4NWZkMjc5NjQ2MzU3N2RiZDY2NjkyZTNiMjhhNTMwMWM4OGExZmU5NDI5YjkxXCIsXCJWZXJzaW9uXCI6XCIxLjFcIixcIlRyYW5EdGxzXCI6e1wiVGF4U2NoXCI6XCJHU1RcIixcIlN1cFR5cFwiOlwiQjJCXCIsXCJSZWdSZXZcIjpcIk5cIixcIklnc3RPbkludHJhXCI6XCJOXCJ9LFwiRG9jRHRsc1wiOntcIlR5cFwiOlwiSU5WXCIsXCJOb1wiOlwiUkFNSVJOSU5BMTk5XCIsXCJEdFwiOlwiMjEvMDYvMjAyMVwifSxcIlNlbGxlckR0bHNcIjp7XCJHc3RpblwiOlwiMjRBQUFQSTMxODJNMDAyXCIsXCJMZ2xObVwiOlwiSktMIFB2dC4gTHRkXCIsXCJUcmRObVwiOlwiSktMIFB2dC4gTHRkXCIsXCJBZGRyMVwiOlwiS2lsbGEgTm9cXHUwMDI3cyAyOS8xNi8yLDI1LjM3LzUsNiwxNSAsXCIsXCJBZGRyMlwiOlwiIERpc3RyaWN0IEd1cnVncmFtICxWaWxsYWdlIFRhaiBOYWdhciAsSGFyeWFuYVwiLFwiTG9jXCI6XCJCYW5nYWxvcmVcIixcIlBpblwiOjM5NTAwMyxcIlN0Y2RcIjpcIjI0XCIsXCJQaFwiOlwiOTAwMDIwNzAyOFwifSxcIkJ1eWVyRHRsc1wiOntcIkdzdGluXCI6XCIyOUFBQVBJMzE4Mk0wMDBcIixcIkxnbE5tXCI6XCJUZXN0IE9yZyBQdnQgTHRkLCBLaW5nc3dheSBCdWlsZGluZ1wiLFwiVHJkTm1cIjpcIlRlc3QgT3JnIFB2dCBMdGQsIEtpbmdzd2F5IEJ1aWxkaW5nXCIsXCJQb3NcIjpcIjI5XCIsXCJBZGRyMVwiOlwiU2hlZCBOby4xMCwgVmlzaW9uIFJlYWx0ZWNoIFByaXZhdGUgTGltaXRlZCwgS2hhc3JhIDc3LzEzIFxcdTAwMjYgNzcvMTFcIixcIkFkZHIyXCI6XCJTYW1wbGEga2hhcmtob2RhIHJvYWQsT3BwIFRDSSBIVUwgV2FyZWhvdXNlLCBUZWhzaWwgU0FNUExBLFZpbGxhZ2UtSGFzc2FuZ2FyaFwiLFwiTG9jXCI6XCJSb2h0YWtcIixcIlBpblwiOjU2MDAyNSxcIlBoXCI6XCI5MDAwMjA3MDI3XCIsXCJTdGNkXCI6XCIyOVwifSxcIkl0ZW1MaXN0XCI6W3tcIkl0ZW1Ob1wiOjAsXCJTbE5vXCI6XCIxXCIsXCJJc1NlcnZjXCI6XCJOXCIsXCJQcmREZXNjXCI6XCJQQVRBTkpBTEkgU0FVTkRBUllBIEFMT0VWRVJBIEdFTCAxNTBNTCBcIixcIkhzbkNkXCI6XCIzNDAxMzA5MFwiLFwiUXR5XCI6NDIwLFwiRnJlZVF0eVwiOjAsXCJVbml0XCI6XCJQQ1NcIixcIlVuaXRQcmljZVwiOjY1LjIxLFwiVG90QW10XCI6MjczODguMixcIkRpc2NvdW50XCI6MCxcIlByZVRheFZhbFwiOjEsXCJBc3NBbXRcIjoyNzM4OC4yLFwiR3N0UnRcIjoxOCxcIklnc3RBbXRcIjo0OTI5Ljg4LFwiQ2dzdEFtdFwiOjAsXCJTZ3N0QW10XCI6MCxcIkNlc1J0XCI6MCxcIkNlc0FtdFwiOjAsXCJDZXNOb25BZHZsQW10XCI6MCxcIlN0YXRlQ2VzUnRcIjowLFwiU3RhdGVDZXNBbXRcIjowLFwiU3RhdGVDZXNOb25BZHZsQW10XCI6MCxcIk90aENocmdcIjoyNC4yNCxcIlRvdEl0ZW1WYWxcIjozMjM0Mi4zMixcIkF0dHJpYkR0bHNcIjpbe1wiTm1cIjpcIlBBVEFOSkFMSSBTQVVOREFSWUEgQUxPRVZFUkEgR0VMIDE1ME1MIFwiLFwiVmFsXCI6XCIyNzM4OC4yMFwifV19XSxcIlZhbER0bHNcIjp7XCJBc3NWYWxcIjoyNzM4OC4yLFwiQ2dzdFZhbFwiOjAsXCJTZ3N0VmFsXCI6MCxcIklnc3RWYWxcIjo0OTI5Ljg4LFwiQ2VzVmFsXCI6MCxcIlN0Q2VzVmFsXCI6MCxcIkRpc2NvdW50XCI6MCxcIk90aENocmdcIjowLFwiUm5kT2ZmQW10XCI6MCxcIlRvdEludlZhbFwiOjMyMzQyLjMyfSxcIlJlZkR0bHNcIjp7XCJJbnZSbVwiOlwiSW52b2ljZSBSZW1hcmtzXCIsXCJEb2NQZXJkRHRsc1wiOntcIkludlN0RHRcIjpcIjIxLzA2LzIwMjFcIixcIkludkVuZER0XCI6XCIzMS8xMi8yMDIxXCJ9fSxcIkV3YkR0bHNcIjp7XCJUcmFuc05hbWVcIjpcIkFCQ0FTXCIsXCJEaXN0YW5jZVwiOjB9fSIsImlzcyI6Ik5JQyBTYW5kYm94In0.vdniSkPmIrrcsQNx7XuyAtJG4-l5-6I28CL9Vhr6mRSYkOEOrgHyPCMQDXQLCPw3dfnKuV85y501Xy3ovKvNbzEQ2nZeNViV-QYjDWlyZdTEQojgoH5HcvU6_7vQkYtRr2KgLyj1Gau6xSzOCDWgRZWec33Q84jpFczs87fAgDIppdYogTGbrBzxmZoSfqdiQIW4jMxnL-HoEkj4LcUxhzJqYpPPFvbf2LwuLK7NPib1QGik5qKAtG9QIfk73duTwLdkb1qZFd2moUX-LYuQCwmhVBa_OfExAFvNlvQJYAjrkon7z3WSRj7db7-k9z-wGG2kHhhlhx_1GWgL1OBcuQ"
},
"SignedQRCode": {
"description": "Complete e-Invoice data digitally signed using JSON Web Token(JWT) and JSON Web Signature (JWS) with 'SHA256RSA' algorithm",
"type": "string",
"example": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjE1MTNCODIxRUU0NkM3NDlBNjNCODZFMzE4QkY3MTEwOTkyODdEMUYiLCJ4NXQiOiJGUk80SWU1R3gwbW1PNGJqR0w5eEVKa29mUjgiLCJ0eXAiOiJKV1QifQ.eyJkYXRhIjoie1wiU2VsbGVyR3N0aW5cIjpcIjI0QUFBUEkzMTgyTTAwMlwiLFwiQnV5ZXJHc3RpblwiOlwiMjlBQUFQSTMxODJNMDAwXCIsXCJEb2NOb1wiOlwiUkFNSVJOSU5BMTk5XCIsXCJEb2NUeXBcIjpcIklOVlwiLFwiRG9jRHRcIjpcIjIxLzA2LzIwMjFcIixcIlRvdEludlZhbFwiOjMyMzQyLjMyLFwiSXRlbUNudFwiOjEsXCJNYWluSHNuQ29kZVwiOlwiMzQwMTMwOTBcIixcIklyblwiOlwiOWEzNmM4NzRkNTc0ZWRhNDIzODVmZDI3OTY0NjM1NzdkYmQ2NjY5MmUzYjI4YTUzMDFjODhhMWZlOTQyOWI5MVwiLFwiSXJuRHRcIjpcIjIwMjMtMDctMDYgMTY6NDI6MzhcIn0iLCJpc3MiOiJOSUMgU2FuZGJveCJ9.ibQ-nD6SC6_khq8gM2EYvjLcSKgYBiBr4UYC8mG8cfA8lTX16h4j1r5HOoS2_xglcvldrTo9oCJ6YCQJxg4fcx-sxcN-nl2xaui_dF5vc8Dq9KIJmIRc94DvE5zyuDgLA-Tnf_sHkIl7OnbQ_2JmUkj4UBZoXEMROkuuJD5oopCyvKaxByWhJDDfkud03ID6GjjaEMPVKIzzUz6zC7rCN0cR6yiVxGyRTPe3B33tZWPmOLzrLUXJBZZGx95u1g3wfPH3MiYDPRqJREfdcJq2uWyrMm__sQ0deX3n-1YhYBhsUnjukoLElJyzjeQCB6i1XE34E1f8SUpaieRK3b7Elw"
},
"Status": {
"description": "'ACT' for Active and 'CNL' for Cancelled",
"type": "string",
"enum": [
"ACT",
"CNL"
],
"example": "ACT"
},
"EwbNo": {
"description": "E Way Bill No. , if E Way Bill is generated",
"type": [
"number",
"null"
],
"example": 191008688443
},
"EwbDt": {
"description": "E Way Bill Date. , if E Way Bill is generated",
"type": [
"string",
"null"
],
"example": "2020-08-05 15:18:00"
},
"EwbValidTill": {
"description": "E Way Bill validity date, if Part B details are provided in the payload",
"type": [
"string",
"null"
],
"example": "2020-08-06 23:59:00"
},
"Remarks": {
"type": [
"string",
"null"
],
"example": "null"
}
}
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"example": null
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"data"
]
}
}
}
},
"400": {
"description": "Failure Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status"
},
"data": {
"type": "null"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"type": "object"
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"error"
]
}
}
}
},
"403": {
"description": "Authorization information is missing or invalid.",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/403/content/application~1json/schema"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/irp/{irp}/eway-bill/by-einvoice": {
"post": {
"tags": [
"Compliance Suite"
],
"summary": "Generate E-WayBill By Irn",
"description": "Generate EWB via IRN offers single EWB generation using this API.",
"operationId": "eas_basic_v1_generate_ewaybill_by_invoice",
"_peer-api": "/basic/einv/v3.0/ni1/eiewb/v1.03/ewaybill",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/2"
},
{
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice/post/parameters/3"
},
{
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice/post/parameters/4"
},
{
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice/post/parameters/5"
},
{
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice/post/parameters/6"
},
{
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice/post/parameters/7"
},
{
"name": "irp",
"in": "path",
"required": true,
"schema": {
"type": "string",
"enum": [
"ni1",
"ni2"
],
"example": "ni1"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Irn": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Irn Number",
"example": "988610af33bfa7cf38114cd804d537d5b95e2cbe402962f8494ec3ff83992fc9"
},
"TransId": {
"type": "string",
"minLength": 15,
"maxLength": 15,
"pattern": "([0-9]{2}[0-9A-Z]{13})",
"description": "Transin/GSTIN",
"example": "12AWGPV7107B1Z1"
},
"TransName": {
"type": "string",
"minLength": 3,
"maxLength": 100,
"pattern": "^([^\\\"])*$",
"description": "Name of the transporter",
"example": "trans name"
},
"TransMode": {
"type": "string",
"maxLength": 1,
"minLength": 1,
"enum": [
"1",
"2",
"3",
"4"
],
"pattern": "^([1-4]{1})?$",
"description": "Mode of transport (Road-1, Rail-2, Air-3, Ship-4)",
"example": "1"
},
"Distance": {
"type": "number",
"minimum": 0,
"maximum": 4000,
"description": "Distance between source and destination PIN codes",
"example": "100"
},
"TransDocNo": {
"type": "string",
"minLength": 1,
"maxLength": 15,
"pattern": "^([a-zA-Z0-9/-]{1,15})$",
"description": "Transport Document Number",
"example": "TRAN/DOC/11"
},
"TransDocDt": {
"type": "string",
"minLength": 10,
"maxLength": 10,
"pattern": "^[a-zA-Z0-9]{1}[a-zA-Z0-9-/]*$",
"description": "Transport Document Date",
"example": "26/09/2023"
},
"VehNo": {
"type": "string",
"minLength": 4,
"maxLength": 20,
"pattern": "^([A-Z|a-z|0-9]{4,20})$",
"description": "Vehicle Number",
"example": "KA12ER1234"
},
"VehType": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"enum": [
"O",
"R"
],
"pattern": "^([O|R]{1})$",
"description": "Whether O-ODC or R-Regular ",
"example": "R"
},
"ExpShipDtls": {
"type": "object",
"properties": {
"Addr1": {
"type": "string",
"minLength": 3,
"maxLength": 100,
"pattern": "^([^\\\"])*$",
"description": "Address1 of the entity to whom the supplies are shipped to. (Building/Flat no.,Road/Street etc.)",
"example": "7th block, kuvempu layout"
},
"Addr2": {
"type": "string",
"minLength": 3,
"maxLength": 100,
"pattern": "^([^\\\"])*$",
"description": "Address 2 of the entity to whom the supplies are shipped to. (Floor no., Name of the premises/building).",
"example": "kuvempu layout"
},
"Loc": {
"type": "string",
"minLength": 3,
"maxLength": 100,
"pattern": "^([^\\\"])*$",
"description": "Place (City,Town,Village) entity to whom the supplies are shipped to.",
"example": "Banagalore"
},
"Pin": {
"type": "number",
"minimum": 100000,
"maximum": 999999,
"description": "Pincode",
"example": "562160"
},
"Stcd": {
"type": "string",
"minLength": 1,
"maxLength": 2,
"pattern": "^(?!0+$)([0-9]{1,2})$",
"description": "State Code to which supplies are shipped to. Refer the master",
"example": "29"
}
},
"required": [
"Addr1",
"Loc",
"Pin",
"Stcd"
]
},
"DispDtls": {
"type": "object",
"properties": {
"Nm": {
"type": "string",
"minLength": 3,
"maxLength": 100,
"pattern": "^([^\\\"])*$",
"description": "Name of the company from which the goods are dispatched",
"example": "ABC Company pvt ltd"
},
"Addr1": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^([^\\\"])*$",
"description": "Address 1 of the entity from which goods are dispatched. (Building/Flat no.Road/Street etc.)",
"example": "7th block, kuvempu layout"
},
"Addr2": {
"type": "string",
"minLength": 3,
"maxLength": 100,
"pattern": "^([^\\\"])*$",
"description": "Address 2 of the entity from which goods are dispatched. (Floor no., Name of the premises/building)",
"example": "kuvempu layout"
},
"Loc": {
"type": "string",
"minLength": 3,
"maxLength": 100,
"pattern": "^([^\\\"])*$",
"description": "Location",
"example": "Banagalore"
},
"Pin": {
"type": "number",
"minimum": 100000,
"maximum": 999999,
"description": "Pincode",
"example": "562160"
},
"Stcd": {
"type": "string",
"minLength": 1,
"maxLength": 2,
"pattern": "^(?!0+$)([0-9]{1,2})$",
"description": "State Code. Refer the master",
"example": "29"
}
},
"required": [
"Nm",
"Addr1",
"Loc",
"Pin",
"Stcd"
]
}
},
"required": [
"Irn",
"Distance",
"TransId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status",
"example": "1"
},
"data": {
"type": "object",
"properties": {
"EwbNo": {
"description": "E-way bill number",
"type": "string",
"example": "131002251962"
},
"EwbDt": {
"type": "string",
"description": "E-way bill date, when e-way bill was generated (DD/MM/YYYY HH:MM:SS AM/PM)",
"example": "13/07/2023 03:13:00 PM"
},
"EwbValidTill": {
"type": "string",
"description": "Validity of the E-way bill (DD/MM/YYYY HH:MM:SS AM/PM)",
"example": "14/07/2023 11:59:00 PM"
},
"Remarks": {
"type": [
"string",
"null"
],
"description": "Additional information such as, If distance is passed is 0, shows actual distance calculated for the pair of PIN codes",
"example": "Total invoice value is more than the sum of total assessible value and tax values, "
}
}
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"example": null
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"data"
]
}
}
}
},
"400": {
"description": "Failure Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status"
},
"data": {
"type": "null"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"type": "object"
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"error"
]
}
}
}
},
"403": {
"description": "Authorization information is missing or invalid.",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/403/content/application~1json/schema"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/irp/{irp}/einvoice/{irn}": {
"get": {
"tags": [
"Compliance Suite"
],
"summary": "Get E-Invoice by IRN",
"description": "Given an invoice reference number (IRN), you can get e-invoice details using this API.",
"operationId": "eas_basic_v1_fetch_invoice_get",
"_peer-api": "/basic/einv/v3.0/ni1/eicore/v1.03/Invoice/irn/0d7cd189815aefc5eb7f740fde7a52fdcd4cde2764fb14063abef22fd616d681",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/2"
},
{
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice/post/parameters/3"
},
{
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice/post/parameters/4"
},
{
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice/post/parameters/5"
},
{
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice/post/parameters/6"
},
{
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice/post/parameters/7"
},
{
"name": "irp",
"in": "path",
"required": true,
"schema": {
"type": "string",
"enum": [
"ni1",
"ni2"
],
"example": "ni1"
}
},
{
"name": "irn",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "9a36c874d574eda42385fd2796463577dbd66692e3b28a5301c88a1fe9429b91"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status",
"example": "1"
},
"data": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice/post/responses/200/content/application~1json/schema/properties/data"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"example": null
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"data"
]
}
}
}
},
"400": {
"description": "Failure Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status"
},
"data": {
"type": "null"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"type": "object"
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"error"
]
}
}
}
},
"403": {
"description": "Authorization information is missing or invalid.",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/403/content/application~1json/schema"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/irp/{irp}/einvoice/cancel": {
"patch": {
"tags": [
"Compliance Suite"
],
"summary": "Cancel E-Invoice",
"description": "Cancel IRN offers single e-invoice cancellation.",
"operationId": "eas_basic_v1_cancel_invoice",
"_peer-api": "/basic/einv/v3.0/ni1/eicore/v1.03/Invoice/Cancel",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/2"
},
{
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice/post/parameters/3"
},
{
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice/post/parameters/4"
},
{
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice/post/parameters/5"
},
{
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice/post/parameters/6"
},
{
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice/post/parameters/7"
},
{
"name": "irp",
"in": "path",
"required": true,
"schema": {
"type": "string",
"enum": [
"ni1",
"ni2"
],
"example": "ni1"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"IRN": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Invoice Reference Number",
"example": "9a36c874d574eda42385fd2796463577dbd66692e3b28a5301c88a1fe9429b91"
},
"CnlRsn": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"enum": [
"1",
"2",
"3",
"4"
],
"description": "Cancel Reason 1- Duplicate, 2 - Data entry mistake, 3- Order Cancelled, 4 - Others",
"example": "1"
},
"CnlRem": {
"type": "string",
"minLength": 0,
"maxLength": 100,
"description": "Cancel Remarks",
"example": "Wrong Entry"
}
},
"required": [
"IRN",
"CnlRsn"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status",
"example": "1"
},
"data": {
"type": "object",
"properties": {
"IRN": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1cancel/patch/requestBody/content/application~1json/schema/properties/IRN"
},
"CancelDate": {
"type": "string",
"description": "Date of cancellation of the IRN",
"example": "2023-07-06 06:14:00"
}
}
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"example": "null"
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"data"
]
}
}
}
},
"400": {
"description": "Failure Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status"
},
"data": {
"type": "null"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"type": "object"
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"error"
]
}
}
}
},
"403": {
"description": "Authorization information is missing or invalid.",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/403/content/application~1json/schema"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/irp/{irp}/einvoice/{irn}/pdf": {
"get": {
"tags": [
"Compliance Suite"
],
"summary": "E-Invoice PDF Download",
"description": "The E-Invoice PDF Download API streamlines the process of obtaining electronic invoices in PDF format programmatically. Users authenticate securely using methods like API keys or OAuth tokens. This API offers flexibility through customizable query parameters, allowing users to retrieve specific invoices based on criteria such as invoice number or date range. The output is standardized in the widely accepted PDF format, ensuring accessibility and consistency across platforms.",
"operationId": "eas_enriched_v1_download_invoice_pdf",
"_peer-api": "/enriched/einv/v1.0/ni1/invoices/download-pdf/9a36c874d574eda42385fd2796463577dbd66692e3b28a5301c88a1fe9429b91",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/2"
},
{
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice/post/parameters/4"
},
{
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice/post/parameters/5"
},
{
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice/post/parameters/6"
},
{
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice/post/parameters/7"
},
{
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice/post/parameters/3"
},
{
"name": "irp",
"in": "path",
"required": true,
"schema": {
"type": "string",
"enum": [
"ni1",
"ni2"
],
"example": "ni1"
}
},
{
"name": "irn",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "9a36c874d574eda42385fd2796463577dbd66692e3b28a5301c88a1fe9429b91"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "Failure Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status"
},
"data": {
"type": "null"
},
"error": {
"type": [
"object",
"null"
],
"properties": {
"type": {
"type": "string"
},
"message": {
"description": "Message",
"type": "string"
},
"args": {
"description": "Args",
"type": [
"object",
"null"
]
}
}
},
"info": {
"type": "null"
},
"additionalInfo": {
"type": "null"
},
"alert": {
"type": "null"
}
}
}
}
}
},
"403": {
"description": "Authorization information is missing or invalid.",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/403/content/application~1json/schema"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/eway/{ewb-provider}/eway-bill/{ewb-number}/pdf": {
"get": {
"tags": [
"Compliance Suite"
],
"summary": "Get E-way PDF",
"description": "By using this API, you can get the e-way bill PDF for an e-way bill Number.",
"operationId": "eas_enriched_v1_get_ewaybill_pdf",
"_peer-api": "/enriched/eway/v3.0/ew1/eway-bills/download-pdf/131002258398",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/2"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/3"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/4"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/5"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/6"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/7"
},
{
"required": true,
"schema": {
"type": "string",
"enum": [
"ew1",
"ew2"
],
"example": "ew1"
},
"description": "E-way bill provider",
"name": "ewb-provider",
"in": "path"
},
{
"required": true,
"schema": {
"type": "string",
"example": "131002251962"
},
"description": "E-way bill number",
"name": "ewb-number",
"in": "path"
}
],
"responses": {
"200": {
"description": "Successful Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "Failure Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status"
},
"data": {
"type": "null"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"type": "object"
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"error"
]
}
}
}
},
"403": {
"description": "Authorization information is missing or invalid.",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/403/content/application~1json/schema"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/irp/{irp}/eway-bill/bulk": {
"post": {
"tags": [
"Compliance Suite"
],
"summary": "Generate Bulk E-WayBill By Irn",
"description": "Generate Bulk EWB via IRN offers multiple EWB generation using this API.",
"operationId": "eas_enriched_v1_generate_bulk_ewaybill_by_invoice",
"_peer-api": "/enriched/einv/v3.0/ni1/invoices/generate-ewb",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/2"
},
{
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice/post/parameters/3"
},
{
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice/post/parameters/4"
},
{
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice/post/parameters/5"
},
{
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice/post/parameters/6"
},
{
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice/post/parameters/7"
},
{
"name": "irp",
"in": "path",
"required": true,
"schema": {
"type": "string",
"enum": [
"ni1",
"ni2"
],
"example": "ni1"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"payload": {
"type": "array",
"items": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1eway-bill~1by-einvoice/post/requestBody/content/application~1json/schema"
}
},
"meta": {
"type": "null",
"example": null
}
},
"required": [
"payload"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status",
"example": "1"
},
"data": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/data"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"example": null
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"data"
]
}
}
}
},
"400": {
"description": "Failure Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status"
},
"data": {
"type": "null"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"type": "object"
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"error"
]
}
}
}
},
"403": {
"description": "Authorization information is missing or invalid.",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/403/content/application~1json/schema"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/eway/{ewb-provider}/eway-bill": {
"post": {
"tags": [
"Compliance Suite"
],
"summary": "Create E-Way Bill",
"description": "Generate E-way Bill API is used to generate an E-way Bill using the given request payload.",
"operationId": "eas_basic_v1_generate_ewaybill",
"_peer-api": "/basic/eway/v3.0/ew1/v1.03/ewayapi/gen-ewb",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/2"
},
{
"name": "X-FLYNN-N-EWB-GSP-CODE",
"in": "header",
"required": true,
"description": "GSP Identifier",
"schema": {
"type": "string",
"enum": [
"vay"
]
}
},
{
"name": "X-FLYNN-N-EWB-GSTIN",
"in": "header",
"required": true,
"description": "GSTIN of the taxpayer",
"schema": {
"maxLength": 15,
"example": "29HJKPS9689A8Z5"
}
},
{
"name": "X-FLYNN-N-EWB-USERNAME",
"in": "header",
"required": true,
"description": "Portal username associated with taxpayer GSTIN for the GSP, Non-sensitive",
"schema": {
"type": "string",
"example": "test_24_001"
}
},
{
"name": "X-FLYNN-N-EWB-PWD",
"in": "header",
"required": false,
"description": "Portal password associated with GSTIN and Username for the GSP, Non-Sensitive.
Provide either `X-FLYNN-N-EWB-PWD` or `X-FLYNN-S-EWB-PWD`",
"schema": {
"type": "string",
"example": "Trial63$value"
}
},
{
"name": "X-FLYNN-S-EWB-PWD",
"in": "header",
"required": false,
"description": "Encrypted Portal password associated with GSTIN and Username for the GSP, Non-Sensitive.
Provide either `X-FLYNN-N-EWB-PWD` or `X-FLYNN-S-EWB-PWD`
for encryption details see S-REK",
"schema": {
"type": "string",
"example": "Trial63$value"
}
},
{
"required": true,
"schema": {
"type": "string",
"enum": [
"ew1",
"ew2"
],
"example": "ew1"
},
"description": "E-way bill provider",
"name": "ewb-provider",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"supplyType": {
"type": "string",
"maxLength": 1,
"minLength": 1,
"enum": [
"O",
"I"
],
"description": "Supply Type",
"example": "O"
},
"subSupplyType": {
"type": "string",
"description": "Sub Supply Type",
"example": "1"
},
"subSupplyDesc": {
"type": "string",
"maxLength": 20,
"description": "Other Sub Supply Description",
"example": ""
},
"docType": {
"type": "string",
"enum": [
"INV",
"CHL",
"BIL",
"BOE",
"OTH"
],
"description": "Document Type",
"example": "INV"
},
"docNo": {
"type": "string",
"maxLength": 16,
"description": "Document Number (Alphanumeric with / and - are allowed)",
"example": "7001-8"
},
"docDate": {
"type": "string",
"pattern": "[0-3][0-9]/[0-1][0-9]/[2][0][1-2][0-9]",
"description": "Document Date",
"example": "15/12/2017"
},
"fromGstin": {
"type": "string",
"maxLength": 15,
"minLength": 15,
"pattern": "[0-9]{2}[0-9|A-Z]{13}",
"description": "From GSTIN (Supplier or Consigner)",
"example": "27AAAPI3182M002"
},
"fromTrdName": {
"type": "string",
"maxLength": 100,
"description": "From Trade Name (Consigner Trade name)",
"example": "welton"
},
"fromAddr1": {
"type": "string",
"maxLength": 120,
"description": "From Address Line 1 (Valid Special Chars #,-,/)",
"example": "2ND CROSS NO 59 19 A"
},
"fromAddr2": {
"type": "string",
"maxLength": 120,
"description": "From Address Line 2(Valid Special Chars # , - ,/)",
"example": "GROUND FLOOR OSBORNE ROAD"
},
"fromPlace": {
"type": "string",
"maxLength": 50,
"description": "From Place",
"example": "FRAZER TOWN"
},
"actFromStateCode": {
"type": "integer",
"maximum": 99,
"description": "Actual From State Code",
"example": 29
},
"fromPincode": {
"type": "integer",
"maximum": 999999,
"minimum": 100000,
"description": "From Pincode",
"example": 560090
},
"fromStateCode": {
"type": "integer",
"maximum": 99,
"description": "From State Code",
"example": 27
},
"toGstin": {
"type": "string",
"maxLength": 15,
"minLength": 15,
"pattern": "[0-9]{2}[0-9|A-Z]{13}",
"description": "To GSTIN (Consignee or Recipient)",
"example": "19AAAPI3182M007"
},
"toTrdName": {
"type": "string",
"maxLength": 100,
"description": "To Trade Name (Consignee Trade name or Recipient Trade name)",
"example": "sthuthya"
},
"toAddr1": {
"type": "string",
"maxLength": 120,
"description": "To Address Line 1 (Valid Special Chars #,-,/)",
"example": "Shree Nilaya"
},
"toAddr2": {
"type": "string",
"maxLength": 120,
"description": "To Address Line 2 (Valid Special Chars #,-,/)",
"example": "Dasarahosahalli"
},
"toPlace": {
"type": "string",
"maxLength": 50,
"description": "To Place",
"example": "Beml Nagar"
},
"toPincode": {
"type": "integer",
"description": "To Pincode",
"example": 560090
},
"actToStateCode": {
"type": "integer",
"maximum": 99,
"description": "Actual To State Code",
"example": 29
},
"toStateCode": {
"type": "integer",
"maximum": 99,
"description": "To State Code",
"example": 19
},
"transactionType": {
"type": "integer",
"maximum": 4,
"description": "Transaction type",
"example": 4
},
"totalValue": {
"type": "number",
"format": "float",
"multipleOf": 0.01,
"description": "Sum of Taxable value ",
"example": 56099
},
"cgstValue": {
"type": "number",
"format": "float",
"multipleOf": 0.01,
"description": "CGST value",
"example": 0
},
"sgstValue": {
"type": "number",
"format": "float",
"multipleOf": 0.01,
"description": "SGST value",
"example": 0
},
"igstValue": {
"type": "number",
"format": "float",
"multipleOf": 0.01,
"description": "IGST value",
"example": 300.67
},
"cessValue": {
"type": "number",
"format": "float",
"multipleOf": 0.01,
"description": "Cess value",
"example": 400.67
},
"cessNonAdvolValue": {
"type": "number",
"format": "float",
"multipleOf": 0.01,
"description": "Cess Non Advol value",
"example": 400
},
"otherValue": {
"type": "number",
"format": "float",
"multipleOf": 0.01,
"description": "Other charges, if any ",
"example": 0
},
"totInvValue": {
"type": "number",
"format": "float",
"multipleOf": 0.01,
"description": "Total Invoice Value (Including taxable value, tax value,and other charges if any)",
"example": 68358
},
"transMode": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4"
],
"description": "Mode of transport (Road-1, Rail-2, Air-3, Ship-4) ",
"example": "1"
},
"transDistance": {
"type": "string",
"description": "Distance (<4000 km) ",
"example": "100"
},
"transporterName": {
"type": "string",
"maxLength": 100,
"description": "Name of the transporter",
"example": "trans name"
},
"transporterId": {
"type": "string",
"pattern": "[0-9]{2}[0-9|A-Z]{13}",
"description": "15 Digit Transporter GSTIN/TRANSIN",
"example": "03AAAPI3182M002"
},
"transDocNo": {
"type": "string",
"maxLength": 15,
"description": "Transport Document Number (Alphanumeric with / and – are allowed)",
"example": "TRAN/DOC/12"
},
"transDocDate": {
"type": "string",
"description": "Transport Document Date",
"example": "08/09/2020"
},
"vehicleNo": {
"type": "string",
"minLength": 7,
"maxLength": 15,
"description": "Vehicle Number",
"example": "PVC1234"
},
"vehicleType": {
"type": "string",
"description": "Vehicle Type",
"example": "R"
},
"itemList": {
"type": "array",
"items": {
"type": "object",
"properties": {
"productName": {
"type": "string",
"maxLength": 100,
"description": "Product / Item Name",
"example": "Wheat"
},
"productDesc": {
"type": "string",
"maxLength": 100,
"description": "Product / Item description",
"example": "Wheat"
},
"hsnCode": {
"type": "number",
"description": "HSN Code",
"example": 1001
},
"quantity": {
"type": "number",
"description": "Quantity",
"example": 4
},
"qtyUnit": {
"type": "string",
"maxLength": 3,
"minLength": 3,
"description": "Unit",
"example": "BOX"
},
"taxableAmount": {
"type": "number",
"format": "float",
"multipleOf": 0.01,
"description": "Taxable Amount",
"example": "5609889"
},
"sgstRate": {
"type": "number",
"multipleOf": 0.001,
"description": "SGST Rate of Tax",
"example": 0
},
"cgstRate": {
"type": "number",
"multipleOf": 0.001,
"description": "CGST Rate of Tax",
"example": 0
},
"igstRate": {
"type": "number",
"multipleOf": 0.001,
"description": "IGST Rate of Tax",
"example": 3
},
"cessRate": {
"type": "number",
"multipleOf": 0.001,
"description": "Cess Rate of Tax",
"example": 3
},
"cessNonadvol": {
"type": "number",
"description": "Cess Non-Advolerum",
"example": 0
}
},
"required": [
"hsnCode",
"taxableAmount"
]
}
}
},
"required": [
"supplyType",
"subSupplyType",
"docType",
"docNo",
"docDate",
"fromGstin",
"fromPincode",
"fromStateCode",
"toGstin",
"toPincode",
"toStateCode",
"transDistance",
"itemList",
"actToStateCode",
"actFromStateCode",
"totInvValue",
"transactionType"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status",
"example": "1"
},
"data": {
"type": "object",
"properties": {
"ewayBillNo": {
"description": "E-way bill number",
"type": "string",
"example": "131002251962"
},
"ewayBillDate": {
"type": "string",
"description": "E-way bill date, when e-way bill was generated (DD/MM/YYYY HH:MM:SS AM/PM)",
"example": "13/07/2023 03:13:00 PM"
},
"validUpto": {
"type": "string",
"description": "Validity of the E-way bill (DD/MM/YYYY HH:MM:SS AM/PM)",
"example": "14/07/2023 11:59:00 PM"
},
"alert": {
"type": "string",
"example": "Total invoice value is more than the sum of total assessible value and tax values, "
}
}
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"example": null
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"data"
]
}
}
}
},
"400": {
"description": "Failure Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status"
},
"data": {
"type": "null"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"type": "object"
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"error"
]
}
}
}
},
"403": {
"description": "Authorization information is missing or invalid.",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/403/content/application~1json/schema"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/eway/{ewb-provider}/eway-bill/part-b": {
"put": {
"tags": [
"Compliance Suite"
],
"summary": "Update E-Way Bill Part B",
"description": "Update Part-B API updates the transporter details for already generated E-way Bill.",
"operationId": "eas_basic_v1_update_ewaybill_partb",
"_peer-api": "/basic/eway/v3.0/ew1/v1.03/ewayapi/update-part-b",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/2"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/3"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/4"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/5"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/6"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/7"
},
{
"required": true,
"schema": {
"type": "string",
"enum": [
"ew1",
"ew2"
],
"example": "ew1"
},
"description": "E-way bill provider",
"name": "ewb-provider",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ewbNo": {
"type": "number",
"description": "Ewaybill Number",
"example": 111000609282
},
"vehicleNo": {
"type": "string",
"minLength": 7,
"maxLength": 15,
"description": "Vehicle Number",
"example": "PQR1234"
},
"fromPlace": {
"type": "string",
"maxLength": 50,
"description": "From Place",
"example": "BANGALORE"
},
"fromState": {
"type": "integer",
"maximum": 99,
"description": "From State",
"example": 29
},
"reasonCode": {
"type": "string",
"maxLength": 1,
"minLength": 1,
"description": "Reason Code",
"example": "1"
},
"reasonRem": {
"type": "string",
"maxLength": 50,
"description": "Remarks",
"example": "vehicle broke down"
},
"transDocNo": {
"type": "string",
"maxLength": 15,
"description": "Transport Document Number",
"example": "1234"
},
"transDocDate": {
"type": "string",
"pattern": "[0-3][0-9]/[0-1][0-9]/[2][0][1-2][0-9]",
"description": "Transport Document Date",
"example": "12/10/2021"
},
"transMode": {
"type": "string",
"description": "Transport Mode",
"example": "1"
},
"vehicleType": {
"type": "string",
"description": "Vehicle Type",
"example": "R"
}
},
"required": [
"fromPlace",
"fromState",
"reasonCode",
"reasonRem",
"transMode"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status",
"example": "1"
},
"data": {
"type": "object",
"properties": {
"vehUpdDate": {
"type": "string",
"description": "Vehicle details updated date (DD/MM/YYYY HH:MM:SS AM/PM)",
"example": "06/07/2023 08:10:00 PM"
},
"validUpto": {
"type": "string",
"description": "Valid upto (DD/MM/YYYY HH:MM:SS AM/PM)",
"example": "09/07/2023 11:59:00 PM"
}
}
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"example": null
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"data"
]
}
}
}
},
"400": {
"description": "Failure Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status"
},
"data": {
"type": "null"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"type": "object"
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"error"
]
}
}
}
},
"403": {
"description": "Authorization information is missing or invalid.",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/403/content/application~1json/schema"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/eway/{ewb-provider}/eway-bill/add-multi-vehicle": {
"put": {
"tags": [
"Compliance Suite"
],
"summary": "Add Multi Vehicle To Group",
"description": "This API can be used to add multi vehicle to a group generated in Initiare Multi Vehicle Movement API",
"operationId": "eas_basic_v1_add_multi_vehicle_to_group",
"_peer-api": "/basic/eway/v3.0/ew1/v1.03/ewayapi/add-multi-vehicle",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/2"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/3"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/4"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/5"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/6"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/7"
},
{
"required": true,
"schema": {
"type": "string",
"enum": [
"ew1",
"ew2"
],
"example": "ew1"
},
"description": "E-way bill provider",
"name": "ewb-provider",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ewbNo": {
"description": "E-way bill number",
"type": "string",
"example": "131002251962"
},
"groupNo": {
"type": "string",
"example": "1"
},
"vehicleNo": {
"type": "string",
"minLength": 7,
"maxLength": 15,
"description": "Vehicle Number",
"example": "PQR1234"
},
"transDocNo": {
"type": "string",
"maxLength": 15,
"description": "Transport Document Number",
"example": "1234"
},
"transDocDate": {
"type": "string",
"pattern": "[0-3][0-9]/[0-1][0-9]/[2][0][1-2][0-9]",
"description": "Transport Document Date",
"example": "12/10/2021"
},
"quantity": {
"type": "number",
"description": "Quantity",
"example": 4
}
},
"required": [
"ewbNo",
"groupNo",
"vehicleNo",
"transDocNo",
"transDocDate",
"quantity"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status",
"example": "1"
},
"data": {
"type": "object",
"properties": {
"ewbNo": {
"description": "E-way bill number",
"type": "string",
"example": "131002251962"
},
"groupNo": {
"type": "string",
"example": "1"
},
"vehAddedDate": {
"type": "string",
"format": "DD/MM/YYYY HH:MM:SS AM/PM",
"description": "Vehicle Added Date",
"example": "13/07/2023 03:21:00 PM"
}
}
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"example": null
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"data"
]
}
}
}
},
"400": {
"description": "Failure Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status"
},
"data": {
"type": "null"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"type": "object"
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"error"
]
}
}
}
},
"403": {
"description": "Authorization information is missing or invalid.",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/403/content/application~1json/schema"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/eway/{ewb-provider}/eway-bill/change-multi-vehicle": {
"patch": {
"tags": [
"Compliance Suite"
],
"summary": "Change Multi Vehicle",
"description": "This API can be used to update exiting multi vehicle to a group generated in Initiare Multi Vehicle Movement API",
"operationId": "eas_basic_v1_change_multi_vehicle",
"_peer-api": "/basic/eway/v3.0/ew1/v1.03/ewayapi/change-multi-vehicle",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/2"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/3"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/4"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/5"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/6"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/7"
},
{
"required": true,
"schema": {
"type": "string",
"enum": [
"ew1",
"ew2"
],
"example": "ew1"
},
"description": "E-way bill provider",
"name": "ewb-provider",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ewbNo": {
"description": "E-way bill number",
"type": "string",
"example": "131002251962"
},
"groupNo": {
"type": "string",
"example": "1"
},
"oldvehicleNo": {
"type": "string",
"minLength": 7,
"maxLength": 15,
"description": "Old Vehicle Number",
"example": "PQR1234"
},
"newVehicleNo": {
"type": "string",
"minLength": 7,
"maxLength": 15,
"description": "New Vehicle Number",
"example": "PQR1234"
},
"oldTranNo": {
"type": "string",
"maxLength": 15,
"description": "Old Transport Document Number",
"example": "1234"
},
"newTranNo": {
"type": "string",
"maxLength": 15,
"description": "New Transport Document Number",
"example": "1234"
},
"fromPlace": {
"type": "string",
"maxLength": 50,
"description": "From Place",
"example": "Bengaluru"
},
"fromState": {
"type": "integer",
"maximum": 99,
"description": "From State",
"example": 29
},
"reasonCode": {
"type": "string",
"maxLength": 1,
"minLength": 1,
"description": "Reason Code",
"example": "1"
},
"reasonRem": {
"type": "string",
"maxLength": 50,
"description": "Remarks",
"example": "vehicle broke down"
}
},
"required": [
"ewbNo",
"groupNo",
"oldvehicleNo",
"newVehicleNo",
"oldTranNo",
"newTranNo",
"fromPlace",
"fromState",
"reasonCode",
"reasonRem"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status",
"example": "1"
},
"data": {
"type": "object",
"properties": {
"ewbNo": {
"description": "E-way bill number",
"type": "string",
"example": "131002251962"
},
"groupNo": {
"type": "string",
"example": "1"
},
"vehUpdDate": {
"type": "string",
"format": "DD/MM/YYYY HH:MM:SS AM/PM",
"description": "Vehicle Updated Date",
"example": "13/07/2023 03:21:00 PM"
}
}
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"example": null
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"data"
]
}
}
}
},
"400": {
"description": "Failure Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status"
},
"data": {
"type": "null"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"type": "object"
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"error"
]
}
}
}
},
"403": {
"description": "Authorization information is missing or invalid.",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/403/content/application~1json/schema"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/eway/{ewb-provider}/eway-bill/transporter": {
"patch": {
"tags": [
"Compliance Suite"
],
"summary": "Update Ewb Transporter",
"description": "This API can be used to update the transporter details of a generated E-way Bill.",
"operationId": "eas_basic_v1_update_ewb_transporter",
"_peer-api": "/basic/eway/v3.0/ew1/v1.03/ewayapi/update-transporter",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/2"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/3"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/4"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/5"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/6"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/7"
},
{
"required": true,
"schema": {
"type": "string",
"enum": [
"ew1",
"ew2"
],
"example": "ew1"
},
"description": "E-way bill provider",
"name": "ewb-provider",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ewbNo": {
"description": "E-way bill number",
"type": "string",
"example": "131002251962"
},
"transporterId": {
"type": "string",
"pattern": "[0-9]{2}[0-9|A-Z]{13}",
"description": "15 Digit Transporter GSTIN/TRANSIN",
"example": "03AAAPI3182M002"
}
},
"required": [
"ewbNo",
"transporterId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status",
"example": "1"
},
"data": {
"type": "object",
"properties": {
"ewayBillNo": {
"description": "E-way bill number",
"type": "string",
"example": "131002251962"
},
"transporterId": {
"description": "15 Digit Transporter GSTIN/TRANSIN",
"type": "string",
"example": "12AWGPV7107B1Z1"
},
"transUpdateDate": {
"type": "string",
"format": "DD/MM/YYYY HH:MM:SS AM/PM",
"description": "Vehicle Updated Date",
"example": "13/07/2023 03:21:00 PM"
}
}
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"example": null
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"data"
]
}
}
}
},
"400": {
"description": "Failure Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status"
},
"data": {
"type": "null"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"type": "object"
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"error"
]
}
}
}
},
"403": {
"description": "Authorization information is missing or invalid.",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/403/content/application~1json/schema"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/eway/{ewb-provider}/eway-bill/initiate-multi-vehicle-movement": {
"post": {
"tags": [
"Compliance Suite"
],
"summary": "Initiate Multi Vehicle Movement",
"description": "This API can be used to start the movement of multi vehicle for a given Eway bill.",
"operationId": "eas_basic_v1_initiate_multi_vehicle_movement",
"_peer-api": "/basic/eway/v3.0/ew1/v1.03/ewayapi/initiate-multi-vehicle",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/2"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/3"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/4"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/5"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/6"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/7"
},
{
"required": true,
"schema": {
"type": "string",
"enum": [
"ew1",
"ew2"
],
"example": "ew1"
},
"description": "E-way bill provider",
"name": "ewb-provider",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ewbNo": {
"description": "E-way bill number",
"type": "string",
"example": "131002251962"
},
"reasonCode": {
"type": "string",
"maxLength": 1,
"minLength": 1,
"description": "Reason Code",
"example": "1"
},
"reasonRem": {
"type": "string",
"maxLength": 50,
"description": "Remarks",
"example": "vehicle broke down"
},
"fromPlace": {
"type": "string",
"maxLength": 50,
"description": "From Place",
"example": "Bengaluru"
},
"fromState": {
"type": "integer",
"maximum": 99,
"description": "From State",
"example": 29
},
"toPlace": {
"type": "string",
"maxLength": 50,
"description": "To Place",
"example": "Beml Nagar"
},
"toState": {
"type": "integer",
"maximum": 99,
"description": "To State Code",
"example": 19
},
"transMode": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4"
],
"description": "Mode of transport (Road-1, Rail-2, Air-3, Ship-4) ",
"example": "1"
},
"totalQuantity": {
"type": "number",
"description": "Total Quantity",
"example": "33"
},
"unitCode": {
"type": "string",
"maxLength": 3,
"minLength": 3,
"description": "Unit Code",
"example": "NOS"
}
},
"required": [
"ewbNo",
"reasonCode",
"reasonRem",
"fromPlace",
"fromState",
"toPlace",
"toState",
"transMode",
"totalQuantity",
"unitCode"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status",
"example": "1"
},
"data": {
"type": "object",
"properties": {
"ewbNo": {
"description": "E-way bill number",
"type": "string",
"example": "131002251962"
},
"groupNo": {
"type": "string",
"example": "1"
},
"createdDate": {
"type": "string",
"format": "DD/MM/YYYY HH:MM:SS AM/PM",
"description": "Created Date",
"example": "13/07/2023 03:21:00 PM"
}
}
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"example": null
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"data"
]
}
}
}
},
"400": {
"description": "Failure Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status"
},
"data": {
"type": "null"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"type": "object"
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"error"
]
}
}
}
},
"403": {
"description": "Authorization information is missing or invalid.",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/403/content/application~1json/schema"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/eway/{ewb-provider}/eway-bill/extend-validity": {
"patch": {
"tags": [
"Compliance Suite"
],
"summary": "Extend E-Way Bill Validity",
"description": "Extend E-way Bill API is used to extend the validity of a generated E-way Bill.",
"operationId": "eas_basic_v1_extend_ewaybill_validity",
"_peer-api": "basic/eway/v3.0/ew1/v1.03/ewayapi/extend-validity",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/2"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/3"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/4"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/5"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/6"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/7"
},
{
"required": true,
"schema": {
"type": "string",
"enum": [
"ew1",
"ew2"
],
"example": "ew1"
},
"description": "E-way bill provider",
"name": "ewb-provider",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ewbNo": {
"type": "number",
"description": "Ewaybill Number",
"example": 161000843009
},
"vehicleNo": {
"type": "string",
"minLength": 7,
"maxLength": 15,
"example": "PQR1234",
"description": "Vehicle Number"
},
"fromPlace": {
"type": "string",
"maxLength": 50,
"description": "From Place",
"example": "Bengaluru"
},
"fromState": {
"type": "integer",
"maximum": 99,
"description": "From State",
"example": 29
},
"remainingDistance": {
"type": "number",
"description": "Remaining Distance",
"example": 50
},
"transDocNo": {
"type": "string",
"maxLength": 15,
"description": "Transport Document Number",
"example": "1234"
},
"transDocDate": {
"type": "string",
"pattern": "[0-3][0-9]/[0-1][0-9]/[2][0][1-2][0-9]",
"description": "Transport Document Date",
"example": "12/10/2021"
},
"transMode": {
"type": "string",
"description": "Transport Mode",
"example": "5"
},
"extnRsnCode": {
"type": "number",
"description": "Extension Reason Code",
"example": 1
},
"extnRemarks": {
"type": "string",
"description": "Extension Remarks",
"example": "Flood"
},
"fromPincode": {
"type": "number",
"description": "From Pincode",
"example": 560090
},
"consignmentStatus": {
"type": "string",
"description": "consignmentStatus(T)",
"example": "T"
},
"transitType": {
"type": "string",
"description": "transit Type",
"example": "R"
},
"addressLine1": {
"type": "string",
"description": "addressLine1",
"example": "Bengaluru"
},
"addressLine2": {
"type": "string",
"description": "addressLine2",
"example": "Bengaluru"
},
"addressLine3": {
"type": "string",
"description": "addressLine3",
"example": "Bengaluru"
}
},
"required": [
"fromPlace",
"fromState",
"fromPincode",
"remainingDistance",
"transMode",
"ewbNo",
"extnRsnCode",
"extnRemarks"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status",
"example": "1"
},
"data": {
"type": "object",
"properties": {
"ewayBillNo": {
"description": "E-way bill number",
"type": "string",
"example": "131002251962"
},
"updatedDate": {
"type": "string",
"description": "E-way bill date, when e-way bill was generated (DD/MM/YYYY HH:MM:SS AM/PM)",
"example": "13/07/2023 03:13:00 PM"
},
"validUpto": {
"type": "string",
"description": "Validity of the E-way bill (DD/MM/YYYY HH:MM:SS AM/PM)",
"example": "14/07/2023 11:59:00 PM"
}
}
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"example": null
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"data"
]
}
}
}
},
"400": {
"description": "Failure Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status"
},
"data": {
"type": "null"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"type": "object"
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"error"
]
}
}
}
},
"403": {
"description": "Authorization information is missing or invalid.",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/403/content/application~1json/schema"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/eway/{ewb-provider}/eway-bill/cancel": {
"patch": {
"tags": [
"Compliance Suite"
],
"summary": "Cancel E-way bill",
"description": "Cancel E-way Bill API is used to Cancel a generated E-way Bill using the given e-way bill number.",
"operationId": "eas_basic_v1_cancel_ewaybill",
"_peer-api": "/basic/eway/v3.0/ew1/v1.03/ewayapi/cancel",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/2"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/3"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/4"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/5"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/6"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/7"
},
{
"required": true,
"schema": {
"type": "string",
"enum": [
"ew1",
"ew2"
],
"example": "ew1"
},
"description": "E-way bill provider",
"name": "ewb-provider",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ewbNo": {
"type": "number",
"description": "Ewaybill Number",
"example": 161000843009
},
"cancelRsnCode": {
"type": "number",
"description": "Reason for cancellation",
"example": 2
},
"cancelRmrk": {
"type": "string",
"description": "Remarks",
"example": "Cancelled the order"
}
},
"required": [
"ewbNo",
"cancelRsnCode"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status",
"example": "1"
},
"data": {
"type": "object",
"properties": {
"ewayBillNo": {
"description": "E-way bill number",
"type": "string",
"example": "131002251962"
},
"cancelDate": {
"type": "string",
"description": "E-way bill date, when e-way bill was generated (DD/MM/YYYY HH:MM:SS AM/PM)",
"example": "13/07/2023 03:13:00 PM"
}
}
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"example": null
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"data"
]
}
}
}
},
"400": {
"description": "Failure Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status"
},
"data": {
"type": "null"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"type": "object"
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"error"
]
}
}
}
},
"403": {
"description": "Authorization information is missing or invalid.",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/403/content/application~1json/schema"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/eway/{ewb-provider}/eway-bill/{ewb-number}": {
"get": {
"tags": [
"Compliance Suite"
],
"summary": "Get E-way bill",
"description": "By using this API, you can get the e-way bill Details for an e-way bill Number.",
"operationId": "eas_basic_v1_fetch_ewaybill",
"_peer-api": "/basic/eway/v3.0/ew1/v1.03/ewayapi/GetEwayBill?ewbNo=131002258398",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/2"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/3"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/4"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/5"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/6"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/7"
},
{
"required": true,
"schema": {
"type": "string",
"example": "131002251962"
},
"description": "E-way bill number",
"name": "ewb-number",
"in": "path"
},
{
"required": true,
"schema": {
"type": "string",
"enum": [
"ew1",
"ew2"
],
"example": "ew1"
},
"description": "E-way bill provider",
"name": "ewb-provider",
"in": "path"
}
],
"responses": {
"200": {
"description": "Successful Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status",
"example": "1"
},
"data": {
"type": "object",
"properties": {
"actFromStateCode": {
"description": "Actual From State Code",
"type": "integer",
"example": 29
},
"actToStateCode": {
"description": "Actual To State Code",
"type": "integer",
"example": 29
},
"actualDist": {
"description": "Actual Distance",
"type": "integer",
"example": 500
},
"cessNonAdvolValue": {
"description": "Cess Non Advol value",
"format": "float",
"type": "number",
"example": "0.00"
},
"cessValue": {
"description": "Cess value",
"format": "float",
"type": "number",
"example": "0.00"
},
"cgstValue": {
"description": "CGST value",
"format": "float",
"type": "number",
"example": "26518.52"
},
"docDate": {
"description": "Document Date (DD/MM/YYYY)",
"type": "string",
"example": "03/08/2021"
},
"docNo": {
"description": "Document Number (Alphanumeric with / and - are allowed)",
"type": "string",
"example": "7007-8"
},
"docType": {
"description": "Document Type",
"type": "string",
"example": "INV"
},
"ewayBillDate": {
"type": "string",
"description": "E-way bill date, when e-way bill was generated (DD/MM/YYYY HH:MM:SS AM/PM)",
"example": "13/07/2023 03:13:00 PM"
},
"ewbNo": {
"type": "number",
"description": "Ewaybill Number",
"example": 161000843009
},
"extendedTimes": {
"type": "number",
"description": "Count of Extensions made for this Ewaybill",
"example": 1
},
"fromAddr1": {
"description": "From Address Line 1 (Valid Special Chars #,-,/)",
"type": "string",
"example": "2ND CROSS NO 59 19 A"
},
"fromAddr2": {
"description": "From Address Line 2(Valid Special Chars # , - ,/)",
"type": "string",
"example": "GROUND FLOOR OSBORNE ROAD"
},
"fromGstin": {
"description": "From GSTIN (Supplier or Consigner)",
"type": "string",
"example": "29AKLPM8755F1Z2"
},
"fromPincode": {
"description": "From Pincode",
"type": "integer",
"example": 500039
},
"fromPlace": {
"description": "From Place",
"type": "string",
"example": "FRAZER TOWN"
},
"fromStateCode": {
"description": "From State Code",
"type": "integer",
"example": 29
},
"fromTrdName": {
"description": "From Trade Name (Consigner Trade name)",
"type": "string",
"example": "welton"
},
"genMode": {
"type": "string",
"description": "Generation mode",
"example": "API"
},
"igstValue": {
"description": "IGST value",
"format": "float",
"type": "number",
"example": 0
},
"noValidDays": {
"description": "number of days Ewaybill is valid",
"type": "number",
"example": 3
},
"otherValue": {
"description": "Other charges, if any ",
"format": "float",
"type": "number",
"example": "0.00"
},
"rejectStatus": {
"type": "string",
"example": "N"
},
"vehicleType": {
"description": "Vehicle Type",
"type": "string",
"example": "R"
},
"sgstValue": {
"description": "SGST value",
"format": "float",
"example": 26518.52,
"type": "number"
},
"status": {
"description": "Vehicle Type",
"type": "string",
"example": "ACT"
},
"subSupplyType": {
"description": "Sub Supply Type",
"type": "string",
"example": "1"
},
"supplyType": {
"description": "Supply Type",
"type": "string",
"example": "O"
},
"toAddr1": {
"description": "To Address Line 1 (Valid Special Chars #,-,/)",
"type": "string",
"example": "Shree Nilaya"
},
"toAddr2": {
"description": "To Address Line 2 (Valid Special Chars #,-,/)",
"type": "string",
"example": "Dasarahosahalli"
},
"toGstin": {
"description": "To GSTIN (Consignee or Recipient)",
"type": "string",
"example": "URP"
},
"toPincode": {
"description": "To Pincode",
"type": "integer",
"example": "560090"
},
"toPlace": {
"description": "To Place",
"type": "string",
"example": "Beml Nagar"
},
"toStateCode": {
"description": "To State Code",
"type": "integer",
"example": 29
},
"totalValue": {
"description": "Sum of Taxable value ",
"format": "float",
"type": "number",
"example": 189418
},
"totInvValue": {
"description": "Total Invoice Value (Including taxable value, tax value,and other charges if any)",
"format": "float",
"type": "number",
"example": 242455.04
},
"toTrdName": {
"description": "To Trade Name (Consignee Trade name or Recipient Trade name)",
"type": "string",
"example": "test2"
},
"transporterId": {
"description": "15 Digit Transporter GSTIN/TRANSIN",
"type": "string",
"example": "12AWGPV7107B1Z1"
},
"transporterName": {
"description": "Name of the transporter",
"type": "string",
"example": "trans name"
},
"transactionType": {
"type": "integer",
"example": 4
},
"userGstin": {
"type": "string",
"description": "Gstin of the Business",
"example": "13AWGPV7107B1Z1"
},
"validUpto": {
"type": "string",
"description": "Validity of the E-way bill (DD/MM/YYYY HH:MM:SS AM/PM)",
"example": "14/07/2023 11:59:00 PM"
},
"itemList": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cessNonadvol": {
"description": "Cess Non-Advolerum",
"type": "number",
"example": 0
},
"cessRate": {
"description": "Cess Rate of Tax",
"type": "number",
"example": 0
},
"cgstRate": {
"description": "CGST Rate of Tax",
"type": "number",
"example": 14
},
"hsnCode": {
"description": "HSN Code",
"type": "number",
"example": 1001
},
"igstRate": {
"description": "IGST Rate of Tax",
"type": "number",
"example": 0
},
"productDesc": {
"description": "Product / Item description",
"type": "string",
"example": 0
},
"productName": {
"description": "Product / Item Name",
"type": "string",
"example": "Wheat"
},
"qtyUnit": {
"description": "Unit",
"type": "string",
"example": "BOX"
},
"quantity": {
"description": "Quantity",
"type": "number",
"example": 4
},
"sgstRate": {
"description": "SGST Rate of Tax",
"type": "number",
"example": 14
},
"taxableAmount": {
"description": "Taxable Amount",
"format": "float",
"type": "number",
"example": 5612
}
}
}
},
"VehiclListDetails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"updMode": {
"type": "string",
"example": "API"
},
"vehicleNo": {
"description": "Vehicle Number",
"type": "string",
"example": "PQR1234"
},
"fromPlace": {
"type": "string",
"example": "Bengaluru"
},
"fromState": {
"type": "integer",
"example": 29
},
"tripshtNo": {
"type": "integer",
"example": 1810002031
},
"userGSTINTransin": {
"type": "string",
"example": "29AKLPM8755F1Z2"
},
"enteredDate": {
"type": "string",
"description": "Entered Date (DD/MM/YYYY HH:MM:SS AM/PM)",
"example": "26/08/2022 02:40:00 PM"
},
"transMode": {
"type": "string",
"example": "1"
},
"transDocNo": {
"type": "string",
"example": "1234"
},
"transDocDate": {
"type": "string",
"example": "26/05/2022"
},
"groupNo": {
"type": "string",
"example": "1"
}
}
}
}
}
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"example": null
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"data"
]
}
}
}
},
"400": {
"description": "Failure Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status"
},
"data": {
"type": "null"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"type": "object"
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"error"
]
}
}
}
},
"403": {
"description": "Authorization information is missing or invalid.",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/403/content/application~1json/schema"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/eway/{ewb-provider}/eway-bill/consigner/doc-type/{doc-type}/doc-no/{doc-number}": {
"get": {
"tags": [
"Compliance Suite"
],
"summary": "Get E-way bill generated by Consigner",
"description": "This API provides the e-way bill details for a Document Type and Document number.",
"operationId": "eas_basic_v1_fetch_ewaybill_generated_by_consigner",
"_peer-api": "/basic/eway/v3.0/ew1/v1.03/ewayapi/GetEwayBillGeneratedByConsigner?docType=INV&DocNo=MGTEST0003A1004",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/2"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/3"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/4"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/5"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/6"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/7"
},
{
"required": true,
"schema": {
"type": "string",
"enum": [
"INV",
"BIL",
"BOE",
"CHL",
"CNT",
"OTH"
],
"example": "INV"
},
"description": "document type",
"name": "doc-type",
"in": "path"
},
{
"required": true,
"schema": {
"type": "string",
"example": "131002251962"
},
"description": "document type",
"name": "doc-number",
"in": "path"
},
{
"required": true,
"schema": {
"type": "string",
"enum": [
"ew1",
"ew2"
],
"example": "ew1"
},
"description": "E-way bill provider",
"name": "ewb-provider",
"in": "path"
}
],
"responses": {
"200": {
"description": "Successful Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status",
"example": "1"
},
"data": {
"type": "object",
"properties": {
"ewayBillNo": {
"description": "E-way bill number",
"type": "string",
"example": "131002251962"
},
"ewayBillDate": {
"type": "string",
"description": "E-way bill date, when e-way bill was generated (DD/MM/YYYY HH:MM:SS AM/PM)",
"example": "13/07/2023 03:13:00 PM"
},
"validUpto": {
"type": "string",
"description": "Validity of the E-way bill (DD/MM/YYYY HH:MM:SS AM/PM)",
"example": "14/07/2023 11:59:00 PM"
},
"alert": {
"type": "string",
"example": "Total invoice value is more than the sum of total assessible value and tax values, "
}
}
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"example": null
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"data"
]
}
}
}
},
"400": {
"description": "Failure Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status"
},
"data": {
"type": "null"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"type": "object"
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"error"
]
}
}
}
},
"403": {
"description": "Authorization information is missing or invalid.",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/403/content/application~1json/schema"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/eway/{ewb-provider}/eway-bill-error": {
"get": {
"tags": [
"Compliance Suite"
],
"summary": "Get Error List",
"description": "This API returns a string containing all the errors thrown by e-way bill APIs along with their error codes",
"operationId": "eas_basic_v1_fetch_ewaybill_error_list",
"_peer_api": "basic/eway/v3.0/ew1/v1.03/Master/GetErrorList",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/2"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/3"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/4"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/5"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/6"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/7"
},
{
"required": true,
"schema": {
"type": "string",
"enum": [
"ew1",
"ew2"
],
"example": "ew1"
},
"description": "E-way bill provider",
"name": "ewb-provider",
"in": "path"
}
],
"responses": {
"200": {
"description": "Successful Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status",
"example": "1"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"example": "103"
},
"errorDesc": {
"type": "string",
"example": "Invalid Client -Id"
}
}
}
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"example": null
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"data"
]
}
}
}
},
"400": {
"description": "Failure Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status"
},
"data": {
"type": "null"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"type": "object"
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"error"
]
}
}
}
},
"403": {
"description": "Authorization information is missing or invalid.",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/403/content/application~1json/schema"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/eway/{ewb-provider}/eway-bill/by-other-party": {
"get": {
"tags": [
"Compliance Suite"
],
"summary": "Get E-way Bills of Other Party",
"description": "This API provides the list of E-way bills generated by other parties on your GSTIN. This can be used for rejecting the e-way bill, if required. Note that the headers date and month support both 1 character and 2 characters i.e. both ¼/2020 and 01/04/2020 are valid formats in the URL. However, year needs to be 4 characters.",
"operationId": "eas_basic_v1_fetch_ewaybill_of_other_party",
"_peer-api": "basic/eway/v3.0/ew1/v1.03/ewayapi/GetEwayBillsofOtherParty?date=20/06/2021",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/2"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/3"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/4"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/5"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/6"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/7"
},
{
"required": true,
"schema": {
"type": "string",
"example": "31/12/2020"
},
"description": "date (format DD/MM/YYYY, like 31/12/2020)",
"name": "date",
"in": "query"
},
{
"required": true,
"schema": {
"type": "string",
"enum": [
"ew1",
"ew2"
],
"example": "ew1"
},
"description": "E-way bill provider",
"name": "ewb-provider",
"in": "path"
}
],
"responses": {
"200": {
"description": "Successful Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status",
"example": "1"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ewbNo": {
"type": "number",
"description": "Ewaybill Number",
"example": 161000843009
},
"ewayBillDate": {
"type": "string",
"description": "E-way bill date, when e-way bill was generated (DD/MM/YYYY HH:MM:SS AM/PM)",
"example": "13/07/2023 03:13:00 PM"
},
"genMode": {
"type": "string",
"description": "Generation mode",
"example": "API"
},
"genGstin": {
"type": "string",
"example": "29AAACW4202F1ZM"
},
"docNo": {
"type": "string",
"example": "ARGST20/20010381"
},
"docDate": {
"type": "string",
"example": "20/06/2021"
},
"fromGstin": {
"type": "string",
"example": "29AAACW4202F1ZM"
},
"fromTradeName": {
"type": "string",
"example": "XYZ Enterprises"
},
"toGstin": {
"type": "string",
"example": "29AEKPV7203E1Z9"
},
"toTradeName": {
"type": "string",
"example": "ABC Enterprises"
},
"totInvValue": {
"description": "Total Invoice Value (Including taxable value, tax value,and other charges if any)",
"format": "float",
"multipleOf": 0.01,
"type": "number",
"example": "1234556"
},
"hsnCode": {
"type": "number",
"description": "HSN Code",
"example": 28
},
"hsnDesc": {
"type": "string",
"example": "CMC"
},
"status": {
"description": "'ACT' for Active and 'CNL' for Cancelled",
"type": "string",
"enum": [
"ACT",
"CNL"
],
"example": "ACT"
},
"rejectStatus": {
"type": "boolean",
"description": "Reject Status",
"example": false
}
}
}
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"example": null
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"data"
]
}
}
}
},
"400": {
"description": "Failure Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status"
},
"data": {
"type": "null"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"type": "object"
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"error"
]
}
}
}
},
"403": {
"description": "Authorization information is missing or invalid.",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/403/content/application~1json/schema"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/eway/{ewb-provider}/hsn/{hsn-code}": {
"get": {
"tags": [
"Compliance Suite"
],
"summary": "Get HSN details by Hsn Code",
"description": "This API returns a string containing the HSN description details for a given HSN Code.",
"operationId": "eas_basic_v1_fetch_ewaybill_hsn_details",
"_peer-api": "/basic/eway/v3.0/ew1/v1.03/Master/GetHsnDetailsByHsnCode?hsncode=998319",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/2"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/3"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/4"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/5"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/6"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/7"
},
{
"required": true,
"schema": {
"type": "string",
"enum": [
"ew1",
"ew2"
],
"example": "ew1"
},
"description": "E-way bill provider",
"name": "ewb-provider",
"in": "path"
},
{
"required": true,
"schema": {
"type": "string",
"example": "998319"
},
"description": "HSN code for which the details are required",
"name": "hsn-code",
"in": "path"
}
],
"responses": {
"200": {
"description": "Successful Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status",
"example": "1"
},
"data": {
"type": "object",
"properties": {
"hsnCode": {
"type": "string",
"description": "Hsn code",
"example": "998319"
},
"hsnDesc": {
"type": "string",
"description": "Hsn description",
"example": "Other information technology services n.e."
}
}
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"example": null
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"data"
]
}
}
}
},
"400": {
"description": "Failure Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status"
},
"data": {
"type": "null"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"type": "object"
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"error"
]
}
}
}
},
"403": {
"description": "Authorization information is missing or invalid.",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/403/content/application~1json/schema"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/eway/{ewb-provider}/transporter/{trn-no}": {
"get": {
"tags": [
"Compliance Suite"
],
"summary": "Get Transporter details by transporter number",
"description": "This API returns a string containing details for a given transporter Transin.",
"operationId": "eas_basic_v1_fetch_ewaybill_transporter_details",
"_peer-api": "/basic/eway/v3.0/ew1/v1.03/Master/GetTransporterDetails?trn_no=29AKLPM8755F1Z2",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/2"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/3"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/4"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/5"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/6"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/7"
},
{
"required": true,
"schema": {
"type": "string",
"example": "01AALFT1663P1ZU"
},
"description": "transporter GSTIN or Transin number (max 15 digits)",
"name": "trn-no",
"in": "path"
},
{
"required": true,
"schema": {
"type": "string",
"enum": [
"ew1",
"ew2"
],
"example": "ew1"
},
"description": "E-way bill provider",
"name": "ewb-provider",
"in": "path"
}
],
"responses": {
"200": {
"description": "Successful Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status",
"example": "1"
},
"data": {
"type": "object",
"properties": {
"transin": {
"type": "string",
"example": "01AALFT1663P1ZU"
},
"tradeName": {
"type": [
"string",
"null"
],
"example": "XYZ Traders"
},
"legalName": {
"type": "string",
"example": "Transitplus Global"
},
"address1": {
"type": "string",
"example": "Plot No 30A Sector 1 ,Plot No 30A Sector 1 ,Sanjay Nagar"
},
"address2": {
"type": "string",
"example": "Sanjay Nagar ,Jammu ,Jammu"
},
"stateCode": {
"type": "string",
"example": "1"
},
"pinCode": {
"type": "string",
"example": "180004"
}
}
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"example": null
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"data"
]
}
}
}
},
"400": {
"description": "Failure Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status"
},
"data": {
"type": "null"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"type": "object"
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"error"
]
}
}
}
},
"403": {
"description": "Authorization information is missing or invalid.",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/403/content/application~1json/schema"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/eway/{ewb-provider}/eway-bill/transporter-by-date": {
"get": {
"tags": [
"Compliance Suite"
],
"summary": "Get Transporter details by date",
"description": "This API returns a string containing details for a given transporter date.",
"operationId": "eas_basic_v1_fetch_ewaybill_transporter_details_by_date",
"_peer-api": "/basic/eway/v3.0/ew1/v1.03/ewayapi/GetEwayBillsForTransporter?date='31/12/2020'",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/2"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/3"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/4"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/5"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/6"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/7"
},
{
"required": true,
"schema": {
"type": "string",
"pattern": "^(0[1-9]|[12][0-9]|3[01])/(0[1-9]|1[0-2])/[0-9]{4}$",
"example": "31/12/2020"
},
"description": "date (format DD/MM/YYYY, like 31/12/2020)",
"name": "date",
"in": "query"
},
{
"required": true,
"schema": {
"type": "string",
"enum": [
"ew1",
"ew2"
],
"example": "ew1"
},
"description": "E-way bill provider",
"name": "ewb-provider",
"in": "path"
}
],
"responses": {
"200": {
"description": "Successful Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status",
"example": "1"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ewbNo": {
"type": "number",
"description": "Ewaybill Number",
"example": 161000843009
},
"ewbDate": {
"type": "string",
"description": "Date of generation of the EWB",
"example": "2023-07-06 06:14:00"
},
"status": {
"description": "'ACT' for Active and 'CNL' for Cancelled",
"type": "string",
"enum": [
"ACT",
"CNL"
],
"example": "ACT"
},
"genGstin": {
"type": "string",
"example": "29AAACW4202F1ZM"
},
"docNo": {
"description": "Document Number (Alphanumeric with / and - are allowed)",
"type": "string",
"example": "7007-8"
},
"docDate": {
"description": "Document Date (DD/MM/YYYY)",
"type": "string",
"example": "03/08/2021"
},
"delPinCode": {
"type": "string",
"example": "180004"
},
"delStateCode": {
"type": "integer",
"maximum": 99,
"description": "State Code",
"example": 19
},
"delPlace": {
"type": "string",
"maxLength": 50,
"description": "Place",
"example": "Bengaluru"
},
"validUpto": {
"type": "string",
"description": "Valid upto (DD/MM/YYYY HH:MM:SS AM/PM)",
"example": "09/07/2023 11:59:00 PM"
},
"extendedTimes": {
"type": "number",
"description": "Count of Extensions made for this Ewaybill",
"example": 1
},
"rejectStatus": {
"type": "boolean",
"description": "Reject Status",
"example": false
}
}
}
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"example": null
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"data"
]
}
}
}
},
"400": {
"description": "Failure Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status"
},
"data": {
"type": "null"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"type": "object"
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"error"
]
}
}
}
},
"403": {
"description": "Authorization information is missing or invalid.",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/403/content/application~1json/schema"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/eway/{ewb-provider}/eway-bill/transporter-by-gstin-and-date": {
"get": {
"tags": [
"Compliance Suite"
],
"summary": "Get Transporter details by GSTIN and Date",
"description": "This API returns a string containing details for a given transporter date and gstin.",
"operationId": "eas_basic_v1_fetch_ewaybill_transporter_details_by_gstin_and_date",
"_peer-api": "/basic/eway/v3.0/ew1/v1.03/ewayapi/GetEwayBillsForTransporterByGstin?Gen_gstin='29HJKPS9689A8Z5'&date='31/12/2020'",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/2"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/3"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/4"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/5"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/6"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/7"
},
{
"required": true,
"schema": {
"type": "string",
"maxLength": 15,
"example": "29HJKPS9689A8Z5"
},
"description": "GSTIN to search",
"name": "Gen_gstin",
"in": "query"
},
{
"required": true,
"schema": {
"type": "string",
"pattern": "^(0[1-9]|[12][0-9]|3[01])/(0[1-9]|1[0-2])/[0-9]{4}$",
"example": "31/12/2020"
},
"description": "date (format DD/MM/YYYY, like 31/12/2020)",
"name": "date",
"in": "query"
},
{
"required": true,
"schema": {
"type": "string",
"enum": [
"ew1",
"ew2"
],
"example": "ew1"
},
"description": "E-way bill provider",
"name": "ewb-provider",
"in": "path"
}
],
"responses": {
"200": {
"description": "Successful Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status",
"example": "1"
},
"data": {
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill~1transporter-by-date/get/responses/200/content/application~1json/schema/properties/data"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"example": null
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"data"
]
}
}
}
},
"400": {
"description": "Failure Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status"
},
"data": {
"type": "null"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"type": "object"
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"error"
]
}
}
}
},
"403": {
"description": "Authorization information is missing or invalid.",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/403/content/application~1json/schema"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/eway/{ewb-provider}/eway-bill/transporter-by-state-code-and-date": {
"get": {
"tags": [
"Compliance Suite"
],
"summary": "Get Transporter details by State Code and Date",
"description": "This API returns a string containing details for a given transporter state-code and date.",
"operationId": "eas_basic_v1_fetch_ewaybill_transporter_details_by_statecode_and_date",
"_peer-api": "/basic/eway/v3.0/ew1/v1.03/ewayapi/GetEwayBillsForTransporterByState?stateCode='24'&date='31/12/2025'",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/2"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/3"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/4"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/5"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/6"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/7"
},
{
"required": true,
"schema": {
"type": "string",
"example": "24"
},
"description": "State code",
"example": "24",
"name": "stateCode",
"in": "query"
},
{
"required": true,
"schema": {
"type": "string",
"pattern": "^(0[1-9]|[12][0-9]|3[01])/(0[1-9]|1[0-2])/[0-9]{4}$",
"example": "31/12/2020"
},
"description": "date (format DD/MM/YYYY, like 31/12/2020)",
"name": "date",
"in": "query"
},
{
"required": true,
"schema": {
"type": "string",
"enum": [
"ew1",
"ew2"
],
"example": "ew1"
},
"description": "E-way bill provider",
"name": "ewb-provider",
"in": "path"
}
],
"responses": {
"200": {
"description": "Successful Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status",
"example": "1"
},
"data": {
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill~1transporter-by-date/get/responses/200/content/application~1json/schema/properties/data"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"example": null
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"data"
]
}
}
}
},
"400": {
"description": "Failure Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status"
},
"data": {
"type": "null"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"type": "object"
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"error"
]
}
}
}
},
"403": {
"description": "Authorization information is missing or invalid.",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/403/content/application~1json/schema"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/eway/{ewb-provider}/eway-bill/transporter-assigned-date": {
"get": {
"tags": [
"Compliance Suite"
],
"summary": "Get EWB Report by Transporter Assigned Date and State Code",
"description": "This API returns a details for a given transporter state-code and Assigned date.",
"operationId": "eas_basic_v1_fetch_ewaybill_report_transporter_details_by_statecode_and_Assigned_date",
"_peer-api": "/basic/eway/v3.0/ew1/v1.03/ewayapi/GetEwayBillReportByTransporterassignedDate?stateCode='24'&date='31/12/2025'",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/2"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/3"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/4"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/5"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/6"
},
{
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill/post/parameters/7"
},
{
"required": true,
"schema": {
"type": "string",
"example": "24"
},
"description": "State code",
"example": "24",
"name": "stateCode",
"in": "query"
},
{
"required": true,
"schema": {
"type": "string",
"pattern": "^(0[1-9]|[12][0-9]|3[01])/(0[1-9]|1[0-2])/[0-9]{4}$",
"example": "31/12/2020"
},
"description": "date (format DD/MM/YYYY, like 31/12/2020)",
"name": "date",
"in": "query"
},
{
"required": true,
"schema": {
"type": "string",
"enum": [
"ew1",
"ew2"
],
"example": "ew1"
},
"description": "E-way bill provider",
"name": "ewb-provider",
"in": "path"
}
],
"responses": {
"200": {
"description": "Successful Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status",
"example": "1"
},
"data": {
"$ref": "#/paths/~1atlas~1v1~1eway~1%7Bewb-provider%7D~1eway-bill~1transporter-by-date/get/responses/200/content/application~1json/schema/properties/data"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"example": null
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"data"
]
}
}
}
},
"400": {
"description": "Failure Response",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/400/content/application~1json/schema/properties/status"
},
"data": {
"type": "null"
},
"error": {
"$ref": "#/paths/~1atlas~1v1~1irp~1%7Birp%7D~1einvoice~1%7Birn%7D~1pdf/get/responses/400/content/application~1json/schema/properties/error",
"type": "object"
},
"info": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/info",
"example": null
},
"additionalInfo": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/additionalInfo",
"example": null
},
"alert": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/content/application~1json/schema/properties/alert",
"example": null
}
},
"required": [
"status",
"error"
]
}
}
}
},
"403": {
"description": "Authorization information is missing or invalid.",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
},
"X-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/403/content/application~1json/schema"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/aadhaar/{aadharNumber}": {
"get": {
"tags": [
"Verification Suite"
],
"summary": "Place an Aadhaar Data request",
"description": "Place an Aadhaar data request and and get verified data",
"operationId": "rubix_post_kyc_aadhar",
"_peer-api": "/kyc/v2/aadhar",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/2"
},
{
"name": "aadharNumber",
"in": "path",
"description": "Aadhar Number",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
},
"results": {
"type": [
"object",
"null"
],
"properties": {
"aadhar_number": {
"type": "string"
},
"gender": {
"type": "string"
},
"masked_mobile_number": {
"type": "string"
},
"age_band": {
"type": "string"
},
"state": {
"type": "string"
}
},
"example": {
"aadhar_number": "123456789101",
"gender": "MALE",
"masked_mobile_number": "*******123",
"age_band": "30-40",
"state": "Maharashtra"
}
},
"agency_signature": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/agency_signature"
}
},
"required": [
"message",
"results",
"agency_signature"
]
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
}
},
"required": [
"message"
],
"x-examples": {
"Example 1": {
"message": "Missing required request parameters: [aadharNumber]"
}
}
},
"examples": {
"Example 1": {
"value": {
"message": "Missing required request parameters: [aadharNumber]"
}
}
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"BearerAuth": []
}
],
"x-stoplight": {
"id": "cquklno3h6z7p"
}
}
},
"/atlas/v1/pan/{pan}": {
"get": {
"tags": [
"Verification Suite"
],
"summary": "Place a PAN data request",
"description": "Place a PAN data request and get verified data",
"operationId": "rubix_post_kyc_v2_pan",
"_peer-api": "/kyc/v2/pan",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/2"
},
{
"name": "pan",
"in": "path",
"description": "PAN of the company",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
},
"results": {
"type": [
"object",
"null"
],
"properties": {
"pan": {
"type": "string"
},
"name": {
"type": "string"
},
"status": {
"type": "string"
}
},
"example": {
"pan": "AAAAA1234A",
"name": "ABC Company",
"status": "PAN is Active and the details are matching with PAN database"
}
},
"agency_signature": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/agency_signature"
}
},
"required": [
"message",
"results",
"agency_signature"
]
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
}
},
"required": [
"message"
],
"x-examples": {
"Example 1": {
"message": "Missing required request parameters: [pan]"
}
}
},
"examples": {
"400": {
"value": {
"message": "Missing required request parameters: [pan]"
}
}
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"BearerAuth": []
}
],
"x-stoplight": {
"id": "n066q0rwk4obf"
}
},
"parameters": []
},
"/atlas/v1/pan/{pan}/details": {
"get": {
"tags": [
"Verification Suite"
],
"summary": "Place a detailed PAN Data request",
"description": "Place a detailed PAN data request and get verified data",
"operationId": "rubix_post_kyc_pan_detailed",
"_peer-api": "/kyc/v2/pan/detailed",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/2"
},
{
"name": "pan",
"in": "path",
"description": "PAN Number of the company",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
},
"results": {
"type": [
"object",
"null"
],
"properties": {
"name": {
"type": "string"
},
"adhaar": {
"type": "string"
},
"pan": {
"type": "string"
},
"address": {
"type": "string"
},
"city": {
"type": "string"
},
"pincode": {
"type": "string"
},
"state": {
"type": "string"
},
"country": {
"type": "string"
},
"dob": {
"type": "string"
},
"gender": {
"type": "string"
}
},
"example": {
"name": "ABC Company",
"adhaar": "",
"pan": "AAAAA1234A",
"address": "D 424 NEELKANTH BUSINESS PARK, NATHANI ROAD, VIDYAVIHAR WEST, MUMBAI - 400086, MAHARASHTRA",
"city": "Mumbai",
"pincode": "400086",
"state": "Maharashtra",
"country": "India",
"dob": "03-05-2010",
"gender": ""
}
},
"agency_signature": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/agency_signature"
}
},
"required": [
"message",
"results",
"agency_signature"
]
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"BearerAuth": []
}
],
"x-stoplight": {
"id": "9snql1l0qj67h"
}
}
},
"/atlas/v1/tan/{tanNumber}": {
"get": {
"tags": [
"Verification Suite"
],
"summary": "Place a TAN data request",
"description": "Place a TAN data request and get verified data and get verified data",
"operationId": "rubix_post_kyc_tan",
"_peer-api": "/kyc/v2/tan",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/2"
},
{
"name": "tanNumber",
"in": "path",
"description": "Tan Number",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
},
"results": {
"type": [
"object",
"null"
],
"properties": {
"name": {
"type": "string"
},
"tanNumber": {
"type": "string"
}
},
"example": {
"name": "ABC Company",
"tanNumber": "ABCD12345A"
}
},
"agency_signature": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/agency_signature"
}
},
"required": [
"message",
"results",
"agency_signature"
]
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"BearerAuth": []
}
],
"x-stoplight": {
"id": "az4vcxifhsd3w"
}
}
},
"/atlas/v1/bankAccount/{ifsc}/{accountNumber}": {
"get": {
"tags": [
"Verification Suite"
],
"summary": "Place a bank account details request",
"description": "Place a Bank Account details request and get verified data",
"operationId": "rubix_post_kyc_bankAccount",
"_peer-api": "/kyc/v2/bankAccount",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/2"
},
{
"name": "accountNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ifsc",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
},
"results": {
"type": [
"object",
"null"
],
"properties": {
"utr": {
"type": "string"
},
"city": {
"type": "string"
},
"account_holder_name": {
"type": "string"
},
"micr": {
"type": "string"
},
"bank_name": {
"type": "string"
},
"account_number": {
"type": "string"
},
"ifsc": {
"type": "string"
},
"branch": {
"type": "string"
}
},
"example": {
"utr": "123456789012",
"city": "MUMBAI",
"account_holder_name": "Holder name",
"micr": "0",
"bank_name": "ABC BANK",
"account_number": "12345678901234",
"ifsc": "ABCC0001234",
"branch": "VIDYAVIHAR WEST"
}
},
"agency_signature": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/agency_signature"
}
},
"required": [
"message",
"results",
"agency_signature"
]
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
}
},
"required": [
"message"
],
"x-examples": {
"Example 1": {
"message": "Missing required request parameters: [iec, name]"
}
}
},
"examples": {
"Example 1": {
"value": {
"message": "Missing required request parameters: [accountNumber, ifsc]"
}
}
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"BearerAuth": []
}
],
"x-stoplight": {
"id": "t7y278sp795rn"
}
}
},
"/atlas/v1/fssaiCertificate/{licenseNumber}": {
"get": {
"tags": [
"Verification Suite"
],
"summary": "Place a Fssai Certificate details request",
"description": "Place a Fssai Certificate details request and get verified data",
"operationId": "fssaiCertificate",
"_peer-api": "/kyc/v2/fssaiCertificate",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/2"
},
{
"name": "licenseNumber",
"in": "path",
"description": "License Number of Fssai Certificate",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
},
"results": {
"type": [
"object",
"null"
],
"properties": {
"license_number": {
"type": "string"
},
"entity_name": {
"type": "string"
},
"status": {
"type": "string"
},
"license_type": {
"type": "string"
},
"address": {
"type": "string"
},
"state": {
"type": "string"
},
"list_of_products": {
"type": "string"
}
},
"example": {
"license_number": "123456789012",
"entity_name": "ABC Company",
"status": "ACTIVE",
"license_type": "STATE LICENSE",
"address": "MUMBAI,MAHARASHTRA-400012",
"state": "MAHARASHTRA",
"list_of_products": " DAIRY PRODUCTS AND ANALOGUES, EXCLUDING PRODUCTS OF FOOD CATEGORY , FRUITS AND VEGETABLES (INCLUDING MUSHROOMS AND FUNGI, ROOTS AND TUBERS, FRESH PULSES AND LEGUMES, AND ALOE VERA), SEAWEEDS, AND NUTS AND SEEDS, MEAT AND MEAT PRODUCTS, INCLUDING POULTRY AND GAME, EGGS AND EGG PRODUCTS, SALTS, SPICES, SOUPS, SAUCES, SALADS AND PROTEIN PRODUCTS, BEVERAGES, EXCLUDING DAIRY PRODUCTS"
}
},
"agency_signature": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/agency_signature"
}
},
"required": [
"message",
"results",
"agency_signature"
]
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"BearerAuth": []
}
],
"x-stoplight": {
"id": "xk9c5y0dtltqz"
}
}
},
"/atlas/v1/vehicleNumber/{vehicleNumber}": {
"get": {
"tags": [
"Verification Suite"
],
"summary": "Place a Vehicle Number details request",
"description": "Place a Vehicle Number details request and get verified data ",
"operationId": "rubix_post_kyc_vehicleNumber",
"_peer-api": "/kyc/v2/vehicleNumber",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/2"
},
{
"name": "vehicleNumber",
"in": "path",
"description": "Vehicle Registration Certificate Number",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
},
"results": {
"type": [
"object",
"null"
],
"properties": {
"vehicle_number": {
"type": "string"
},
"owner_name": {
"type": "string"
},
"registration_date": {
"type": "string"
},
"chasis_number": {
"type": "string"
},
"engine_number": {
"type": "string"
},
"fuel_type": {
"type": "string"
},
"vehicle_class": {
"type": "string"
},
"maker_name": {
"type": "string"
},
"model": {
"type": "string"
},
"insurance_upto": {
"type": "string"
},
"pollution_expiry": {
"type": "string"
},
"fitness_upto": {
"type": "string"
},
"blackList_status": {
"type": "string"
},
"rc_status": {
"type": "string"
},
"permanent_address": {
"type": "string"
},
"insurance_company": {
"type": "string"
},
"insurance_policy_number": {
"type": "string"
},
"vehicle_category_description": {
"type": "string"
},
"puc_number": {
"type": "string"
},
"permit_number": {
"type": "string"
},
"permit_valid_from": {
"type": "string"
},
"permit_valid_upto": {
"type": "string"
},
"permit_type": {
"type": "string"
},
"national_permit_number": {
"type": "string"
},
"national_permit_upto": {
"type": "string"
},
"national_permit_issued_by": {
"type": "string"
},
"challan_details": {
"type": "string"
}
},
"example": {
"vehicle_number": "AB12CD1234",
"owner_name": "ABC surname",
"registration_date": "01-06-2020",
"chasis_number": "AB1ABCDE1AB123456",
"engine_number": "A-123*12345*",
"fuel_type": "PETROL",
"vehicle_class": "2WN",
"maker_name": "ABC AUTO LTD",
"model": "ABC 800",
"insurance_upto": "15-06-2025",
"pollution_expiry": "23-07-2024",
"fitness_upto": "18-09-2035",
"blackList_status": "",
"rc_status": "ACTIVE",
"permanent_address": "A 1234 ABC, PHASE 1 DOMBIVALI EAST, Thane-421204",
"insurance_company": "ABC INSURANCE CO. LTD.",
"insurance_policy_number": "12345678901200000",
"vehicle_category_description": "M-Cycle/Scooter(2WN)",
"puc_number": "AB01234567890123",
"permit_number": "",
"permit_valid_from": "",
"permit_valid_upto": "",
"permit_type": "",
"national_permit_number": "",
"national_permit_upto": "",
"national_permit_issued_by": "",
"challan_details": ""
}
},
"agency_signature": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/agency_signature"
}
},
"required": [
"message",
"results",
"agency_signature"
]
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"BearerAuth": []
}
],
"x-stoplight": {
"id": "wdh2pmjjpp36z"
}
}
},
"/atlas/v1/challan/{last5DigitsOfChasisNo}/{vehicleNumber}": {
"get": {
"tags": [
"Verification Suite"
],
"summary": "Place a Challan data request",
"description": "Place a Challan data request and get verified data",
"operationId": "rubix_post_kyc_v2_challan",
"_peer-api": "/kyc/v2/challan",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/2"
},
{
"name": "vehicleNumber",
"in": "path",
"description": "Vehicle number",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "last5DigitsOfChasisNo",
"in": "path",
"description": "Last 5 digits of chasis number",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
},
"results": {
"type": [
"object",
"null"
],
"properties": {
"challan_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"number": {
"type": "integer"
},
"challanNumber": {
"type": "string"
},
"offenseDetails": {
"type": "string"
},
"challanDate": {
"type": "string"
},
"accusedName": {
"type": "string"
},
"amount": {
"type": "integer"
},
"challanStatus": {
"type": "string"
}
}
}
}
},
"example": {
"message": null,
"results": {
"challan_list": [
{
"number": 1,
"challanNumber": "MH11314523120******7",
"offenseDetails": "Custom offence 1",
"challanDate": "2023-12-08 21:30:10",
"accusedName": "ABC",
"amount": 1000,
"challanStatus": "Disposed"
},
{
"number": 2,
"challanNumber": "MH10749123120******5",
"offenseDetails": "Reflectors not fitted",
"challanDate": "2023-12-04 14:00:02",
"accusedName": "ABC",
"amount": 1000,
"challanStatus": "Pending"
}
]
},
"agency_signature": {
"agency_name": "Rubix Data Sciences Private Limited",
"agency_contact": "+912249744274",
"agency_website": "https://rubixds.com",
"agency_address": "D - 424, Neelkanth Business Park, Vidyavihar (West), Mumbai 400086, India",
"agency_gst": "27AAICR5957Q1ZC",
"agency_email": "info@rubixds.com",
"disclaimer": "https://rubixds.com/rubix-api-service-disclaimer"
}
}
},
"agency_signature": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/agency_signature"
}
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
}
},
"required": [
"message"
]
},
"examples": {
"400": {
"value": {
"message": "Missing required request parameters: [vehicleNumber]"
}
}
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"BearerAuth": []
}
],
"x-stoplight": {
"id": "uiekod51yrfat"
}
}
},
"/atlas/v1/drivingLicence/{dlNumber}": {
"get": {
"tags": [
"Verification Suite"
],
"summary": "Place a Driving Licence details request",
"description": "Place a Driving Licence details request and get and get verified data",
"operationId": "rubix_post_kyc_v2_drivingLicence",
"_peer-api": "/kyc/v2/drivingLicence",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/2"
},
{
"name": "dlNumber",
"in": "path",
"description": "Driving Licence Number",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "dob",
"in": "query",
"description": "Date of Birth",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
},
"results": {
"type": [
"object",
"null"
],
"properties": {
"dob": {
"type": "string"
},
"name": {
"type": "string"
},
"address": {
"type": "string"
},
"valid_to_date": {
"type": "string"
},
"valid_from_date": {
"type": "string"
},
"class_of_vehicle": {
"type": "string"
},
"father_or_husband_name": {
"type": "string"
},
"driving_licence_number": {
"type": "string"
}
},
"example": {
"message": null,
"results": {
"dob": "01/01/1982",
"name": "Mr A",
"address": "FLAT NO.06, MUMBAI, 400001",
"valid_to_date": "13/10/2031",
"valid_from_date": "14/10/2011",
"class_of_vehicle": "LMV ",
"father_or_husband_name": "Mr R",
"driving_licence_number": "MH3120110000000"
},
"agency_signature": {
"agency_name": "Rubix Data Sciences Private Limited",
"agency_contact": "+912249744274",
"agency_website": "https://rubixds.com",
"agency_address": "D - 424, Neelkanth Business Park, Vidyavihar (West), Mumbai 400086, India",
"agency_gst": "27AAICR5957Q1ZC",
"agency_email": "info@rubixds.com",
"disclaimer": "https://rubixds.com/rubix-api-service-disclaimer"
}
}
},
"agency_signature": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/agency_signature"
}
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
}
},
"required": [
"message"
]
},
"examples": {
"400": {
"value": {
"message": "Missing required request parameters: [dlNumber]"
}
}
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"BearerAuth": []
}
],
"x-stoplight": {
"id": "n42dq1pww7py1"
}
}
},
"/atlas/v1/mca/{cin}": {
"get": {
"tags": [
"Verification Suite"
],
"summary": "Place a MCA Data request",
"description": "Place the request for fetching MCA data on the basis of CIN and get verified data",
"operationId": "rubix_post_kyc_v2_mca",
"_peer-api": "/kyc/v2/mca",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/2"
},
{
"name": "cin",
"in": "path",
"description": "CIN of the company",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
},
"results": {
"type": [
"object",
"null"
],
"properties": {
"company_info": {
"type": "object",
"properties": {
"mca_name": {
"type": "string"
},
"mca_cin": {
"type": "string"
},
"mca_roc": {
"type": "string"
},
"mca_registration_number": {
"type": "string"
},
"company_address": {
"type": "string"
},
"other_address": {
"type": "string"
},
"class_of_company": {
"type": "string"
},
"company_category": {
"type": "string"
},
"sub_category": {
"type": "string"
},
"company_status": {
"type": "string"
},
"mca_status": {
"type": "string"
},
"date_of_incorporation": {
"type": "string"
},
"listing_status": {
"type": "string"
},
"number_of_members": {
"type": "string"
},
"suspended_at_stock_exchange": {
"type": "string"
},
"date_of_last_balance_sheet": {
"type": "string"
},
"date_of_last_annual_general_meeting": {
"type": "string"
},
"authorized_capital": {
"type": "string"
},
"paid_up_capital": {
"type": "string"
},
"company_email": {
"type": "string"
}
}
},
"director_info": {
"type": "object",
"properties": {
"current_director": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"designation": {
"type": "string"
},
"date_of_appointment": {
"type": "string"
},
"din_pan": {
"type": "string"
}
}
}
}
}
},
"index_of_charges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"srn": {
"type": "string"
},
"charge_id": {
"type": "string"
},
"charge_holder_name": {
"type": "string"
},
"date_of_creation": {
"type": "string"
},
"date_of_modification": {
"type": "string"
},
"date_of_satisfaction": {
"type": "string"
},
"amount": {
"type": "string"
}
}
}
}
},
"example": {
"message": null,
"results": {
"company_info": {
"mca_name": "ABC Company",
"mca_cin": "A12345AB2017ABC123456",
"mca_roc": "RoC-Mumbai",
"mca_registration_number": "123456",
"company_address": "Mumbai",
"other_address": "-",
"class_of_company": "Public",
"company_category": "Company limited by Shares",
"sub_category": "Non-govt company",
"company_status": "Active",
"mca_status": "ACTIVE compliant",
"date_of_incorporation": "01-Oct-2010",
"listing_status": "Listed",
"number_of_members": "100",
"suspended_at_stock_exchange": "-",
"date_of_last_balance_sheet": "31-Mar-2022",
"date_of_last_annual_general_meeting": "01-Jun-2022",
"authorized_capital": "500000",
"paid_up_capital": "50000",
"company_email": "info@rubixds.com"
},
"director_info": {
"current_director": [
{
"name": "ABC DEFG",
"designation": "Director",
"date_of_appointment": "30/06/2022",
"din_pan": "01234567"
},
{
"name": "DEF GHI",
"designation": "Director",
"date_of_appointment": "30/06/2014",
"din_pan": "01234578"
}
]
},
"index_of_charges": [
{
"id": "1",
"srn": "A0123456",
"charge_id": "12345678",
"charge_holder_name": "ABC Company",
"date_of_creation": "08-05-2003",
"date_of_modification": "25-02-2005",
"date_of_satisfaction": "05-10-2007",
"amount": "1230000"
}
]
},
"agency_signature": {
"agency_name": "Rubix Data Sciences Private Limited",
"agency_contact": "+912249744274",
"agency_website": "https://rubixds.com",
"agency_address": "D - 424, Neelkanth Business Park, Vidyavihar (West), Mumbai 400086, India",
"agency_gst": "27AAICR5957Q1ZC",
"agency_email": "info@rubixds.com",
"disclaimer": "https://rubixds.com/rubix-api-service-disclaimer"
}
}
},
"agency_signature": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/agency_signature"
}
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
}
},
"required": [
"message"
]
},
"examples": {
"400": {
"value": {
"message": "Missing required request parameters: [cin]"
}
}
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"BearerAuth": []
}
],
"x-stoplight": {
"id": "15d7606o5cm2t"
}
}
},
"/atlas/v1/voterId/{state}/{voterIdNumber}": {
"get": {
"tags": [
"Verification Suite"
],
"summary": "Place a Voter Id details request",
"description": "Place a Voter Id details request and get verified data",
"operationId": "rubix_post_kyc_v2_voterId",
"_peer-api": "/kyc/v2/voterId",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/2"
},
{
"name": "voterIdNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "state",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
},
"results": {
"type": [
"object",
"null"
],
"properties": {
"dob": {
"type": "string"
},
"name": {
"type": "string"
},
"state": {
"type": "string"
},
"gender": {
"type": "string"
},
"district": {
"type": "string"
},
"father_name": {
"type": "string"
},
"voter_id_number": {
"type": "string"
}
},
"example": {
"message": null,
"results": {
"dob": "",
"name": "Mr A",
"state": "MAHARASHTRA",
"gender": "Male",
"district": "Mumbai",
"father_name": "Mr R",
"voter_id_number": "YKB7226000"
},
"agency_signature": {
"agency_name": "Rubix Data Sciences Private Limited",
"agency_contact": "+912249744274",
"agency_website": "https://rubixds.com",
"agency_address": "D - 424, Neelkanth Business Park, Vidyavihar (West), Mumbai 400086, India",
"agency_gst": "27AAICR5957Q1ZC",
"agency_email": "info@rubixds.com",
"disclaimer": "https://rubixds.com/rubix-api-service-disclaimer"
}
}
},
"agency_signature": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/agency_signature"
}
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
}
},
"required": [
"message"
]
},
"examples": {
"400": {
"value": {
"message": "Missing required request parameters: [voterIdNumber]"
}
}
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"BearerAuth": []
}
],
"x-stoplight": {
"id": "o4r9huclt40sm"
}
}
},
"/atlas/v1/shopEstablishment/{state}/{registrationNumber}": {
"get": {
"tags": [
"Verification Suite"
],
"summary": "Place a Shop & Establishment details request",
"description": "Place a Shop Establishment details request and get verified data.\n.\n\nNote : For Shop Establishment, the following states work:\n\n1. West Bengal\n2. Telangana\n3. Uttar Pradesh\n4. Rajasthan\n5. Haryana\n6. Delhi\n7. Maharashtra\n8. Karnataka\n9. Jharkhand\n10. Madhya Pradesh\n11. Jammu Kashmir\n\n\nIf you pass Maharashtra in the state, then an additional field needs to be updated with one of the following Values:\n\n1. Shop I\n2. Commercial II\n3. Restaurant and Eating House IV\n4. Residential Hotel III\n5. Theatre - Public Amusement V",
"operationId": "rubix_post_kyc_v2_shopEstablishment",
"_peer-api": "/kyc/v2/shopEstablishment",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/2"
},
{
"name": "registrationNumber",
"in": "path",
"description": "Registration Number of Shop Establishment",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "state",
"in": "path",
"description": "state",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "category",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
},
"results": {
"type": [
"object",
"null"
],
"properties": {
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"state": {
"type": "string"
},
"address": {
"type": "string"
},
"category": {
"type": "string"
},
"contact_number": {
"type": "string"
},
"manager_name": {
"type": "string"
},
"occupier_name": {
"type": "string"
},
"total_workers": {
"type": "string"
},
"business_nature": {
"type": "string"
},
"registration_date": {
"type": "string"
},
"total_male_workers": {
"type": "string"
},
"date_of_commencement": {
"type": "string"
},
"total_young_workers": {
"type": "string"
},
"registration_number": {
"type": "string"
},
"total_female_workers": {
"type": "string"
},
"total_family_members_working": {
"type": "string"
}
},
"example": {
"message": null,
"results": {
"name": "ABC Company",
"email": "ABC@GMAIL.COM",
"state": "Delhi",
"address": "FLAT NO.2, NEW DELHI, DELHI. PIN-110001",
"category": "COMMERCIAL ESTABLISHMENT",
"contact_number": "9999999999",
"manager_name": "MR. A",
"occupier_name": "MR. A",
"total_workers": "3",
"business_nature": "REPAIRING",
"registration_date": "24/10/2017",
"total_male_workers": "0",
"date_of_commencement": "12/10/2017",
"total_young_workers": "2",
"registration_number": "2017086000",
"total_female_workers": "1",
"total_family_members_working": "0"
},
"agency_signature": {
"agency_name": "Rubix Data Sciences Private Limited",
"agency_contact": "+912249744274",
"agency_website": "https://rubixds.com",
"agency_address": "D - 424, Neelkanth Business Park, Vidyavihar (West), Mumbai 400086, India",
"agency_gst": "27AAICR5957Q1ZC",
"agency_email": "info@rubixds.com",
"disclaimer": "https://rubixds.com/rubix-api-service-disclaimer"
}
}
},
"agency_signature": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/agency_signature"
}
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
}
},
"required": [
"message"
]
},
"examples": {
"400": {
"value": {
"message": "Missing required request parameters: [registrationNumber]"
}
}
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"BearerAuth": []
}
],
"x-stoplight": {
"id": "h5jhy14rftj7z"
}
}
},
"/atlas/v1/mcaInstant": {
"get": {
"tags": [
"Verification Suite"
],
"summary": "MCA - Instant",
"description": "Get MCA data of a counterparty on the basis of CIN or CounterpartyId.\n\nCounterpartyId can be fetched using the Counterparty Search API. Checkout /indian/search or /international/search API endpoints.\n\nNote: Either CIN or CounterpartyId is mandatory (Cannot provide both the parameters)\n\nDisclaimer: This API provides MCA face data which is available in our database. It may not be the most latest data. In order to request for latest MCA data, please check /mca API endpoint.",
"operationId": "rubix_get_kyc_v1_mcaInstant",
"_peer-api": "v1/kyc/mcaInstant",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"name": "Accept",
"in": "header",
"required": true,
"schema": {
"type": "string",
"example": "application/json"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"schema": {
"type": "string",
"example": "application/json"
}
},
{
"schema": {
"type": "string"
},
"in": "query",
"name": "counterpartyId",
"description": "ID of the counterparty"
},
{
"schema": {
"type": "string"
},
"in": "query",
"name": "cin",
"description": "CIN of the counterparty"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"example": null,
"type": [
"string",
"null"
]
},
"results": {},
"agency_signature": {
"type": [
"object"
],
"properties": {
"agency_email": {
"type": [
"string",
"null"
],
"example": "info@rubixds.com"
},
"agency_address": {
"type": [
"string",
"null"
],
"example": "D - 424, Neelkanth Business Park, Vidyavihar (West), Mumbai 400086, India"
},
"agency_contact": {
"type": [
"string",
"null"
],
"example": "+912249744274"
},
"agency_website": {
"type": [
"string",
"null"
],
"example": "https://rubixds.com"
},
"agency_name": {
"type": [
"string",
"null"
],
"example": "Rubix Data Sciences Private Limited"
},
"disclaimer": {
"type": [
"string",
"null"
],
"example": "https://rubixds.com/rubix-api-service-disclaimer"
},
"agency_gst": {
"type": [
"string",
"null"
],
"example": "27AAICR5957Q1ZC"
}
}
}
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
}
},
"required": [
"message"
]
},
"examples": {
"400": {
"value": {
"message": "Missing required request parameters: [counterpartyId]"
}
}
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/aadhaarConsent-async/{aadharNumber}": {
"get": {
"tags": [
"Verification Suite"
],
"summary": "1. Place consent based aadhaar data request",
"description": "Place consent based Aadhaar data request and get reference ID. To get data use the reference ID in /atlas/v1/aadhaarConsent-async/result/{referenceId} endpoint",
"operationId": "rubix_post_kyc_v1_aadhar_consent",
"_peer-api": "v1/kyc/aadhar/consent",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/2"
},
{
"schema": {
"type": "string"
},
"in": "path",
"name": "aadharNumber",
"description": "Aadhar number",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
},
"results": {
"$ref": "#/paths/~1atlas~1v1~1epf-async~1%7BepfNumber%7D/get/responses/200/content/application~1json/schema/properties/results"
},
"agency_signature": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/agency_signature"
}
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
}
},
"required": [
"message"
]
},
"examples": {
"400": {
"value": {
"message": "Missing required request parameters: [aadharNumber]"
}
}
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/aadhaarConsent-async/result/{referenceId}/{otp}": {
"get": {
"tags": [
"Verification Suite"
],
"summary": "2. Get Aadhar Data",
"description": "Retrieve the consent based Aadhar data using the referenceId and OTP",
"operationId": "rubix_get_kyc_v1_aadhar_consent",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/2"
},
{
"schema": {
"type": "string"
},
"in": "path",
"name": "referenceId",
"required": true,
"description": "Reference Id received in POST call"
},
{
"schema": {
"type": "string"
},
"in": "path",
"name": "otp",
"description": "OTP recevied on mobile number",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
},
"results": {
"type": [
"object",
"null"
],
"properties": {
"full_name": {
"type": "string"
},
"aadhar_number": {
"type": "string"
},
"dob": {
"type": "string"
},
"gender": {
"type": "string"
},
"pincode": {
"type": "string"
},
"address": {
"type": "string"
},
"country": {
"type": "string"
},
"state": {
"type": "string"
},
"city": {
"type": "string"
},
"profile_image": {
"type": "string"
}
},
"example": {
"message": null,
"results": {
"full_name": "Rubix Data Sciences",
"aadhar_number": "12345XXXXXXXX",
"dob": "1991-09-20",
"gender": "M",
"pincode": "400001",
"address": "xxxxx, Mumbai",
"country": "India",
"state": "Maharashtra",
"city": "xxxxx",
"profile_image": "QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL"
},
"agency_signature": {
"agency_name": "Rubix Data Sciences Private Limited",
"agency_contact": "+912249744274",
"agency_website": "https://rubixds.com",
"agency_address": "D - 424, Neelkanth Business Park, Vidyavihar (West), Mumbai 400086, India",
"agency_gst": "27AAICR5957Q1ZC",
"agency_email": "info@rubixds.com",
"disclaimer": "https://rubixds.com/rubix-api-service-disclaimer"
}
}
},
"agency_signature": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/agency_signature"
}
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": "Invalid referenceId"
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/panGstLink-async/{pan}": {
"get": {
"tags": [
"Verification Suite"
],
"summary": "1. Place a Pan Gst Link details request",
"description": "Place a Pan Gst Link details request and get reference ID. To get data use the reference ID in /atlas/v1/panGstLink-async/result/{referenceId} endpoint",
"operationId": "rubix_post_kyc_v1_panGstLink",
"_peer-api": "v1/kyc/panGstLink",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/2"
},
{
"schema": {
"type": "string"
},
"in": "path",
"name": "pan",
"required": true,
"description": "Pan Number for pan gst link"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
},
"results": {
"$ref": "#/paths/~1atlas~1v1~1epf-async~1%7BepfNumber%7D/get/responses/200/content/application~1json/schema/properties/results"
},
"agency_signature": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/agency_signature"
}
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
}
},
"required": [
"message"
]
},
"examples": {
"400": {
"value": {
"message": "Missing required request parameters: [pan]"
}
}
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"BearerAuth": []
}
],
"x-stoplight": {
"id": "qmk9t232fr0l3"
}
}
},
"/atlas/v1/panGstLink-async/result/{referenceId}": {
"get": {
"tags": [
"Verification Suite"
],
"summary": "2. Get Pan Gst Link details",
"description": "Retrieve the Pan Gst Link details using the referenceId received while placing the Pan gst Link details request",
"operationId": "rubix_get_kyc_v1_panGstLink",
"_peer-api": "v1/kyc/panGstLink",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/2"
},
{
"schema": {
"type": "string"
},
"in": "path",
"name": "referenceId",
"description": "ReferenceId received in POST call",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
},
"results": {
"type": [
"object",
"null"
],
"properties": {
"pan_number": {
"type": "string"
},
"gst_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"gst_number": {
"type": "string"
},
"status": {
"type": "string"
}
}
}
}
},
"example": {
"message": null,
"results": {
"properties": {
"pan_number": {
"type": "string"
},
"gst_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"gst_number": {
"type": "string"
},
"status": {
"type": "string"
}
}
}
}
}
},
"agency_signature": {
"agency_name": "Rubix Data Sciences Private Limited",
"agency_contact": "+912249744274",
"agency_website": "https://rubixds.com",
"agency_address": "D - 424, Neelkanth Business Park, Vidyavihar (West), Mumbai 400086, India",
"agency_gst": "27AAICR5957Q1ZC",
"agency_email": "info@rubixds.com",
"disclaimer": "https://rubixds.com/rubix-api-service-disclaimer"
}
}
},
"agency_signature": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/agency_signature"
}
}
},
"examples": {
"Example 1": {
"value": {
"message": null,
"results": {
"pan_number": "ABUFS6967K",
"gst_list": [
{
"gst_number": "29ABUFS6967K1ZV",
"status": "Inactive"
},
{
"gst_number": "27ABUFS6967K1ZZ",
"status": "Active"
}
]
},
"agency_signature": {
"agency_name": "Rubix Data Sciences Private Limited",
"agency_contact": "+912249744274",
"agency_website": "https://rubixds.com",
"agency_address": "D - 424, Neelkanth Business Park, Vidyavihar (West), Mumbai 400086, India",
"agency_gst": "27AAICR5957Q1ZC",
"agency_email": "info@rubixds.com",
"disclaimer": "https://rubixds.com/rubix-api-service-disclaimer"
}
}
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": "Invalid referenceId"
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"BearerAuth": []
}
],
"x-stoplight": {
"id": "rzedllwi1vzv0"
}
}
},
"/atlas/v1/passport-async/{fileNumber}": {
"get": {
"tags": [
"Verification Suite"
],
"summary": "1. Place passport data request",
"operationId": "rubix_post_kyc_v1_passport",
"_peer-api": "v1/kyc/passport",
"description": "Place a Passport data request and get reference ID. To get data use the reference ID in /atlas/v1/passport-async/result/{referenceId} endpoint",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/2"
},
{
"schema": {
"type": "string"
},
"in": "path",
"name": "fileNumber",
"required": true,
"description": "File Number of the passport application"
},
{
"schema": {
"type": "string"
},
"in": "query",
"name": "dateOfBirth",
"description": "Date of birth in dd/mm/yyyy format (e.g. 20/01/1994)",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
},
"results": {
"$ref": "#/paths/~1atlas~1v1~1epf-async~1%7BepfNumber%7D/get/responses/200/content/application~1json/schema/properties/results"
},
"agency_signature": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/agency_signature"
}
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
}
},
"required": [
"message"
]
},
"examples": {
"400": {
"value": {
"message": "Missing required request parameters: [fileNumber]"
}
}
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/passport-async/result/{referenceId}": {
"get": {
"tags": [
"Verification Suite"
],
"summary": "2. Get passport data",
"description": "Retrieve the Passport data using the referenceId received while placing the Passport data request",
"operationId": "rubix_get_kyc_v1_passport",
"_peer-api": "v1/kyc/passport",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/2"
},
{
"schema": {
"type": "string"
},
"in": "path",
"name": "referenceId",
"required": true,
"description": "ReferenceId received in POST call"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
},
"results": {
"type": [
"object",
"null"
],
"properties": {
"file_number": {
"type": "string"
},
"passort_number": {
"type": "string"
},
"name": {
"type": "string"
},
"date_of_birth": {
"type": "string"
},
"dispatch_date": {
"type": "string"
}
},
"example": {
"message": null,
"results": {
"file_number": "ABCD02108711",
"passort_number": "A123456",
"name": "RUBIX DATA SCIENCES",
"date_of_birth": "20/01/1994",
"dispatch_date": "16/12/2022"
},
"agency_signature": {
"agency_name": "Rubix Data Sciences Private Limited",
"agency_contact": "+912249744274",
"agency_website": "https://rubixds.com",
"agency_address": "D - 424, Neelkanth Business Park, Vidyavihar (West), Mumbai 400086, India",
"agency_gst": "27AAICR5957Q1ZC",
"agency_email": "info@rubixds.com",
"disclaimer": "https://rubixds.com/rubix-api-service-disclaimer"
}
}
},
"agency_signature": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/agency_signature"
}
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": "Invalid referenceId"
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/udyog-async/{udyogNumber}": {
"get": {
"tags": [
"Verification Suite"
],
"summary": "1. Place Udyog data request",
"operationId": "rubix_post_kyc_v1_udyog",
"_peer-api": "v1/kyc/udyog",
"description": "Place a Udyog data request and get reference ID. To get data use the reference ID in /atlas/v1/udyog-async/result/{referenceId} endpoint",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/2"
},
{
"schema": {
"type": "string"
},
"in": "path",
"name": "udyogNumber",
"description": "Udyog Number",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
},
"results": {
"$ref": "#/paths/~1atlas~1v1~1epf-async~1%7BepfNumber%7D/get/responses/200/content/application~1json/schema/properties/results"
},
"agency_signature": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/agency_signature"
}
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
}
},
"required": [
"message"
]
},
"examples": {
"400": {
"value": {
"message": "Missing required request parameters: [udyogNumber]"
}
}
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/udyog-async/result/{referenceId}": {
"get": {
"tags": [
"Verification Suite"
],
"summary": "2. Get Udyog Data",
"description": "Retrieve the Udyog data using the referenceId received while placing the Udyog data request",
"operationId": "rubix_get_kyc_v1_udyog",
"_peer-api": "v1/kyc/udyog",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/2"
},
{
"schema": {
"type": "string"
},
"in": "path",
"name": "referenceId",
"description": "ReferenceId received in POST call",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
},
"results": {
"type": [
"object",
"null"
],
"properties": {
"uan_number": {
"type": "string"
},
"enterprise_name": {
"type": "string"
},
"type_of_enterprise": {
"type": "string"
},
"major_activity": {
"type": "string"
},
"social_category": {
"type": "string"
},
"udhyog_aadhaar_certificate_validity": {
"type": "string"
},
"date_of_commencement": {
"type": "string"
},
"dic_name": {
"type": "string"
},
"address": {
"type": "string"
},
"state": {
"type": "string"
},
"mobile_number": {
"type": "string"
},
"email": {
"type": "string"
},
"pincode": {
"type": "string"
},
"applied_date": {
"type": "string"
},
"modified_date": {
"type": "string"
},
"nic_details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"nic_2_digit": {
"type": "string"
},
"nic_4_digit": {
"type": "string"
},
"nic_5_digit": {
"type": "string"
},
"nic_activity": {
"type": "string"
},
"date": {
"type": "string"
}
}
}
}
},
"example": {
"message": null,
"results": {
"uan_number": "MH19E0114908",
"enterprise_name": "RUBIX DATA SCIENCES PRIVATE LIMITED",
"type_of_enterprise": "Small",
"major_activity": "Services",
"social_category": "General",
"udhyog_aadhaar_certificate_validity": "30/06/2022",
"date_of_commencement": "30/10/2017",
"dic_name": "Mumbai City",
"address": "D-424,Neelkanth Business Park,Vidyavihar West,Vidyavihar West,MUMBAI",
"state": "MAHARASHTRA",
"mobile_number": "98*****371",
"email": "sa******di@rubixds.com",
"pincode": "400086",
"applied_date": "10/10/2019",
"modified_date": "N/A",
"nic_details": [
{
"nic_2_digit": "63-Information service activities",
"nic_4_digit": "6311-Data processing hosting and related activities",
"nic_5_digit": "63119-Other data processing hosting and related activities n.e.c.",
"nic_activity": "Services",
"date": "10/10/2019"
}
]
},
"agency_signature": {
"agency_name": "Rubix Data Sciences Private Limited",
"agency_contact": "+912249744274",
"agency_website": "https://rubixds.com",
"agency_address": "D - 424, Neelkanth Business Park, Vidyavihar (West), Mumbai 400086, India",
"agency_gst": "27AAICR5957Q1ZC",
"agency_email": "info@rubixds.com",
"disclaimer": "https://rubixds.com/rubix-api-service-disclaimer"
}
}
},
"agency_signature": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/agency_signature"
}
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": "Invalid referenceId"
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/udyam-async/{udyamNumber}": {
"get": {
"tags": [
"Verification Suite"
],
"summary": "1. Place Udyam data request",
"operationId": "rubix_post_kyc_v1_udyam",
"_peer-api": "v1/kyc/udyam",
"description": "Place a Udyam data request and get reference ID. To get data use the reference ID in /atlas/v1/udyam/result/{referenceId} endpoint",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/2"
},
{
"schema": {
"type": "string"
},
"in": "path",
"name": "udyamNumber",
"description": "Udyam Number",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
},
"results": {
"$ref": "#/paths/~1atlas~1v1~1epf-async~1%7BepfNumber%7D/get/responses/200/content/application~1json/schema/properties/results"
},
"agency_signature": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/agency_signature"
}
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
}
},
"required": [
"message"
]
},
"examples": {
"400": {
"value": {
"message": "Missing required request parameters: [udyamNumber]"
}
}
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/udyam-async/result/{referenceId}": {
"get": {
"tags": [
"Verification Suite"
],
"operationId": "rubix_get_kyc_v1_udyam",
"description": "Retrieve the Udyam data using the referenceId received while placing the Udyam data request",
"summary": "2. Get Udyam Data",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/2"
},
{
"schema": {
"type": "string"
},
"in": "path",
"name": "referenceId",
"required": true,
"description": "ReferenceId received in POST call"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
},
"results": {
"type": [
"object",
"null"
],
"properties": {
"udyam_registration_number": {
"type": "string",
"example": "UDYAM-MH-19-0028772",
"required": true
},
"enterprise_name": {
"type": "string",
"example": "M/S RUBIX DATA SCIENCES PRIVATE LIMITED",
"required": true
},
"organisation_type": {
"type": "string",
"example": "Private Limited Company",
"required": true
},
"major_activity": {
"type": "string",
"example": "Services",
"required": true
},
"gender": {
"type": "string",
"example": "Male",
"required": true
},
"social_category": {
"type": "string",
"example": "General",
"required": true
},
"date_of_incorporation": {
"type": "string",
"example": "30/10/2017",
"required": true
},
"date_of_commencement": {
"type": "string",
"example": "30/10/2017",
"required": true
},
"state": {
"type": "string",
"example": "MAHARASHTRA",
"required": true
},
"mobile_number": {
"type": "string",
"example": "98*****371",
"required": true
},
"email": {
"type": "string",
"example": "samirmodi123@gmail.com",
"required": true
},
"dic": {
"type": "string",
"example": "MUMBAI CITY",
"required": true
},
"msme_dfo": {
"type": "string",
"example": "MUMBAI",
"required": true
},
"udyam_registration_date": {
"type": "string",
"example": "23/12/2020",
"required": true
},
"address": {
"type": "string",
"example": "D-424,NEELKANTH BUSINESS PARK,424,NATHANI ROAD,MUMBAI,MUMBAI",
"required": true
},
"pincode": {
"type": "string",
"example": "400086",
"required": true
},
"enterprise_type_details": {
"type": "array",
"required": true,
"items": {
"type": "object",
"properties": {
"classification_year": {
"type": "string",
"example": "2022-23",
"required": true
},
"enterprise_type": {
"type": "string",
"example": "Micro",
"required": true
},
"classification_date": {
"type": "string",
"example": "26/06/2022",
"required": true
}
}
}
},
"plant_details": {
"type": "array",
"required": true,
"items": {
"type": "object",
"properties": {
"unit_name": {
"type": "string",
"example": "RUBIX DATA SCIENCES PRIVATE LIMITED",
"required": true
},
"address": {
"type": "string",
"example": "D-424,NEELKANTH BUSINESS PARK,WEST,VIDYAVIHAR,MUMBAI",
"required": true
},
"pincode": {
"type": "string",
"example": "400086",
"required": true
},
"state": {
"type": "string",
"example": "MAHARASHTRA",
"required": true
}
}
}
},
"nic_details": {
"type": "array",
"required": true,
"items": {
"type": "object",
"required": true,
"properties": {
"nic_2_digit": {
"type": "string",
"example": "63 - Information service activities",
"required": true
},
"nic_4_digit": {
"type": "string",
"example": "6311 - Data processing hosting and related activities",
"required": true
},
"nic_5_digit": {
"type": "string",
"example": "63111 - Data processing activities including report writing",
"required": true
},
"activity": {
"type": "string",
"example": "Services",
"required": true
},
"date": {
"type": "string",
"example": "23/12/2020",
"required": true
}
}
}
}
}
},
"agency_signature": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/agency_signature"
}
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": "Invalid referenceId"
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/epf-async/{epfNumber}": {
"get": {
"tags": [
"Verification Suite"
],
"summary": "1. Place a EPF Data request",
"operationId": "rubix_post_kyc_v1_epf",
"_peer-api": "v1/kyc/epf",
"description": "Place the request for fetching EPF data on the basis of EPF Number and get reference ID. To get data use the reference ID in /atlas/v1/epf-async/result/{referenceId} endpoint",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/2"
},
{
"schema": {
"type": "string"
},
"in": "path",
"name": "epfNumber",
"description": "EPF Number of the company",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
},
"results": {
"type": "object",
"properties": {
"reference_id": {
"type": "string",
"example": "1dda38aa-6fb2-42ea-a60b-4ba6efd19bc1"
}
}
},
"agency_signature": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/agency_signature"
}
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
}
},
"required": [
"message"
]
},
"examples": {
"400": {
"value": {
"message": "Missing required request parameters: [epfnumber]"
}
}
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"BearerAuth": []
}
],
"x-stoplight": {
"id": "vds0diiqjkhsa"
}
}
},
"/atlas/v1/epf-async/result/{referenceId}": {
"get": {
"tags": [
"Verification Suite"
],
"summary": "2. Get EPF Data",
"operationId": "rubix_get_kyc_v1_epf",
"_peer-api": "v1/kyc/epf",
"description": "Retrieve the EPF data using the referenceId received while placing the EPF data request",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/2"
},
{
"schema": {
"type": "string"
},
"in": "path",
"name": "referenceId",
"description": "ReferenceId received in POST call",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
},
"results": {
"type": [
"object",
"null"
],
"properties": {
"estblishment_details": {
"type": "object",
"properties": {
"establishment_code": {
"type": "string"
},
"establishment_name": {
"type": "string"
},
"establishment_status": {
"type": "string"
},
"registration_status": {
"type": "string"
},
"post_coverage_status": {
"type": "string"
},
"exemption_status": {
"type": "string"
},
"working_status": {
"type": "string"
},
"coverage_section": {
"type": "string"
},
"actionable_status": {
"type": "string"
},
"date_of_coverage": {
"type": "string"
},
"pan_status": {
"type": "string"
},
"section_applicable": {
"type": "string"
},
"esic_code": {
"type": "string"
},
"ownership_type": {
"type": "string"
},
"address": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"epfo_office_name": {
"type": "string"
},
"zone": {
"type": "string"
},
"primary_business_activity": {
"type": "string"
},
"date_of_setup_of_establishment": {
"type": "string"
},
"pin_code": {
"type": "string"
},
"district": {
"type": "string"
},
"country": {
"type": "string"
},
"epfo_office_address": {
"type": "string"
},
"region": {
"type": "string"
},
"payment_details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"establishment_code": {
"type": "string"
},
"trrn": {
"type": "string"
},
"date_of_credit": {
"type": "string"
},
"amount": {
"type": "string"
},
"wage_month": {
"type": "string"
},
"no_of_employee": {
"type": "string"
},
"ecr": {
"type": "string"
},
"total_delay": {
"type": "string"
}
}
}
}
}
},
"pf_compliance": {
"type": "object",
"properties": {
"pf_average_delay": {
"type": "string"
},
"pf_total_pf_returns": {
"type": "string"
},
"pf_on_time_returns": {
"type": "string"
},
"pf_delayed_returns": {
"type": "string"
},
"current_pf_average": {
"type": "string"
}
}
}
},
"example": {
"message": null,
"results": {
"estblishment_details": {
"establishment_code": "UPLKO2515592000",
"establishment_name": "TRISHUL INDUSTRIAL MARKETING",
"establishment_status": "CODE NO ALLOTTED WAS AFTER ONLINE REGISTRATION STARTED.",
"registration_status": "PERMANENT LOGIN CREATED BY OWNER ON ECR PORTAL",
"post_coverage_status": "--",
"exemption_status": "PF: UNEXEMPTED, PENSION: UNEXEMPTED, EDLI: UNEXEMPTED",
"working_status": "LIVE ESTABLISHMENT",
"coverage_section": "0001(3)(b)",
"actionable_status": "ACTIONABLE ESTABLISHMENT",
"date_of_coverage": "05-OCT-2021",
"pan_status": "VERIFIED",
"section_applicable": "OTHER ESTABLISHMENTS IN WHICH EMPLOYING 20 OR MORE PERSONS AND NOTIFIED BY THE CENTRAL GOVT.",
"esic_code": "",
"ownership_type": "Partnership Firm",
"address": "B 1-35 Palm Ville, Sector B Pocket1 Sushant Golf City",
"city": "Lucknow",
"state": "UTTAR PRADESH",
"epfo_office_name": "LUCKNOW",
"zone": "UTTAR PRADESH AND BIHAR",
"primary_business_activity": "AUTOMIBILE SERVICING",
"date_of_setup_of_establishment": "08-JAN-2021",
"pin_code": "226030",
"district": "LUCKNOW",
"country": "India",
"epfo_office_address": "Bhavishya Nidhi Bhawan, Vibhuti Khand, Gomti Nagar,",
"region": "UP - KANPUR",
"payment_details": [
{
"establishment_code": "UPLKO2515592000",
"trrn": "4342201002582",
"date_of_credit": "17-JAN-2022 12:34:39",
"amount": "14149",
"wage_month": "NOV-21",
"no_of_employee": "5",
"ecr": "YES"
},
{
"establishment_code": "UPLKO2515592000",
"trrn": "4342201002589",
"date_of_credit": "17-JAN-2022 17:13:29",
"amount": "14263",
"wage_month": "DEC-21",
"no_of_employee": "5",
"ecr": "YES"
},
{
"establishment_code": "UPLKO2515592000",
"trrn": "4342202003504",
"date_of_credit": "16-FEB-2022 15:18:03",
"amount": "13889",
"wage_month": "JAN-22",
"no_of_employee": "5",
"ecr": "YES"
},
{
"establishment_code": "UPLKO2515592000",
"trrn": "4342203004913",
"date_of_credit": "15-MAR-2022 12:46:35",
"amount": "13212",
"wage_month": "FEB-22",
"no_of_employee": "5",
"ecr": "YES"
},
{
"establishment_code": "UPLKO2515592000",
"trrn": "4342204006274",
"date_of_credit": "22-APR-2022 12:01:12",
"amount": "13612",
"wage_month": "MAR-22",
"no_of_employee": "5",
"ecr": "YES"
},
{
"establishment_code": "UPLKO2515592000",
"trrn": "4342205005316",
"date_of_credit": "17-MAY-2022 14:57:39",
"amount": "13871",
"wage_month": "APR-22",
"no_of_employee": "5",
"ecr": "YES"
},
{
"establishment_code": "UPLKO2515592000",
"trrn": "4342206006029",
"date_of_credit": "15-JUN-2022 14:07:58",
"amount": "16798",
"wage_month": "MAY-22",
"no_of_employee": "6",
"ecr": "YES"
},
{
"establishment_code": "UPLKO2515592000",
"trrn": "4342207006723",
"date_of_credit": "15-JUL-2022 16:16:10",
"amount": "18459",
"wage_month": "JUN-22",
"no_of_employee": "6",
"ecr": "YES"
},
{
"establishment_code": "UPLKO2515592000",
"trrn": "4342208006316",
"date_of_credit": "16-AUG-2022 09:21:09",
"amount": "18602",
"wage_month": "JUL-22",
"no_of_employee": "6",
"ecr": "YES",
"total_delay": "1"
},
{
"establishment_code": "UPLKO2515592000",
"trrn": "4342209004467",
"date_of_credit": "12-SEP-2022 13:23:50",
"amount": "17826",
"wage_month": "AUG-22",
"no_of_employee": "6",
"ecr": "YES",
"total_delay": "0"
},
{
"establishment_code": "UPLKO2515592000",
"trrn": "4342210008467",
"date_of_credit": "01-NOV-2022 16:11:57",
"amount": "18684",
"wage_month": "SEP-22",
"no_of_employee": "6",
"ecr": "YES",
"total_delay": "17"
},
{
"establishment_code": "UPLKO2515592000",
"trrn": "4342211005051",
"date_of_credit": "16-NOV-2022 17:46:29",
"amount": "18800",
"wage_month": "OCT-22",
"no_of_employee": "6",
"ecr": "YES",
"total_delay": "1"
},
{
"establishment_code": "UPLKO2515592000",
"trrn": "4342212006510",
"date_of_credit": "15-DEC-2022 15:02:40",
"amount": "18402",
"wage_month": "NOV-22",
"no_of_employee": "6",
"ecr": "YES",
"total_delay": "0"
},
{
"establishment_code": "UPLKO2515592000",
"trrn": "4342301006645",
"date_of_credit": "15-JAN-2023 19:01:28",
"amount": "16848",
"wage_month": "DEC-22",
"no_of_employee": "6",
"ecr": "YES",
"total_delay": "0"
},
{
"establishment_code": "UPLKO2515592000",
"trrn": "4342302005783",
"date_of_credit": "14-FEB-2023 12:45:09",
"amount": "18424",
"wage_month": "JAN-23",
"no_of_employee": "6",
"ecr": "YES",
"total_delay": "0"
},
{
"establishment_code": "UPLKO2515592000",
"trrn": "4342303006261",
"date_of_credit": "16-MAR-2023 12:25:08",
"amount": "15246",
"wage_month": "FEB-23",
"no_of_employee": "6",
"ecr": "YES",
"total_delay": "1"
},
{
"establishment_code": "UPLKO2515592000",
"trrn": "4342304006573",
"date_of_credit": "15-APR-2023 20:04:30",
"amount": "15020",
"wage_month": "MAR-23",
"no_of_employee": "5",
"ecr": "YES",
"total_delay": "0"
},
{
"establishment_code": "UPLKO2515592000",
"trrn": "4342305007046",
"date_of_credit": "17-MAY-2023 09:16:35",
"amount": "15625",
"wage_month": "APR-23",
"no_of_employee": "5",
"ecr": "YES",
"total_delay": "2"
},
{
"establishment_code": "UPLKO2515592000",
"trrn": "4342306005504",
"date_of_credit": "15-JUN-2023 20:29:22",
"amount": "15788",
"wage_month": "MAY-23",
"no_of_employee": "5",
"ecr": "YES",
"total_delay": "0"
}
]
},
"pf_compliance": {
"pf_average_delay": "2.0",
"pf_total_pf_returns": "12",
"pf_on_time_returns": "6",
"pf_delayed_returns": "6",
"current_pf_average": "3.0"
}
},
"agency_signature": {
"agency_name": "Rubix Data Sciences Private Limited",
"agency_contact": "+912249744274",
"agency_website": "https://rubixds.com",
"agency_address": "D - 424, Neelkanth Business Park, Vidyavihar (West), Mumbai 400086, India",
"agency_gst": "27AAICR5957Q1ZC",
"agency_email": "info@rubixds.com",
"disclaimer": "https://rubixds.com/rubix-api-service-disclaimer"
}
}
},
"agency_signature": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/agency_signature"
}
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": "Invalid referenceId"
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"BearerAuth": []
}
],
"x-stoplight": {
"id": "tkj27r54503bi"
}
}
},
"/atlas/v1/counterparty/search/{pageNo}/{pageSize}": {
"get": {
"tags": [
"Verification Suite"
],
"summary": "Search for counterparty",
"description": "Search for domestic (Indian) counterparty on the basis of Name, PAN, CIN, GST or LEI.\nNote:- Only one of Name, PAN, CIN, GST or LEI is required in the query parameter",
"operationId": "rubix_post_kyc_v1_indian_search",
"_peer-api": "v1/kyc/indian/search",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/2"
},
{
"schema": {
"type": "string"
},
"in": "path",
"name": "pageNo",
"description": "Page Number",
"required": true
},
{
"schema": {
"type": "string"
},
"in": "path",
"name": "pageSize",
"description": "Page Size",
"required": true
},
{
"schema": {
"type": "string"
},
"in": "query",
"name": "gst",
"description": "GST of the counterparty"
},
{
"schema": {
"type": "string"
},
"in": "query",
"name": "lei",
"description": "LEI of counterparty"
},
{
"schema": {
"type": "string"
},
"in": "query",
"name": "pan",
"description": "PAN of the counterparty"
},
{
"schema": {
"type": "string"
},
"in": "query",
"name": "counterpartyName",
"description": "Name of domestic counterparty"
},
{
"schema": {
"type": "string"
},
"in": "query",
"name": "cin",
"description": "CIN of the counterparty"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
},
"results": {
"type": [
"object",
"null"
],
"properties": {
"paging": {
"type": "object",
"properties": {
"pageNo": {
"type": "integer"
},
"totalPages": {
"type": "integer"
},
"pageSize": {
"type": "integer"
}
}
},
"counterparties": {
"type": "array",
"items": {
"type": "object",
"properties": {
"counterparty_id": {
"type": "string"
},
"counterparty_name": {
"type": "string"
},
"counterparty_address": {
"type": "string"
},
"counterparty_website": {
"type": "null"
},
"counterparty_email": {
"type": "null"
},
"counterparty_city": {
"type": "string"
},
"counterparty_state": {
"type": "string"
},
"counterparty_pan_number": {
"type": "string"
},
"counterparty_cin_number": {
"type": [
"null",
"string"
]
},
"counterparty_gst_number": {
"type": "string"
},
"counterparty_lei_number": {
"type": "null"
},
"counterparty_status": {
"type": [
"null",
"string"
]
},
"last_report_updated_date": {
"type": [
"null",
"string"
]
}
}
}
}
},
"example": {
"message": null,
"results": {
"paging": {
"pageNo": 1,
"totalPages": 3,
"pageSize": 10
},
"counterparties": [
{
"counterparty_id": "5f376ae130456b1516de8939",
"counterparty_name": "RUBIX DATA SCIENCES PRIVATE LIMITED",
"counterparty_address": "D-424, Neelkanth Business Park, Vidyavihar (West), NA Mumbai Mumbai City MH 400086 IN",
"counterparty_website": null,
"counterparty_email": null,
"counterparty_city": "Mumbai",
"counterparty_state": "Maharashtra",
"counterparty_pan_number": "AAICR5957Q",
"counterparty_cin_number": "U74999MH2017PTC301282",
"counterparty_gst_number": "27AAICR5957Q1ZC",
"counterparty_lei_number": null,
"counterparty_status": "Active",
"last_report_updated_date": "13-May-2023"
},
{
"counterparty_id": "656590df98dcc71c451da360",
"counterparty_name": "RUBIX TECHNOLOGIES",
"counterparty_address": "2ND AND 3RD FLOOR, D33/1, Thillai Nagar 7th Cross Street, Thillai Nagar, TRICHY, Tiruchirappalli, Tamil Nadu, 620018",
"counterparty_website": null,
"counterparty_email": null,
"counterparty_city": "Tiruchirappalli",
"counterparty_state": "Tamil Nadu",
"counterparty_pan_number": "ABBFR1551K",
"counterparty_cin_number": null,
"counterparty_gst_number": "33ABBFR1551K1ZC",
"counterparty_lei_number": null,
"counterparty_status": null,
"last_report_updated_date": null
}
]
},
"agency_signature": {
"agency_name": "Rubix Data Sciences Private Limited",
"agency_contact": "+912249744274",
"agency_website": "https://rubixds.com",
"agency_address": "D - 424, Neelkanth Business Park, Vidyavihar (West), Mumbai 400086, India",
"agency_gst": "27AAICR5957Q1ZC",
"agency_email": "info@rubixds.com",
"disclaimer": "https://rubixds.com/rubix-api-service-disclaimer"
}
}
},
"agency_signature": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/agency_signature"
}
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
}
},
"required": [
"message"
]
},
"examples": {
"400": {
"value": {
"message": "Missing required request parameters"
}
}
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/bpr/report/{counterpartyId}": {
"get": {
"tags": [
"Verification Suite"
],
"summary": "Get instant report",
"description": "This endpoint will return the Business Profile Report (BPR) in JSON format of a domestic counterparty using counterpartyId",
"operationId": "rubix_post_kyc_v1_indian_instantReport",
"_peer-api": "v1/kyc/indian/instantReport",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/2"
},
{
"schema": {
"type": "string"
},
"in": "path",
"name": "counterpartyId",
"description": "Counterparty Id",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
},
"results": {
"type": [
"object",
"null"
],
"properties": {
"contingent_liabilities": {
"type": "array",
"items": {
"type": "object",
"properties": {
"guarantee_contingent_liabilities": {
"type": "string"
},
"uncalled_liability_on_shares_and_other_investments_partly_paid_contingent_liabilities": {
"type": "string"
},
"other_money_for_which_company_is_contingently_liable_contingent_liabilities": {
"type": "string"
},
"year": {
"type": "string"
},
"claims_against_company_not_acknowledged_as_debt_contingent_liabilities": {
"type": "string"
},
"other_commitments_contingent_liabilities": {
"type": "string"
},
"estimate_of_financial_effect_of_contingent_liabilities": {
"type": "string"
},
"estimated_amount_of_contracts_remaining_to_be_executed_on_capital_account_and_not_provided_for_contingent_liabilities": {
"type": "string"
},
"total_contingent_liabilities": {
"type": "string"
},
"total_commitments": {
"type": "string"
}
}
}
},
"leverage_ratio": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sales_to_net_fixed_assets": {
"type": "string"
},
"total_outside_liabilities_to_total_net_worth": {
"type": "string"
},
"interest_coverage_ratio": {
"type": "string"
},
"current_liabilities_to_net_worth": {
"type": "string"
},
"year": {
"type": "string"
},
"debt_equity_ratio": {
"type": "string"
},
"fixed_asset_to_net_worth": {
"type": "string"
},
"debt_by_ebitda": {
"type": "string"
}
}
}
},
"external_credit_ratings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"short_term_credit_rating_action": {
"type": "string"
},
"rating_agency_name": {
"type": "string"
},
"long_term_credit_rating_action": {
"type": "string"
},
"short_term_credit_rating": {
"type": "string"
},
"date_of_credit_rating": {
"type": "string"
},
"amount_of_credit_rating_in_inr_crores": {
"type": "string"
},
"long_term_credit_rating_outlook": {
"type": "string"
},
"link_of_press_release": {
"type": "string"
},
"long_term_credit_rating": {
"type": "string"
}
}
}
},
"statutory_and_credit_compliance": {
"type": "object",
"properties": {
"gst_average_delay_days": {
"type": "string"
},
"pf_average_delay_days": {
"type": "string"
},
"pf_company_filing_details": {
"type": "string"
},
"gst_current_average_delay_days": {
"type": "string"
},
"total_active_gst_numbers": {
"type": "string"
},
"total_inactive_gst_numbers": {
"type": "string"
},
"total_active_pf_numbers": {
"type": "string"
},
"pf_current_average_delay_days": {
"type": "string"
},
"gst_company_filing_details": {
"type": "string"
},
"mca_company_filing_details": {
"type": "string"
},
"total_inactive_pf_numbers": {
"type": "string"
}
}
},
"balance_sheet": {
"type": "array",
"items": {
"type": "object",
"properties": {
"share_premium": {
"type": "string"
},
"loans_from_directors_shareholders_others": {
"type": "string"
},
"net_fixed_assets": {
"type": "string"
},
"year": {
"type": "string"
},
"non_current_inter_company_loans": {
"type": "string"
},
"current_assets": {
"type": "string"
},
"equity": {
"type": "string"
},
"current_inter_company_loans": {
"type": "string"
},
"non_current_assets": {
"type": "string"
},
"intangible_assets": {
"type": "string"
},
"accounts_receivables": {
"type": "string"
},
"assets": {
"type": "string"
},
"inventories": {
"type": "string"
},
"share_capital": {
"type": "string"
},
"gross_fixed_assets": {
"type": "string"
},
"other_current_assets": {
"type": "string"
},
"liabilities": {
"type": "string"
},
"other_non_current_assets": {
"type": "string"
},
"non_current_loans_advances": {
"type": "string"
},
"current_liabilities": {
"type": "string"
},
"current_investments": {
"type": "string"
},
"cash_and_cash_equivalents": {
"type": "string"
},
"long_term_loans": {
"type": "string"
},
"Less: Depreciation": {
"type": "string"
},
"total_reserves": {
"type": "string"
},
"non_current_liabilities": {
"type": "string"
},
"retained_earnings_loss": {
"type": "string"
},
"deferred_tax_liabilities_net": {
"type": "string"
},
"other_current_liabilties": {
"type": "string"
},
"deferred_tax_assets_net": {
"type": "string"
},
"income_tax_liabilities_net": {
"type": "string"
},
"provisions": {
"type": "string"
},
"short_term_loans": {
"type": "string"
},
"current_Loans_advances": {
"type": "string"
},
"current_portion_of_long_term_debt": {
"type": "string"
},
"non_current_investments": {
"type": "string"
},
"accounts_payable": {
"type": "string"
},
"other_non_current_liabilties": {
"type": "string"
}
}
}
},
"quaterly_results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"element_name_quarterly_result": {
"type": "string"
},
"quarter_2_quarterly_results": {
"type": "string"
},
"quarter_1_quarterly_results": {
"type": "string"
},
"quarter_3_quarterly_results": {
"type": "string"
}
}
}
},
"related_party_transactions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name_of_related_party_in_transaction": {
"type": "string"
},
"year_related_party_transactions": {
"type": "string"
},
"transaction_amount": {
"type": "string"
},
"relationship_related_party_in_transaction": {
"type": "string"
},
"nature_of_transaction_with_related_party": {
"type": "string"
}
}
}
},
"segment_reporting": {
"type": "array",
"items": {
"type": "object",
"properties": {
"segment_revenue": {
"type": "string"
},
"segment_name": {
"type": "string"
},
"year_segment_reporting": {
"type": "string"
}
}
}
},
"media": {
"type": "object",
"properties": {
"employee_sentiment_score": {
"type": "string"
},
"number_of_customer_reviews": {
"type": "string"
},
"customer_sentiment_score": {
"type": "string"
},
"number_of_employee_reviews": {
"type": "string"
}
}
},
"balance_sheet_in_lacs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"": {
"type": "string"
},
"intangibles_lacs": {
"type": "string"
},
"year": {
"type": "string"
},
"total_liabilities_lacs": {
"type": "string"
},
"non_current_liabilities_lacs": {
"type": "string"
},
"current_liabilities_lacs": {
"type": "string"
},
"current_assets_lacs": {
"type": "string"
},
"other_assets_lacs": {
"type": "string"
},
"sources_of_funds_lacs": {
"type": "string"
},
"fixed_assets_lacs": {
"type": "string"
},
"application_of_funds_lacs": {
"type": "string"
},
"investments_lacs": {
"type": "string"
},
"total_assets_lacs": {
"type": "string"
},
"total_shareholders_funds_lacs": {
"type": "string"
}
}
}
},
"benchmark_ratios": {
"type": "array",
"items": {
"type": "object",
"properties": {
"interest_coverage_ratio": {
"type": "string"
},
"net_working_capital_cycle_days": {
"type": "string"
},
"accounts_payable_days": {
"type": "string"
},
"inventory_days": {
"type": "string"
},
"year": {
"type": "string"
},
"debt_equity_ratio": {
"type": "string"
},
"ebitda_percentage": {
"type": "string"
},
"current_ratio": {
"type": "string"
},
"accounts_receivable_days": {
"type": "string"
},
"gross_margin_percentage": {
"type": "string"
},
"pat_percentage": {
"type": "string"
}
}
}
},
"history_of_names": {
"type": "array",
"items": {
"type": "object",
"properties": {
"company_old_name": {
"type": "string"
},
"date_of_name_change": {
"type": "string"
},
"purpose_of_name_change": {
"type": "string"
},
"company_new_name": {
"type": "string"
}
}
}
},
"report_metadata": {
"type": "object",
"properties": {
"company_type": {
"type": "string"
},
"report_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"report_status": {
"type": "string"
},
"report_date": {
"type": "string"
},
"report_pdf_file": {
"type": "string"
}
}
},
"balance_sheet_in_crores": {
"type": "array",
"items": {
"type": "object",
"properties": {
"application_of_funds_crores": {
"type": "string"
},
"fixed_assets_crores": {
"type": "string"
},
"year": {
"type": "string"
},
"non_current_liabilities_crores": {
"type": "string"
},
"sources_of_funds_crores": {
"type": "string"
},
"total_shareholders_funds_crores": {
"type": "string"
},
"investments_crores": {
"type": "string"
},
"intangibles_crores": {
"type": "string"
},
"current_liabilities_crores": {
"type": "string"
},
"total_liabilities_crores": {
"type": "string"
},
"other_assets_crores": {
"type": "string"
},
"current_assets_crores": {
"type": "string"
},
"total_assets_crores": {
"type": "string"
}
}
}
},
"efficiency_ratios": {
"type": "array",
"items": {
"type": "object",
"properties": {
"net_working_capital_cycle_days": {
"type": "string"
},
"accounts_receivable_turnover": {
"type": "string"
},
"inventory_days": {
"type": "string"
},
"accounts_payable_days": {
"type": "string"
},
"asset_turnover": {
"type": "string"
},
"year": {
"type": "string"
},
"inventory_turnover": {
"type": "string"
},
"accounts_receivable_days": {
"type": "string"
}
}
}
},
"profit_loss_account_in_lacs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"direct_expenditure_lacs": {
"type": "string"
},
"other_expenses_lacs": {
"type": "string"
},
"other_income_lacs": {
"type": "string"
},
"": {
"type": "string"
},
"other_operating_income_lacs": {
"type": "string"
},
"extraordinary_items_lacs": {
"type": "string"
},
"year": {
"type": "string"
},
"tax_provision_lacs": {
"type": "string"
},
"profit_before_tax_and_extraordinary_items_lacs": {
"type": "string"
},
"gross_margin_lacs": {
"type": "string"
},
"ebitda_lacs": {
"type": "string"
},
"sales_general_and_administrative_lacs": {
"type": "string"
},
"profit_after_tax_extraordinary_items_lacs": {
"type": "string"
},
"interest_lacs": {
"type": "string"
},
"depreciation_lacs": {
"type": "string"
},
"revenue_lacs": {
"type": "string"
},
"ebit_lacs": {
"type": "string"
}
}
}
},
"additional_funding": {
"type": "array",
"items": {
"type": "object",
"properties": {
"additional_funding_date": {
"type": "string"
},
"additional_funding_type_of_shares": {
"type": "string"
},
"additional_funding_number_of_shares": {
"type": "string"
},
"additional_funding_face_value": {
"type": "string"
},
"additional_funding_premium": {
"type": "string"
},
"additional_funding_total_amount": {
"type": "string"
},
"additional_funding_attachment": {
"type": "string"
}
}
}
},
"news": {
"type": "array",
"items": {
"type": "object",
"properties": {
"news_date": {
"type": "string"
},
"news_link": {
"type": "string"
},
"news_summary": {
"type": "string"
},
"news_sentiment": {
"type": "string"
}
}
}
},
"cash_flow": {
"type": "array",
"items": {
"type": "object",
"properties": {
"adjustments_for_working_capital": {
"type": "string"
},
"net_cash_flows_from_used_in_operating_activities": {
"type": "string"
},
"year": {
"type": "string"
},
"other_proceeds_classified_as_financing_activity": {
"type": "string"
},
"cash_flows_from_used_in_operating_activities": {
"type": "string"
},
"net_cash_flows_from_used_in_investing_activities": {
"type": "string"
},
"interest_paid": {
"type": "string"
},
"other_adjustments_for_which_cash_effects": {
"type": "string"
},
"cash_flows_from_used_in_financing_activities": {
"type": "string"
},
"cash_flows_from_used_in_investing_activities": {
"type": "string"
},
"net_cash_flows_from_used_in_operations": {
"type": "string"
},
"adjustments_for_finance_costs": {
"type": "string"
},
"net_cash_flows_from_used_in_financing_activities": {
"type": "string"
},
"other_payment_classified_as_financing_activity": {
"type": "string"
},
"other_proceeds_classified_as_investing_activity": {
"type": "string"
},
"net_increase_decrease_in_cash_and_cash_equivalents": {
"type": "string"
},
"other_inflows_outflows_of_cash_movement_in_deposits_effect_of_changes_in_exchange_rates": {
"type": "string"
},
"proceeds_from_borrowings": {
"type": "string"
},
"total_adjustments_to_profit_loss": {
"type": "string"
},
"other_adjustments_for_non_cash_items": {
"type": "string"
},
"other_payment_classified_as_investing_activity": {
"type": "string"
},
"purchase_of_tangible_assets": {
"type": "string"
},
"adjustments_for_depreciation_and_amortisation_expense": {
"type": "string"
},
"other_inflows_outflows_of_cash": {
"type": "string"
},
"proceeds_from_sales_of_tangible_assets": {
"type": "string"
},
"repayments_of_borrowings": {
"type": "string"
},
"profit_before_extraordinary_items_and_tax": {
"type": "string"
},
"interest_received": {
"type": "string"
}
}
}
},
"business_facts": {
"type": "object",
"properties": {
"class_of_company": {
"type": "string"
},
"nic_code_description": {
"type": "string"
},
"company_website": {
"type": "string"
},
"company_email": {
"type": "string"
},
"company_contact_details": {
"type": "string"
},
"nic_code": {
"type": "string"
},
"company_address": {
"type": "string"
},
"company_other_comment": {
"type": "string"
},
"paid_up_capital": {
"type": "string"
},
"date_of_balance_sheet": {
"type": "string"
},
"date_of_incorporation": {
"type": "string"
},
"authorized_capital": {
"type": "string"
},
"company_name": {
"type": "string"
},
"listing_status": {
"type": "string"
},
"company_activity": {
"type": "string"
},
"company_status": {
"type": "string"
},
"date_of_last_annual_general_meeting": {
"type": "string"
},
"age_of_company": {
"type": "string"
},
"country_currency": {
"type": "string"
}
}
},
"credit_limit_recommendation": {
"type": "object",
"properties": {
"rubix_credit_limit_rationale": {
"type": "string"
},
"rubix_credit_limit_recommendation": {
"type": "string"
},
"rubix_credit_days_recommendation": {
"type": "string"
}
}
},
"auditor_details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"membership_number_of_auditor": {
"type": "string"
},
"name_of_audit_firm": {
"type": "string"
},
"category_of_auditor": {
"type": "string"
},
"date_of_signing_audit_report_by_auditor": {
"type": "string"
},
"whether_auditor_qualified_report": {
"type": "string"
},
"email_of_auditor": {
"type": "string"
},
"permanent_account_number_of_auditor": {
"type": "string"
},
"date_of_appointment_to_of_auditor": {
"type": "string"
},
"caro_applicable": {
"type": "string"
},
"year_auditor_details": {
"type": "string"
},
"firms_registration_number_of_audit_firm": {
"type": "string"
},
"date_of_signing_of_balance_sheet_by_auditor": {
"type": "string"
},
"name_of_auditor_signing_report": {
"type": "string"
},
"address_of_auditor": {
"type": "string"
},
"date_of_appointment_from_of_auditor": {
"type": "string"
}
}
}
},
"profit_loss_account_in_crores": {
"type": "array",
"items": {
"type": "object",
"properties": {
"profit_after_tax_extraordinary_items_crores": {
"type": "string"
},
"direct_expenditure_crores": {
"type": "string"
},
"extraordinary_items_crores": {
"type": "string"
},
"year": {
"type": "string"
},
"interest_crores": {
"type": "string"
},
"gross_margin_crores": {
"type": "string"
},
"sales_general_and_administrative_crores": {
"type": "string"
},
"ebitda_crores": {
"type": "string"
},
"revenue_crores": {
"type": "string"
},
"other_income_crores": {
"type": "string"
},
"ebit_crores": {
"type": "string"
},
"profit_before_tax_and_extraordinary_items_crores": {
"type": "string"
},
"tax_provision_crores": {
"type": "string"
},
"other_operating_income_crores": {
"type": "string"
},
"other_expenses_crores": {
"type": "string"
},
"depreciation_crores": {
"type": "string"
}
}
}
},
"subsdiary_information": {
"type": "array",
"items": {
"type": "object",
"properties": {
"profit_before_tax_of_subsidiary": {
"type": "string"
},
"subsidiary_cin": {
"type": "string"
},
"subsidiary_country": {
"type": "string"
},
"total_assets_of_subsidiary": {
"type": "string"
},
"turnover_of_subsidiary": {
"type": "string"
},
"percentage_shareholding": {
"type": "string"
},
"year_subsidiary_info": {
"type": "string"
},
"total_liabilities_of_subsidiary": {
"type": "string"
},
"subsidiary_name": {
"type": "string"
}
}
}
},
"index_of_charges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"charge_holder_name": {
"type": "string"
},
"charge_serial_no": {
"type": "string"
},
"charge_id": {
"type": "string"
},
"charge_date_of_modification": {
"type": "string"
},
"charge_date_of_creation": {
"type": "string"
},
"charge_srn": {
"type": "string"
},
"charge_amount": {
"type": "string"
}
}
}
},
"rubix_scorecard": {
"type": "object",
"properties": {
"computed_risk_grade": {
"type": "string"
},
"grade_description": {
"type": "string"
},
"computed_risk_level": {
"type": "string"
},
"rubix_risk_score": {
"type": "integer"
}
}
},
"revenue_from_operation": {
"type": "array",
"items": {
"type": "object",
"properties": {
"export_revenue_services": {
"type": "string"
},
"total_domestic_revenue": {
"type": "string"
},
"export_sale_traded_goods": {
"type": "string"
},
"year": {
"type": "string"
},
"total_revenue": {
"type": "string"
},
"domestic_sale_traded_goods": {
"type": "string"
},
"total_export_revenue": {
"type": "string"
},
"export_sale_manufactured_goods": {
"type": "string"
},
"domestic_sale_of_manufactured_goods": {
"type": "string"
},
"domestic_revenue_services": {
"type": "string"
},
"total_revenue_from_services": {
"type": "string"
}
}
}
},
"company_id_check": {
"type": "object",
"properties": {
"pf_company_name": {
"type": "string"
},
"class_of_company": {
"type": "string"
},
"gst_numbers": {
"type": "string"
},
"pf_company_date_of_coverage": {
"type": "string"
},
"mca_company_cin_number": {
"type": "string"
},
"mca_company_address": {
"type": "string"
},
"mca_company_active_compliant_status": {
"type": "string"
},
"pf_company_status": {
"type": "string"
},
"pf_numbers": {
"type": "string"
},
"pf_company_address": {
"type": "string"
},
"total_active_gst_numbers": {
"type": "string"
},
"gst_company_address": {
"type": "string"
},
"gst_company_status": {
"type": "string"
},
"company_status": {
"type": "string"
},
"mca_company_name": {
"type": "string"
},
"mca_company_date_of_incorporation": {
"type": "string"
},
"gst_company_date_of_registration": {
"type": "string"
},
"company_pan_number": {
"type": "string"
},
"gst_company_name": {
"type": "string"
}
}
},
"legal_check": {
"type": "object",
"properties": {
"fir_petitioner": {
"type": "string"
},
"supreme_court_pending": {
"type": "string"
},
"consumer_court_disposed": {
"type": "string"
},
"defaulters_petitioner": {
"type": "string"
},
"ibc_pending": {
"type": "string"
},
"e_court_petitioner": {
"type": "string"
},
"arrested_respondent": {
"type": "string"
},
"defaulters_disposed": {
"type": "string"
},
"absconders_petitioner": {
"type": "string"
},
"most_wanted_respondent": {
"type": "string"
},
"high_court_total": {
"type": "string"
},
"arrested_disposed": {
"type": "string"
},
"mca_disposed": {
"type": "string"
},
"high_court_petitioner": {
"type": "string"
},
"arrested_total": {
"type": "string"
},
"consumer_court_pending": {
"type": "string"
},
"consumer_court_petitioner": {
"type": "string"
},
"e_court_pending": {
"type": "string"
},
"tribunals_disposed": {
"type": "string"
},
"tribunals_respondent": {
"type": "string"
},
"most_wanted_pending": {
"type": "string"
},
"defaulters_respondent": {
"type": "string"
},
"defaulters_pending": {
"type": "string"
},
"ibc_total": {
"type": "string"
},
"e_court_disposed": {
"type": "string"
},
"consumer_court_respondent": {
"type": "string"
},
"supreme_court_disposed": {
"type": "string"
},
"fir_respondent": {
"type": "string"
},
"mca_total": {
"type": "string"
},
"absconders_pending": {
"type": "string"
},
"supreme_court_respondent": {
"type": "string"
},
"ibc_respondent": {
"type": "string"
},
"high_court_disposed": {
"type": "string"
},
"fir_total": {
"type": "string"
},
"e_court_total": {
"type": "string"
},
"arrested_pending": {
"type": "string"
},
"mca_petitioner": {
"type": "string"
},
"ibc_petitioner": {
"type": "string"
},
"tribunals_petitioner": {
"type": "string"
},
"high_court_pending": {
"type": "string"
},
"supreme_court_petitioner": {
"type": "string"
},
"tribunals_pending": {
"type": "string"
},
"high_court_respondent": {
"type": "string"
},
"supreme_court_total": {
"type": "string"
},
"defaulters_total": {
"type": "string"
},
"absconders_total": {
"type": "string"
},
"arrested_petitioner": {
"type": "string"
},
"consumer_court_total": {
"type": "string"
},
"absconders_respondent": {
"type": "string"
},
"tribunals_total": {
"type": "string"
},
"mca_respondent": {
"type": "string"
},
"ibc_disposed": {
"type": "string"
},
"legal_check_link": {
"type": "string"
},
"most_wanted_petitioner": {
"type": "string"
},
"mca_pending": {
"type": "string"
},
"e_court_respondent": {
"type": "string"
},
"most_wanted_total": {
"type": "string"
},
"most_wanted_disposed": {
"type": "string"
},
"fir_disposed": {
"type": "string"
},
"fir_pending": {
"type": "string"
},
"absconders_disposed": {
"type": "string"
}
}
},
"profit_loss_account": {
"type": "array",
"items": {
"type": "object",
"properties": {
"profit_after_tax": {
"type": "string"
},
"other_income": {
"type": "string"
},
"profit_before_tax_extraordinary_items": {
"type": "string"
},
"year": {
"type": "string"
},
"ebit": {
"type": "string"
},
"ebitda": {
"type": "string"
},
"selling_expenses": {
"type": "string"
},
"gross_profit_loss": {
"type": "string"
},
"salaries_and_wages": {
"type": "string"
},
"revenue": {
"type": "string"
},
"other_operating_income": {
"type": "string"
},
"other_overhead_expenses": {
"type": "string"
},
"direct_expenditure": {
"type": "string"
},
"raw_material_expenses_stores_packaging_etc": {
"type": "string"
},
"power_and_fuel_expenses": {
"type": "string"
},
"interest": {
"type": "string"
},
"general_administration_expenses": {
"type": "string"
},
"number_of_months": {
"type": "string"
},
"other_operating_expenses": {
"type": "string"
},
"extraordinary_items": {
"type": "string"
},
"depreciation": {
"type": "string"
},
"total_tax_provision": {
"type": "string"
}
}
}
},
"ownership_details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"period_ownership_detail": {
"type": "string"
},
"name_of_shareholder_ownership_detail": {
"type": "string"
},
"number_of_shares_ownership_detail": {
"type": "string"
},
"shareholding_percentage_ownership_detail": {
"type": "string"
},
"link_shareholding_ownership_detail": {
"type": "string"
}
}
}
},
"other_directorship": {
"type": "array",
"items": {
"type": "object",
"properties": {
"director_company_cin": {
"type": "string"
},
"director_name": {
"type": "string"
},
"director_company_name": {
"type": "string"
},
"director_date_of_appointment": {
"type": "string"
}
}
}
},
"solvency_ratio": {
"type": "array",
"items": {
"type": "object",
"properties": {
"year": {
"type": "string"
},
"current_ratio": {
"type": "string"
},
"cash_ratio": {
"type": "string"
},
"quick_ratio": {
"type": "string"
}
}
}
},
"estimated_profit_and_loss_in_lacs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"estimated_overhead_expenses": {
"type": "string"
},
"estimated_revenue": {
"type": "string"
},
"year": {
"type": "string"
},
"estimated_profit_before_tax": {
"type": "string"
},
"estimated_tax_provision": {
"type": "string"
},
"estimated_ebitda": {
"type": "string"
},
"estimated_interest": {
"type": "string"
},
"estimated_gross_margin": {
"type": "string"
},
"estimated_direct_expenditure": {
"type": "string"
},
"estimated_profit_after_tax": {
"type": "string"
}
}
}
},
"current_directorship": {
"type": "array",
"items": {
"type": "object",
"properties": {
"current_kmp_name": {
"type": "string"
},
"current_kmp_din_pan": {
"type": "string"
},
"current_kmp_date_of_appointment": {
"type": "string"
},
"current_kmp_designation": {
"type": "string"
}
}
}
},
"shareholding_pattern": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name_of_shareholder": {
"type": "string"
},
"number_of_shares": {
"type": "string"
},
"shareholding_percentage": {
"type": "string"
},
"shareholding_year": {
"type": "string"
}
}
}
},
"related_party_details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"related_party_details_relationship": {
"type": "string"
},
"related_party_details_year": {
"type": "string"
},
"related_party_details_name": {
"type": "string"
}
}
}
},
"profitability_ratios": {
"type": "array",
"items": {
"type": "object",
"properties": {
"gross_margin_growth": {
"type": "string"
},
"ebitda_growth": {
"type": "string"
},
"return_on_total_assets": {
"type": "string"
},
"year": {
"type": "string"
},
"pat_growth": {
"type": "string"
},
"ebitda_percentage": {
"type": "string"
},
"return_on_equity": {
"type": "string"
},
"pbt_percentage": {
"type": "string"
},
"gross_margin_percentage": {
"type": "string"
},
"pbt_growth": {
"type": "string"
},
"pat_percentage": {
"type": "string"
},
"sales_growth": {
"type": "string"
}
}
}
}
},
"example": {
"message": null,
"results": {
"contingent_liabilities": [
{
"guarantee_contingent_liabilities": "0.0",
"uncalled_liability_on_shares_and_other_investments_partly_paid_contingent_liabilities": "0.0",
"other_money_for_which_company_is_contingently_liable_contingent_liabilities": "0.0",
"year": "31-Mar-2019",
"claims_against_company_not_acknowledged_as_debt_contingent_liabilities": "0.0",
"other_commitments_contingent_liabilities": "0.0",
"estimate_of_financial_effect_of_contingent_liabilities": "0.0",
"estimated_amount_of_contracts_remaining_to_be_executed_on_capital_account_and_not_provided_for_contingent_liabilities": "0.0",
"total_contingent_liabilities": "0.0",
"total_commitments": "0.0"
},
{
"guarantee_contingent_liabilities": "0.0",
"uncalled_liability_on_shares_and_other_investments_partly_paid_contingent_liabilities": "0.0",
"other_money_for_which_company_is_contingently_liable_contingent_liabilities": "0.0",
"year": "31-Mar-2020",
"claims_against_company_not_acknowledged_as_debt_contingent_liabilities": "0.0",
"other_commitments_contingent_liabilities": "0.0",
"estimate_of_financial_effect_of_contingent_liabilities": "0.0",
"estimated_amount_of_contracts_remaining_to_be_executed_on_capital_account_and_not_provided_for_contingent_liabilities": "0.0",
"total_contingent_liabilities": "0.0",
"total_commitments": "0.0"
},
{
"guarantee_contingent_liabilities": "0.0",
"uncalled_liability_on_shares_and_other_investments_partly_paid_contingent_liabilities": "0.0",
"other_money_for_which_company_is_contingently_liable_contingent_liabilities": "0.0",
"year": "31-Mar-2021",
"claims_against_company_not_acknowledged_as_debt_contingent_liabilities": "0.0",
"other_commitments_contingent_liabilities": "0.0",
"estimate_of_financial_effect_of_contingent_liabilities": "0.0",
"estimated_amount_of_contracts_remaining_to_be_executed_on_capital_account_and_not_provided_for_contingent_liabilities": "0.0",
"total_contingent_liabilities": "0.0",
"total_commitments": "0.0"
}
],
"leverage_ratio": [
{
"sales_to_net_fixed_assets": "2.7493757089912814",
"total_outside_liabilities_to_total_net_worth": "-2.966987782543967",
"interest_coverage_ratio": "-3.6392882513239266",
"current_liabilities_to_net_worth": "-1.500545838029566",
"year": "FY2019",
"debt_equity_ratio": "-2.400027473402858",
"fixed_asset_to_net_worth": "-0.5409231722118076",
"debt_by_ebitda": "-7.351129476990464"
},
{
"sales_to_net_fixed_assets": "0.35982569179501933",
"total_outside_liabilities_to_total_net_worth": "0.41952837097266",
"interest_coverage_ratio": "-16.670490708371016",
"current_liabilities_to_net_worth": "0.22303699422385623",
"year": "FY2020",
"debt_equity_ratio": "0.16595084017831666",
"fixed_asset_to_net_worth": "0.4563302707158591",
"debt_by_ebitda": "-0.6036028180798314"
},
{
"sales_to_net_fixed_assets": "0.07801180401847678",
"total_outside_liabilities_to_total_net_worth": "2.6545328440297387",
"interest_coverage_ratio": "-30.58657512730416",
"current_liabilities_to_net_worth": "1.1426438227929998",
"year": "FY2021",
"debt_equity_ratio": "1.5131221385033817",
"fixed_asset_to_net_worth": "1.1705113500711033",
"debt_by_ebitda": "-1.9722261328475146"
}
],
"external_credit_ratings": [
{
"short_term_credit_rating_action": "",
"rating_agency_name": "",
"long_term_credit_rating_action": "",
"short_term_credit_rating": "",
"date_of_credit_rating": "",
"amount_of_credit_rating_in_inr_crores": "",
"long_term_credit_rating_outlook": "",
"link_of_press_release": "",
"long_term_credit_rating": ""
}
],
"statutory_and_credit_compliance": {
"gst_average_delay_days": "0.0",
"pf_average_delay_days": "0.0",
"pf_company_filing_details": "No PF details found for this establishment",
"gst_current_average_delay_days": "0.0",
"total_active_gst_numbers": "1.0",
"total_inactive_gst_numbers": "0.0",
"total_active_pf_numbers": "0.0",
"pf_current_average_delay_days": "0.0",
"gst_company_filing_details": "GSTR3B last filed for FY 2021-2022 for MARCH on 15-Apr-2022 for 24AACCC6582E1ZT (Active)",
"mca_company_filing_details": "Financials and Annual Returns filed for FY 2021 with MCA",
"total_inactive_pf_numbers": "0.0"
},
"balance_sheet": [
{
"share_premium": "115485156",
"loans_from_directors_shareholders_others": "0.0",
"net_fixed_assets": "25351158",
"year": "31-Mar-2019",
"non_current_inter_company_loans": "0.0",
"current_assets": "59697161",
"equity": "-46918105",
"current_inter_company_loans": "0.0",
"non_current_assets": "32436969",
"intangible_assets": "51638.0",
"accounts_receivables": "9992614.0",
"assets": "92134130",
"inventories": "8291722.0",
"share_capital": "169984280",
"gross_fixed_assets": "62874349",
"other_current_assets": "330399.0",
"liabilities": "92134130",
"other_non_current_assets": "0.0",
"non_current_loans_advances": "7034173.0",
"current_liabilities": "70325282",
"current_investments": "0.0",
"cash_and_cash_equivalents": "36348539",
"long_term_loans": "58201581",
"Less: Depreciation": "37523191",
"total_reserves": "0.0",
"non_current_liabilities": "68726953",
"retained_earnings_loss": "-332387541",
"deferred_tax_liabilities_net": "0.0",
"other_current_liabilties": "6078771.0",
"deferred_tax_assets_net": "0.0",
"income_tax_liabilities_net": "0.0",
"provisions": "783469.0",
"short_term_loans": "0.0",
"current_Loans_advances": "4733887.0",
"current_portion_of_long_term_debt": "54403160",
"non_current_investments": "0.0",
"accounts_payable": "9059882.0",
"other_non_current_liabilties": "10525372"
},
{
"share_premium": "568554426",
"loans_from_directors_shareholders_others": "0.0",
"net_fixed_assets": "165178914",
"year": "31-Mar-2020",
"non_current_inter_company_loans": "0.0",
"current_assets": "298205479",
"equity": "361958758",
"current_inter_company_loans": "0.0",
"non_current_assets": "215610925",
"intangible_assets": "13534.0",
"accounts_receivables": "5313070.0",
"assets": "513816404",
"inventories": "14850903",
"share_capital": "216915010",
"gross_fixed_assets": "206424066",
"other_current_assets": "1124712.0",
"liabilities": "513816404",
"other_non_current_assets": "31858252",
"non_current_loans_advances": "18560225",
"current_liabilities": "80733212",
"current_investments": "0.0",
"cash_and_cash_equivalents": "222356165",
"long_term_loans": "60067360",
"Less: Depreciation": "41245152",
"total_reserves": "0.0",
"non_current_liabilities": "71124434",
"retained_earnings_loss": "-423510678",
"deferred_tax_liabilities_net": "0.0",
"other_current_liabilties": "51046902",
"deferred_tax_assets_net": "0.0",
"income_tax_liabilities_net": "0.0",
"provisions": "5288570.0",
"short_term_loans": "0.0",
"current_Loans_advances": "54560629",
"current_portion_of_long_term_debt": "0.0",
"non_current_investments": "0.0",
"accounts_payable": "24397740",
"other_non_current_liabilties": "11057074"
},
{
"share_premium": "568554426",
"loans_from_directors_shareholders_others": "0.0",
"net_fixed_assets": "252719191",
"year": "31-Mar-2021",
"non_current_inter_company_loans": "0.0",
"current_assets": "462374513",
"equity": "206609540",
"current_inter_company_loans": "0.0",
"non_current_assets": "317361800",
"intangible_assets": "9295407.0",
"accounts_receivables": "2444257.0",
"assets": "779736313",
"inventories": "91732572",
"share_capital": "216915010",
"gross_fixed_assets": "301138842",
"other_current_assets": "3360041.0",
"liabilities": "779736313",
"other_non_current_assets": "82317.0",
"non_current_loans_advances": "55264885",
"current_liabilities": "246702454",
"current_investments": "0.0",
"cash_and_cash_equivalents": "254866389",
"long_term_loans": "312625469",
"Less: Depreciation": "48419651",
"total_reserves": "0.0",
"non_current_liabilities": "326424319",
"retained_earnings_loss": "-578859896",
"deferred_tax_liabilities_net": "0.0",
"other_current_liabilties": "156299000",
"deferred_tax_assets_net": "0.0",
"income_tax_liabilities_net": "0.0",
"provisions": "12708554",
"short_term_loans": "0.0",
"current_Loans_advances": "109971254",
"current_portion_of_long_term_debt": "0.0",
"non_current_investments": "0.0",
"accounts_payable": "77694900",
"other_non_current_liabilties": "13798850"
}
],
"quaterly_results": [
{
"element_name_quarterly_result": "Quarter",
"quarter_2_quarterly_results": "Sep-21",
"quarter_1_quarterly_results": "Jun-21",
"quarter_3_quarterly_results": "Dec-21"
},
{
"element_name_quarterly_result": "Revenue",
"quarter_2_quarterly_results": "17,061.00",
"quarter_1_quarterly_results": "13,109.00",
"quarter_3_quarterly_results": "21,551.54"
},
{
"element_name_quarterly_result": "Other Income",
"quarter_2_quarterly_results": "1,353.77",
"quarter_1_quarterly_results": "670.49",
"quarter_3_quarterly_results": "1,012.44"
},
{
"element_name_quarterly_result": "Total Income",
"quarter_2_quarterly_results": "18,414.77",
"quarter_1_quarterly_results": "13,779.49",
"quarter_3_quarterly_results": "22,563.98"
},
{
"element_name_quarterly_result": "Expenditure",
"quarter_2_quarterly_results": "15,792.41",
"quarter_1_quarterly_results": "12,550.07",
"quarter_3_quarterly_results": "20,243.06"
},
{
"element_name_quarterly_result": "Interest",
"quarter_2_quarterly_results": "424.21",
"quarter_1_quarterly_results": "466.92",
"quarter_3_quarterly_results": "412.00"
},
{
"element_name_quarterly_result": "PBDT",
"quarter_2_quarterly_results": "2,622.36",
"quarter_1_quarterly_results": "1,229.42",
"quarter_3_quarterly_results": "2,320.92"
},
{
"element_name_quarterly_result": "Depreciation",
"quarter_2_quarterly_results": "261.25",
"quarter_1_quarterly_results": "260.27",
"quarter_3_quarterly_results": "258.73"
},
{
"element_name_quarterly_result": "PBT",
"quarter_2_quarterly_results": "2,361.11",
"quarter_1_quarterly_results": "969.15",
"quarter_3_quarterly_results": "2,062.19"
},
{
"element_name_quarterly_result": "Tax",
"quarter_2_quarterly_results": "335.67",
"quarter_1_quarterly_results": "219.18",
"quarter_3_quarterly_results": "391.35"
},
{
"element_name_quarterly_result": "Net Profit",
"quarter_2_quarterly_results": "2,025.44",
"quarter_1_quarterly_results": "749.97",
"quarter_3_quarterly_results": "1,670.84"
},
{
"element_name_quarterly_result": "Equity",
"quarter_2_quarterly_results": "280.93",
"quarter_1_quarterly_results": "280.92",
"quarter_3_quarterly_results": "280.97"
}
],
"related_party_transactions": [
{
"name_of_related_party_in_transaction": "ASISH MOHAPATRA",
"year_related_party_transactions": "2020",
"transaction_amount": "2480000",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Other related party transactions contribution received"
},
{
"name_of_related_party_in_transaction": "ASISH MOHAPATRA",
"year_related_party_transactions": "2020",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Amounts payable related party transactions"
},
{
"name_of_related_party_in_transaction": "ASISH MOHAPATRA",
"year_related_party_transactions": "2020",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Amounts receivable related party transactions"
},
{
"name_of_related_party_in_transaction": "ASISH MOHAPATRA",
"year_related_party_transactions": "2020",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Outstanding commitments made by entity, related party transactions"
},
{
"name_of_related_party_in_transaction": "ASISH MOHAPATRA",
"year_related_party_transactions": "2020",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Outstanding commitments made on behalf of entity, related party transactions"
},
{
"name_of_related_party_in_transaction": "ASISH MOHAPATRA",
"year_related_party_transactions": "2020",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Provisions for doubtful debts related to outstanding balances of related party transaction"
},
{
"name_of_related_party_in_transaction": "ASISH MOHAPATRA",
"year_related_party_transactions": "2020",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Expense recognised during period for bad and doubtful debts for related party transaction"
},
{
"name_of_related_party_in_transaction": "BHUVAN KUMAR GUPTA",
"year_related_party_transactions": "2020",
"transaction_amount": "6400000",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Other related party transactions contribution received"
},
{
"name_of_related_party_in_transaction": "BHUVAN KUMAR GUPTA",
"year_related_party_transactions": "2020",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Amounts payable related party transactions"
},
{
"name_of_related_party_in_transaction": "BHUVAN KUMAR GUPTA",
"year_related_party_transactions": "2020",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Amounts receivable related party transactions"
},
{
"name_of_related_party_in_transaction": "BHUVAN KUMAR GUPTA",
"year_related_party_transactions": "2020",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Outstanding commitments made by entity, related party transactions"
},
{
"name_of_related_party_in_transaction": "BHUVAN KUMAR GUPTA",
"year_related_party_transactions": "2020",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Outstanding commitments made on behalf of entity, related party transactions"
},
{
"name_of_related_party_in_transaction": "BHUVAN KUMAR GUPTA",
"year_related_party_transactions": "2020",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Provisions for doubtful debts related to outstanding balances of related party transaction"
},
{
"name_of_related_party_in_transaction": "BHUVAN KUMAR GUPTA",
"year_related_party_transactions": "2020",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Expense recognised during period for bad and doubtful debts for related party transaction"
},
{
"name_of_related_party_in_transaction": "OFCONS PROJECTS AND SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2020",
"transaction_amount": "4845000",
"relationship_related_party_in_transaction": "SUBSIDIARY",
"nature_of_transaction_with_related_party": "Purchases of goods related party transactions"
},
{
"name_of_related_party_in_transaction": "OFCONS PROJECTS AND SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2020",
"transaction_amount": "17795000",
"relationship_related_party_in_transaction": "SUBSIDIARY",
"nature_of_transaction_with_related_party": "Revenue from sale of goods related party transactions"
},
{
"name_of_related_party_in_transaction": "OFCONS PROJECTS AND SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2020",
"transaction_amount": "9300000",
"relationship_related_party_in_transaction": "SUBSIDIARY",
"nature_of_transaction_with_related_party": "Services received related party transactions"
},
{
"name_of_related_party_in_transaction": "OFCONS PROJECTS AND SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2020",
"transaction_amount": "109042000",
"relationship_related_party_in_transaction": "SUBSIDIARY",
"nature_of_transaction_with_related_party": "Other related party transactions contribution received"
},
{
"name_of_related_party_in_transaction": "OFCONS PROJECTS AND SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2020",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "SUBSIDIARY",
"nature_of_transaction_with_related_party": "Amounts payable related party transactions"
},
{
"name_of_related_party_in_transaction": "OFCONS PROJECTS AND SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2020",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "SUBSIDIARY",
"nature_of_transaction_with_related_party": "Amounts receivable related party transactions"
},
{
"name_of_related_party_in_transaction": "OFCONS PROJECTS AND SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2020",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "SUBSIDIARY",
"nature_of_transaction_with_related_party": "Outstanding commitments made by entity, related party transactions"
},
{
"name_of_related_party_in_transaction": "OFCONS PROJECTS AND SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2020",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "SUBSIDIARY",
"nature_of_transaction_with_related_party": "Outstanding commitments made on behalf of entity, related party transactions"
},
{
"name_of_related_party_in_transaction": "OFCONS PROJECTS AND SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2020",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "SUBSIDIARY",
"nature_of_transaction_with_related_party": "Provisions for doubtful debts related to outstanding balances of related party transaction"
},
{
"name_of_related_party_in_transaction": "OFCONS PROJECTS AND SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2020",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "SUBSIDIARY",
"nature_of_transaction_with_related_party": "Expense recognised during period for bad and doubtful debts for related party transaction"
},
{
"name_of_related_party_in_transaction": "OXYZO FINANCIAL SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2020",
"transaction_amount": "706000",
"relationship_related_party_in_transaction": "SUBSIDIARY",
"nature_of_transaction_with_related_party": "Revenue from sale of goods related party transactions"
},
{
"name_of_related_party_in_transaction": "OXYZO FINANCIAL SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2020",
"transaction_amount": "17624000",
"relationship_related_party_in_transaction": "SUBSIDIARY",
"nature_of_transaction_with_related_party": "Revenue from rendering of services related party transactions"
},
{
"name_of_related_party_in_transaction": "OXYZO FINANCIAL SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2020",
"transaction_amount": "5139948000",
"relationship_related_party_in_transaction": "SUBSIDIARY",
"nature_of_transaction_with_related_party": "Other related party transactions contribution received"
},
{
"name_of_related_party_in_transaction": "OXYZO FINANCIAL SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2020",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "SUBSIDIARY",
"nature_of_transaction_with_related_party": "Amounts payable related party transactions"
},
{
"name_of_related_party_in_transaction": "OXYZO FINANCIAL SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2020",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "SUBSIDIARY",
"nature_of_transaction_with_related_party": "Amounts receivable related party transactions"
},
{
"name_of_related_party_in_transaction": "OXYZO FINANCIAL SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2020",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "SUBSIDIARY",
"nature_of_transaction_with_related_party": "Outstanding commitments made by entity, related party transactions"
},
{
"name_of_related_party_in_transaction": "OXYZO FINANCIAL SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2020",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "SUBSIDIARY",
"nature_of_transaction_with_related_party": "Outstanding commitments made on behalf of entity, related party transactions"
},
{
"name_of_related_party_in_transaction": "OXYZO FINANCIAL SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2020",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "SUBSIDIARY",
"nature_of_transaction_with_related_party": "Provisions for doubtful debts related to outstanding balances of related party transaction"
},
{
"name_of_related_party_in_transaction": "OXYZO FINANCIAL SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2020",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "SUBSIDIARY",
"nature_of_transaction_with_related_party": "Expense recognised during period for bad and doubtful debts for related party transaction"
},
{
"name_of_related_party_in_transaction": "ASISH MOHAPATRA",
"year_related_party_transactions": "2021",
"transaction_amount": "2391000",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Other related party transactions contribution received"
},
{
"name_of_related_party_in_transaction": "ASISH MOHAPATRA",
"year_related_party_transactions": "2021",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Amounts payable related party transactions"
},
{
"name_of_related_party_in_transaction": "ASISH MOHAPATRA",
"year_related_party_transactions": "2021",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Amounts receivable related party transactions"
},
{
"name_of_related_party_in_transaction": "ASISH MOHAPATRA",
"year_related_party_transactions": "2021",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Outstanding commitments made by entity, related party transactions"
},
{
"name_of_related_party_in_transaction": "ASISH MOHAPATRA",
"year_related_party_transactions": "2021",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Outstanding commitments made on behalf of entity, related party transactions"
},
{
"name_of_related_party_in_transaction": "ASISH MOHAPATRA",
"year_related_party_transactions": "2021",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Provisions for doubtful debts related to outstanding balances of related party transaction"
},
{
"name_of_related_party_in_transaction": "ASISH MOHAPATRA",
"year_related_party_transactions": "2021",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Expense recognised during period for bad and doubtful debts for related party transaction"
},
{
"name_of_related_party_in_transaction": "BHUVAN KUMAR GUPTA",
"year_related_party_transactions": "2021",
"transaction_amount": "6378000",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Other related party transactions contribution received"
},
{
"name_of_related_party_in_transaction": "BHUVAN KUMAR GUPTA",
"year_related_party_transactions": "2021",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Amounts payable related party transactions"
},
{
"name_of_related_party_in_transaction": "BHUVAN KUMAR GUPTA",
"year_related_party_transactions": "2021",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Amounts receivable related party transactions"
},
{
"name_of_related_party_in_transaction": "BHUVAN KUMAR GUPTA",
"year_related_party_transactions": "2021",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Outstanding commitments made by entity, related party transactions"
},
{
"name_of_related_party_in_transaction": "BHUVAN KUMAR GUPTA",
"year_related_party_transactions": "2021",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Outstanding commitments made on behalf of entity, related party transactions"
},
{
"name_of_related_party_in_transaction": "BHUVAN KUMAR GUPTA",
"year_related_party_transactions": "2021",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Provisions for doubtful debts related to outstanding balances of related party transaction"
},
{
"name_of_related_party_in_transaction": "BHUVAN KUMAR GUPTA",
"year_related_party_transactions": "2021",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Expense recognised during period for bad and doubtful debts for related party transaction"
},
{
"name_of_related_party_in_transaction": "OFCONS PROJECTS AND SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2021",
"transaction_amount": "522866000",
"relationship_related_party_in_transaction": "SUBSIDIARY",
"nature_of_transaction_with_related_party": "Purchases of goods related party transactions"
},
{
"name_of_related_party_in_transaction": "OFCONS PROJECTS AND SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2021",
"transaction_amount": "14382000",
"relationship_related_party_in_transaction": "SUBSIDIARY",
"nature_of_transaction_with_related_party": "Revenue from sale of goods related party transactions"
},
{
"name_of_related_party_in_transaction": "OFCONS PROJECTS AND SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2021",
"transaction_amount": "117000",
"relationship_related_party_in_transaction": "SUBSIDIARY",
"nature_of_transaction_with_related_party": "Services received related party transactions"
},
{
"name_of_related_party_in_transaction": "OFCONS PROJECTS AND SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2021",
"transaction_amount": "15783000",
"relationship_related_party_in_transaction": "SUBSIDIARY",
"nature_of_transaction_with_related_party": "Revenue from rendering of services related party transactions"
},
{
"name_of_related_party_in_transaction": "OFCONS PROJECTS AND SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2021",
"transaction_amount": "27243000",
"relationship_related_party_in_transaction": "SUBSIDIARY",
"nature_of_transaction_with_related_party": "Other related party transactions income"
},
{
"name_of_related_party_in_transaction": "OFCONS PROJECTS AND SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2021",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "SUBSIDIARY",
"nature_of_transaction_with_related_party": "Other related party transactions contribution received"
},
{
"name_of_related_party_in_transaction": "OFCONS PROJECTS AND SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2021",
"transaction_amount": "238657000",
"relationship_related_party_in_transaction": "SUBSIDIARY",
"nature_of_transaction_with_related_party": "Amounts payable related party transactions"
},
{
"name_of_related_party_in_transaction": "OFCONS PROJECTS AND SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2021",
"transaction_amount": "97000000",
"relationship_related_party_in_transaction": "SUBSIDIARY",
"nature_of_transaction_with_related_party": "Amounts receivable related party transactions"
},
{
"name_of_related_party_in_transaction": "OFCONS PROJECTS AND SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2021",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "SUBSIDIARY",
"nature_of_transaction_with_related_party": "Outstanding commitments made by entity, related party transactions"
},
{
"name_of_related_party_in_transaction": "OFCONS PROJECTS AND SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2021",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "SUBSIDIARY",
"nature_of_transaction_with_related_party": "Outstanding commitments made on behalf of entity, related party transactions"
},
{
"name_of_related_party_in_transaction": "OFCONS PROJECTS AND SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2021",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "SUBSIDIARY",
"nature_of_transaction_with_related_party": "Provisions for doubtful debts related to outstanding balances of related party transaction"
},
{
"name_of_related_party_in_transaction": "OFCONS PROJECTS AND SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2021",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "SUBSIDIARY",
"nature_of_transaction_with_related_party": "Expense recognised during period for bad and doubtful debts for related party transaction"
},
{
"name_of_related_party_in_transaction": "ASISH MOHAPATRA",
"year_related_party_transactions": "2019",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Other related party transactions contribution received"
},
{
"name_of_related_party_in_transaction": "ASISH MOHAPATRA",
"year_related_party_transactions": "2019",
"transaction_amount": "2946818",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Amounts payable related party transactions"
},
{
"name_of_related_party_in_transaction": "ASISH MOHAPATRA",
"year_related_party_transactions": "2019",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Amounts receivable related party transactions"
},
{
"name_of_related_party_in_transaction": "ASISH MOHAPATRA",
"year_related_party_transactions": "2019",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Outstanding commitments made by entity, related party transactions"
},
{
"name_of_related_party_in_transaction": "ASISH MOHAPATRA",
"year_related_party_transactions": "2019",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Outstanding commitments made on behalf of entity, related party transactions"
},
{
"name_of_related_party_in_transaction": "ASISH MOHAPATRA",
"year_related_party_transactions": "2019",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Provisions for doubtful debts related to outstanding balances of related party transaction"
},
{
"name_of_related_party_in_transaction": "ASISH MOHAPATRA",
"year_related_party_transactions": "2019",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Expense recognised during period for bad and doubtful debts for related party transaction"
},
{
"name_of_related_party_in_transaction": "OFCONS PROJECTS AND SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2019",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "Subsidiary",
"nature_of_transaction_with_related_party": "Other related party transactions contribution received"
},
{
"name_of_related_party_in_transaction": "OFCONS PROJECTS AND SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2019",
"transaction_amount": "99990",
"relationship_related_party_in_transaction": "Subsidiary",
"nature_of_transaction_with_related_party": "Amounts payable related party transactions"
},
{
"name_of_related_party_in_transaction": "OFCONS PROJECTS AND SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2019",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "Subsidiary",
"nature_of_transaction_with_related_party": "Amounts receivable related party transactions"
},
{
"name_of_related_party_in_transaction": "OFCONS PROJECTS AND SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2019",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "Subsidiary",
"nature_of_transaction_with_related_party": "Outstanding commitments made by entity, related party transactions"
},
{
"name_of_related_party_in_transaction": "OFCONS PROJECTS AND SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2019",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "Subsidiary",
"nature_of_transaction_with_related_party": "Outstanding commitments made on behalf of entity, related party transactions"
},
{
"name_of_related_party_in_transaction": "OFCONS PROJECTS AND SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2019",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "Subsidiary",
"nature_of_transaction_with_related_party": "Provisions for doubtful debts related to outstanding balances of related party transaction"
},
{
"name_of_related_party_in_transaction": "OFCONS PROJECTS AND SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2019",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "Subsidiary",
"nature_of_transaction_with_related_party": "Expense recognised during period for bad and doubtful debts for related party transaction"
},
{
"name_of_related_party_in_transaction": "Bhuvan Kumar Gupta",
"year_related_party_transactions": "2019",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Other related party transactions contribution received"
},
{
"name_of_related_party_in_transaction": "Bhuvan Kumar Gupta",
"year_related_party_transactions": "2019",
"transaction_amount": "6400004",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Amounts payable related party transactions"
},
{
"name_of_related_party_in_transaction": "Bhuvan Kumar Gupta",
"year_related_party_transactions": "2019",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Amounts receivable related party transactions"
},
{
"name_of_related_party_in_transaction": "Bhuvan Kumar Gupta",
"year_related_party_transactions": "2019",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Outstanding commitments made by entity, related party transactions"
},
{
"name_of_related_party_in_transaction": "Bhuvan Kumar Gupta",
"year_related_party_transactions": "2019",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Outstanding commitments made on behalf of entity, related party transactions"
},
{
"name_of_related_party_in_transaction": "Bhuvan Kumar Gupta",
"year_related_party_transactions": "2019",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Provisions for doubtful debts related to outstanding balances of related party transaction"
},
{
"name_of_related_party_in_transaction": "Bhuvan Kumar Gupta",
"year_related_party_transactions": "2019",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "DIRECTOR",
"nature_of_transaction_with_related_party": "Expense recognised during period for bad and doubtful debts for related party transaction"
},
{
"name_of_related_party_in_transaction": "OXYZO FINANCIAL SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2019",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "Subsidiary",
"nature_of_transaction_with_related_party": "Other related party transactions contribution received"
},
{
"name_of_related_party_in_transaction": "OXYZO FINANCIAL SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2019",
"transaction_amount": "3591617636",
"relationship_related_party_in_transaction": "Subsidiary",
"nature_of_transaction_with_related_party": "Amounts payable related party transactions"
},
{
"name_of_related_party_in_transaction": "OXYZO FINANCIAL SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2019",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "Subsidiary",
"nature_of_transaction_with_related_party": "Amounts receivable related party transactions"
},
{
"name_of_related_party_in_transaction": "OXYZO FINANCIAL SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2019",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "Subsidiary",
"nature_of_transaction_with_related_party": "Outstanding commitments made by entity, related party transactions"
},
{
"name_of_related_party_in_transaction": "OXYZO FINANCIAL SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2019",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "Subsidiary",
"nature_of_transaction_with_related_party": "Outstanding commitments made on behalf of entity, related party transactions"
},
{
"name_of_related_party_in_transaction": "OXYZO FINANCIAL SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2019",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "Subsidiary",
"nature_of_transaction_with_related_party": "Provisions for doubtful debts related to outstanding balances of related party transaction"
},
{
"name_of_related_party_in_transaction": "OXYZO FINANCIAL SERVICES PRIVATE LIMITED",
"year_related_party_transactions": "2019",
"transaction_amount": "0",
"relationship_related_party_in_transaction": "Subsidiary",
"nature_of_transaction_with_related_party": "Expense recognised during period for bad and doubtful debts for related party transaction"
}
],
"segment_reporting": [
{
"segment_revenue": "691944100000",
"segment_name": "Infrastructure",
"year_segment_reporting": "2020.0"
},
{
"segment_revenue": "23184600000",
"segment_name": "Power",
"year_segment_reporting": "2020.0"
},
{
"segment_revenue": "32049100000",
"segment_name": "Heavy Engineering",
"year_segment_reporting": "2020.0"
},
{
"segment_revenue": "36991600000",
"segment_name": "Defence Engineering",
"year_segment_reporting": "2020.0"
},
{
"segment_revenue": "45573400000",
"segment_name": "Electrical & Automation",
"year_segment_reporting": "2020.0"
},
{
"segment_revenue": "43671500000",
"segment_name": "Others",
"year_segment_reporting": "2020.0"
},
{
"segment_revenue": "0",
"segment_name": "Elimination",
"year_segment_reporting": "2020.0"
},
{
"segment_revenue": "0",
"segment_name": "Unallocated corporate",
"year_segment_reporting": "2020.0"
},
{
"segment_revenue": "583641500000",
"segment_name": "Infrastructure",
"year_segment_reporting": "2021.0"
},
{
"segment_revenue": "31926400000",
"segment_name": "Power",
"year_segment_reporting": "2021.0"
},
{
"segment_revenue": "30182300000",
"segment_name": "Heavy Engineering",
"year_segment_reporting": "2021.0"
},
{
"segment_revenue": "34101200000",
"segment_name": "Defence Engineering",
"year_segment_reporting": "2021.0"
},
{
"segment_revenue": "12627400000",
"segment_name": "Electrical & Automation",
"year_segment_reporting": "2021.0"
},
{
"segment_revenue": "56608600000",
"segment_name": "Others",
"year_segment_reporting": "2021.0"
},
{
"segment_revenue": "0",
"segment_name": "Elimination",
"year_segment_reporting": "2021.0"
},
{
"segment_revenue": "0",
"segment_name": "Unallocated corporate",
"year_segment_reporting": "2021.0"
},
{
"segment_revenue": "689085300000",
"segment_name": "Infrastructure",
"year_segment_reporting": "2019.0"
},
{
"segment_revenue": "39830900000",
"segment_name": "Power",
"year_segment_reporting": "2019.0"
},
{
"segment_revenue": "25132500000",
"segment_name": "Heavy Engineering",
"year_segment_reporting": "2019.0"
},
{
"segment_revenue": "38495800000",
"segment_name": "Defence Engineering",
"year_segment_reporting": "2019.0"
},
{
"segment_revenue": "49305600000",
"segment_name": "Electrical & Automation",
"year_segment_reporting": "2019.0"
},
{
"segment_revenue": "36607000000",
"segment_name": "Others",
"year_segment_reporting": "2019.0"
},
{
"segment_revenue": "6277300000",
"segment_name": "Elimination",
"year_segment_reporting": "2019.0"
},
{
"segment_revenue": "0",
"segment_name": "Unallocated corporate",
"year_segment_reporting": "2019.0"
}
],
"media": {
"employee_sentiment_score": "70.0",
"number_of_customer_reviews": "0.0",
"customer_sentiment_score": "0.0",
"number_of_employee_reviews": "14.0"
},
"balance_sheet_in_lacs": [
{
"": "",
"intangibles_lacs": "0.51638",
"year": "31-Mar-2019",
"total_liabilities_lacs": "921.3413",
"non_current_liabilities_lacs": "687.26953",
"current_liabilities_lacs": "703.25282",
"current_assets_lacs": "596.97161",
"other_assets_lacs": "70.34173",
"sources_of_funds_lacs": "",
"fixed_assets_lacs": "253.51158",
"application_of_funds_lacs": "",
"investments_lacs": "0.0",
"total_assets_lacs": "921.3413",
"total_shareholders_funds_lacs": "-469.18105"
},
{
"": "",
"intangibles_lacs": "0.13534",
"year": "31-Mar-2020",
"total_liabilities_lacs": "5138.16404",
"non_current_liabilities_lacs": "711.24434",
"current_liabilities_lacs": "807.33212",
"current_assets_lacs": "2982.05479",
"other_assets_lacs": "504.18477",
"sources_of_funds_lacs": "",
"fixed_assets_lacs": "1651.78914",
"application_of_funds_lacs": "",
"investments_lacs": "0.0",
"total_assets_lacs": "5138.16404",
"total_shareholders_funds_lacs": "3619.58758"
},
{
"": "",
"intangibles_lacs": "92.95407",
"year": "31-Mar-2021",
"total_liabilities_lacs": "7797.36313",
"non_current_liabilities_lacs": "3264.24319",
"current_liabilities_lacs": "2467.02454",
"current_assets_lacs": "4623.74513",
"other_assets_lacs": "553.47202",
"sources_of_funds_lacs": "",
"fixed_assets_lacs": "2527.19191",
"application_of_funds_lacs": "",
"investments_lacs": "0.0",
"total_assets_lacs": "7797.363130000001",
"total_shareholders_funds_lacs": "2066.0954"
}
],
"benchmark_ratios": [
{
"interest_coverage_ratio": "1.59",
"net_working_capital_cycle_days": "",
"accounts_payable_days": "34.00268761874018",
"inventory_days": "48.99233043961485",
"year": "FY18",
"debt_equity_ratio": "0.8232937868099787",
"ebitda_percentage": "3.49",
"current_ratio": "1.3229737195278624",
"accounts_receivable_days": "27.67",
"gross_margin_percentage": "7.36",
"pat_percentage": "1.07"
}
],
"history_of_names": [
{
"company_old_name": "",
"date_of_name_change": "",
"purpose_of_name_change": "",
"company_new_name": ""
}
],
"report_metadata": {
"company_type": "CUSTOMER",
"report_id": "061e5bde-bf9c-4b8e-b18a-226590cdb54a",
"company_name": "CHEMTEX MATERIALS PRIVATE LIMITED",
"report_status": "COMPLETED",
"report_date": "15-Jul-2023",
"report_pdf_file": "https://core.rubixds.com/api/pdf/6266a558db6084260d3617da"
},
"balance_sheet_in_crores": [
{
"application_of_funds_crores": "",
"fixed_assets_crores": "2.5351158",
"year": "31-Mar-2019",
"non_current_liabilities_crores": "6.8726953",
"sources_of_funds_crores": "",
"total_shareholders_funds_crores": "-4.6918105",
"investments_crores": "0.0",
"intangibles_crores": "0.0051638",
"current_liabilities_crores": "7.0325282",
"total_liabilities_crores": "9.213413",
"other_assets_crores": "0.7034173",
"current_assets_crores": "5.9697161",
"total_assets_crores": "9.213413"
},
{
"application_of_funds_crores": "",
"fixed_assets_crores": "16.5178914",
"year": "31-Mar-2020",
"non_current_liabilities_crores": "7.1124434",
"sources_of_funds_crores": "",
"total_shareholders_funds_crores": "36.1958758",
"investments_crores": "0.0",
"intangibles_crores": "0.0013534",
"current_liabilities_crores": "8.0733212",
"total_liabilities_crores": "51.3816404",
"other_assets_crores": "5.0418477",
"current_assets_crores": "29.8205479",
"total_assets_crores": "51.3816404"
},
{
"application_of_funds_crores": "",
"fixed_assets_crores": "25.2719191",
"year": "31-Mar-2021",
"non_current_liabilities_crores": "32.6424319",
"sources_of_funds_crores": "",
"total_shareholders_funds_crores": "20.660954",
"investments_crores": "0.0",
"intangibles_crores": "0.9295407",
"current_liabilities_crores": "24.6702454",
"total_liabilities_crores": "77.9736313",
"other_assets_crores": "5.5347202",
"current_assets_crores": "46.2374513",
"total_assets_crores": "77.9736313"
}
],
"efficiency_ratios": [
{
"net_working_capital_cycle_days": "49.03636715856861",
"accounts_receivable_turnover": "6.975137636658436",
"inventory_days": "35.53848877930455",
"accounts_payable_days": "38.83083812974232",
"asset_turnover": "0.7565042183607746",
"year": "FY2019",
"inventory_turnover": "8.405956929091449",
"accounts_receivable_days": "52.32871650900638"
},
{
"net_working_capital_cycle_days": "10.707353850497661",
"accounts_receivable_turnover": "11.186680582036374",
"inventory_days": "34.09953459867076",
"accounts_payable_days": "56.02026888596428",
"asset_turnover": "0.11567481407230432",
"year": "FY2020",
"inventory_turnover": "4.0021550878084655",
"accounts_receivable_days": "32.62808813779118"
},
{
"net_working_capital_cycle_days": "73.98956559823912",
"accounts_receivable_turnover": "8.065878506229092",
"inventory_days": "187.79026981304278",
"accounts_payable_days": "159.05305951845955",
"asset_turnover": "0.02528429120371107",
"year": "FY2021",
"inventory_turnover": "0.21491908021504075",
"accounts_receivable_days": "45.25235530365588"
}
],
"profit_loss_account_in_lacs": [
{
"direct_expenditure_lacs": "607.35251",
"other_expenses_lacs": "0.0",
"other_income_lacs": "63.08428",
"": "",
"other_operating_income_lacs": "1.42709",
"extraordinary_items_lacs": "0.0",
"year": "FY2019",
"tax_provision_lacs": "0.0",
"profit_before_tax_and_extraordinary_items_lacs": "-168.5781900000001",
"gross_margin_lacs": "91.07315999999992",
"ebitda_lacs": "-153.1801900000001",
"sales_general_and_administrative_lacs": "244.25335",
"profit_after_tax_extraordinary_items_lacs": "-168.5781900000001",
"interest_lacs": "42.0907",
"depreciation_lacs": "36.39158",
"revenue_lacs": "696.99858",
"ebit_lacs": "-126.4874900000001"
},
{
"direct_expenditure_lacs": "564.55412",
"other_expenses_lacs": "0.0",
"other_income_lacs": "181.86042",
"": "",
"other_operating_income_lacs": "0.1312",
"extraordinary_items_lacs": "0.0",
"year": "FY2020",
"tax_provision_lacs": "0.0",
"profit_before_tax_and_extraordinary_items_lacs": "-911.2313699999999",
"gross_margin_lacs": "29.933250000000044",
"ebitda_lacs": "-995.1471099999999",
"sales_general_and_administrative_lacs": "1025.08036",
"profit_after_tax_extraordinary_items_lacs": "-911.2313699999999",
"interest_lacs": "59.69513",
"depreciation_lacs": "38.24955",
"revenue_lacs": "594.35617",
"ebit_lacs": "-851.5362399999999"
},
{
"direct_expenditure_lacs": "653.17985",
"other_expenses_lacs": "0.0",
"other_income_lacs": "155.35293",
"": "",
"other_operating_income_lacs": "0.6763",
"extraordinary_items_lacs": "0.0",
"year": "FY2021",
"tax_provision_lacs": "0.0",
"profit_before_tax_and_extraordinary_items_lacs": "-1553.4921799999997",
"gross_margin_lacs": "-455.35275",
"ebitda_lacs": "-1585.14008",
"sales_general_and_administrative_lacs": "1129.7873299999999",
"profit_after_tax_extraordinary_items_lacs": "-1553.4921799999997",
"interest_lacs": "51.8247",
"depreciation_lacs": "71.88033",
"revenue_lacs": "197.1508",
"ebit_lacs": "-1501.6674799999998"
}
],
"additional_funding": [
{
"additional_funding_date": "",
"additional_funding_type_of_shares": "",
"additional_funding_number_of_shares": "",
"additional_funding_face_value": "",
"additional_funding_premium": "",
"additional_funding_total_amount": "",
"additional_funding_attachment": ""
}
],
"news": [
{
"news_date": "",
"news_link": "",
"news_summary": "",
"news_sentiment": ""
}
],
"cash_flow": [
{
"adjustments_for_working_capital": "3756533.0",
"net_cash_flows_from_used_in_operating_activities": "-7596119.0",
"year": "31-Mar-2019",
"other_proceeds_classified_as_financing_activity": "0.0",
"cash_flows_from_used_in_operating_activities": "",
"net_cash_flows_from_used_in_investing_activities": "-18811201",
"interest_paid": "4072277.0",
"other_adjustments_for_which_cash_effects": "-2687560.0",
"cash_flows_from_used_in_financing_activities": "",
"cash_flows_from_used_in_investing_activities": "",
"net_cash_flows_from_used_in_operations": "6358863.0",
"adjustments_for_finance_costs": "0.0",
"net_cash_flows_from_used_in_financing_activities": "26927723",
"other_payment_classified_as_financing_activity": "0.0",
"other_proceeds_classified_as_investing_activity": "-17659367",
"net_increase_decrease_in_cash_and_cash_equivalents": "520403.0",
"other_inflows_outflows_of_cash_movement_in_deposits_effect_of_changes_in_exchange_rates": "0.0",
"proceeds_from_borrowings": "31000000",
"total_adjustments_to_profit_loss": "2602330.0",
"other_adjustments_for_non_cash_items": "1650732.0",
"other_payment_classified_as_investing_activity": "0.0",
"purchase_of_tangible_assets": "2991823.0",
"adjustments_for_depreciation_and_amortisation_expense": "3639158.0",
"other_inflows_outflows_of_cash": "2902837.0",
"proceeds_from_sales_of_tangible_assets": "0.0",
"repayments_of_borrowings": "0.0",
"profit_before_extraordinary_items_and_tax": "-16857819",
"interest_received": "1839989.0"
},
{
"adjustments_for_working_capital": "-33688932",
"net_cash_flows_from_used_in_operating_activities": "-129491768",
"year": "31-Mar-2020",
"other_proceeds_classified_as_financing_activity": "500000000",
"cash_flows_from_used_in_operating_activities": "",
"net_cash_flows_from_used_in_investing_activities": "-101058646",
"interest_paid": "3628578.0",
"other_adjustments_for_which_cash_effects": "1865779.0",
"cash_flows_from_used_in_financing_activities": "",
"cash_flows_from_used_in_investing_activities": "",
"net_cash_flows_from_used_in_operations": "-22434660",
"adjustments_for_finance_costs": "0.0",
"net_cash_flows_from_used_in_financing_activities": "441379422",
"other_payment_classified_as_financing_activity": "0.0",
"other_proceeds_classified_as_investing_activity": "-7036870.0",
"net_increase_decrease_in_cash_and_cash_equivalents": "210829008",
"other_inflows_outflows_of_cash_movement_in_deposits_effect_of_changes_in_exchange_rates": "0.0",
"proceeds_from_borrowings": "0.0",
"total_adjustments_to_profit_loss": "11254272",
"other_adjustments_for_non_cash_items": "5563538.0",
"other_payment_classified_as_investing_activity": "0.0",
"purchase_of_tangible_assets": "111210165",
"adjustments_for_depreciation_and_amortisation_expense": "3824955.0",
"other_inflows_outflows_of_cash": "-15933971",
"proceeds_from_sales_of_tangible_assets": "0.0",
"repayments_of_borrowings": "54992000",
"profit_before_extraordinary_items_and_tax": "-91123137",
"interest_received": "17188389"
},
{
"adjustments_for_working_capital": "-62867066",
"net_cash_flows_from_used_in_operating_activities": "-208819676",
"year": "31-Mar-2021",
"other_proceeds_classified_as_financing_activity": "0.0",
"cash_flows_from_used_in_operating_activities": "",
"net_cash_flows_from_used_in_investing_activities": "-151588853",
"interest_paid": "3550783.0",
"other_adjustments_for_which_cash_effects": "-8022842.0",
"cash_flows_from_used_in_financing_activities": "",
"cash_flows_from_used_in_investing_activities": "",
"net_cash_flows_from_used_in_operations": "-54334595",
"adjustments_for_finance_costs": "0.0",
"net_cash_flows_from_used_in_financing_activities": "318164818",
"other_payment_classified_as_financing_activity": "0.0",
"other_proceeds_classified_as_investing_activity": "-42978000",
"net_increase_decrease_in_cash_and_cash_equivalents": "-42243711",
"other_inflows_outflows_of_cash_movement_in_deposits_effect_of_changes_in_exchange_rates": "0.0",
"proceeds_from_borrowings": "321715601",
"total_adjustments_to_profit_loss": "8532471.0",
"other_adjustments_for_non_cash_items": "9367280.0",
"other_payment_classified_as_investing_activity": "0.0",
"purchase_of_tangible_assets": "111844667",
"adjustments_for_depreciation_and_amortisation_expense": "7188033.0",
"other_inflows_outflows_of_cash": "864137.0",
"proceeds_from_sales_of_tangible_assets": "0.0",
"repayments_of_borrowings": "0.0",
"profit_before_extraordinary_items_and_tax": "-155349218",
"interest_received": "3233814.0"
}
],
"business_facts": {
"class_of_company": "Private Limited",
"nic_code_description": "Wholesale of textiles, fabrics, yarn, household linen, articles of clothing, floor coverings and tapestry, sports clothes",
"company_website": "Not Found",
"company_email": "info@chemtexind.com",
"company_contact_details": "+919824087012",
"nic_code": "46411",
"company_address": "Plot No 277/278 GIDC Industrial Estate Odhav, Ahmedabad – 382415, Gujarat, India",
"company_other_comment": "-",
"paid_up_capital": "100000",
"date_of_balance_sheet": "31-Mar-2021",
"date_of_incorporation": "05-Sep-2003",
"authorized_capital": "500000.0",
"company_name": "Chemtex Materials Private Limited",
"listing_status": "Not Applicable",
"company_activity": "The company is engaged in trading of cotton & yarn",
"company_status": "Active",
"date_of_last_annual_general_meeting": "30-Nov-2021",
"age_of_company": "19.0",
"country_currency": "INR"
},
"credit_limit_recommendation": {
"rubix_credit_limit_rationale": "The limits have been arrived at by modeling of the Cash flow of the customer to arrive at the cash flow pool available to pay its vendors. \n\nWe recomend you to share your transaction history with the company to add accuracy of the credit limit setting model in the context of your specific business with the subject company. Discounting based on Rubix Risk Score to factor in the stability of monthly cash flows.",
"rubix_credit_limit_recommendation": "18.3",
"rubix_credit_days_recommendation": "24"
},
"auditor_details": [
{
"membership_number_of_auditor": "088926",
"name_of_audit_firm": "Singhi & Co.",
"category_of_auditor": "Auditors firm",
"date_of_signing_audit_report_by_auditor": "2021-05-28",
"whether_auditor_qualified_report": "false",
"email_of_auditor": "NA",
"permanent_account_number_of_auditor": "AASFS9578D",
"date_of_appointment_to_of_auditor": "NA",
"caro_applicable": "true",
"year_auditor_details": "2021.0",
"firms_registration_number_of_audit_firm": "302049E",
"date_of_signing_of_balance_sheet_by_auditor": "2021-05-28",
"name_of_auditor_signing_report": "BIMAL KUMAR SIPANI",
"address_of_auditor": "WORLD TRADE TOWER, 17TH FLOOR, UNIT NO 1704 SECTOR 16 DND FLYWAY, NOIDA -UP-201301",
"date_of_appointment_from_of_auditor": "NA"
},
{
"membership_number_of_auditor": "088926",
"name_of_audit_firm": "SINGHI & CO.",
"category_of_auditor": "Auditors firm",
"date_of_signing_audit_report_by_auditor": "2020-06-29",
"whether_auditor_qualified_report": "false",
"email_of_auditor": "NA",
"permanent_account_number_of_auditor": "AASFS9578D",
"date_of_appointment_to_of_auditor": "NA",
"caro_applicable": "true",
"year_auditor_details": "2020.0",
"firms_registration_number_of_audit_firm": "302049E",
"date_of_signing_of_balance_sheet_by_auditor": "2020-06-29",
"name_of_auditor_signing_report": "Bimal Kumar Sipani",
"address_of_auditor": "WORLD TRADE TOWER, 17TH FLOOR, UNIT NO 1704 SECTOR 16 DND FLYWAY, NOIDA -UP-201301",
"date_of_appointment_from_of_auditor": "NA"
}
],
"profit_loss_account_in_crores": [
{
"profit_after_tax_extraordinary_items_crores": "-1.6857819000000005",
"direct_expenditure_crores": "6.0735251",
"extraordinary_items_crores": "0.0",
"year": "FY2019",
"interest_crores": "0.420907",
"gross_margin_crores": "0.9107315999999992",
"sales_general_and_administrative_crores": "2.4425334999999997",
"ebitda_crores": "-1.5318019000000005",
"revenue_crores": "6.9699858",
"other_income_crores": "0.6308428",
"ebit_crores": "-1.2648749000000006",
"profit_before_tax_and_extraordinary_items_crores": "-1.6857819000000005",
"tax_provision_crores": "0.0",
"other_operating_income_crores": "0.0142709",
"other_expenses_crores": "0.0",
"depreciation_crores": "0.3639158"
},
{
"profit_after_tax_extraordinary_items_crores": "-9.1123137",
"direct_expenditure_crores": "5.6455412",
"extraordinary_items_crores": "0.0",
"year": "FY2020",
"interest_crores": "0.5969513",
"gross_margin_crores": "0.2993325000000002",
"sales_general_and_administrative_crores": "10.2508036",
"ebitda_crores": "-9.9514711",
"revenue_crores": "5.9435617",
"other_income_crores": "1.8186042",
"ebit_crores": "-8.515362399999999",
"profit_before_tax_and_extraordinary_items_crores": "-9.1123137",
"tax_provision_crores": "0.0",
"other_operating_income_crores": "0.001312",
"other_expenses_crores": "0.0",
"depreciation_crores": "0.3824955"
},
{
"profit_after_tax_extraordinary_items_crores": "-15.534921800000003",
"direct_expenditure_crores": "6.5317985",
"extraordinary_items_crores": "0.0",
"year": "FY2021",
"interest_crores": "0.518247",
"gross_margin_crores": "-4.5535274999999995",
"sales_general_and_administrative_crores": "11.297873300000001",
"ebitda_crores": "-15.8514008",
"revenue_crores": "1.971508",
"other_income_crores": "1.5535293",
"ebit_crores": "-15.016674800000002",
"profit_before_tax_and_extraordinary_items_crores": "-15.534921800000003",
"tax_provision_crores": "0.0",
"other_operating_income_crores": "0.006763",
"other_expenses_crores": "0.0",
"depreciation_crores": "0.7188033"
}
],
"subsdiary_information": [
{
"profit_before_tax_of_subsidiary": "63600000",
"subsidiary_cin": "U10100MH1930PLC001612",
"subsidiary_country": "India",
"total_assets_of_subsidiary": "855700000",
"turnover_of_subsidiary": "0",
"percentage_shareholding": "1",
"year_subsidiary_info": "2019.0",
"total_liabilities_of_subsidiary": "39100000",
"subsidiary_name": "ACC MINERAL RESOURCES LIMTED"
},
{
"profit_before_tax_of_subsidiary": "31800000",
"subsidiary_cin": "U99999MH1992PLC066679",
"subsidiary_country": "India",
"total_assets_of_subsidiary": "692700000",
"turnover_of_subsidiary": "187800000",
"percentage_shareholding": "0.9465",
"year_subsidiary_info": "2019.0",
"total_liabilities_of_subsidiary": "115300000",
"subsidiary_name": "BulK Cement Corporation (India) Limited"
},
{
"profit_before_tax_of_subsidiary": "-4800000",
"subsidiary_cin": "U14219RJ1976PLC001697",
"subsidiary_country": "India",
"total_assets_of_subsidiary": "6600000",
"turnover_of_subsidiary": "0",
"percentage_shareholding": "1",
"year_subsidiary_info": "2019.0",
"total_liabilities_of_subsidiary": "26500000",
"subsidiary_name": "LUCKY MINMAT LTD"
},
{
"profit_before_tax_of_subsidiary": "-3900000",
"subsidiary_cin": "U26944RJ1981PTC002227",
"subsidiary_country": "India",
"total_assets_of_subsidiary": "20300000",
"turnover_of_subsidiary": "0",
"percentage_shareholding": "1",
"year_subsidiary_info": "2019.0",
"total_liabilities_of_subsidiary": "19700000",
"subsidiary_name": "NATIONAL LIME STONE COMPANY PRIVATE LIMITED"
},
{
"profit_before_tax_of_subsidiary": "500000",
"subsidiary_cin": "U14109MP1992PTC007264",
"subsidiary_country": "India",
"total_assets_of_subsidiary": "18600000",
"turnover_of_subsidiary": "36300000",
"percentage_shareholding": "1",
"year_subsidiary_info": "2019.0",
"total_liabilities_of_subsidiary": "22100000",
"subsidiary_name": "SINGHANIA MINERALS PVT LTD"
},
{
"profit_before_tax_of_subsidiary": "100000",
"subsidiary_cin": "U10100MH1930PLC001612",
"subsidiary_country": "India",
"total_assets_of_subsidiary": "884000000",
"turnover_of_subsidiary": "29100000",
"percentage_shareholding": "1",
"year_subsidiary_info": "2020.0",
"total_liabilities_of_subsidiary": "38400000",
"subsidiary_name": "ACC MINERAL RESOURCES LIMTED"
},
{
"profit_before_tax_of_subsidiary": "5000000",
"subsidiary_cin": "U99999MH1992PLC066679",
"subsidiary_country": "India",
"total_assets_of_subsidiary": "683000000",
"turnover_of_subsidiary": "20800000",
"percentage_shareholding": "0.9465",
"year_subsidiary_info": "2020.0",
"total_liabilities_of_subsidiary": "89800000",
"subsidiary_name": "BulK Cement Corporation (India) Limited"
},
{
"profit_before_tax_of_subsidiary": "0",
"subsidiary_cin": "U14219RJ1976PLC001697",
"subsidiary_country": "India",
"total_assets_of_subsidiary": "6500000",
"turnover_of_subsidiary": "5000000",
"percentage_shareholding": "1",
"year_subsidiary_info": "2020.0",
"total_liabilities_of_subsidiary": "31400000",
"subsidiary_name": "LUCKY MINMAT LTD"
},
{
"profit_before_tax_of_subsidiary": "0",
"subsidiary_cin": "U26944RJ1981PTC002227",
"subsidiary_country": "India",
"total_assets_of_subsidiary": "0",
"turnover_of_subsidiary": "16400000",
"percentage_shareholding": "1",
"year_subsidiary_info": "2020.0",
"total_liabilities_of_subsidiary": "0",
"subsidiary_name": "NATIONAL LIME STONE COMPANY PRIVATE LIMITED"
},
{
"profit_before_tax_of_subsidiary": "0",
"subsidiary_cin": "U14109MP1992PTC007264",
"subsidiary_country": "India",
"total_assets_of_subsidiary": "14000000",
"turnover_of_subsidiary": "6100000",
"percentage_shareholding": "1",
"year_subsidiary_info": "2020.0",
"total_liabilities_of_subsidiary": "23600000",
"subsidiary_name": "SINGHANIA MINERALS PVT LTD"
},
{
"profit_before_tax_of_subsidiary": "-110800000",
"subsidiary_cin": "U10100MH1930PLC001612",
"subsidiary_country": "India",
"total_assets_of_subsidiary": "748200000",
"turnover_of_subsidiary": "0",
"percentage_shareholding": "1",
"year_subsidiary_info": "2017.0",
"total_liabilities_of_subsidiary": "44200000",
"subsidiary_name": "ACC MINERAL RESOURCES LIMTED"
},
{
"profit_before_tax_of_subsidiary": "28800000",
"subsidiary_cin": "U99999MH1992PLC066679",
"subsidiary_country": "India",
"total_assets_of_subsidiary": "691600000",
"turnover_of_subsidiary": "172700000",
"percentage_shareholding": "0.9465",
"year_subsidiary_info": "2017.0",
"total_liabilities_of_subsidiary": "166100000",
"subsidiary_name": "BulK Cement Corporation (India) Limited"
},
{
"profit_before_tax_of_subsidiary": "-4700000",
"subsidiary_cin": "U14219RJ1976PLC001697",
"subsidiary_country": "India",
"total_assets_of_subsidiary": "6300000",
"turnover_of_subsidiary": "0",
"percentage_shareholding": "1",
"year_subsidiary_info": "2017.0",
"total_liabilities_of_subsidiary": "16500000",
"subsidiary_name": "LUCKY MINMAT LTD"
},
{
"profit_before_tax_of_subsidiary": "-1900000",
"subsidiary_cin": "U26944RJ1981PTC002227",
"subsidiary_country": "India",
"total_assets_of_subsidiary": "17900000",
"turnover_of_subsidiary": "0",
"percentage_shareholding": "1",
"year_subsidiary_info": "2017.0",
"total_liabilities_of_subsidiary": "11100000",
"subsidiary_name": "NATIONAL LIME STONE COMPANY PRIVATE LIMITED"
},
{
"profit_before_tax_of_subsidiary": "-7500000",
"subsidiary_cin": "U14109MP1992PTC007264",
"subsidiary_country": "India",
"total_assets_of_subsidiary": "13800000",
"turnover_of_subsidiary": "24800000",
"percentage_shareholding": "1",
"year_subsidiary_info": "2017.0",
"total_liabilities_of_subsidiary": "18200000",
"subsidiary_name": "SINGHANIA MINERALS PVT LTD"
}
],
"index_of_charges": [
{
"charge_holder_name": "CANARA BANK",
"charge_serial_no": "1",
"charge_id": "90061846",
"charge_date_of_modification": "05-Feb-1997",
"charge_date_of_creation": "06-Dec-1999",
"charge_srn": "Y10141941",
"charge_amount": "600000.0"
},
{
"charge_holder_name": "ICICI LIMITED",
"charge_serial_no": "2",
"charge_id": "90061781",
"charge_date_of_modification": "-",
"charge_date_of_creation": "24-Sep-1999",
"charge_srn": "Y10141876",
"charge_amount": "115000000.0"
},
{
"charge_holder_name": "ICICI LIMITED",
"charge_serial_no": "3",
"charge_id": "90061706",
"charge_date_of_modification": "24-Sep-1999",
"charge_date_of_creation": "07-Jun-1999",
"charge_srn": "Y10141801",
"charge_amount": "160000000.0"
},
{
"charge_holder_name": "SCICI LIMITED",
"charge_serial_no": "4",
"charge_id": "90041586",
"charge_date_of_modification": "08-May-1997",
"charge_date_of_creation": "22-Dec-1995",
"charge_srn": "Y10121681",
"charge_amount": "10600000.0"
},
{
"charge_holder_name": "THE INDUSTRIAL CREDIT AND INVESTMENT CORP. OF INDIA LTD.",
"charge_serial_no": "5",
"charge_id": "90060695",
"charge_date_of_modification": "-",
"charge_date_of_creation": "26-Jun-1995",
"charge_srn": "Y10140790",
"charge_amount": "10000000.0"
},
{
"charge_holder_name": "Canara Bank",
"charge_serial_no": "6",
"charge_id": "90041401",
"charge_date_of_modification": "14-Aug-2013",
"charge_date_of_creation": "16-Feb-1995",
"charge_srn": "B86602463",
"charge_amount": "975000000.0"
},
{
"charge_holder_name": "THE INDUSTRIAL CREDIT AND INVESTMENT CORP. OF INDIA LTD.",
"charge_serial_no": "7",
"charge_id": "90041353",
"charge_date_of_modification": "08-May-1997",
"charge_date_of_creation": "22-Dec-1994",
"charge_srn": "Y10121448",
"charge_amount": "632944.0"
}
],
"rubix_scorecard": {
"computed_risk_grade": "Rx5",
"grade_description": "Above Average Counterparty Risk",
"computed_risk_level": "MEDIUM",
"rubix_risk_score": 58
},
"revenue_from_operation": [
{
"export_revenue_services": "0.0",
"total_domestic_revenue": "0.0",
"export_sale_traded_goods": "0.0",
"year": "31-Mar-2019",
"total_revenue": "0.0",
"domestic_sale_traded_goods": "38584306",
"total_export_revenue": "0.0",
"export_sale_manufactured_goods": "0.0",
"domestic_sale_of_manufactured_goods": "15567151",
"domestic_revenue_services": "15548401",
"total_revenue_from_services": "0.0"
},
{
"export_revenue_services": "0.0",
"total_domestic_revenue": "0.0",
"export_sale_traded_goods": "0.0",
"year": "31-Mar-2020",
"total_revenue": "0.0",
"domestic_sale_traded_goods": "29180310",
"total_export_revenue": "0.0",
"export_sale_manufactured_goods": "0.0",
"domestic_sale_of_manufactured_goods": "7161747.0",
"domestic_revenue_services": "23093560",
"total_revenue_from_services": "0.0"
},
{
"export_revenue_services": "0.0",
"total_domestic_revenue": "0.0",
"export_sale_traded_goods": "0.0",
"year": "31-Mar-2021",
"total_revenue": "0.0",
"domestic_sale_traded_goods": "6783775.0",
"total_export_revenue": "0.0",
"export_sale_manufactured_goods": "0.0",
"domestic_sale_of_manufactured_goods": "4770921.0",
"domestic_revenue_services": "8160384.0",
"total_revenue_from_services": "0.0"
}
],
"company_id_check": {
"pf_company_name": "Not Found",
"class_of_company": "Private",
"gst_numbers": "24AACCC6582E1ZT (Active)",
"pf_company_date_of_coverage": "Not Found",
"mca_company_cin_number": "U24231GJ2003PTC042866",
"mca_company_address": "PLOT NO 277/278 GIDC INDUSTRIAL ESTATE ODHAV AHMEDABAD GJ 382415 IN",
"mca_company_active_compliant_status": "ACTIVE compliant",
"pf_company_status": "Not Found",
"pf_numbers": "Not Found",
"pf_company_address": "Not Found",
"total_active_gst_numbers": "1.0",
"gst_company_address": "44, 4TH FLOOR, JMC HOUSE, NEAR PARIMAL GARDEN, AMBAWADI, AHMEDABAD, , Gujarat, 380006",
"gst_company_status": "Active",
"company_status": "Active",
"mca_company_name": "CHEMTEX MATERIALS PRIVATE LIMITED",
"mca_company_date_of_incorporation": "05-Sep-2003",
"gst_company_date_of_registration": "01-Jul-2017",
"company_pan_number": "AACCC6582E",
"gst_company_name": "CHEMTEX MATERIALS PRIVATE LIMITED"
},
"legal_check": {
"fir_petitioner": "0",
"supreme_court_pending": "0",
"consumer_court_disposed": "0",
"defaulters_petitioner": "0",
"ibc_pending": "0",
"e_court_petitioner": "0",
"arrested_respondent": "0",
"defaulters_disposed": "0",
"absconders_petitioner": "0",
"most_wanted_respondent": "0",
"high_court_total": "0",
"arrested_disposed": "0",
"mca_disposed": "0",
"high_court_petitioner": "0",
"arrested_total": "0",
"consumer_court_pending": "0",
"consumer_court_petitioner": "0",
"e_court_pending": "0",
"tribunals_disposed": "0",
"tribunals_respondent": "0",
"most_wanted_pending": "0",
"defaulters_respondent": "0",
"defaulters_pending": "0",
"ibc_total": "0",
"e_court_disposed": "0",
"consumer_court_respondent": "0",
"supreme_court_disposed": "0",
"fir_respondent": "0",
"mca_total": "0",
"absconders_pending": "0",
"supreme_court_respondent": "0",
"ibc_respondent": "0",
"high_court_disposed": "0",
"fir_total": "0",
"e_court_total": "0",
"arrested_pending": "0",
"mca_petitioner": "0",
"ibc_petitioner": "0",
"tribunals_petitioner": "0",
"high_court_pending": "0",
"supreme_court_petitioner": "0",
"tribunals_pending": "0",
"high_court_respondent": "0",
"supreme_court_total": "0",
"defaulters_total": "0",
"absconders_total": "0",
"arrested_petitioner": "0",
"consumer_court_total": "0",
"absconders_respondent": "0",
"tribunals_total": "0",
"mca_respondent": "0",
"ibc_disposed": "0",
"legal_check_link": "NA",
"most_wanted_petitioner": "0",
"mca_pending": "0",
"e_court_respondent": "0",
"most_wanted_total": "0",
"most_wanted_disposed": "0",
"fir_disposed": "0",
"fir_pending": "0",
"absconders_disposed": "0"
},
"profit_loss_account": [
{
"profit_after_tax": "-16857819",
"other_income": "6308428.0",
"profit_before_tax_extraordinary_items": "-16857819",
"year": "FY2019",
"ebit": "-12648749",
"ebitda": "-15318019",
"selling_expenses": "752699.0",
"gross_profit_loss": "9107316.0",
"salaries_and_wages": "31657675",
"revenue": "69699858",
"other_operating_income": "142709.0",
"other_overhead_expenses": "0.0",
"direct_expenditure": "60735251",
"raw_material_expenses_stores_packaging_etc": "28137322",
"power_and_fuel_expenses": "608160.0",
"interest": "4209070.0",
"general_administration_expenses": "23672636",
"number_of_months": "12.0",
"other_operating_expenses": "332094.0",
"extraordinary_items": "0.0",
"depreciation": "3639158.0",
"total_tax_provision": "0.0"
},
{
"profit_after_tax": "-91123137",
"other_income": "18186042",
"profit_before_tax_extraordinary_items": "-91123137",
"year": "FY2020",
"ebit": "-85153624",
"ebitda": "-99514711",
"selling_expenses": "264344.0",
"gross_profit_loss": "2993325.0",
"salaries_and_wages": "36255914",
"revenue": "59435617",
"other_operating_income": "13120.0",
"other_overhead_expenses": "0.0",
"direct_expenditure": "56455412",
"raw_material_expenses_stores_packaging_etc": "19209654",
"power_and_fuel_expenses": "680015.0",
"interest": "5969513.0",
"general_administration_expenses": "102243692",
"number_of_months": "12.0",
"other_operating_expenses": "309829.0",
"extraordinary_items": "0.0",
"depreciation": "3824955.0",
"total_tax_provision": "0.0"
},
{
"profit_after_tax": "-155349218",
"other_income": "15535293",
"profit_before_tax_extraordinary_items": "-155349218",
"year": "FY2021",
"ebit": "-150166748",
"ebitda": "-158514008",
"selling_expenses": "160361.0",
"gross_profit_loss": "-45535275",
"salaries_and_wages": "49109670",
"revenue": "19715080",
"other_operating_income": "67630.0",
"other_overhead_expenses": "0.0",
"direct_expenditure": "65317985",
"raw_material_expenses_stores_packaging_etc": "12568712",
"power_and_fuel_expenses": "2197176.0",
"interest": "5182470.0",
"general_administration_expenses": "112818372",
"number_of_months": "12.0",
"other_operating_expenses": "1442427.0",
"extraordinary_items": "0.0",
"depreciation": "7188033.0",
"total_tax_provision": "0.0"
}
],
"ownership_details": [
{
"period_ownership_detail": "",
"name_of_shareholder_ownership_detail": "",
"number_of_shares_ownership_detail": "",
"shareholding_percentage_ownership_detail": "",
"link_shareholding_ownership_detail": ""
}
],
"other_directorship": [
{
"director_company_cin": "AAR-6815",
"director_name": "TAPAN CHANDRAKANT SHAH",
"director_company_name": "ECOSYS MATERIALS LLP",
"director_date_of_appointment": "22-Jan-2020"
},
{
"director_company_cin": "AAR-6815",
"director_name": "SNEHAL CHANDRAKANT SHAH",
"director_company_name": "ECOSYS MATERIALS LLP",
"director_date_of_appointment": "22-Jan-2020"
}
],
"solvency_ratio": [
{
"year": "FY2019",
"current_ratio": "0.8488719746619715",
"cash_ratio": "0.5168630393831908",
"quick_ratio": "0.7309666955903569"
},
{
"year": "FY2020",
"current_ratio": "3.693715035145635",
"cash_ratio": "2.754209320942167",
"quick_ratio": "3.5097646802408904"
},
{
"year": "FY2021",
"current_ratio": "1.874219350083968",
"cash_ratio": "1.033092232637459",
"quick_ratio": "1.5023844918867324"
}
],
"estimated_profit_and_loss_in_lacs": [
{
"estimated_overhead_expenses": "5.0",
"estimated_revenue": "85.0",
"year": "FY18",
"estimated_profit_before_tax": "3.0",
"estimated_tax_provision": "0.0",
"estimated_ebitda": "3.0",
"estimated_interest": "0.0",
"estimated_gross_margin": "8.0",
"estimated_direct_expenditure": "77.0",
"estimated_profit_after_tax": "3.0"
}
],
"current_directorship": [
{
"current_kmp_name": "TAPAN CHANDRAKANT SHAH",
"current_kmp_din_pan": "00999346",
"current_kmp_date_of_appointment": "05-Sep-2003",
"current_kmp_designation": "Director"
},
{
"current_kmp_name": "CHANDRAKANT TEJPAL SHAH",
"current_kmp_din_pan": "00999423",
"current_kmp_date_of_appointment": "05-Sep-2003",
"current_kmp_designation": "Director"
},
{
"current_kmp_name": "DIPTIBEN SNEHALBHAI SHAH",
"current_kmp_din_pan": "00999734",
"current_kmp_date_of_appointment": "05-Sep-2003",
"current_kmp_designation": "Director"
},
{
"current_kmp_name": "MINAXIBEN CHANDRAKANTBHAI SHAH",
"current_kmp_din_pan": "00999826",
"current_kmp_date_of_appointment": "05-Sep-2003",
"current_kmp_designation": "Director"
},
{
"current_kmp_name": "SNEHAL CHANDRAKANT SHAH",
"current_kmp_din_pan": "01152138",
"current_kmp_date_of_appointment": "05-Sep-2003",
"current_kmp_designation": "Director"
}
],
"shareholding_pattern": [
{
"name_of_shareholder": "Mr. Tapan Chandrakant Shah",
"number_of_shares": "3500.0",
"shareholding_percentage": "0.35",
"shareholding_year": "2019.0"
},
{
"name_of_shareholder": "Ms. Snehal Chandrakant Shah",
"number_of_shares": "3500.0",
"shareholding_percentage": "0.35",
"shareholding_year": "2019.0"
},
{
"name_of_shareholder": "Others",
"number_of_shares": "3000.0",
"shareholding_percentage": "0.3",
"shareholding_year": "2019.0"
},
{
"name_of_shareholder": "Mr. Tapan Chandrakant Shah",
"number_of_shares": "3500.0",
"shareholding_percentage": "0.35",
"shareholding_year": "2020.0"
},
{
"name_of_shareholder": "Ms. Snehal Chandrakant Shah",
"number_of_shares": "3500.0",
"shareholding_percentage": "0.35",
"shareholding_year": "2020.0"
},
{
"name_of_shareholder": "Others",
"number_of_shares": "3000.0",
"shareholding_percentage": "0.3",
"shareholding_year": "2020.0"
},
{
"name_of_shareholder": "Mr. Tapan Chandrakant Shah",
"number_of_shares": "3500.0",
"shareholding_percentage": "0.35",
"shareholding_year": "2021.0"
},
{
"name_of_shareholder": "Ms. Snehal Chandrakant Shah",
"number_of_shares": "3500.0",
"shareholding_percentage": "0.35",
"shareholding_year": "2021.0"
},
{
"name_of_shareholder": "Others",
"number_of_shares": "3000.0",
"shareholding_percentage": "0.3",
"shareholding_year": "2021.0"
}
],
"related_party_details": [
{
"related_party_details_relationship": "Enterprises which are owned, or have significant influence of or are partners with Key management personnel and their relatives",
"related_party_details_year": "2020.0",
"related_party_details_name": "RAMA UDYOG PRIVATE LIMITED"
},
{
"related_party_details_relationship": "Enterprises which are owned, or have significant influence of or are partners with Key management personnel and their relatives",
"related_party_details_year": "2020.0",
"related_party_details_name": "RKSK STEEL INDIA PRIVATE LIMITED"
},
{
"related_party_details_relationship": "Key Management Personnel",
"related_party_details_year": "2020.0",
"related_party_details_name": "Sanjay Goyal"
},
{
"related_party_details_relationship": "Relatives of Key management personnel",
"related_party_details_year": "2020.0",
"related_party_details_name": "Uma Goyal"
},
{
"related_party_details_relationship": "Enterprises which are owned, or have significant influence of or are partners with Key management personnel and their relatives",
"related_party_details_year": "2021.0",
"related_party_details_name": "RAMA UDYOG PRIVATE LIMITED"
},
{
"related_party_details_relationship": "Enterprises which are owned, or have significant influence of or are partners with Key management personnel and their relatives",
"related_party_details_year": "2021.0",
"related_party_details_name": "RKSK STEEL INDIA PRIVATE LIMITED"
},
{
"related_party_details_relationship": "Key Management Personnel",
"related_party_details_year": "2021.0",
"related_party_details_name": "Sanjay Goyal"
},
{
"related_party_details_relationship": "Relatives of Key management personnel",
"related_party_details_year": "2021.0",
"related_party_details_name": "Uma Goyal"
},
{
"related_party_details_relationship": "Key Management Personnel",
"related_party_details_year": "2019.0",
"related_party_details_name": "Sanjay Goyal"
},
{
"related_party_details_relationship": "Key Management Personnel",
"related_party_details_year": "2019.0",
"related_party_details_name": "Suresh Kumar Goyal"
},
{
"related_party_details_relationship": "Relatives of Key management personnel",
"related_party_details_year": "2019.0",
"related_party_details_name": "Uma Goyal"
},
{
"related_party_details_relationship": "Enterprises which are owned, or have significant influence of or are partners with Key management personnel and their relatives",
"related_party_details_year": "2019.0",
"related_party_details_name": "CHETALI TRADING PVT LTD"
},
{
"related_party_details_relationship": "Enterprises which are owned, or have significant influence of or are partners with Key management personnel and their relatives",
"related_party_details_year": "2019.0",
"related_party_details_name": "RAMA INFRA SOLUTION PRIVATE LIMITED"
},
{
"related_party_details_relationship": "Enterprises which are owned, or have significant influence of or are partners with Key management personnel and their relatives",
"related_party_details_year": "2019.0",
"related_party_details_name": "RAMA UDYOG PRIVATE LIMITED"
},
{
"related_party_details_relationship": "Enterprises which are owned, or have significant influence of or are partners with Key management personnel and their relatives",
"related_party_details_year": "2019.0",
"related_party_details_name": "Rama Farms"
},
{
"related_party_details_relationship": "Enterprises which are owned, or have significant influence of or are partners with Key management personnel and their relatives",
"related_party_details_year": "2019.0",
"related_party_details_name": "RKSK Steel India Private Limited"
},
{
"related_party_details_relationship": "Enterprises which are owned, or have significant influence of or are partners with Key management personnel and their relatives",
"related_party_details_year": "2019.0",
"related_party_details_name": "Rama Safari LLP"
}
],
"profitability_ratios": [
{
"gross_margin_growth": "",
"ebitda_growth": "",
"return_on_total_assets": "-0.18297040412711338",
"year": "FY2019",
"pat_growth": "",
"ebitda_percentage": "-0.21977116510050854",
"return_on_equity": "0.35930306648147875",
"pbt_percentage": "-0.24186303220302113",
"gross_margin_percentage": "0.13066477122521541",
"pbt_growth": "",
"pat_percentage": "-0.24186303220302113",
"sales_growth": ""
},
{
"gross_margin_growth": "-0.6713274251162472",
"ebitda_growth": "5.4965783760941935",
"return_on_total_assets": "-0.17734571393715176",
"year": "FY2020",
"pat_growth": "4.405393010804067",
"ebitda_percentage": "-1.6743278865936564",
"return_on_equity": "-0.2517500543528774",
"pbt_percentage": "-1.5331402549417465",
"gross_margin_percentage": "0.05036247878103125",
"pbt_growth": "4.405393010804067",
"pat_percentage": "-1.5331402549417465",
"sales_growth": "-0.14726344205751463"
},
{
"gross_margin_growth": "-16.21227230588058",
"ebitda_growth": "0.5928701033960697",
"return_on_total_assets": "-0.19923301686733166",
"year": "FY2021",
"pat_growth": "0.7048273700234882",
"ebitda_percentage": "-8.04024168301625",
"return_on_equity": "-0.7518976035666117",
"pbt_percentage": "-7.879715324513012",
"gross_margin_percentage": "-2.3096672699273855",
"pbt_growth": "0.7048273700234882",
"pat_percentage": "-7.879715324513012",
"sales_growth": "-0.6682951907439608"
}
]
},
"agency_signature": {
"agency_name": "Rubix Data Sciences Private Limited",
"agency_contact": "+912249744274",
"agency_website": "https://rubixds.com",
"agency_address": "D - 424, Neelkanth Business Park, Vidyavihar (West), Mumbai 400086, India",
"agency_gst": "27AAICR5957Q1ZC",
"agency_email": "info@rubixds.com",
"disclaimer": "https://rubixds.com/rubix-api-service-disclaimer"
}
}
},
"agency_signature": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/agency_signature"
}
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
}
},
"required": [
"message"
]
},
"examples": {
"400": {
"value": {
"message": "Missing required request parameters"
}
}
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/atlas/v1/report/pdf/{reportId}": {
"get": {
"tags": [
"Verification Suite"
],
"summary": "Get Report PDF by report id",
"description": "Returns Rubix risk report pdf on the basis of report id.",
"operationId": "rubix_post_kyc_v1_indian_report_pdf",
"_peer-api": "v1/kyc/indian/report/pdf",
"parameters": [
{
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/parameters/0"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/1"
},
{
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/parameters/2"
},
{
"schema": {
"type": "string"
},
"in": "path",
"name": "reportId",
"description": "Id of the report request given to you in response of corresponding Report POST request.",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
},
"results": {
"type": [
"object",
"null"
],
"properties": {
"message": {
"nullable": true
},
"results": {
"type": "object",
"properties": {
"report_pdf": {
"type": "string"
},
"report_metadata": {
"type": "object",
"properties": {
"company_type": {
"type": "string"
},
"report_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"report_status": {
"type": "string"
},
"report_date": {
"type": "string"
}
}
}
}
},
"agency_signature": {
"type": "object",
"properties": {
"agency_name": {
"type": "string"
},
"agency_contact": {
"type": "string"
},
"agency_website": {
"type": "string"
},
"agency_address": {
"type": "string"
},
"agency_gst": {
"type": "string"
},
"agency_email": {
"type": "string"
},
"disclaimer": {
"type": "string"
}
}
}
},
"example": {
"message": null,
"results": {
"report_pdf": "base 64 report pdf",
"report_metadata": {
"company_type": "CUSTOMER",
"report_id": "30f31c68-bd2f-4f2d-818a-a95cd155e4e6",
"company_name": "Bharat Forge International Limited",
"report_status": "COMPLETED",
"report_date": "18-Jul-2023"
}
},
"agency_signature": {
"agency_name": "Rubix Data Sciences Private Limited",
"agency_contact": "+912249744274",
"agency_website": "https://rubixds.com",
"agency_address": "D - 424, Neelkanth Business Park, Vidyavihar (West), Mumbai 400086, India",
"agency_gst": "27AAICR5957Q1ZC",
"agency_email": "info@rubixds.com",
"disclaimer": "https://rubixds.com/rubix-api-service-disclaimer"
}
}
},
"agency_signature": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/agency_signature"
}
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"X-ATLAS-CALL-ID": {
"$ref": "#/paths/~1atlas~1v1~1gcs~1bulk/post/responses/200/headers/X-ATLAS-CALL-ID"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"$ref": "#/paths/~1atlas~1v1~1mcaInstant/get/responses/200/content/application~1json/schema/properties/message",
"example": null
}
},
"required": [
"message"
]
},
"examples": {
"400": {
"value": {
"message": "Missing required request parameters: [reportId]"
}
}
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/theodore/apis/v1/authtokens": {
"post": {
"tags": [
"Authorization Suite"
],
"summary": "Login by email or mobile",
"description": "Returns a JWT authtoken which can be used to make authenticated calls. Token validity period (in minutes) can be specified using `tokenDurationInMins` in the request body, which is a non-mandatory param. Default token duration, if not specified, is 20 mins. Max duration restricted to 360 mins (6 hours). So if one specifies tokenDurationInMins = 370; the token will be created with expiry of 360 mins. Hard expiry of the session, once a token is issued to the user, is set to 6x of the token duration. For ex, If token duration is of 20 mins, hard expiry will be 120 mins (2 hours). If token duration is of 360 mins, hard expiry will be 2160 mins (36 hours). After hard expiry, tokens cannot be refreshed. User will have to re-authenticate. v1 api ll generate the token without factor number claims in the token payload, thus not disrupting any current functionality/integration but v2 of this api generate the token with factor number (fn) claim in the token payload",
"operationId": "login",
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1theodore~1apis~1v1~1authtokens/put/responses/200/content/application~1json/schema"
}
}
}
},
"400": {
"description": "client request error",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1theodore~1apis~1v1~1logout/post/responses/400/content/application~1json/schema"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1theodore~1apis~1v1~1logout/post/responses/400/content/application~1json/schema"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"handle",
"handleType"
],
"properties": {
"handle": {
"type": "string"
},
"handleType": {
"type": "string",
"enum": [
"email",
"mobile"
],
"example": "email",
"description": "If the handle type is Mobile Number, you are expected to provide mobile number with country code"
},
"password": {
"type": "string",
"example": "password"
},
"otp": {
"type": "string",
"example": "123456",
"description": "You can get the otp through /users/email/otps or /users/mobile/otps"
},
"tokenDurationInMins": {
"type": "integer",
"example": 20,
"description": "This is a non-mandatory field to mention token validity period in minutes. It will be set to 20 mins by default, if not set. Maximum value can be 360 mins."
}
}
}
}
},
"description": "handle is either email-id or mobile number. Either of the password and OTP are mandatory to login"
}
},
"put": {
"tags": [
"Authorization Suite"
],
"summary": "Refresh token",
"description": "Returns a JWT authtoken which can be used to make authenticated calls. If token generated using v1 AuthTokens APIs is used in auth header, the response token will not contain factor number claim & if token generated using v2 AuthTokens APIs is used, the response token will contain factor number(fn) claim.",
"operationId": "refresh_token",
"security": [
{
"BearerAuth": []
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"token": {
"type": "string"
},
"userId": {
"type": "string",
"format": "uuid"
},
"expiry": {
"type": "number",
"description": "This is epoch timestamp in milliseconds"
},
"email": {
"type": "string"
},
"mobile": {
"type": "string",
"nullable": true
},
"givenName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"state": {
"type": "string"
},
"verificationStatus": {
"type": "string",
"enum": [
"None",
"Email",
"Mobile",
"Both"
],
"description": "Indicates if email, mobile or both have been verified through OTP"
},
"passwordLastModified": {
"type": "number",
"nullable": true,
"description": "This is epoch timestamp in milliseconds"
},
"associatedOrgs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"organisation": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"taxIdentifier": {
"type": "string"
},
"taxIdentifierType": {
"type": "string",
"enum": [
"PAN",
"TIN"
],
"example": "PAN"
},
"country": {
"type": "string"
},
"services": {
"type": "array",
"items": {
"type": "object",
"properties": {
"serviceCode": {
"type": "string"
},
"serviceName": {
"type": "string"
}
}
}
}
}
},
"userAccessInfo": {
"type": "object",
"properties": {
"primary": {
"type": "boolean"
},
"admin": {
"type": "boolean"
}
}
}
}
}
},
"timezone": {
"type": "string"
},
"locale": {
"type": "string"
},
"createdOn": {
"type": "number",
"description": "This is epoch timestamp in milliseconds"
},
"lastUpdated": {
"type": "number",
"nullable": true,
"description": "This is epoch timestamp in milliseconds"
}
}
}
}
}
}
}
},
"403": {
"description": "Unauthorized. The token in the header is invalid or expired"
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1theodore~1apis~1v1~1logout/post/responses/400/content/application~1json/schema"
}
}
}
}
}
}
},
"/theodore/apis/v1/users/email/otps": {
"post": {
"tags": [
"Authorization Suite"
],
"summary": "Email OTP generation",
"description": "To generate and send OTP to given email id. This otp can be used for logging in, creating user with the given email id and updating email id.",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "client request error",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1theodore~1apis~1v1~1logout/post/responses/400/content/application~1json/schema"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1theodore~1apis~1v1~1logout/post/responses/400/content/application~1json/schema"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"email": {
"type": "string"
},
"otpPurposeType": {
"type": "string",
"enum": [
"SignupOTP",
"UpdateHandleOTP",
"LoginOTP"
],
"example": "SignupOTP",
"description": "SignupOTP - For user creation with this email ID. UpdateHandleOTP - For updating email id. OTP will be sent to new email id."
}
}
}
}
},
"description": "User needs to provide otpPurposeType, which can have three values: LoginOTP, SignupOTP, UpdateHandleOTP"
}
}
},
"/theodore/apis/v1/users/mobile/otps": {
"post": {
"tags": [
"Authorization Suite"
],
"summary": "Mobile OTP generation",
"description": "To generate and send OTP to given mobile number. This otp can be used for logging in, creating user with the given mobile number and updating mobile number.",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "client request error",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1theodore~1apis~1v1~1logout/post/responses/400/content/application~1json/schema"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1theodore~1apis~1v1~1logout/post/responses/400/content/application~1json/schema"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mobile": {
"type": "string",
"example": "+91-9111111111",
"description": "Mobile number should be provided with country code, Currently Only Indian Mobile Numbers can avail mobile otp service."
},
"otpPurposeType": {
"type": "string",
"enum": [
"SignupOTP",
"UpdateHandleOTP",
"LoginOTP"
],
"example": "SignupOTP",
"description": "SignupOTP - For user creation with this mobile number. UpdateHandleOTP - For updating email id. OTP will be sent to new mobile number."
}
}
}
}
},
"description": "User needs to provide otpPurposeType, which can have three values: LoginOTP, SignupOTP, UpdateHandleOTP"
}
}
},
"/theodore/apis/v1/logout": {
"post": {
"tags": [
"Authorization Suite"
],
"summary": "logout from the application",
"description": "logout from the application",
"operationId": "logout",
"security": [
{
"BearerAuth": []
}
],
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "client request error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "object",
"required": [
"message",
"type"
],
"properties": {
"message": {
"type": "string"
},
"args": {
"type": "object"
},
"type": {
"type": "string",
"example": "ClientError"
}
}
}
},
"example": {
"error": {
"message": "err-issue-with-parameter",
"args": {
"parameter-name": "some-parameter"
}
}
}
}
}
}
},
"403": {
"description": "Unauthorized. The token in the header is invalid or expired"
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1theodore~1apis~1v1~1logout/post/responses/400/content/application~1json/schema"
}
}
}
}
}
}
}
},
"components": {
"securitySchemes": {
"BearerAuth": {
"type": "http",
"scheme": "bearer"
}
}
}
}