Get a specific chart_of_account by ID

GET 
/v1/chart_of_accounts/:id

Get a specific chart_of_account by ID

Request

Path Parameters

id stringrequired

The ID of the ChartOfAccount to retrieve

Responses

200

A chart_of_account object

application/json

Schema

Schema

data object

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.

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

404

ChartOfAccount not found or inaccessible

application/json

Schema

Schema

errors object[]
Array [
status stringrequired
source object
pointer stringrequired
title stringrequired
detail stringrequired
]

Example (from schema)

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

Loading...