Accounting · Treasury
Debt & Instruments
Loans, facilities, deposits and derivatives. A facility’s undrawn headroom is the most important liquidity figure a company has and lives nowhere in an ordinary ledger.
/api/accounting/financial-instrumentsPublished as /api/v1/financial-instrumentsDownload specification (OpenAPI 3.1) Screen: Debt & Instruments
Overview
| Package | Accounting |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold Accounting › Debt & Instruments on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | acct.financial_instruments · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
10 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/accounting/financial-instrumentsList debt & instruments
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"instrument_no": "INS-000001",
"name": "Example",
"instrument_type": "text",
"direction": "borrowing",
"counterparty": "text",
"counterparty_supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"counterparty_org_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bank_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"currency": "USD",
"principal_amount": "1250.00",
"outstanding_amount": "1250.00",
"facility_limit": "1250.00"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/accounting/financial-instruments?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/financial-instruments/{id}Read one financial instrument
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"instrument_no": "INS-000001",
"name": "Example",
"instrument_type": "text",
"direction": "borrowing",
"counterparty": "text",
"counterparty_supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"counterparty_org_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bank_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"currency": "USD",
"principal_amount": "1250.00",
"outstanding_amount": "1250.00",
"facility_limit": "1250.00"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/accounting/financial-instruments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/financial-instrumentsCreate a financial instrument
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
name | text | Yes | Name |
instrument_type | text | No | Type |
direction | text | No | Direction Allowed: borrowing investment hedge |
counterparty | text | No | Counterparty |
counterparty_supplier_id | uuid | No | Counterparty (supplier) |
counterparty_org_id | uuid | No | Counterparty (group company) |
bank_account_id | uuid | No | Bank account |
currency | text | No | Currency |
principal_amount | numeric | No | Principal |
outstanding_amount | numeric | No | Outstanding |
facility_limit | numeric | No | Facility limit |
drawn_amount | numeric | No | Drawn |
trade_date | date | No | Traded |
value_date | date | No | Value date |
maturity_date | date | No | Matures |
rate_type | text | No | Rate type Allowed: fixed floating zero discount stepped |
interest_rate_pct | numeric | No | Interest rate % |
reference_rate | text | No | Reference rate — SOFR, EURIBOR, SAIBOR. |
margin_pct | numeric | No | Margin % |
day_count | text | No | Day count Allowed: actual_360 actual_365 30_360 actual_actual |
payment_frequency | text | No | Payment frequency Allowed: monthly quarterly semi_annual annual at_maturity irregular |
buy_currency | text | No | Buy currency |
sell_currency | text | No | Sell currency |
buy_amount | numeric | No | Buy amount |
sell_amount | numeric | No | Sell amount |
contract_rate | numeric | No | Contract rate |
is_hedge | boolean | No | Designated as a hedge — Without an effectiveness test the gains go straight to profit rather than to other comprehensive income. |
hedge_type | text | No | Hedge type Allowed: fair_value cash_flow net_investment |
hedged_item | text | No | Hedged item |
hedge_ratio | numeric | No | Hedge ratio |
effectiveness_pct | numeric | No | Effectiveness % |
fair_value | numeric | No | Fair value |
fair_value_date | date | No | Valued on |
accrued_interest | numeric | No | Accrued interest |
principal_account_id | uuid | No | Principal account |
interest_account_id | uuid | No | Interest account |
fair_value_account_id | uuid | No | Fair value account id |
contract_ref | text | No | Contract reference |
notes | text | No | Notes |
Sample body
{
"name": "Example",
"instrument_type": "text",
"direction": "borrowing",
"counterparty": "text",
"counterparty_supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"instrument_no": "INS-000001",
"name": "Example",
"instrument_type": "text",
"direction": "borrowing",
"counterparty": "text",
"counterparty_supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"counterparty_org_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bank_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"currency": "USD",
"principal_amount": "1250.00",
"outstanding_amount": "1250.00",
"facility_limit": "1250.00"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/financial-instruments" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","instrument_type":"text","direction":"borrowing","counterparty":"text","counterparty_supplier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/accounting/financial-instruments/{id}Change a financial instrument
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
name | text | Yes | Name |
instrument_type | text | No | Type |
direction | text | No | Direction Allowed: borrowing investment hedge |
counterparty | text | No | Counterparty |
counterparty_supplier_id | uuid | No | Counterparty (supplier) |
counterparty_org_id | uuid | No | Counterparty (group company) |
bank_account_id | uuid | No | Bank account |
currency | text | No | Currency |
principal_amount | numeric | No | Principal |
outstanding_amount | numeric | No | Outstanding |
facility_limit | numeric | No | Facility limit |
drawn_amount | numeric | No | Drawn |
trade_date | date | No | Traded |
value_date | date | No | Value date |
maturity_date | date | No | Matures |
rate_type | text | No | Rate type Allowed: fixed floating zero discount stepped |
interest_rate_pct | numeric | No | Interest rate % |
reference_rate | text | No | Reference rate — SOFR, EURIBOR, SAIBOR. |
margin_pct | numeric | No | Margin % |
day_count | text | No | Day count Allowed: actual_360 actual_365 30_360 actual_actual |
payment_frequency | text | No | Payment frequency Allowed: monthly quarterly semi_annual annual at_maturity irregular |
buy_currency | text | No | Buy currency |
sell_currency | text | No | Sell currency |
buy_amount | numeric | No | Buy amount |
sell_amount | numeric | No | Sell amount |
contract_rate | numeric | No | Contract rate |
is_hedge | boolean | No | Designated as a hedge — Without an effectiveness test the gains go straight to profit rather than to other comprehensive income. |
hedge_type | text | No | Hedge type Allowed: fair_value cash_flow net_investment |
hedged_item | text | No | Hedged item |
hedge_ratio | numeric | No | Hedge ratio |
effectiveness_pct | numeric | No | Effectiveness % |
fair_value | numeric | No | Fair value |
fair_value_date | date | No | Valued on |
accrued_interest | numeric | No | Accrued interest |
principal_account_id | uuid | No | Principal account |
interest_account_id | uuid | No | Interest account |
fair_value_account_id | uuid | No | Fair value account id |
contract_ref | text | No | Contract reference |
notes | text | No | Notes |
Sample body
{
"name": "Example",
"instrument_type": "text"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"instrument_no": "INS-000001",
"name": "Example",
"instrument_type": "text",
"direction": "borrowing",
"counterparty": "text",
"counterparty_supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"counterparty_org_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bank_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"currency": "USD",
"principal_amount": "1250.00",
"outstanding_amount": "1250.00",
"facility_limit": "1250.00"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/accounting/financial-instruments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","instrument_type":"text"}'DELETE/api/accounting/financial-instruments/{id}Delete a financial instrument
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/accounting/financial-instruments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/financial-instruments/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/financial-instruments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'GET/api/accounting/financial-instruments/{parentId}/scheduleSchedule
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/accounting/financial-instruments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/schedule" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/financial-instruments/{parentId}/scheduleSchedule
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/financial-instruments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/schedule" \
-H "Authorization: Bearer $TOKEN"PUT/api/accounting/financial-instruments/{parentId}/schedule/{lineId}Schedule
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/accounting/financial-instruments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/schedule/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/accounting/financial-instruments/{parentId}/schedule/{lineId}Schedule
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/accounting/financial-instruments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/schedule/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a financial instrument, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
instrument_no | text | read only | Instrument no |
name | text | read, write | Name |
instrument_type | text | read, write | Type |
direction | text | read, write | Direction Allowed: borrowing investment hedge |
counterparty | text | read, write | Counterparty |
counterparty_supplier_id | uuid | read, write | Counterparty (supplier) |
counterparty_org_id | uuid | read, write | Counterparty (group company) |
bank_account_id | uuid | read, write | Bank account |
currency | text | read, write | Currency |
principal_amount | numeric | read, write | Principal |
outstanding_amount | numeric | read, write | Outstanding |
facility_limit | numeric | read, write | Facility limit |
drawn_amount | numeric | read, write | Drawn |
trade_date | date | read, write | Traded |
value_date | date | read, write | Value date |
maturity_date | date | read, write | Matures |
rate_type | text | read, write | Rate type Allowed: fixed floating zero discount stepped |
interest_rate_pct | numeric | read, write | Interest rate % |
reference_rate | text | read, write | Reference rate — SOFR, EURIBOR, SAIBOR. |
margin_pct | numeric | read, write | Margin % |
day_count | text | read, write | Day count Allowed: actual_360 actual_365 30_360 actual_actual |
payment_frequency | text | read, write | Payment frequency Allowed: monthly quarterly semi_annual annual at_maturity irregular |
buy_currency | text | read, write | Buy currency |
sell_currency | text | read, write | Sell currency |
buy_amount | numeric | read, write | Buy amount |
sell_amount | numeric | read, write | Sell amount |
contract_rate | numeric | read, write | Contract rate |
is_hedge | boolean | read, write | Designated as a hedge — Without an effectiveness test the gains go straight to profit rather than to other comprehensive income. |
hedge_type | text | read, write | Hedge type Allowed: fair_value cash_flow net_investment |
hedged_item | text | read, write | Hedged item |
hedge_ratio | numeric | read, write | Hedge ratio |
effectiveness_pct | numeric | read, write | Effectiveness % |
fair_value | numeric | read, write | Fair value |
fair_value_date | date | read, write | Valued on |
accrued_interest | numeric | read, write | Accrued interest |
principal_account_id | uuid | read, write | Principal account |
interest_account_id | uuid | read, write | Interest account |
fair_value_account_id | uuid | read, write | Fair value account id |
status | text | read only | Status |
contract_ref | text | read, write | Contract reference |
notes | text | read, write | Notes |
created_by | uuid | read only | Created by |
created_at | timestamp with time zone | read only | Created at |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Accounting › Debt & Instruments for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.