Supply Chain · Reachable by link
Supplier · Bank Details
Where the money goes. Changing any identifier resets the verification — an emailed "we have changed our bank" is the commonest fraud there is.
/api/scm/supplier-bank-accountsPublished as /api/v1/supplier-bank-accountsDownload specification (OpenAPI 3.1) Screen: Supplier · Bank Details
Overview
| Package | Supply Chain |
|---|---|
| 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 Supply Chain › Supplier · Bank Details 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. |
| Table | scm.supplier_bank_accounts · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The 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/scm/supplier-bank-accountsList supplier · bank details
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"site_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_name": "Example",
"bank_name": "Example",
"branch": "text",
"country": "US",
"currency": "USD",
"account_number_cipher": "text",
"account_last4": "text",
"iban_cipher": "text",
"iban_last4": "text",
"swift_bic": "text",
"routing_number": "ROU-000001"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/supplier-bank-accounts?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/supplier-bank-accounts/{id}Read one supplier bank accounts
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"site_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_name": "Example",
"bank_name": "Example",
"branch": "text",
"country": "US",
"currency": "USD",
"account_number_cipher": "text",
"account_last4": "text",
"iban_cipher": "text",
"iban_last4": "text",
"swift_bic": "text",
"routing_number": "ROU-000001"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/supplier-bank-accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/supplier-bank-accountsCreate a supplier bank accounts
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
supplier_id | uuid | Yes | Supplier |
site_id | uuid | No | Payment site |
account_name | text | Yes | Account name |
bank_name | text | Yes | Bank |
branch | text | No | Branch |
country | text | No | Country |
currency | text | No | Currency |
account_last4 | text | No | Last four digits |
iban_last4 | text | No | IBAN last four |
swift_bic | text | No | SWIFT / BIC |
routing_number | text | No | Routing number — ABA, sort code, IFSC, BSB — whichever the country uses. |
routing_scheme | text | No | Routing scheme Allowed: aba sort_code ifsc bsb clabe iban other |
intermediary_bank | text | No | Intermediary bank |
intermediary_swift | text | No | Intermediary swift |
is_primary | boolean | No | Primary account |
verification_status | text | No | Verification Allowed: unverified pending verified failed expired |
verified_by | uuid | No | Verified by |
verified_on | date | No | Verified on |
verification_method | text | No | Verified by Allowed: callback bank_letter penny_test portal in_person third_party |
effective_from | date | No | In force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead. |
effective_to | date | No | Until — Leave empty for open-ended. Setting it ends this version rather than deleting it. |
Sample body
{
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_name": "Example",
"bank_name": "Example",
"site_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"branch": "text",
"country": "US",
"currency": "USD"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"site_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_name": "Example",
"bank_name": "Example",
"branch": "text",
"country": "US",
"currency": "USD",
"account_number_cipher": "text",
"account_last4": "text",
"iban_cipher": "text",
"iban_last4": "text",
"swift_bic": "text",
"routing_number": "ROU-000001"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/supplier-bank-accounts" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"supplier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","account_name":"Example","bank_name":"Example","site_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","branch":"text","country":"US","currency":"USD"}'PUT/api/scm/supplier-bank-accounts/{id}Change a supplier bank accounts
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
supplier_id | uuid | Yes | Supplier |
site_id | uuid | No | Payment site |
account_name | text | Yes | Account name |
bank_name | text | Yes | Bank |
branch | text | No | Branch |
country | text | No | Country |
currency | text | No | Currency |
account_last4 | text | No | Last four digits |
iban_last4 | text | No | IBAN last four |
swift_bic | text | No | SWIFT / BIC |
routing_number | text | No | Routing number — ABA, sort code, IFSC, BSB — whichever the country uses. |
routing_scheme | text | No | Routing scheme Allowed: aba sort_code ifsc bsb clabe iban other |
intermediary_bank | text | No | Intermediary bank |
intermediary_swift | text | No | Intermediary swift |
is_primary | boolean | No | Primary account |
verification_status | text | No | Verification Allowed: unverified pending verified failed expired |
verified_by | uuid | No | Verified by |
verified_on | date | No | Verified on |
verification_method | text | No | Verified by Allowed: callback bank_letter penny_test portal in_person third_party |
effective_from | date | No | In force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead. |
effective_to | date | No | Until — Leave empty for open-ended. Setting it ends this version rather than deleting it. |
Sample body
{
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"site_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_name": "Example",
"bank_name": "Example",
"branch": "text",
"country": "US",
"currency": "USD",
"account_number_cipher": "text",
"account_last4": "text",
"iban_cipher": "text",
"iban_last4": "text",
"swift_bic": "text",
"routing_number": "ROU-000001"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/supplier-bank-accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"supplier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","account_name":"Example"}'DELETE/api/scm/supplier-bank-accounts/{id}Delete a supplier bank accounts
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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/scm/supplier-bank-accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/supplier-bank-accounts/{id}/copyCopy
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):
overrides, preview, withLinesResponse
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/scm/supplier-bank-accounts/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 supplier bank accounts, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
supplier_id | uuid | read, write | Supplier |
site_id | uuid | read, write | Payment site |
account_name | text | read, write | Account name |
bank_name | text | read, write | Bank |
branch | text | read, write | Branch |
country | text | read, write | Country |
currency | text | read, write | Currency |
account_number_cipher | bytea | read only | Account number cipher |
account_last4 | text | read, write | Last four digits |
iban_cipher | bytea | read only | Iban cipher |
iban_last4 | text | read, write | IBAN last four |
swift_bic | text | read, write | SWIFT / BIC |
routing_number | text | read, write | Routing number — ABA, sort code, IFSC, BSB — whichever the country uses. |
routing_scheme | text | read, write | Routing scheme Allowed: aba sort_code ifsc bsb clabe iban other |
intermediary_bank | text | read, write | Intermediary bank |
intermediary_swift | text | read, write | Intermediary swift |
is_primary | boolean | read, write | Primary account |
verification_status | text | read, write | Verification Allowed: unverified pending verified failed expired |
verified_by | uuid | read, write | Verified by |
verified_on | date | read, write | Verified on |
verification_method | text | read, write | Verified by Allowed: callback bank_letter penny_test portal in_person third_party |
last_changed_on | date | read only | Last changed on |
last_changed_by | uuid | read only | Last changed by |
created_at | timestamp with time zone | read only | Created at |
effective_from | date | read, write | In force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead. |
effective_to | date | read, write | Until — Leave empty for open-ended. Setting it ends this version rather than deleting it. |
org_unit_id | uuid | read only | Org unit id |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
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 Supply Chain › Supplier · Bank Details 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.