GSTIN API · JSON-LD Context

Gstinapi Context

JSON-LD context defining the semantic vocabulary for Gstinapi from GSTIN API.

9 Classes 47 Properties 4 Namespaces
View Context View on GitHub

Namespaces

schema: https://schema.org/
xsd: http://www.w3.org/2001/XMLSchema#
dcterms: http://purl.org/dc/terms/
gstinapi: https://gstinapi.com/schema#

Classes

BulkJobRequest BulkJobEnvelope BulkJob BulkResultRow Outcome TaxpayerProfile TaxpayerEnvelope Pagination Error

Properties

Property Type Container
gstins list
text string
name string
success boolean
job reference
links
job_id string
status string
stopped_reason string
source string
progress
results
credits_used integer
created_at dateTime
started_at dateTime
finished_at dateTime
row integer
input string
gstin string
outcome reference
message string
data
legal_name string
trade_name string
taxpayer_type string
constitution string
registration_date date
cancellation_date date
last_updated_at date
active_years integer
nature_of_business list
jurisdiction
principal_address
additional_address_count integer
e_invoice
filing_counts
derived
taxpayer_data
filing_data list
preference_data list
nc_data
page integer
per_page integer
total integer
last_page integer
has_more boolean
reason string

JSON-LD Document

Raw ↑
{
  "@context": {
    "@vocab": "https://gstinapi.com/schema#",
    "schema": "https://schema.org/",
    "xsd": "http://www.w3.org/2001/XMLSchema#",
    "dcterms": "http://purl.org/dc/terms/",
    "gstinapi": "https://gstinapi.com/schema#",
    "BulkJobRequest": "gstinapi:BulkJobRequest",
    "gstins": {
      "@id": "gstinapi:gstins",
      "@container": "@list"
    },
    "text": {
      "@id": "gstinapi:text",
      "@type": "xsd:string"
    },
    "name": {
      "@id": "gstinapi:name",
      "@type": "xsd:string"
    },
    "BulkJobEnvelope": "gstinapi:BulkJobEnvelope",
    "success": {
      "@id": "gstinapi:success",
      "@type": "xsd:boolean"
    },
    "job": {
      "@id": "gstinapi:job",
      "@type": "@id"
    },
    "links": {
      "@id": "gstinapi:links"
    },
    "BulkJob": "gstinapi:BulkJob",
    "job_id": {
      "@id": "gstinapi:job_id",
      "@type": "xsd:string"
    },
    "status": {
      "@id": "gstinapi:status",
      "@type": "xsd:string"
    },
    "stopped_reason": {
      "@id": "gstinapi:stopped_reason",
      "@type": "xsd:string"
    },
    "source": {
      "@id": "gstinapi:source",
      "@type": "xsd:string"
    },
    "progress": {
      "@id": "gstinapi:progress"
    },
    "results": {
      "@id": "gstinapi:results"
    },
    "credits_used": {
      "@id": "gstinapi:credits_used",
      "@type": "xsd:integer"
    },
    "created_at": {
      "@id": "gstinapi:created_at",
      "@type": "xsd:dateTime"
    },
    "started_at": {
      "@id": "gstinapi:started_at",
      "@type": "xsd:dateTime"
    },
    "finished_at": {
      "@id": "gstinapi:finished_at",
      "@type": "xsd:dateTime"
    },
    "BulkResultRow": "gstinapi:BulkResultRow",
    "row": {
      "@id": "gstinapi:row",
      "@type": "xsd:integer"
    },
    "input": {
      "@id": "gstinapi:input",
      "@type": "xsd:string"
    },
    "gstin": {
      "@id": "gstinapi:gstin",
      "@type": "xsd:string"
    },
    "outcome": {
      "@id": "gstinapi:outcome",
      "@type": "@id"
    },
    "message": {
      "@id": "gstinapi:message",
      "@type": "xsd:string"
    },
    "data": {
      "@id": "gstinapi:data"
    },
    "Outcome": "gstinapi:Outcome",
    "TaxpayerProfile": "gstinapi:TaxpayerProfile",
    "legal_name": {
      "@id": "gstinapi:legal_name",
      "@type": "xsd:string"
    },
    "trade_name": {
      "@id": "gstinapi:trade_name",
      "@type": "xsd:string"
    },
    "taxpayer_type": {
      "@id": "gstinapi:taxpayer_type",
      "@type": "xsd:string"
    },
    "constitution": {
      "@id": "gstinapi:constitution",
      "@type": "xsd:string"
    },
    "registration_date": {
      "@id": "gstinapi:registration_date",
      "@type": "xsd:date"
    },
    "cancellation_date": {
      "@id": "gstinapi:cancellation_date",
      "@type": "xsd:date"
    },
    "last_updated_at": {
      "@id": "gstinapi:last_updated_at",
      "@type": "xsd:date"
    },
    "active_years": {
      "@id": "gstinapi:active_years",
      "@type": "xsd:integer"
    },
    "nature_of_business": {
      "@id": "gstinapi:nature_of_business",
      "@container": "@list"
    },
    "jurisdiction": {
      "@id": "gstinapi:jurisdiction"
    },
    "principal_address": {
      "@id": "gstinapi:principal_address"
    },
    "additional_address_count": {
      "@id": "gstinapi:additional_address_count",
      "@type": "xsd:integer"
    },
    "e_invoice": {
      "@id": "gstinapi:e_invoice"
    },
    "filing_counts": {
      "@id": "gstinapi:filing_counts"
    },
    "derived": {
      "@id": "gstinapi:derived"
    },
    "TaxpayerEnvelope": "gstinapi:TaxpayerEnvelope",
    "taxpayer_data": {
      "@id": "gstinapi:taxpayer_data"
    },
    "filing_data": {
      "@id": "gstinapi:filing_data",
      "@container": "@list"
    },
    "preference_data": {
      "@id": "gstinapi:preference_data",
      "@container": "@list"
    },
    "nc_data": {
      "@id": "gstinapi:nc_data"
    },
    "Pagination": "gstinapi:Pagination",
    "page": {
      "@id": "gstinapi:page",
      "@type": "xsd:integer"
    },
    "per_page": {
      "@id": "gstinapi:per_page",
      "@type": "xsd:integer"
    },
    "total": {
      "@id": "gstinapi:total",
      "@type": "xsd:integer"
    },
    "last_page": {
      "@id": "gstinapi:last_page",
      "@type": "xsd:integer"
    },
    "has_more": {
      "@id": "gstinapi:has_more",
      "@type": "xsd:boolean"
    },
    "Error": "gstinapi:Error",
    "reason": {
      "@id": "gstinapi:reason",
      "@type": "xsd:string"
    }
  },
  "@type": "schema:Dataset",
  "schema:name": "GSTIN API API JSON-LD context",
  "schema:description": "A JSON-LD @context for the objects GSTIN API's own API contract declares: one class per component schema, one property per declared field, typed from the contract. Derived by script (derive-json-ld.py, 2026-10-18) from openapi/gstinapi-openapi.yml.",
  "dcterms:created": "2026-10-18",
  "dcterms:source": [
    "openapi/gstinapi-openapi.yml"
  ]
}