TRANXACT.AI Help

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.

Type REST6 operationsBase path /api/accounting/bank-guaranteesPublished as /api/v1/bank-guarantees

Download specification (OpenAPI 3.1) Screen: Guarantees & Letters of Credit

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 › 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.
Tableacct.bank_guarantees · 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

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

GET/api/accounting/bank-guaranteesList guarantees & letters of credit

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",
      "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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
nametextYesName
guarantee_typetextNoType
directiontextNoDirection
Allowed: issued received
issuing_banktextNoIssuing bank
bank_account_iduuidNoBank account
beneficiarytextNoBeneficiary
account_iduuidNoCustomer
supplier_iduuidNoSupplier
project_iduuidNoProject
contract_iduuidNoJob contract
currencytextNoCurrency
amountnumericNoAmount
current_amountnumericNoCurrent amount
is_reducingbooleanNoSteps down as the contract progresses
issue_datedateNoIssued
effective_datedateNoEffective
expiry_datedateNoExpires
claim_period_daysintegerNoClaim period (days)
cash_marginnumericNoCash margin held — Restricted cash: it must not be counted as available.
commission_pctnumericNoCommission %
commission_paidnumericNoCommission paid
auto_renewbooleanNoRenews automatically — One that renews forever costs a fee every year; one that is forgotten loses the contract.
renewal_notice_daysintegerNoRenewal notice (days)
claim_amountnumericNoClaim amount
claim_datedateNoClaim date
referencetextNoReference
document_urltextNoDocument
notestextNoNotes

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

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
nametextYesName
guarantee_typetextNoType
directiontextNoDirection
Allowed: issued received
issuing_banktextNoIssuing bank
bank_account_iduuidNoBank account
beneficiarytextNoBeneficiary
account_iduuidNoCustomer
supplier_iduuidNoSupplier
project_iduuidNoProject
contract_iduuidNoJob contract
currencytextNoCurrency
amountnumericNoAmount
current_amountnumericNoCurrent amount
is_reducingbooleanNoSteps down as the contract progresses
issue_datedateNoIssued
effective_datedateNoEffective
expiry_datedateNoExpires
claim_period_daysintegerNoClaim period (days)
cash_marginnumericNoCash margin held — Restricted cash: it must not be counted as available.
commission_pctnumericNoCommission %
commission_paidnumericNoCommission paid
auto_renewbooleanNoRenews automatically — One that renews forever costs a fee every year; one that is forgotten loses the contract.
renewal_notice_daysintegerNoRenewal notice (days)
claim_amountnumericNoClaim amount
claim_datedateNoClaim date
referencetextNoReference
document_urltextNoDocument
notestextNoNotes

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

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-guarantees/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/bank-guarantees/{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-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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
guarantee_notextread onlyGuarantee no
nametextread, writeName
guarantee_typetextread, writeType
directiontextread, writeDirection
Allowed: issued received
issuing_banktextread, writeIssuing bank
bank_account_iduuidread, writeBank account
beneficiarytextread, writeBeneficiary
account_iduuidread, writeCustomer
supplier_iduuidread, writeSupplier
project_iduuidread, writeProject
contract_iduuidread, writeJob contract
currencytextread, writeCurrency
amountnumericread, writeAmount
current_amountnumericread, writeCurrent amount
is_reducingbooleanread, writeSteps down as the contract progresses
issue_datedateread, writeIssued
effective_datedateread, writeEffective
expiry_datedateread, writeExpires
claim_period_daysintegerread, writeClaim period (days)
cash_marginnumericread, writeCash margin held — Restricted cash: it must not be counted as available.
commission_pctnumericread, writeCommission %
commission_paidnumericread, writeCommission paid
auto_renewbooleanread, writeRenews automatically — One that renews forever costs a fee every year; one that is forgotten loses the contract.
renewal_notice_daysintegerread, writeRenewal notice (days)
statustextread onlyStatus
released_attimestamp with time zoneread onlyReleased at
claim_amountnumericread, writeClaim amount
claim_datedateread, writeClaim date
referencetextread, writeReference
document_urltextread, writeDocument
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
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_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 › Guarantees & Letters of Credit 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.