Fetches a list of chart_of_accounts

GET 
/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] integerrequired
The number of chart of accounts to return per page.
Example: 10
page[number] integerrequired
The page number to retrieve.
Example: 1
sort stringrequired
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] stringrequired
Comma-separated list of fields to include in the response.
Example: account_identifier,account_name,account_status
filter[organization_id_eq] stringrequired
Filter chart of accounts by fields.
Example: 1

Responses

200

OK

application/json

Schema

Schema

data object[]
Array [
id stringrequired
Unique Bookkeep identifier for the ChartOfAccount object in string format.
type stringrequired
Default value: qb_account
Type of object.
attributes object
ChartOfAccount attributes.
id integerrequired
Unique identifier for the ChartOfAccount object.
app_name stringrequired
Name of accounting Platform.
app_identifier stringrequired
Unique identifier specific to accounting platform.
account_identifier stringrequired
ChartOfAccount identifier in accounting platform.
account_name stringrequired
Name of the ChartOfAccount in accounting platform.
account_currency stringrequired
Currency of ChartOfAccount in accounting platform or base currency of the accounting platform.
account_type stringrequired
ChartOfAccount type in accouting platform.
account_code stringrequired
ChartOfAccount code in accounting platform.
account_status stringrequired
ChartOfAccount status in accounting platform.
description stringrequired
Bookkeep Generated ChartOfAccount description.
account_class_type stringrequired
ChartOfAccount class type in accounting platform.
account_sub_type stringrequired
ChartOfAccount sub_type in accounting platform.
organization_id integerrequired
Unique identifier for the Organization object.
]
meta object

pagination object

current integerrequired

The index of the current page.

next integernullablerequired

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

last integernullablerequired

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

records integerrequired

The total number of objects.

links object

self stringrequired

URL to the object or collection of objects.

current stringnullablerequired

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

next stringnullablerequired

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

last stringnullablerequired

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

Example (from schema)

{
  "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"
  }
}

Loading...