API endpoint reference: how to call TRANXACT
How a third-party product reaches TRANXACT over HTTPS: the two ways in, authentication, every verb and parameter, the filter language, the answers and errors, MCP, and a page per module listing all 1110 resources with their fields.
Browse every API, operation by operation, in the API Hub (help.tranxact.ai/en/api/): packages, APIs, parameters, request and response bodies, data models, errors, samples and a specification to download for each API.
Two ways in
| Published API (recommended for partners) | Service account (whole modules) | |
|---|---|---|
| ಮೂಲ ವಿಳಾಸ | <your TRANXACT address>/api/v1 | <your TRANXACT address>/api |
| A resource | /api/v1/<code> and /api/v1/<code>/<id> | /api/<module>/<resource> and /api/<module>/<resource>/<id> |
| ಪ್ರಮಾಣಪತ್ರ | An API key from Platform › Published API (sent as Authorization: Bearer <key> or X-API-Key: <key>) | A client id and secret from Platform › Access › Service Accounts, exchanged for a bearer token at POST /api/auth/service-token |
| What it reaches | Only what an administrator published and granted to the key: chosen resources, columns, rows and verbs | Everything the service account's roles allow, like a person with those roles |
| ಕಾರ್ಯನಿರ್ವಹಿಸುತ್ತದೆ | The run-as user set on the key's client | The service account itself |
| Describes itself | GET /api/v1 · GET /api/v1/resources · GET /api/v1/openapi.json (this key's own reach) | This reference, and the full OpenAPI file below |
Every call goes through the same rules as the screen: validation, numbering, approvals, posting rules, the company and organisational unit the caller belongs to, and the audit trail. Nothing reached through the API can do what the same user could not do on screen.
Authenticating
# Published API: the key on every call
curl https://demo.tranxact.ai/api/v1 -H "Authorization: Bearer tx_partner_xxxxxxxxxxxxxxxx"
curl https://demo.tranxact.ai/api/v1 -H "X-API-Key: tx_partner_xxxxxxxxxxxxxxxx"
# Service account: a token first, then the token on every call
curl -X POST https://demo.tranxact.ai/api/auth/service-token -H "Content-Type: application/json" \
-d '{"client_id":"loader@service.example","secret":"<the secret>"}'
# -> {"token":"eyJ...","token_type":"Bearer","expires_in":3600,...}
curl https://demo.tranxact.ai/api/scm/items?limit=10 -H "Authorization: Bearer eyJ..."
The verbs
| ಕರೆ ಮಾಡಿ | ಪ್ರಕಟಿತ API | Service account | ಉತ್ತರ |
|---|---|---|---|
| ಪಟ್ಟಿ | GET /api/v1/<code> | GET /api/<module>/<resource> | 200 {"rows":[...],"count":N}; the published API also sends X-Total-Count |
| One record | GET /api/v1/<code>/<id> | GET /api/<module>/<resource>/<id> | 200 the record, or 404 |
| ರಚಿಸಿ | POST /api/v1/<code> with the record as JSON | POST /api/<module>/<resource> | 201 the created record, with its id and number |
| ಬದಲಾವಣೆ | PATCH or PUT /api/v1/<code>/<id> with the fields to change | PUT /api/<module>/<resource>/<id> | 200 the changed record |
| ಅಳಿಸಿ | DELETE /api/v1/<code>/<id> | DELETE /api/<module>/<resource>/<id> | 200 {"deleted":true} |
| Check without saving | — | POST /api/<module>/<resource>/_check, PUT /api/<module>/<resource>/<id>/_check | 200 when it would save, or the same refusal a save would give |
Documents that move through a process (release an order, post an invoice, approve a requisition) have their own action routes, which are reached with a service account in the same way as the screen's buttons; the published API reaches records, not actions.
Listing: paging, search, sort and filter
| ಪ್ಯಾರಾಮೀಟರ್ | ಅರ್ಥ | ಉದಾಹರಣೆ |
|---|---|---|
| limit | Rows per page: 50 by default, at most 200 with a service account, at most the exposure's maximum on the published API | limit=100 |
| offset | Rows to skip | offset=200 |
| q | Free-text search over the resource's search columns | q=acme |
| sort | column:asc or column:desc, several separated by commas | sort=created_at:desc,item_no:asc |
| filter | A JSON condition or group of conditions (below), URL-encoded | filter={"col":"status","op":"eq","value":"open"} |
| <column>=<value> | Shorthand for "column is value" | status=open |
A condition is {"col": "<field>", "op": "<operator>", "value": <value>} ("values": [..] for operators that take several, none for empty and not_empty; "not": true inverts it). A group is {"join": "and" | "or", "conditions": [ ...conditions or groups... ]}, nested as deep as needed. On the published API the caller's filter is always applied underneath the restriction the administrator published, so it can only narrow what the key may see.
| ಆಪರೇಟರ್ | ಅರ್ಥ |
|---|---|
| eq · ne | is · is not |
| in · not_in | is any of · is none of (values: [...]) |
| contains · starts | contains · starts with (text, any case) |
| gt · gte · lt · lte | more than · at least · less than · at most (numbers and dates) |
| between · not_between | within · outside two values (values: [from, to]) |
| on · before · after | a date: on, before, after |
| last_days · not_last_days | within (or not) the last N days |
| empty · not_empty | has no value · has a value |
# open purchase orders over 10,000, or any from one supplier, newest first
FILTER='{"join":"or","conditions":[{"join":"and","conditions":[{"col":"status","op":"eq","value":"open"},{"col":"total","op":"gt","value":10000}]},{"col":"supplier_id","op":"eq","value":"<supplier id>"}]}'
curl -G https://demo.tranxact.ai/api/v1/purchase-orders -H "Authorization: Bearer $KEY" \
--data-urlencode "filter=$FILTER" --data-urlencode "sort=order_date:desc" -d limit=50
Creating and changing
curl -X POST https://demo.tranxact.ai/api/v1/items -H "Authorization: Bearer $KEY" -H "Content-Type: application/json" \
-d '{"item_no":"SCREW-M4","name":"Screw M4 x 12","item_type":"raw","uom":"EA","standard_cost":0.1}'
curl -X PATCH https://demo.tranxact.ai/api/v1/items/<id> -H "Authorization: Bearer $KEY" -H "Content-Type: application/json" \
-d '{"standard_cost":0.12}'
Send only the fields to set; on a change, fields left out keep their value. On the published API a field the exposure does not publish is dropped rather than written. A number generated by TRANXACT (an order or invoice number) is assigned on create and cannot be sent.
In code
# Python (requests)
import requests
BASE, KEY = "https://demo.tranxact.ai/api/v1", "tx_partner_xxxxxxxx"
s = requests.Session(); s.headers["Authorization"] = f"Bearer {KEY}"
offset, rows = 0, []
while True:
page = s.get(f"{BASE}/accounts", params={"limit": 100, "offset": offset}).json()["rows"]
rows += page; offset += len(page)
if len(page) < 100: break
// JavaScript (Node 18+ or a browser on an allowed origin)
const r = await fetch("https://demo.tranxact.ai/api/v1/accounts?limit=100", { headers: { Authorization: "Bearer " + KEY } });
const { rows, count } = await r.json();
Field types in JSON
| Type in this reference | In JSON |
|---|---|
| uuid | a string, e.g. "3f1c…"; ids and references to other records |
| text, character varying | a string |
| integer, smallint | a number |
| numeric, bigint | a string holding the exact number (e.g. "1250.00"), so no precision is lost; send a number or a string |
| ಬೂಲಿಯನ್ | true or false |
| ದಿನಾಂಕ | a string, YYYY-MM-DD |
| timestamp with time zone | a string, ISO 8601 in UTC |
| jsonb | an object or array |
| _text, _uuid (arrays) | an array of strings |
Answers that are not a success
| ಸ್ಥಿತಿ | ಏಕೆ |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No key or token, or it is wrong, revoked or expired |
| 403 | The key is not granted this verb on this resource, the run-as user's roles do not allow it, or the call came from an address or origin not allowed |
| 404 | Nothing is published under that code, or no record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, or the record changed or is locked by someone else |
| 422 | The record was refused by the same validation as the screen; the error says which field and why |
| 429 | The key's calls per minute were used up (or too many unauthenticated calls from one address); wait and retry |
Every error is JSON: {"error": "<a sentence saying what was wrong>"} and, where it applies, "field". Every call, allowed or refused, is on Platform › Published API › API Call Log.
MCP: the same resources for an AI assistant
POST /api/v1/mcp speaks the Model Context Protocol (JSON-RPC 2.0) with the same key, if its protocol is MCP or both. tools/list returns, for each published resource, list_<code>, get_<code>, create_<code>, update_<code> and delete_<code> as granted; tools/call runs them under exactly the same rules as the REST calls.
curl -X POST https://demo.tranxact.ai/api/v1/mcp -H "Authorization: Bearer $KEY" -H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","id":1,"method":"tools/list"}'
curl -X POST https://demo.tranxact.ai/api/v1/mcp -H "Authorization: Bearer $KEY" -H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"list_accounts","arguments":{"q":"acme","limit":5}}}'
The machine-readable reference
The whole catalogue, all 1110 resources with every field and type, is one OpenAPI 3.1 file: https://help.tranxact.ai/assets/tranxact-openapi.json. It describes the service-account paths (/api/<module>/<resource>); the published API serves the same records at /api/v1/<code>, and GET /api/v1/openapi.json on your own installation gives the exact document for one key.
The resources, by module
| ಮಾಡ್ಯೂಲ್ | ಸಂಪನ್ಮೂಲಗಳು | ಪುಟ |
|---|---|---|
| ಲೆಕ್ಕಪತ್ರ | 230 | API endpoints: Accounting |
| ಏಜೆಂಟ್ AI | 22 | API endpoints: Agentic AI |
| ಗ್ರಾಹಕ ಸಂಬಂಧ ನಿರ್ವಹಣೆ | 134 (134) | API endpoints: CRM |
| ಆರೋಗ್ಯ ದಾಖಲೆಗಳು | 67 | API endpoints: EHR |
| ಉದ್ಯೋಗಿ ಸ್ವಯಂ ಸೇವೆ | 5 | API endpoints: Employee Self Service |
| ಮಾನವ ಸಂಪನ್ಮೂಲ | 168 | API endpoints: HRMS |
| india | 31 ಕನ್ನಡ | API endpoints: india |
| ಉತ್ಪಾದನೆ | 95 | API endpoints: Manufacturing |
| mdm | 9 | API endpoints: mdm |
| ವೇದಿಕೆ | 85 | API endpoints: Platform |
| ವಿದ್ಯಾರ್ಥಿ ಜೀವನಚಕ್ರ | 52 | API endpoints: Student Lifecycle |
| ಪೂರೈಕೆ ಸರಪಳಿ | 182 | API endpoints: Supply Chain |
| ಪ್ರತಿಭೆ ಮತ್ತು ಅನಿಶ್ಚಿತ ಕಾರ್ಯಪಡೆ | 30 | API endpoints: Talent & Contingent Workforce |
Setting up keys, what an administrator publishes and the roles involved: Connecting other software to TRANXACT: the published API. TRANXACT as an MCP server covers the governed MCP worker endpoint. Some resources appear only in a company of a given country (for example the India statutory resources).