Appearance

Get Tracking categories ​

Endpoint ​

http
GET /unified/accounting/tracking_categories/{id}
Integrations supported
  • Brightpearl
  • Coupa
  • Microsoft Dynamics 365 Business Central
  • Oracle Netsuite
  • QuickBooks
  • Xero

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
category_type
string

The category type of the tracking category.

All possible enum values:
  • class
  • department
  • location
Required in
  • Oracle Netsuite

Response Body ​

id
string
REQUIRED · 

The unique identifier for tracking categories

Supported in
  • Brightpearl
  • Coupa
  • Microsoft Dynamics 365 Business Central
  • Oracle Netsuite
  • QuickBooks
  • Xero
name
string

The name of the tracking category

Supported in
  • Brightpearl
  • Coupa
  • Microsoft Dynamics 365 Business Central
  • Oracle Netsuite
  • QuickBooks
  • Xero
status
string

The status of the tracking category

All possible enum values:
  • active
  • archived
Supported in
  • Brightpearl
  • Coupa
  • Oracle Netsuite
  • QuickBooks
  • Xero
category_type
string

The category type of the tracking category

Supported in
  • Brightpearl
  • Coupa
  • Microsoft Dynamics 365 Business Central
  • Oracle Netsuite
  • QuickBooks
parent_category
string

The parent category of the tracking category

Supported in
  • Brightpearl
  • Oracle Netsuite
company
string

The company the tracking category belongs to

References: CompanyInfo → id
Supported in
  • Brightpearl
  • Microsoft Dynamics 365 Business Central
options
object[]

The options for the tracking category. Present in Xero

Supported in
  • Brightpearl
  • Microsoft Dynamics 365 Business Central
  • Xero
id
string

The unique identifier for tracking option

name
string

The name for tracking option

status
string

The status for tracking option

All possible enum values:
  • active
  • archived
created_at
string · date-time

This represents the date when the tracking category was created

Supported in
  • Brightpearl
  • Coupa
  • QuickBooks
updated_at
string · date-time

This represents the date when the tracking category was updated

Supported in
  • Brightpearl
  • Coupa
  • Microsoft Dynamics 365 Business Central
  • Oracle Netsuite
  • QuickBooks
remote_data
object

Raw data returned from the remote API call.