TRANXACT.AI Help

Accounting · Ledgers & Principles

Currencies

What a currency is, so 1,234 JPY is not shown with two decimals and a rate cannot be entered two orders of magnitude out.

Type REST6 operationsBase path /api/accounting/currenciesPublished as /api/v1/currencies

Download specification (OpenAPI 3.1) Screen: Currencies

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 › Currencies 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.currencies
RecordCreated, changed and (where the screen allows) deleted; key code
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

6 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/accounting/currenciesList currencies

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": [
    {
      "code": "COD-000001",
      "name": "Example",
      "symbol": "text",
      "decimals": 10,
      "quote_per": 10,
      "is_active": true,
      "sort_order": 10,
      "xf_text_1": "text",
      "xf_text_2": "text",
      "xf_text_3": "text",
      "xf_text_4": "text",
      "xf_text_5": "text",
      "xf_num_1": "1250.00",
      "xf_num_2": "1250.00"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/accounting/currencies?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/accounting/currencies/{code}Read one currency

Path parameters

NameTypeDescription
codestring (uuid)The record's code, as a list returns it.

Response 200

{
  "code": "COD-000001",
  "name": "Example",
  "symbol": "text",
  "decimals": 10,
  "quote_per": 10,
  "is_active": true,
  "sort_order": 10,
  "xf_text_1": "text",
  "xf_text_2": "text",
  "xf_text_3": "text",
  "xf_text_4": "text",
  "xf_text_5": "text",
  "xf_num_1": "1250.00",
  "xf_num_2": "1250.00"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/accounting/currencies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/currenciesCreate a currency

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
nametextYesName
symboltextNoSymbol
decimalsintegerNoDecimal places
quote_perintegerNoQuoted per — Some currencies are quoted per 100 or 1,000 units because the unit is small.
is_activebooleanNoActive
sort_orderintegerNoSort order

Sample body

{
  "name": "Example",
  "symbol": "text",
  "decimals": 10,
  "quote_per": 10,
  "is_active": true
}

Response 201

{
  "code": "COD-000001",
  "name": "Example",
  "symbol": "text",
  "decimals": 10,
  "quote_per": 10,
  "is_active": true,
  "sort_order": 10,
  "xf_text_1": "text",
  "xf_text_2": "text",
  "xf_text_3": "text",
  "xf_text_4": "text",
  "xf_text_5": "text",
  "xf_num_1": "1250.00",
  "xf_num_2": "1250.00"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/currencies" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example","symbol":"text","decimals":10,"quote_per":10,"is_active":true}'
PUT/api/accounting/currencies/{code}Change a currency

Path parameters

NameTypeDescription
codestring (uuid)The record's code, as a list returns it.

Request body

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

FieldTypeRequiredDescription
nametextYesName
symboltextNoSymbol
decimalsintegerNoDecimal places
quote_perintegerNoQuoted per — Some currencies are quoted per 100 or 1,000 units because the unit is small.
is_activebooleanNoActive
sort_orderintegerNoSort order

Sample body

{
  "name": "Example",
  "symbol": "text"
}

Response 200

{
  "code": "COD-000001",
  "name": "Example",
  "symbol": "text",
  "decimals": 10,
  "quote_per": 10,
  "is_active": true,
  "sort_order": 10,
  "xf_text_1": "text",
  "xf_text_2": "text",
  "xf_text_3": "text",
  "xf_text_4": "text",
  "xf_text_5": "text",
  "xf_num_1": "1250.00",
  "xf_num_2": "1250.00"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/accounting/currencies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example","symbol":"text"}'
DELETE/api/accounting/currencies/{code}Delete a currency

Path parameters

NameTypeDescription
codestring (uuid)The record's code, 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/currencies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/currencies/{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/currencies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'

Data model

Every field of a currency, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
codetextread, writeISO code — Three letters — USD, SAR, INR.
nametextread, writeName
symboltextread, writeSymbol
decimalsintegerread, writeDecimal places
quote_perintegerread, writeQuoted per — Some currencies are quoted per 100 or 1,000 units because the unit is small.
is_activebooleanread, writeActive
sort_orderintegerread, writeSort order
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
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
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 › Currencies 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.