Tracking Categories

The TrackingCategory object is used to represent a company's tracking categories.

The TrackingCategory object

Properties


idString
Required

remote_idString
Optional
The third-party API ID of the matching object.

remote_dataRemoteData[]
Optional

nameString
Optional
The tracking category's name.

statusEnum
Optional
The tracking category's status. Possible values include: ACTIVE, ARCHIVED, or - in cases where there is no clear mapping - the original value passed through.

category_typeEnum
Optional
The tracking category’s type. Possible values include: CLASS, DEPARTMENT, or - in cases where there is no clear mapping - the original value passed through.

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted by third party webhooks.

The TrackingCategory object
JSON
{
"id": "ecbe05ac-62a3-46c5-ab31-4b478b37d1b4",
"remote_id": "948201",
"remote_data": [
{
"path": "/actions",
"data": [
"Varies by platform"
]
}
],
"name": "Marketing Department",
"status": "ACTIVE",
"category_type": "DEPARTMENT",
"remote_was_deleted": true
}

GET

/tracking-categories

Returns a list of TrackingCategory objects.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


created_afterString
Optional
If provided, will only return objects created after this datetime.

created_beforeString
Optional
If provided, will only return objects created before this datetime.

cursorString
Optional
The pagination cursor value.

include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

modified_afterString
Optional
If provided, will only return objects modified after this datetime.

modified_beforeString
Optional
If provided, will only return objects modified before this datetime.

page_sizeInteger
Optional
Number of results to return per page.

remote_fieldsString
Optional
Which fields should be returned in non-normalized form.

remote_idString
Optional
The API provider's ID for the given object.

Response
JSON
{
"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
"previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
"results": [
{
"id": "ecbe05ac-62a3-46c5-ab31-4b478b37d1b4",
"remote_id": "948201",
"remote_data": [
{
"path": "/actions",
"data": [
"Varies by platform"
]
}
],
"name": "Marketing Department",
"status": "ACTIVE",
"category_type": "DEPARTMENT",
"remote_was_deleted": true
}
]
}
Field support by platform

FreshBooks

FreshBooks

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]

remote_idString

statusEnum

NetSuite

NetSuite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


category_typeEnum

nameString

remote_dataRemoteData[]

remote_idString

statusEnum

QuickBooks Online

QuickBooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


category_typeEnum

nameString

remote_idString

statusEnum

Sage Intacct

Sage Intacct

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


category_typeEnum

nameString

remote_dataRemoteData[]

remote_idString

statusEnum

Xero

Xero

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_idString

statusEnum
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET

/tracking-categories/{id}

Returns a TrackingCategory object with the given id.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


idString
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

remote_fieldsString
Optional
Which fields should be returned in non-normalized form.
Response
JSON
{
"id": "ecbe05ac-62a3-46c5-ab31-4b478b37d1b4",
"remote_id": "948201",
"remote_data": [
{
"path": "/actions",
"data": [
"Varies by platform"
]
}
],
"name": "Marketing Department",
"status": "ACTIVE",
"category_type": "DEPARTMENT",
"remote_was_deleted": true
}
Field support by platform

FreshBooks

FreshBooks

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]

remote_idString

statusEnum

NetSuite

NetSuite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


category_typeEnum

nameString

remote_dataRemoteData[]

remote_idString

statusEnum

QuickBooks Online

QuickBooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


category_typeEnum

nameString

remote_idString

statusEnum

Sage Intacct

Sage Intacct

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


category_typeEnum

nameString

remote_dataRemoteData[]

remote_idString

statusEnum

Xero

Xero

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_idString

statusEnum
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.

Previous

Tax Rates