Clarionby TraCartaSign in
Clarion API · v1

Your airline GST data,
straight into your systems.

Pull reconciled lines, airline PDFs and reconciliation reports into your ERP, data warehouse or Excel. Simple REST, JSON responses, one key per person.

REST · JSONBearer keys60 requests / minuteSame access as the key's ownerHosted in India
Terminal
curl "https://clarion.tracarta.com/api/v1/lines?fy=2026-27&per_page=1" \
  -H "Authorization: Bearer $CLARION_KEY"
{
  "total": 295,
  "page": 1,
  "per_page": 1,
  "lines": [{
    "transaction_id": "VX-B99205",
    "airline_name": "Air India",
    "airline_invoice_number": "HR/2627/0009920",
    "total_igst": 304.95,
    "in_gstr2b": true,
    "document_url": "…/api/v1/documents/…"
  }]
}

Introduction

Built for finance teams and their systems

The Clarion API gives your systems the same data you see in Clarion: every reconciled airline line, the airline invoices and credit notes behind them, and TraCarta's reconciliation reports.

It's read-only and safe by design. A key acts as the person who made it and sees exactly what they can see: the same companies, GSTINs and columns. Nothing more.

Reconciled lines
Every column of My Data, filtered your way.
Airline PDFs
Download the invoice behind any line.
Reports
TraCarta's reconciliation workbooks.

Quick start

Three steps to your first call

  1. 1
    Make a key
    In Clarion, open Settings → API and choose Create key. Copy it straight away: it's shown only once.
  2. 2
    Keep it safe
    Store it as an environment variable, for example CLARION_KEY. Never put it in a web page or share it by email.
  3. 3
    Call the API
    Start with /gstins to check the key works, then fetch your lines.
curl "https://clarion.tracarta.com/api/v1/gstins" \
  -H "Authorization: Bearer $CLARION_KEY"

Authentication

One key, sent with every request

Send your key in the Authorization header as a Bearer token. Keys start with clr_live_.

  • Keys can only read. Nothing in the API changes your data.
  • A key sees at most what its owner sees: their companies, GSTINs and the columns TraCarta allows.
  • When you make a key you choose what it can read (data lines, documents, reports, GSTINs), which addresses it works from, and when it stops working.
  • If the owner loses access to a company, so does the key, immediately.
  • Revoke a key any time in Settings → API; it stops working straight away.
Every request
Authorization: Bearer clr_live_8f2a…
Without a valid key · 401
{
  "error": "This key isn't valid or has been turned off."
}

Endpoint

Companies and GSTINs

GET/api/v1/gstins

The companies and GSTINs your key can see. A good first call to check the key works.

curl "https://clarion.tracarta.com/api/v1/gstins" \
  -H "Authorization: Bearer $CLARION_KEY"
200 OKResponse
{
  "account": "Vertex Global Services",
  "companies": [
    {
      "name": "Vertex Analytics India Pvt Ltd",
      "pan": "AAKCV4821M",
      "gstins": [
        {
          "gstin": "29AAKCV4821M1Z5",
          "state": "Karnataka"
        },
        {
          "gstin": "27AAKCV4821M1ZA",
          "state": "Maharashtra"
        }
      ]
    },
    {
      "name": "Vertex Technologies Pvt Ltd",
      "pan": "AAGCV1190K",
      "gstins": [
        {
          "gstin": "33AAGCV1190K1Z0",
          "state": "Tamil Nadu"
        }
      ]
    }
  ]
}

Endpoint

Reconciled lines

GET/api/v1/lines

Every reconciled line, the same as My Data, newest airline invoice date first. Each line has the columns TraCarta lets your company see, plus links to its airline PDF.

  • All the filters below work here.
  • in_gstr2b is true, false, or null when not checked yet (accounts with reconciliation).

Query parameters

fytext
Financial year. Leave out for all years. e.g. 2026-27
gstintext, repeatable
Only lines for these client GSTINs. Leave out for every GSTIN the key can see. e.g. 27AAKCV4821M1ZA
from · todate
Date of airline invoice, from and to (inclusive), as YYYY-MM-DD. e.g. 2026-10-01
monthYYYY-MM, repeatable
One or more months of the airline invoice date. e.g. 2026-10
airlinetext, repeatable
Standard airline name from the airline master. e.g. IndiGo
typeinvoice · credit
Only invoices, or only credit notes.
doclinked · waiting
Lines that have their airline PDF, or are still waiting for it.
b2yes · no · unchecked
Reflected in GSTR-2B (accounts with reconciliation).
qtext
Search transaction ID, airline invoice number, e-ticket or passenger.
pagenumber
Page number, starting at 1. e.g. 1
per_pagenumber
Lines per page: 100 by default, up to 1,000. e.g. 500
curl "https://clarion.tracarta.com/api/v1/lines?fy=2026-27&airline=IndiGo&doc=linked&per_page=2" \
  -H "Authorization: Bearer $CLARION_KEY"
200 OKResponse
{
  "total": 112,
  "page": 1,
  "per_page": 2,
  "lines": [
    {
      "transaction_id": "VX-B98491",
      "financial_year": "2026-27",
      "transaction_type": "Invoice",
      "client_gstn": "27AAKCV4821M1ZA",
      "pax_name": "Ms Kavya Raman",
      "itinerary": "DEL-BOM",
      "airline_iata": "6E",
      "airline_name": "IndiGo",
      "airline_invoice_number": "MH12261028BA9849",
      "airline_invoice_date": "2026-10-28",
      "airline_gstn": "27AABCI2726B1Z6",
      "taxable_value": 13142,
      "total_igst": 0,
      "total_cgst": 328.55,
      "total_sgst": 328.55,
      "gstr2b_status": "Yes",
      "in_gstr2b": true,
      "document_url": "https://clarion.tracarta.com/api/v1/documents/7f3c…"
    },
    {
      "transaction_id": "VX-B1027827",
      "financial_year": "2026-27",
      "transaction_type": "Invoice",
      "client_gstn": "29AAKCV4821M1Z5",
      "pax_name": "Ms Pooja Shetty",
      "itinerary": "BOM-BLR",
      "airline_iata": "6E",
      "airline_name": "IndiGo",
      "airline_invoice_number": "DL12261028BA10278",
      "airline_invoice_date": "2026-10-28",
      "airline_gstn": "07AABCI2726B1Z6",
      "taxable_value": 6468,
      "total_igst": 323.4,
      "total_cgst": 0,
      "total_sgst": 0,
      "gstr2b_status": null,
      "in_gstr2b": null,
      "document_url": "https://clarion.tracarta.com/api/v1/documents/a91d…"
    }
  ]
}

Endpoint

Airline PDF

GET/api/v1/documents/{id}

Downloads the airline invoice, credit note or debit note for a line. Use the document_url from /lines; the file name is the document number.

curl "https://clarion.tracarta.com/api/v1/documents/DOCUMENT_ID" \
  -H "Authorization: Bearer $CLARION_KEY" \
  -o invoice.pdf
200 OKReturns application/pdf · DL_2526_004512.pdf
(the PDF file)

Endpoint

Reconciliation reports

GET/api/v1/reports

The reconciliation reports TraCarta has added, newest first, with the period each one covers. Filter with fy.

Query parameters

fytext
Only reports filed under this financial year. e.g. 2026-27
curl "https://clarion.tracarta.com/api/v1/reports?fy=2026-27" \
  -H "Authorization: Bearer $CLARION_KEY"
200 OKResponse
{
  "total": 2,
  "reports": [
    {
      "id": "3b1e…",
      "name": "Reconciliation – Oct 2026",
      "period": "Oct 2026",
      "period_from": "2026-10-01",
      "period_to": "2026-10-31",
      "financial_year": "2026-27",
      "added_on": "2026-11-11T09:30:00.000Z",
      "size_bytes": 16384,
      "download_url": "https://clarion.tracarta.com/api/v1/reports/3b1e…"
    },
    {
      "id": "c720…",
      "name": "Quarterly summary – Q1 FY 2026-27",
      "period": "Q1 FY 2026-27 (Apr–Jun 2026)",
      "period_from": "2026-04-01",
      "period_to": "2026-06-30",
      "financial_year": "2026-27",
      "added_on": "2026-10-11T09:30:00.000Z",
      "size_bytes": 29696,
      "download_url": "https://clarion.tracarta.com/api/v1/reports/c720…"
    }
  ]
}

Endpoint

Download a report

GET/api/v1/reports/{id}

Downloads one reconciliation report as the Excel workbook TraCarta uploaded.

curl "https://clarion.tracarta.com/api/v1/reports/REPORT_ID" \
  -H "Authorization: Bearer $CLARION_KEY" \
  -o report.xlsx
200 OKReturns application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
(the Excel file)

Reference

Filters

Use these on /lines. Combine as many as you like. Repeat a parameter to pass several values, for example airline=IndiGo&airline=Air India.

fytext
Financial year. Leave out for all years. e.g. 2026-27
gstintext, repeatable
Only lines for these client GSTINs. Leave out for every GSTIN the key can see. e.g. 27AAKCV4821M1ZA
from · todate
Date of airline invoice, from and to (inclusive), as YYYY-MM-DD. e.g. 2026-10-01
monthYYYY-MM, repeatable
One or more months of the airline invoice date. e.g. 2026-10
airlinetext, repeatable
Standard airline name from the airline master. e.g. IndiGo
typeinvoice · credit
Only invoices, or only credit notes.
doclinked · waiting
Lines that have their airline PDF, or are still waiting for it.
b2yes · no · unchecked
Reflected in GSTR-2B (accounts with reconciliation).
qtext
Search transaction ID, airline invoice number, e-ticket or passenger.
pagenumber
Page number, starting at 1. e.g. 1
per_pagenumber
Lines per page: 100 by default, up to 1,000. e.g. 500

Reference

Pagination

Lines come in pages: 100 by default, up to 1,000 with per_page. Every response says how many lines match in total, so you know when you have them all.

total
lines matching
page
this page
per_page
lines per page
Fetch every page · Python
import os, requests

key = os.environ["CLARION_KEY"]
lines, page = [], 1
while True:
    r = requests.get(
        "https://clarion.tracarta.com/api/v1/lines",
        params={"fy": "2026-27", "per_page": 1000, "page": page},
        headers={"Authorization": f"Bearer {key}"},
    )
    r.raise_for_status()
    data = r.json()
    lines += data["lines"]
    if page * data["per_page"] >= data["total"]:
        break
    page += 1
print(len(lines), "lines")

Reference

Fields in a line

Each line carries the columns of TraCarta's standard airline ITC format that your company can see, plus in_gstr2b and document_url. Dates are YYYY-MM-DD; amounts are numbers in rupees.

FieldMeaningType
transaction_idTransaction IDtext
financial_yearFinancial Yeartext
transaction_typeTransaction Typetext
client_nameClient Nametext
client_gstnClient GSTNtext
client_gstn_state_codeClient GSTN State Codetext
client_place_of_supplyClient Place of Supplytext
ta_invoice_dateDate of Travel Agent Invoicedate
itineraryItinerarytext
city_of_originCity of Origintext
journey_typeJourney Typetext
total_fareTotal Farenumber
pax_namePax Nametext
class_of_travelClass of Traveltext
airline_iataAirline IATA Codetext
airline_nameAirline Nametext
eticketAirline E-Ticket Numbertext
airline_invoice_numberAirline Invoice Numbertext
airline_invoice_dateDate of Airline Invoicedate
airline_gstnAirline GST Numbertext
los_codeCode for Location of Supply - Airline Servicetext
losLocation of Supply - Airline Servicetext
hsnHSN Code - Airline Servicetext
taxable_valueTaxable Value of Service - Airline Servicenumber
tax_typeType of Taxtext
gst_pctPercentage of GSTnumber
igst_pctPercentage of IGST - Airline Servicenumber
igst_amtIGST Amount - Airline Servicenumber
cgst_pctPercentage of CGST - Airline Servicenumber
cgst_amtCGST Amount - Airline Servicenumber
sgst_pctPercentage of SGST - Airline Servicenumber
sgst_amtSGST Amount - Airline Servicenumber
total_igstTotal IGST Charged by Airlinesnumber
total_cgstTotal CGST Charged by Airlinesnumber
total_sgstTotal SGST Charged by Airlinesnumber
gstr2b_statusReflected in GSTR-2Btext
in_gstr2bReflected in GSTR-2B: true, false or nullboolean
document_urlLink to the airline PDF, or null if still waitingurl

Reference

Errors

Clarion uses ordinary HTTP status codes. Errors come back as JSON with a plain-language error message you can show or log.

200
OK
Everything worked.
401
Unauthorised
The key is missing, not valid, revoked or expired.
403
Forbidden
The key isn't allowed to read this, is used from an address it doesn't allow, or the account isn't active.
404
Not found
The document or report doesn't exist, or the key can't see it.
429
Too many requests
Over the per-minute limit. Wait for the Retry-After seconds, then try again.
503
API switched off
TraCarta has paused the API for now.
429Example error
{
  "error": "Too many requests. Wait a little and try again."
}

Reference

Limits and keys

60
requests per minute, per key
1,000
lines per page at most
No expiry
before a key stops working

Over the limit you get 429 with a Retry-After header. For large pulls, use per_page=1000 and filter by financial year or dates rather than fetching everything every time.

Tools

Try it live

Send a real request to your Clarion account from this page. Your key isn't saved anywhere.

GEThttps://clarion.tracarta.com/api/v1/lines?per_page=5
Response

Paste your key, pick an endpoint and press Send. The real response from your Clarion account shows here.

Tools

Changelog

13 Nov 2026
Reports endpoints, GSTR-2B status (in_gstr2b and the b2 filter), standard airline names and IATA codes from TraCarta's airline master.
12 Nov 2026
First version: /gstins, /lines and /documents.

Questions about the API? Write to TraCarta support from the Help page in Clarion.