Accounting · Services and actions
Banking
The banking service of Accounting: 14 operation(s).
/api/accounting/bankingOverview
| 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 › Banking 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
14 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/accounting/banking/connection-setupConnection setup
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/accounting/banking/connection-setup" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/banking/validate-routingValidate routing
Request body
The keys this action reads (* = required; "one of" lists the only values):
routingResponse
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/banking/validate-routing" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"routing":"value"}'GET/api/accounting/banking/reports/cash-positionReports cash position
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/accounting/banking/reports/cash-position" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/banking/reports/connection-healthReports connection health
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/accounting/banking/reports/connection-health" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/banking/reports/reconciliation-statusReports reconciliation status
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/accounting/banking/reports/reconciliation-status" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/banking/overviewOverview
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/accounting/banking/overview" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/banking/link/optionsLink options
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/accounting/banking/link/options" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/banking/link/startLink start
Request body
The keys this action reads (* = required; "one of" lists the only values):
institutionId*, reconnectResponse
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/banking/link/start" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"institutionId":"value","reconnect":"value"}'POST/api/accounting/banking/link/{id}/authenticateLink authenticate
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, 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/banking/link/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/authenticate" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/banking/link/{id}/answerLink answer
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, 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/banking/link/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/answer" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/banking/link/{id}Link
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/banking/link/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/banking/link/{id}/completeLink complete
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):
allowEmpty, accounts, environment; environment one of sandbox|uat|productionResponse
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/banking/link/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/complete" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"allowEmpty":"value","accounts":"value","environment;":"value"}'POST/api/accounting/banking/link/{id}/oauth/startLink oauth start
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, 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/banking/link/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/oauth/start" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/banking/link/{id}/oauth/accountsLink oauth accounts
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/banking/link/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/oauth/accounts" \
-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 › Banking 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.