Fetches a list of chart_of_accounts | Build with Bookkeep

Fetches a list of chart_of_accounts

GET https://api.bookkeep.com/v1/chart_of_accounts

Retrieves a paginated list of chart of accounts based on the provided query parameters. Each chart of account includes details such as app_name, account_identifier, account_name, account_currency, account_type.

Request

Query Parameters

page[size] integer

The number of chart of accounts to return per page.

Example: 10

page[number] integer

The page number to retrieve.

Example: 1

sort string

The sorting order of the chart of accounts. Supported values are account_identifier, -account_identifier, id, -id, account_name, -account_name, account_currency, -account_currency, account_type, -account_type, account_code, -account_code, account_status, -account_status, account_class_type, -account_class_type, account_sub_type, -account_sub_type, ignored_at, -ignored_at, resolved_at, -resolved_at.

Example:-id

fields[qb_account] string

Comma-separated list of fields to include in the response.

Example: account_identifier,account_name,account_status

filter[organization_id_eq] string

Filter chart of accounts by fields.

Example: 1

Responses

OK

Schema

data object[]

Array [

id string

Unique Bookkeep identifier for the ChartOfAccount object in string format.

Example: 1

type string

Type of object.

Default value: qb_account

Example: qb_account

attributes object

ChartOfAccount attributes.

id integer

Unique identifier for the ChartOfAccount object.

Example: 1

app_name string

Name of accounting Platform.

Example: net_suite

app_identifier string

Unique identifier specific to accounting platform.

Example: 4873XXXX_SB2

account_identifier string

ChartOfAccount identifier in accounting platform.

Example: 1960

account_name string

Name of the ChartOfAccount in accounting platform.

Example: Stripe Sales

account_currency string

Currency of ChartOfAccount in accounting platform or base currency of the accounting platform.

Example: USD

account_type string

ChartOfAccount type in accounting platform.

account_code string

ChartOfAccount code in accounting platform.

Example: BKSTR123

account_status string

ChartOfAccount status in accounting platform.

Example: BKSTR123

description string

Bookkeep Generated ChartOfAccount description.

Example: Stripe Sales (USD)

account_class_type string

ChartOfAccount class type in accounting platform.

account_sub_type string

ChartOfAccount sub_type in accounting platform.

organization_id integer

Unique identifier for the Organization object.

Example: 1

]

meta object

pagination object

current integer

The index of the current page.

Example: 1

next integernullable

The index of the next page. This property is only included when there is a next page available.

Example: 2

last integernullable

The index of the last page. This property is only included when there is a next page available.

Example: 5

records integer

The total number of objects.

Example: 100

links object

self string

URL to the object or collection of objects.

Example: https://api.bookkeep.com/v1/notifications

current stringnullable

URL to the current page of objects. This property is only returned when fetching a collection of objects.

Example: https://api.bookkeep.com/v1/notifications?page[number]=1&page[size]=10

next stringnullable

URL to the next page of notifications. This property is only returned when fetching a collection of objects when a next page is available.

last stringnullable

URL to the last page of notifications. This property is only returned when fetching a collection of objects when a next page is available.

{
  "data": [
    {
      "id": "1",
      "type": "qb_account",
      "attributes": {
        "id": 1,
        "app_name": "net_suite",
        "app_identifier": "4873XXXX_SB2",
        "account_identifier": "1960",
        "account_name": "Stripe Sales",
        "account_currency": "USD",
        "account_type": "string",
        "account_code": "BKSTR123",
        "account_status": "BKSTR123",
        "description": "Stripe Sales (USD)",
        "account_class_type": "string",
        "account_sub_type": "string",
        "organization_id": 1
      }
    }
  ],
  "meta": {
    "pagination": {
      "current": 1,
      "next": 2,
      "last": 5,
      "records": 100
    }
  },
  "links": {
    "self": "https://api.bookkeep.com/v1/notifications",
    "current": "https://api.bookkeep.com/v1/notifications?page[number]=1&page[size]=10",
    "next": "string",
    "last": "string"
  }
}

Authorization: http

name: basic
authtype: http
description: The Bookkeep API uses API keys to authenticate requests. You can view and manage your API keys in the [Bookkeep Developer Dashboard](https://app.bookkeep.com/developers/api_keys).
Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
Authentication to the API is performed via HTTP Basic Auth. Provide your Publishable key as the basic auth username value and your Secret key as the basic auth password value.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

curl -L -X GET 'https://api.bookkeep.com/v1/entities' \
  -H 'Authorization: Basic ZGlsaXAuYmFpcmFnaUBib29ra2VlcC5jbzpXLlM4NVZGbkJyeEY2QmI='

curl -L 'https://api.bookkeep.com/v1/chart_of_accounts' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'

Request Collapse all

Base URL

Edit

https://api.bookkeep.com

Auth

Username

Password

Parameters

Show optional parameters

page[size] — query

page[number] — query

sort — query

fields[qb_account] — query

filter[organization_id_eq] — query

Send API Request

ResponseClear

Click the Send API Request button above and see the response here!