GET
/
api
/
item-categories
[
  {
    "id": 1,
    "name": "Electronics",
    "description": "Electronic devices and accessories",
    "costAccountId": 1,
    "sellAccountId": 1,
    "inventoryAccountId": 1,
    "costMethod": "FIFO",
    "userId": 1,
    "createdAt": "2024-03-20T10:00:00Z",
    "updatedAt": "2024-03-20T10:00:00Z",
    "count": 5
  }
]

Headers

​
Authorization
string
required

Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

​
organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

Response

200 - application/json

The item categories have been successfully retrieved.

​
id
number
required

The unique identifier of the item category

Example:

1

​
name
string
required

The name of the item category

Example:

"Electronics"

​
userId
number
required

The user ID who created the category

Example:

1

​
createdAt
string<date-time>
required

The creation date of the category

Example:

"2024-03-20T10:00:00Z"

​
updatedAt
string<date-time>
required

The last update date of the category

Example:

"2024-03-20T10:00:00Z"

​
count
number
required

The number of items in this category

Example:

5

​
description
string

The description of the item category

Example:

"Electronic devices and accessories"

​
costAccountId
number

The cost account ID

Example:

1

​
sellAccountId
number

The sell account ID

Example:

1

​
inventoryAccountId
number

The inventory account ID

Example:

1

​
costMethod
string

The cost method

Example:

"FIFO"