Get a specific chart_of_account by ID | Build with Bookkeep

Get a specific chart_of_account by ID

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

Get a specific chart_of_account by ID

Request

Path Parameters

id string required
The ID of the ChartOfAccount to retrieve

Responses

A chart_of_account object

Schema

data object

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

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

links object

self string
URL to the object or collection of objects.
Example: https://api.bookkeep.com/v1/notifications

current string null
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 string null
URL to the next page of notifications. This property is only returned when fetching a collection of objects a next page is available.

last string null
URL to the last page of notifications. This property is only returned when fetching a collection of objects 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
    }
  },
  "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"
  }
}

ChartOfAccount not found or inaccessible

Schema

errors object[]

Array [ {
status string
Example: 404
source object
pointer string
Example:/chart_of_accounts/0
title string
Example: invalid_or_inaccessible_chart_of_account_id
detail string
Example: ChartOfAccount not found or you do not have access to it. Please try again with a valid chart_of_account id or contact support. See '/chart_of_accounts' for a list of all chart_of_accounts accessible to you.
}
]

{
  "errors": [
    {
      "status": "404",
      "source": {
        "pointer": "/chart_of_accounts/0"
      },
      "title": "invalid_or_inaccessible_chart_of_account_id",
      "detail": "ChartOfAccount not found or you do not have access to it. Please try again with a valid chart_of_account id or contact support. See '/chart_of_accounts' for a list of all chart_of_accounts accessible to you."
    }
  ]
}

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

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

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

Base URL

Edit

https://api.bookkeep.com

Auth

Username

Password

Parameters

id — path required

Send API Request

Response Clear

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