Tracking Categories
TheTrackingCategory object is used to represent a company's tracking categories.The TrackingCategory object
Properties
idStringRequired
remote_idStringOptional
The third-party API ID of the matching object.
nameStringOptional
The tracking category's name.
statusEnumOptional
The tracking category's status. Possible values include:
ACTIVE, ARCHIVED, or - in cases where there is no clear mapping - the original value passed through.remote_was_deletedBooleanRequired
Indicates whether or not this object has been deleted on the third-party.
The TrackingCategory object
JSON
{"id": "ecbe05ac-62a3-46c5-ab31-4b478b37d1b4","remote_id": "948201","name": "Marketing Department","status": "ACTIVE","remote_was_deleted": true}
GET
/tracking-categories
Returns a list of TrackingCategory objects.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
created_afterStringOptional
If provided, will only return objects created after this datetime.
created_beforeStringOptional
If provided, will only return objects created before this datetime.
cursorStringOptional
The pagination cursor value.
include_deleted_dataBooleanOptional
Whether to include data that was deleted in the third-party service.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_afterStringOptional
If provided, will only return objects modified after this datetime.
modified_beforeStringOptional
If provided, will only return objects modified before this datetime.
page_sizeIntegerOptional
Number of results to return per page.
remote_idStringOptional
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","name": "Marketing Department","status": "ACTIVE","remote_was_deleted": true}]}
Field support by platform
FreshBooks
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
remote_idStringnameStringstatusEnum
Xero
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
remote_idStringnameStringstatusEnum
Quickbooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
remote_idStringnameStringstatusEnum
Netsuite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
remote_idStringnameStringstatusEnumHint: Use the /linked-accounts endpoint to pull platform support information.
GET
/tracking-categories/{id}
Returns a TrackingCategory object with the given id.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
idStringRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
Response
JSON
{"id": "ecbe05ac-62a3-46c5-ab31-4b478b37d1b4","remote_id": "948201","name": "Marketing Department","status": "ACTIVE","remote_was_deleted": true}
Field support by platform
FreshBooks
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
remote_idStringnameStringstatusEnumXero
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
remote_idStringnameStringstatusEnumQuickbooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
remote_idStringnameStringstatusEnumNetsuite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
remote_idStringnameStringstatusEnumHint: Use the /linked-accounts endpoint to pull platform support information.