Tracking Categories

Available tracking categories for a business.

Overview

Tracking categories, also known as classes, are used to see how different areas of your business are performing (such as departments, cost centres, or locations). From the Tracking Categories endpoint, you can retrieve or update a list of all tracking categories for a specified business. See Tracking Categories endpoint for more details.

Data Model

Field

Type

Description

id
sortable, filterable

string

Identifier for the tracking category, unique to the business in the accounting service provider.

name
sortable, filterable

string

Name of the tracking category in the accounting service provider.

isEditable

boolean

Indicates if a tracking category can be edited in the accounting service provider.

parentRef

object

Parent or main category that the tracking category belongs to

status

string

Current statues of a tracking category. Can be:
active
archived
unknown

sourceModifiedDate

string
See Date

Date the record was last changed in the accounting service provider.

ParentRef

Field

Type

Description

id
filterable

string

Unique identifier for the tracking category in the accounting service provider.

name
filterable

decimal

Name of the tracking category in the accounting service provider.

Tracking Category Reference

Data types that reference a tracking category, for example, invoice and bills, use a trackingCategoryRef that includes the id and name of the linked tracking category.

❗️

Pushing Tracking Categories

Assigning tracking categories is currently not supported for push transactions.

Example Data

{
  "data":
  [
    {
      "id": "123",
      "name": "East Coast",
      "isEditable": true,
      "parentRef":
      {
        "id": "434",
        "name": "Region"
      },
      "status": "active",
      "sourceModifiedDate": "2021-03-10T11:26:06.619Z"
    }
  ]
}

Did this page help you?