Bank Accounts
Bank accounts connect statements, payments, and reconciliation. Use these queries and mutations to provision cash/bank ledgers, update metadata, and remove unused accounts. Pair this with Bank Ingest when you import transactions.
Prerequisites
- A Naqood API secret or OAuth-issued secret scoped to the organization
- The organization
slugon every request - A role that can manage bank accounts
BankAccount fields
| Field | Type | Notes |
|---|---|---|
id | ID! | Stable identifier |
name | String! | Display label (for example “Main AED Account”) |
bankName | String | Optional bank name |
iban / bic | String | Optional identifiers |
branch | String | Optional branch info |
address / city / postalCode | String | Optional location details |
country | String | ISO country name |
currency | String! | ISO‑4217 code (for example AED, USD) |
account | Account | Linked ledger account (when applicable) |
externalId | String | Upstream reference (for example a bank feed identifier) |
externalBalance | String | Optional latest observed balance from your source system |
externalBalanceDate | Timestamp | When that balance was recorded |
createdAt / updatedAt | Timestamp! | Audit timestamps |
List bank accounts
Fetch all bank and cash accounts for an organization.
query BankAccounts($slug: Slug!) {
organization(slug: $slug) {
bankAccounts {
id
name
bankName
currency
iban
bic
externalId
}
}
}
Create a bank account
mutation CreateBankAccount($input: CreateBankAccountInput!) {
createBankAccount(input: $input)
}
CreateBankAccountInput highlights:
| Field | Required | Notes |
|---|---|---|
slug | ✅ | Organization issuing the account |
name | ✅ | Display label |
currency | ✅ | ISO‑4217 code |
bankName | Optional | Bank label shown in UI |
iban / bic | Optional | Banking identifiers |
externalId | Optional | Use to align with external systems |
Update a bank account
mutation UpdateBankAccount($input: UpdateBankAccountInput!) {
updateBankAccount(input: $input) {
id
name
bankName
iban
bic
externalId
externalBalance
externalBalanceDate
}
}
Provide the id plus any fields you want to change. Use externalBalance and externalBalanceDate to keep Naqood aligned with the latest statement balance you observe upstream.