Xero Accounting Endpoint: TrackingCategories: 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 may have up to..." |
No edit summary |
||
| (15 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
== Overview == | == Overview == | ||
The Xero '''TrackingCategories''' [[Endpoints|endpoint]] allows you to access the list of tracking categories. | The Xero '''TrackingCategories''' [[Xero Accounting Endpoints|endpoint]] allows you to access the list of tracking categories. | ||
A [[Data Files|Xero data file]] may have up to 2 tracking categories active but may have many more defined. | A [[Data Files|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. | 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 [[Xero Accounting Endpoint: TrackingCategoriesTable|TrackingCategoriesTable]] is available which provides a format that can more easily integrate with Tableau, SSIS and Azure Data Factory. | |||
== Fields == | == Fields == | ||
The following fields are available for the TrackingCategories endpoint. | The following fields are available for the TrackingCategories endpoint. | ||
;DataFile | |||
:A [[Field Type: Record|record field]] that identifies the [[Field: DataFiles|source data file]] for this record. | |||
;TrackingCategoryID | ;TrackingCategoryID | ||
| Line 32: | Line 40: | ||
The [[#Fields|Options Fields]] provides a list of all possible tracking category option (e.g. value) that can be applied to a tracking category. | The [[#Fields|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. | It contains the following sub fields. | ||
| Line 53: | Line 59: | ||
== Xero API == | == Xero API == | ||
For a detailed run through of the endpoint, you can see the [developer.xero.com/documentation/api/accounting/trackingcategories Xero API]. | For a detailed run through of the endpoint, you can see the [https://developer.xero.com/documentation/api/accounting/trackingcategories Xero API]. | ||
| Line 63: | Line 69: | ||
== Related Endpoints == | == Related Endpoints == | ||
: | :[[Xero Accounting Endpoint: BankTransactionsExpanded|BankTransactionsExpanded]] | ||
:[[Xero Accounting Endpoint: Budgets|Budgets]] | |||
:[[Xero Accounting Endpoint: BudgetsAmounts|BudgetsAmounts]] | |||
:[[Xero Accounting Endpoint: CreditNotesExpanded|CreditNotesExpanded]] | |||
:[[Xero Accounting Endpoint: InvoicesExpanded|InvoicesExpanded]] | |||
:[[Xero Accounting Endpoint: JournalsAccrual|JournalsAccrual]] | |||
:[[Xero Accounting Endpoint: JournalsCash|JournalsCash]] | |||
:[[Xero Accounting Endpoint: ManualJournalsExpanded|ManualJournalsExpanded]] | |||
:[[Xero Accounting Endpoint: OverpaymentsExpanded|OverpaymentsExpanded]] | |||
:[[Xero Accounting Endpoint: PrepaymentsExpanded|PrepaymentsExpanded]] | |||
:[[Xero Accounting Endpoint: PurchaseOrders|PurchaseOrders]] | |||
:[[Xero Accounting Endpoint: Quotes|Quotes]] | |||
:[[Xero Accounting Endpoint: RepeatingInvoices|RepeatingInvoices]] | |||
:[[Xero Accounting Endpoint: TrackingCategoriesTable|TrackingCategoriesTable]] | |||
== Related Topics == | |||
:[[Xero Accounting Models]] | |||
:[[Xero Accounting Endpoints]] | |||
Latest revision as of 22:26, 18 December 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 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.
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
- TrackingCategoriesTable