Get a Category by ID - Bookeeping.ai Docs

GET

categories

{id}

Get a Category by ID

curl --request GET \
  --url https://api.bookeeping.ai/public-api/v1/categories/{id} \
  --header 'Authorization: Bearer <token>'

{
  "message": "<string>",
  "metaData": {
    "warnings": [
      "<string>"
    ]
  },
  "data": {
    "_id": "<string>",
    "name": "<string>",
    "projectId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "emoji": "<string>",
    "parentCategory": "INCOME",
    "isArchived": true,
    "number": "<string>",
    "group": "<string>",
    "createdBy": "USER"
  }
}

Authorizations

Authorization

string

header

required

API key for authentication. Get your key from the Dashboard > Settings > API Access.

Path Parameters

string

required

The id of the category. Expected to be a valid object id like 666666666666666666666666

Response

Get a Category by ID executed successfully

message

string

Success message

metaData

object

Show child attributes

metaData.warnings

string[]

Any validation warnings

data

object

Show child attributes

data._id

string

required

The id of the category

data.name

string

required

The name of the category

data.projectId

string

required

The project id of the category

data.createdAt

string<date-time>

required

The created at of the category

data.updatedAt

string<date-time>

required

The updated at of the category

data.emoji

string | null

data.parentCategory

enum<string> | null

Available options:

INCOME,

OTHER_INCOME,

SALES,

EXPENSE,

DEPRECIATION,

COST_OF_GOODS_SOLD,

OTHER_EXPENSE,

OVERHEAD,

CURRENT_ASSET,

FIXED_ASSET,

INVENTORY,

NON_CURRENT_ASSET,

PREPAYMENT,

LIABILITY,

CURRENT_LIABILITY,

NON_CURRENT_LIABILITY,

TAX_PAYABLE,

TAX,

EQUITY,

OTHER

data.isArchived

boolean | null

data.number

string | null

data.group

string | null

data.createdBy

enum<string> | null

Available options:

USER,

SYSTEM

Update a CategoryUpdate a Category

⌘I

Get a Category by ID

curl --request GET \
  --url https://api.bookeeping.ai/public-api/v1/categories/{id} \
  --header 'Authorization: Bearer <token>'

{
  "message": "<string>",
  "metaData": {
    "warnings": [
      "<string>"
    ]
  },
  "data": {
    "_id": "<string>",
    "name": "<string>",
    "projectId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "emoji": "<string>",
    "parentCategory": "INCOME",
    "isArchived": true,
    "number": "<string>",
    "group": "<string>",
    "createdBy": "USER"
  }
}

Routes

Authorizations

Path Parameters

Response