Accounting · Services and actions
Treasury
The treasury service of Accounting: 8 operation(s).
/api/accounting/treasuryOverview
| 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 › Treasury 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. |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
8 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/accounting/treasury/positionPosition
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/accounting/treasury/position" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/treasury/captureCapture
Request body
The keys this action reads (* = required; "one of" lists the only values):
date, reportingCurrencyResponse
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/treasury/capture" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"date":"value","reportingCurrency":"value"}'POST/api/accounting/treasury/forecast/buildForecast build
Request body
The keys this action reads (* = required; "one of" lists the only values):
horizonFrom, currency, revenueShiftPct, fxShiftPct, name, horizonDays, grain, scenario, collectionDelayDays, paymentDelayDays; grain one of day|week|month|quarter; scenario one of base|optimistic|pessimistic|stress|what_ifResponse
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/treasury/forecast/build" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"horizonFrom":"value","currency":"value","revenueShiftPct":"value","fxShiftPct":"value","name":"value","horizonDays":"value"}'GET/api/accounting/treasury/forecast/{id}/curveForecast curve
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/accounting/treasury/forecast/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/curve" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/treasury/pools/{id}/sweepPools sweep
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):
sweepDateResponse
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/treasury/pools/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/sweep" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"sweepDate":"value"}'POST/api/accounting/treasury/instruments/{id}/scheduleInstruments schedule
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):
amortisingResponse
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/treasury/instruments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/schedule" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"amortising":"value"}'POST/api/accounting/treasury/covenants/testCovenants test
Request body
The keys this action reads (* = required; "one of" lists the only values):
testDate, covenantIdResponse
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/treasury/covenants/test" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"testDate":"value","covenantId":"value"}'GET/api/accounting/treasury/debt-maturityDebt maturity
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/accounting/treasury/debt-maturity" \
-H "Authorization: Bearer $TOKEN"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 › Treasury 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.