API Reference

Client Documents API.

The full quote → invoice → receipt → ticket lifecycle, callable from your own finance tool or CRM.

Authentication

Two valid ways in - by design.

Most endpoints (key management, profile, approvals, voids) require your logged-in session only. Creating a quotation or a ticket accepts either your session or an API key - so a human on the dashboard and your own integrated system can both call the exact same real entry point.

The Lifecycle

Quote to receipt, in order.

POST/api/v1/client-documents/quotations

Start a quotation against a mission. Auth: session or API key.

POST/api/v1/client-documents/{document_id}/line-items

Add a line item - description and amount. Call once per line. Auth: session.

POST/api/v1/client-documents/{document_id}/submit

Submit the quotation for internal approval. Auth: session.

POST/api/v1/client-documents/{document_id}/approve

Approve it. Auth: session.

POST/api/v1/client-documents/{document_id}/lock-and-issue

Lock the numbers and issue the real, numbered document. Currency defaults to USD; supply fx_rate for anything else. Auth: session.

POST/api/v1/public/quotations/{token}/respond

The client's own accept/decline link - {"response": "ACCEPTED"} or "DECLINED". No auth: this is what your client clicks, not something you call yourself.

POST/api/v1/client-documents/quotations/{document_id}/create-invoice

Turn an accepted quotation into an invoice - the numbers carry over. Auth: session.

POST/api/v1/client-documents/invoices/{document_id}/mark-paid

Mark an invoice paid. Auth: session.

POST/api/v1/client-documents/invoices/{document_id}/create-receipt

Issue the receipt once /receipt-eligibility confirms it's payable. Auth: session.

POST/api/v1/client-documents/tickets

Issue a ticket for a passenger against a mission. Auth: session or API key.

POST/api/v1/client-documents/{document_id}/void

Void any document with a reason. Nothing is silently edited - the void is on the record. Auth: session.

GET/api/v1/client-documents/{document_id}/chain

See the full quote-to-receipt chain for one document. Auth: session.

Keys & Setup

Mint, list, revoke - and set your document profile.

API Keys

GET/POST /api-keys, DELETE /api-keys/{key_id} - all session-authenticated, from your own account settings.

Document Profile

GET/PUT /profile - your legal name, logo, bank details, and tax rate, used on every document you issue.

None of this works until Client Documents is enabled for your operator - an Executive does that from their own dashboard, not through this API.

What You Get Back

The same documents your team prints.

Quotations, invoices and receipts come from the flight record with your logo, colours, terms and payment details - identical to what your team prints inside the platform.

An invoice made by SkyTrade Operator
Curious How This Fits Your Finance Tool?

See it connected to your own systems.