List bank accounts with balance summary

GET

/accounts/

const url = 'https://app.commitly.com/api/accounts/';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://app.commitly.com/api/accounts/ \
  --header 'Authorization: Bearer <token>'

Returns all bank accounts of the company together with aggregated balances. Each account includes its most recent transaction.

Group level (Enterprise Edition): called with group-level credentials, the response covers the bank accounts of all companies in the group.

Authorizations

commitlyOAuth

Responses

200

Balance summary and accounts.

application/json

object

total

Sum of all account balances, in the company currency.

number

available_limit

Sum of overdraft limits as of today.

number

current_month_balance

Forecast balance at the end of the current month; null if the company has no current forecast.

number | null

current_month_limit

Limits at the end of the current month.

number | null

next_month_balance

Forecast balance at the end of next month; null without a current forecast.

number | null

next_month_limit

Limits at the end of next month.

number | null

in_3_months_balance

Forecast balance three months ahead; null without a current forecast.

number | null

in_3_months_limit

Limits three months ahead.

number | null

fiscal_year_ending_balance

Forecast balance at the end of the fiscal year; null without a current forecast.

number | null

fiscal_year_ending_limit

Limits at the end of the fiscal year.

number | null

accounts

Array<object>

object

integer

bank

Bank data embedded in an account.

object

open_banking_connection_id

integer | null

name

string

bic

string

transaction_count

integer

last_transaction

Present in GET /accounts/ only.

object

integer

account

Short form of a bank account, embedded in transactions.

object

integer

name

string

alias

string

bank

Bank name. Present in the create-transactions response only.

string

currency

Present in the create-transactions response only.

string

value_date

string format: date-time

amount

number

purpose

string

counterpart_name

string

currency

ISO 4217 currency code.

string

date_created

string format: date-time

date_updated

string format: date-time

name

string

alias

string

iban

string

type_name

Account type as supplied by the bank provider (free text, e.g. Checking). Empty for offline accounts.

string

balance

number

overdraft_limit

number | null

status

Account status. Only offline accounts accept transactions via POST /accounts/{account_id}/transactions/; accounts with status API or DISCONNECTED, and accounts linked to a bank connection, do not.

string

Allowed values: UPDATED UPDATED_FIXED DOWNLOAD_IN_PROGRESS DOWNLOAD_FAILED DEPRECATED DISCONNECTED API OFFLINE

last_successful_update

string | null format: date-time

last_update_attempt

string | null format: date-time

banking_api_account

integer | null

Example

{
  "total": 98865.46,
  "available_limit": 0,
  "current_month_balance": 104158.74,
  "next_month_balance": 263990.44,
  "in_3_months_balance": 262083.61,
  "fiscal_year_ending_balance": 320992.93,
  "accounts": [
    {
      "id": 4002,
      "bank": {
        "open_banking_connection_id": 5001,
        "name": "Example Bank",
        "bic": "EXAMPLEXXXX"
      },
      "transaction_count": 1082,
      "last_transaction": {
        "id": 7001,
        "account": {
          "id": 4002,
          "name": "Checking account",
          "alias": "Main"
        },
        "value_date": "2024-01-11T00:00:00Z",
        "amount": -104.64,
        "purpose": "Payment invoice 200763",
        "counterpart_name": "Example Supplier GmbH"
      },
      "currency": "EUR",
      "date_created": "2022-05-05T13:10:13.354781Z",
      "date_updated": "2024-01-11T10:51:33.342193Z",
      "name": "Checking account",
      "alias": "Main",
      "iban": "DE89370400440532013000",
      "type_name": "Checking",
      "balance": 60360.68,
      "overdraft_limit": 0,
      "status": "UPDATED",
      "last_successful_update": "2024-01-11T10:50:47Z",
      "last_update_attempt": "2024-01-11T10:50:46Z",
      "banking_api_account": 6001
    }
  ]
}

401

The access token is invalid or has expired. Request a new token. The message is localized (see Accept-Language).

application/json

object

detail

required

Error message.

string

code

Present only if the company’s edition does not include the function; value billing_plan_permission_denied.

string

Example

{
  "detail": "Invalid token."
}

Headers

WWW-Authenticate

string

Authentication scheme, Bearer.

Example

Bearer

403

No access token was sent, or the credentials are not allowed to call this endpoint. If the company’s COMMITLY edition does not include the requested function, the body additionally contains "code": "billing_plan_permission_denied".

application/json

object

detail

required

Error message.

string

code

Present only if the company’s edition does not include the function; value billing_plan_permission_denied.

string

Example

{
  "detail": "User must be authenticated to access this resource."
}