BankAccounts

Quick Links

Accounts Accounting Entries Products Customers Sales quotes Sales invoices Suppliers Purchase invoices

HTTP Operation Type Object
Query bankAccounts filtered by id Why?

Description

Bank Accounts represent the aggregated view of a bank in Sage Active.
They combine:

  • the definition of the bank account stored in Sage Active (payment method configuration),
  • and the banking information exposed by the bank, such as balances, synchronization status, and transaction availability.

A Bank Account exposes both accounting-related data and banking synchronization data through a single object.

img img

This operation is an action, not a classic query supporting pagination, filtering, or sorting.
It returns a static list of all banks declared and available in Sage Active.
The result set is predefined and does not depend on dynamic search criteria or runtime parameters.
When a bank account is not connected to the banking service, the returned id is the empty GUID (00000000-0000-0000-0000-000000000000).

GraphQL Query
query {
  bankAccounts {
    id
    paymentMethodId
    disabled
    referenceName
    type
    iban
    bic
    bankName
    bankingBankLogo
    balanceAmount
    bankingHasTransactions
    bankingLastTransactionsReceived
  }
}

Example Response

{
  "data": {
    "bankAccounts": [
      {
        "id": "59d59d75-66f1-44da-8eb0-318b4c4d8982",
        "paymentMethodId": "59d59d75-66f1-44da-8eb0-318b4c4d8982",
        "disabled": false,
        "referenceName": "Compte bancaire par défaut",
        "type": "BANK_ACCOUNT",
        "iban": "ES7921000813610123456789",
        "bic": "CAIXESBB",
        "bankName": "CAIXABANK",
        "bankingBankLogo": "https://s3-eu-west-1.amazonaws.com/bnkc-dev01-s3-eu-west-1-banklogos/sage_demo_bank_icon.svg",
        "balanceAmount": 0,
        "bankingHasTransactions": true,
        "bankingLastTransactionsReceived": "2026-01-26T10:47:41.209Z"
      },
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "paymentMethodId": "8e4f2b1a-3c5d-4e6f-8a9b-0c1d2e3f4a5b",
        "disabled": false,
        "referenceName": "Compte bancaire",
        "type": "BANK_ACCOUNT",
        "iban": "FR7630066100410001057380116",
        "bic": "CMCIFRPP",
        "bankName": "CIC",
        "bankingBankLogo": null,
        "balanceAmount": 0,
        "bankingHasTransactions": false,
        "bankingLastTransactionsReceived": null
      },
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "paymentMethodId": "7d3e1c90-2b4a-5f6e-9d8c-7b6a59483726",
        "disabled": false,
        "referenceName": "Caisse par défaut",
        "type": "CASH",
        "iban": null,
        "bic": null,
        "bankName": null,
        "bankingBankLogo": null,
        "balanceAmount": 23179.2,
        "bankingHasTransactions": false,
        "bankingLastTransactionsReceived": null
      }
    ]
  }
}
Key Value
Authorization Bearer Current access Token How to find?
X-TenantId Current tenant id Why deprecated ?
X-OrganizationId Current organization Id How to find?
x-api-key Primary or secondary subscription key of your app How to find?

bankAccounts

Fields Type Description
id UUID Bank account ID. Empty GUID when when the bank is not connected
paymentMethodId UUID Stable identifier of the payment method
creationDate DateTime Creation date
modificationDate DateTime Last modification date
     
disabled Boolean Indicates whether the payment method is disabled
     
Identification    
referenceName String Reference name
type
  • NOT_SPECIFIED
  • BANK_ACCOUNT
  • CASH
 Payment method type
iban String IBAN
bic String BIC / SWIFT
bankName String Bank name
bankingBankLogo String Bank logo URL
     
Accounting data    
accountingAccountCode String Accounting account code
accountingAccountTotalBalance Decimal Total balance of the accounting account
subAccountId UUID Linked accounting sub-account
journalTypeId UUID Journal type identifier
     
Banking balances    
balanceAmount Decimal Current balance
bankingAvailableBalanceAmount Decimal Available balance amount
bankingLedgerBalanceAmount Decimal Ledger balance amount
bankingAvailableBalanceDate DateTime Available balance date
bankingLedgerBalanceDate DateTime Ledger balance date
     
Connection & synchronization    
bankingLastSyncDate DateTime Last banking synchronization date
bankingPendingTransactions Int Number of pending banking transactions
bankingHasTransactions Boolean Indicates if transactions exist
bankingLastTransactionsReceived DateTime Last time transactions were received
Info

  • Bank account identification

    • id
      When the bank account is not connected to the banking service, id is the empty GUID (00000000-0000-0000-0000-000000000000).
      Use paymentMethodId when you need a stable payment method identifier that still applies in that case.
    • referenceName
      User-defined name of the bank account in Sage Active.
      This value is freely set by the user to identify the bank account in the application (for example, “Main professional account” or “Savings account”).
      It has no impact on synchronization or accounting logic and is used for display and identification purposes only.
    • type
      Payment method type associated with the bank account.
      This field indicates how the bank account is exposed and used within Sage Active (for example, bank account, cash account, etc.).
    • bankName
      Name of the synchronized bank as provided by the banking aggregation service.
      This value reflects the financial institution linked during the bank connection process and may differ from the user-defined reference name.
    • bankingBankLogo URL pointing to the bank logo provided by the banking aggregation service. This value is informational and intended for UI display purposes only.

  • Banking balances

    • balanceAmount Current balance of the bank account as exposed in Sage Active. This value may come from the last synchronization and can differ from the real-time bank balance.
    • bankingAvailableBalanceAmount Available balance reported by the bank, taking into account pending operations such as card payments or authorizations.
    • bankingLedgerBalanceAmount Ledger balance provided by the bank, usually corresponding to the balance after booked transactions only, excluding pending ones.
    • bankingAvailableBalanceDate Date at which the available balance was calculated by the bank.
    • bankingLedgerBalanceDate Date at which the ledger balance was calculated by the bank.

  • Connection & synchronization

    • bankingLastSyncDate Date and time of the last successful synchronization with the bank. This corresponds to the last moment when balances and or transactions were retrieved from the banking provider.
    • bankingPendingTransactions Number of transactions that have been retrieved from the bank but are not yet fully processed or accounted for. This typically includes transactions waiting for categorization or reconciliation.
    • bankingHasTransactions Indicates whether at least one banking transaction has been retrieved for this bank account. This flag does not imply that transactions are already posted in accounting.
    • bankingLastTransactionsReceived Date and time when the last batch of banking transactions was received from the bank, independently of their accounting processing status.