Xero Accounting Endpoint: TrackingCategories

Overview

The Xero TrackingCategories endpoint allows you to access the list of tracking categories.

A Xero data file may have up to 2 tracking categories active but may have many more defined.

Each tracking category is made up of one or more option.

For example, if Australian States were a tracking category, options would be ACT, NSW, NT, QLD, SA, TAS, VIC, WA.

Note that an alternate endpoint named TrackingCategoriesTable is available which provides a format that can more easily integrate with Tableau, SSIS and Azure Data Factory.

Fields

The following fields are available for the TrackingCategories endpoint.

DataFile: A record field that identifies the source data file for this record.

TrackingCategoryID: A GUID field representing the internal id of a tracking category.; This field can be linked to other endpoints.

Name: A text field provides the name of the tracking category.

Status

A text field indicates the status of the tracking category.

Possible values are:

ACTIVE: Indicate the tracking category can be used on transaction.
ARCHIVE: Indicates the tracking category cannot be used on transaction any longer but may have had historical transactions.

Options: A table field provides the list of tracking category option.; See Options Fields for more information.

Options Fields

The Options Fields provides a list of all possible tracking category option (e.g. value) that can be applied to a tracking category.

It contains the following sub fields.

TrackingOptionID: A GUID field representing the internal id of a tracking category option.; This field can be linked to other endpoints.

Name: A text field provides the name of the tracking category option.

Status

A text field indicates the status of the tracking category option.

Possible values are:

ACTIVE: Indicate the option can be used on transaction.
ARCHIVE: Indicates the option cannot be used on transaction any longer but may have had historical transactions.