TRANXACT.AI Help

Accounting · Banks & Accounts

Bank Accounts

The accounts themselves, with the live balance the feed reports and the GL account each one posts to.

Type REST11 operationsBase path /api/accounting/bank-accountsPublished as /api/v1/bank-accounts

Download specification (OpenAPI 3.1) Screen: Bank Accounts

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 › Bank Accounts 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.bank_accounts · 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

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

GET/api/accounting/bank-accountsList bank accounts

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",
      "name": "Example",
      "bank_name": "Example",
      "account_masked": "text",
      "currency": "USD",
      "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "is_active": true,
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "account_number_cipher": "text",
      "routing_number": "ROU-000001",
      "iban": "text",
      "swift_bic": "text"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "name": "Example",
  "bank_name": "Example",
  "account_masked": "text",
  "currency": "USD",
  "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "is_active": true,
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_number_cipher": "text",
  "routing_number": "ROU-000001",
  "iban": "text",
  "swift_bic": "text"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
nametextYesAccount name
bank_nametextYesBank name
account_maskedtextYesMasked number — Set the real number through "Store account number" — it is encrypted and this is derived from it.
currencytextNoCurrency
gl_account_iduuidNoCash GL account
is_activebooleanNoActive

Sample body

{
  "name": "Example",
  "bank_name": "Example",
  "account_masked": "text",
  "currency": "USD",
  "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "is_active": true
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "name": "Example",
  "bank_name": "Example",
  "account_masked": "text",
  "currency": "USD",
  "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "is_active": true,
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_number_cipher": "text",
  "routing_number": "ROU-000001",
  "iban": "text",
  "swift_bic": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/bank-accounts" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example","bank_name":"Example","account_masked":"text","currency":"USD","gl_account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","is_active":true}'
PUT/api/accounting/bank-accounts/{id}Change a bank accounts

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
nametextYesAccount name
bank_nametextYesBank name
account_maskedtextYesMasked number — Set the real number through "Store account number" — it is encrypted and this is derived from it.
currencytextNoCurrency
gl_account_iduuidNoCash GL account
is_activebooleanNoActive

Sample body

{
  "name": "Example",
  "bank_name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "name": "Example",
  "bank_name": "Example",
  "account_masked": "text",
  "currency": "USD",
  "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "is_active": true,
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_number_cipher": "text",
  "routing_number": "ROU-000001",
  "iban": "text",
  "swift_bic": "text"
}

Sample request

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

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/bank-accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/bank-accounts/{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/bank-accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
PUT/api/accounting/bank-accounts/{id}/account-numberAccount number

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):

accountNumber

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/bank-accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/account-number" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"accountNumber":"value"}'
POST/api/accounting/bank-accounts/{id}/recogniseRecognise

Path parameters

NameTypeDescription
idstring (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/bank-accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/recognise" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/bank-accounts/{id}/settle-open-itemsSettle open items

Path parameters

NameTypeDescription
idstring (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/bank-accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/settle-open-items" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/bank-accounts/{id}/post-recognisedPost recognised

Path parameters

NameTypeDescription
idstring (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/bank-accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/post-recognised" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/bank-accounts/{id}/reconcileReconcile

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):

periodStart*, periodEnd, statementId, statementBalance

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/bank-accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/reconcile" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"periodStart":"value","periodEnd":"value","statementId":"value","statementBalance":"value"}'

Data model

Every field of a bank accounts, 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
nametextread, writeAccount name
bank_nametextread, writeBank name
account_maskedtextread, writeMasked number — Set the real number through "Store account number" — it is encrypted and this is derived from it.
currencytextread, writeCurrency
gl_account_iduuidread, writeCash GL account
is_activebooleanread, writeActive
org_unit_iduuidread onlyOrg unit id
provider_iduuidread onlyBank
connection_iduuidread onlyConnection
account_number_cipherbytearead onlyAccount number cipher
routing_numbertextread onlyRouting number
ibantextread onlyIBAN
swift_bictextread onlySWIFT BIC
external_account_idtextread onlyAccount id at the bank — How the bank names this account on its feed.
account_typetextread onlyType
purposetextread onlyWhat it is for
ledger_balancenumericread onlyLedger balance
available_balancenumericread onlyAvailable balance
balance_as_oftimestamp with time zoneread onlyBalance as of
overdraft_limitnumericread onlyOverdraft limit
minimum_balancenumericread onlyMinimum balance
sync_enabledbooleanread onlyCollect from the bank
last_sync_attimestamp with time zoneread onlyLast sync at
last_statement_datedateread onlyLast statement date
is_primarybooleanread onlyPrimary account for this currency
cost_center_iduuidread onlyCost center
link_session_iduuidread onlyLink session id
ofx_bank_idtextread onlyOfx bank id
ofx_account_typetextread onlyOfx account type
countrytextread onlyCountry
iban_maskedtextread onlyIban masked
target_balancenumericread onlyTarget balance
is_restrictedbooleanread onlyIs restricted
restriction_reasontextread onlyRestriction reason
interest_rate_pctnumericread onlyInterest rate pct
value_date_offset_daysintegerread onlyValue date offset days
pool_iduuidread onlyPool id
opened_datedateread onlyOpened date
closed_datedateread onlyClosed date
signatoriestextread onlySignatories
notestextread onlyNotes
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 › Bank Accounts 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.