Xero Accounting Endpoint: TrackingCategoriesTable: Difference between revisions
Jump to navigation
Jump to search
Created page with "== Overview == The Xero '''TrackingCategories''' endpoint allows you to access the list of tracking categories. A Xero data file..." |
No edit summary |
||
| Line 15: | Line 15: | ||
The following fields are available for the TrackingCategoriesTable endpoint. | The following fields are available for the TrackingCategoriesTable endpoint. | ||
;DataFileID | |||
:A [[Field Type: GUID|guid field]] that provides the id of the xero data file as setup in OdataLink. | |||
;DataFileName | |||
:A [[Field Type: Text|text field]] provides the name of the xero data file as setup in OdataLink. | |||
;DataFileCode | |||
:A [[Field Type: Text|text field]] provides the code of the xero data file as setup in OdataLink. | |||
;TrackingCategoryID | ;TrackingCategoryID | ||
Latest revision as of 01:04, 23 June 2023
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 this endpoint is an alternate format of the TrackingCategories endpoint. It provides a format that can more easily integrate with Tableau, SSIS and Azure Data Factory.
Fields
The following fields are available for the TrackingCategoriesTable endpoint.
- DataFileID
- A guid field that provides the id of the xero data file as setup in OdataLink.
- DataFileName
- A text field provides the name of the xero data file as setup in OdataLink.
- DataFileCode
- A text field provides the code of the xero data file as setup in OdataLink.
- TrackingCategoryID
- A GUID field representing the internal id of a tracking category.
- This field can be linked to other endpoints.
- TrackingCategoryName
- A text field provides the name of the tracking category.
- TrackingCategoryStatus
- 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.
- TrackingOptionID
- A GUID field representing the internal id of a tracking category option.
- This field can be linked to other endpoints.
- TrackingOptionName
- A text field provides the name of the tracking category option.
- TrackingOptionStatus
- 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.
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Fields
- None
Related Endpoints
- BankTransactionsExpanded
- Budgets
- BudgetsAmounts
- CreditNotesExpanded
- InvoicesExpanded
- JournalsAccrual
- JournalsCash
- ManualJournalsExpanded
- OverpaymentsExpanded
- PrepaymentsExpanded
- PurchaseOrders
- Quotes
- RepeatingInvoices
- TrackingCategories