Accounting · Treasury
Guarantees & Letters of Credit
Not on the balance sheet and absolutely on the risk register: a performance bond that expires unrenewed loses the contract it secured.
/api/accounting/bank-guaranteesPublished as /api/v1/bank-guaranteesDownload specification (OpenAPI 3.1) Screen: Guarantees & Letters of Credit
Overview
| 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 › Guarantees & Letters of Credit 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 | acct.bank_guarantees · 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/accounting/bank-guaranteesList guarantees & letters of credit
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",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"guarantee_no": "GUA-000001",
"name": "Example",
"guarantee_type": "text",
"direction": "issued",
"issuing_bank": "text",
"bank_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"beneficiary": "text",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"project_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"contract_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"currency": "USD"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/accounting/bank-guarantees?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/bank-guarantees/{id}Read one bank guarantee
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",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"guarantee_no": "GUA-000001",
"name": "Example",
"guarantee_type": "text",
"direction": "issued",
"issuing_bank": "text",
"bank_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"beneficiary": "text",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"project_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"contract_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"currency": "USD"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/accounting/bank-guarantees/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/bank-guaranteesCreate a bank guarantee
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
name | text | Yes | Name |
guarantee_type | text | No | Type |
direction | text | No | Direction Allowed: issued received |
issuing_bank | text | No | Issuing bank |
bank_account_id | uuid | No | Bank account |
beneficiary | text | No | Beneficiary |
account_id | uuid | No | Customer |
supplier_id | uuid | No | Supplier |
project_id | uuid | No | Project |
contract_id | uuid | No | Job contract |
currency | text | No | Currency |
amount | numeric | No | Amount |
current_amount | numeric | No | Current amount |
is_reducing | boolean | No | Steps down as the contract progresses |
issue_date | date | No | Issued |
effective_date | date | No | Effective |
expiry_date | date | No | Expires |
claim_period_days | integer | No | Claim period (days) |
cash_margin | numeric | No | Cash margin held — Restricted cash: it must not be counted as available. |
commission_pct | numeric | No | Commission % |
commission_paid | numeric | No | Commission paid |
auto_renew | boolean | No | Renews automatically — One that renews forever costs a fee every year; one that is forgotten loses the contract. |
renewal_notice_days | integer | No | Renewal notice (days) |
claim_amount | numeric | No | Claim amount |
claim_date | date | No | Claim date |
reference | text | No | Reference |
document_url | text | No | Document |
notes | text | No | Notes |
Sample body
{
"name": "Example",
"guarantee_type": "text",
"direction": "issued",
"issuing_bank": "text",
"bank_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"guarantee_no": "GUA-000001",
"name": "Example",
"guarantee_type": "text",
"direction": "issued",
"issuing_bank": "text",
"bank_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"beneficiary": "text",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"project_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"contract_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"currency": "USD"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/bank-guarantees" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","guarantee_type":"text","direction":"issued","issuing_bank":"text","bank_account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/accounting/bank-guarantees/{id}Change a bank guarantee
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 |
|---|---|---|---|
name | text | Yes | Name |
guarantee_type | text | No | Type |
direction | text | No | Direction Allowed: issued received |
issuing_bank | text | No | Issuing bank |
bank_account_id | uuid | No | Bank account |
beneficiary | text | No | Beneficiary |
account_id | uuid | No | Customer |
supplier_id | uuid | No | Supplier |
project_id | uuid | No | Project |
contract_id | uuid | No | Job contract |
currency | text | No | Currency |
amount | numeric | No | Amount |
current_amount | numeric | No | Current amount |
is_reducing | boolean | No | Steps down as the contract progresses |
issue_date | date | No | Issued |
effective_date | date | No | Effective |
expiry_date | date | No | Expires |
claim_period_days | integer | No | Claim period (days) |
cash_margin | numeric | No | Cash margin held — Restricted cash: it must not be counted as available. |
commission_pct | numeric | No | Commission % |
commission_paid | numeric | No | Commission paid |
auto_renew | boolean | No | Renews automatically — One that renews forever costs a fee every year; one that is forgotten loses the contract. |
renewal_notice_days | integer | No | Renewal notice (days) |
claim_amount | numeric | No | Claim amount |
claim_date | date | No | Claim date |
reference | text | No | Reference |
document_url | text | No | Document |
notes | text | No | Notes |
Sample body
{
"name": "Example",
"guarantee_type": "text"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"guarantee_no": "GUA-000001",
"name": "Example",
"guarantee_type": "text",
"direction": "issued",
"issuing_bank": "text",
"bank_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"beneficiary": "text",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"project_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"contract_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"currency": "USD"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/accounting/bank-guarantees/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","guarantee_type":"text"}'DELETE/api/accounting/bank-guarantees/{id}Delete a bank guarantee
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/accounting/bank-guarantees/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/bank-guarantees/{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/accounting/bank-guarantees/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 bank guarantee, 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 |
org_unit_id | uuid | read only | Org unit id |
guarantee_no | text | read only | Guarantee no |
name | text | read, write | Name |
guarantee_type | text | read, write | Type |
direction | text | read, write | Direction Allowed: issued received |
issuing_bank | text | read, write | Issuing bank |
bank_account_id | uuid | read, write | Bank account |
beneficiary | text | read, write | Beneficiary |
account_id | uuid | read, write | Customer |
supplier_id | uuid | read, write | Supplier |
project_id | uuid | read, write | Project |
contract_id | uuid | read, write | Job contract |
currency | text | read, write | Currency |
amount | numeric | read, write | Amount |
current_amount | numeric | read, write | Current amount |
is_reducing | boolean | read, write | Steps down as the contract progresses |
issue_date | date | read, write | Issued |
effective_date | date | read, write | Effective |
expiry_date | date | read, write | Expires |
claim_period_days | integer | read, write | Claim period (days) |
cash_margin | numeric | read, write | Cash margin held — Restricted cash: it must not be counted as available. |
commission_pct | numeric | read, write | Commission % |
commission_paid | numeric | read, write | Commission paid |
auto_renew | boolean | read, write | Renews automatically — One that renews forever costs a fee every year; one that is forgotten loses the contract. |
renewal_notice_days | integer | read, write | Renewal notice (days) |
status | text | read only | Status |
released_at | timestamp with time zone | read only | Released at |
claim_amount | numeric | read, write | Claim amount |
claim_date | date | read, write | Claim date |
reference | text | read, write | Reference |
document_url | text | read, write | Document |
notes | text | read, write | Notes |
created_at | timestamp with time zone | read only | Created at |
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 Accounting › Guarantees & Letters of Credit 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.