TRANXACT.AI Help

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.

Type REST10 operationsBase path /api/accounting/financial-instrumentsPublished as /api/v1/financial-instruments

Download specification (OpenAPI 3.1) Screen: Debt & Instruments

Overview

PackageAccounting
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tableacct.financial_instruments · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
nametextYesName
instrument_typetextNoType
directiontextNoDirection
Allowed: borrowing investment hedge
counterpartytextNoCounterparty
counterparty_supplier_iduuidNoCounterparty (supplier)
counterparty_org_iduuidNoCounterparty (group company)
bank_account_iduuidNoBank account
currencytextNoCurrency
principal_amountnumericNoPrincipal
outstanding_amountnumericNoOutstanding
facility_limitnumericNoFacility limit
drawn_amountnumericNoDrawn
trade_datedateNoTraded
value_datedateNoValue date
maturity_datedateNoMatures
rate_typetextNoRate type
Allowed: fixed floating zero discount stepped
interest_rate_pctnumericNoInterest rate %
reference_ratetextNoReference rate — SOFR, EURIBOR, SAIBOR.
margin_pctnumericNoMargin %
day_counttextNoDay count
Allowed: actual_360 actual_365 30_360 actual_actual
payment_frequencytextNoPayment frequency
Allowed: monthly quarterly semi_annual annual at_maturity irregular
buy_currencytextNoBuy currency
sell_currencytextNoSell currency
buy_amountnumericNoBuy amount
sell_amountnumericNoSell amount
contract_ratenumericNoContract rate
is_hedgebooleanNoDesignated as a hedge — Without an effectiveness test the gains go straight to profit rather than to other comprehensive income.
hedge_typetextNoHedge type
Allowed: fair_value cash_flow net_investment
hedged_itemtextNoHedged item
hedge_rationumericNoHedge ratio
effectiveness_pctnumericNoEffectiveness %
fair_valuenumericNoFair value
fair_value_datedateNoValued on
accrued_interestnumericNoAccrued interest
principal_account_iduuidNoPrincipal account
interest_account_iduuidNoInterest account
fair_value_account_iduuidNoFair value account id
contract_reftextNoContract reference
notestextNoNotes

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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
nametextYesName
instrument_typetextNoType
directiontextNoDirection
Allowed: borrowing investment hedge
counterpartytextNoCounterparty
counterparty_supplier_iduuidNoCounterparty (supplier)
counterparty_org_iduuidNoCounterparty (group company)
bank_account_iduuidNoBank account
currencytextNoCurrency
principal_amountnumericNoPrincipal
outstanding_amountnumericNoOutstanding
facility_limitnumericNoFacility limit
drawn_amountnumericNoDrawn
trade_datedateNoTraded
value_datedateNoValue date
maturity_datedateNoMatures
rate_typetextNoRate type
Allowed: fixed floating zero discount stepped
interest_rate_pctnumericNoInterest rate %
reference_ratetextNoReference rate — SOFR, EURIBOR, SAIBOR.
margin_pctnumericNoMargin %
day_counttextNoDay count
Allowed: actual_360 actual_365 30_360 actual_actual
payment_frequencytextNoPayment frequency
Allowed: monthly quarterly semi_annual annual at_maturity irregular
buy_currencytextNoBuy currency
sell_currencytextNoSell currency
buy_amountnumericNoBuy amount
sell_amountnumericNoSell amount
contract_ratenumericNoContract rate
is_hedgebooleanNoDesignated as a hedge — Without an effectiveness test the gains go straight to profit rather than to other comprehensive income.
hedge_typetextNoHedge type
Allowed: fair_value cash_flow net_investment
hedged_itemtextNoHedged item
hedge_rationumericNoHedge ratio
effectiveness_pctnumericNoEffectiveness %
fair_valuenumericNoFair value
fair_value_datedateNoValued on
accrued_interestnumericNoAccrued interest
principal_account_iduuidNoPrincipal account
interest_account_iduuidNoInterest account
fair_value_account_iduuidNoFair value account id
contract_reftextNoContract reference
notestextNoNotes

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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, withLines

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/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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
instrument_notextread onlyInstrument no
nametextread, writeName
instrument_typetextread, writeType
directiontextread, writeDirection
Allowed: borrowing investment hedge
counterpartytextread, writeCounterparty
counterparty_supplier_iduuidread, writeCounterparty (supplier)
counterparty_org_iduuidread, writeCounterparty (group company)
bank_account_iduuidread, writeBank account
currencytextread, writeCurrency
principal_amountnumericread, writePrincipal
outstanding_amountnumericread, writeOutstanding
facility_limitnumericread, writeFacility limit
drawn_amountnumericread, writeDrawn
trade_datedateread, writeTraded
value_datedateread, writeValue date
maturity_datedateread, writeMatures
rate_typetextread, writeRate type
Allowed: fixed floating zero discount stepped
interest_rate_pctnumericread, writeInterest rate %
reference_ratetextread, writeReference rate — SOFR, EURIBOR, SAIBOR.
margin_pctnumericread, writeMargin %
day_counttextread, writeDay count
Allowed: actual_360 actual_365 30_360 actual_actual
payment_frequencytextread, writePayment frequency
Allowed: monthly quarterly semi_annual annual at_maturity irregular
buy_currencytextread, writeBuy currency
sell_currencytextread, writeSell currency
buy_amountnumericread, writeBuy amount
sell_amountnumericread, writeSell amount
contract_ratenumericread, writeContract rate
is_hedgebooleanread, writeDesignated as a hedge — Without an effectiveness test the gains go straight to profit rather than to other comprehensive income.
hedge_typetextread, writeHedge type
Allowed: fair_value cash_flow net_investment
hedged_itemtextread, writeHedged item
hedge_rationumericread, writeHedge ratio
effectiveness_pctnumericread, writeEffectiveness %
fair_valuenumericread, writeFair value
fair_value_datedateread, writeValued on
accrued_interestnumericread, writeAccrued interest
principal_account_iduuidread, writePrincipal account
interest_account_iduuidread, writeInterest account
fair_value_account_iduuidread, writeFair value account id
statustextread onlyStatus
contract_reftextread, writeContract reference
notestextread, writeNotes
created_byuuidread onlyCreated by
created_attimestamp with time zoneread onlyCreated at
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Accounting › Debt & Instruments for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.