Tracking Categories
A
TrackingCategory
object represents a categorization method used to classify transactions within an accounting platform. They are often used to group records for reporting and analysis purposes. The most common types of TrackingCategories
are Classes and Departments.Properties
id
UUIDRequired
remote_id
StringOptional
The third-party API ID of the matching object.
created_at
DateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_at
DateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
name
StringOptional
The tracking category's name.
status
EnumOptional
The tracking category's status. Possible values include:
ACTIVE
, ARCHIVED
. In cases where there is no clear mapping, the original value passed through will be returned.category_type
EnumOptional
The tracking category’s type. Possible values include:
CLASS
, DEPARTMENT
. In cases where there is no clear mapping, the original value passed through will be returned.parent_category
UUIDOptional
ID of the parent tracking category.
company
UUIDOptional
The company the tracking category belongs to.
remote_was_deleted
BooleanRequired
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
field_mappings
ObjectOptional
remote_data
RemoteData[]Optional
GET
/tracking-categories
https://api.merge.dev/api/accounting/v1/tracking-categories
US
EU
APAC
Returns a list of TrackingCategory
objects.
Query & Path Parameters
company_id
StringOptional
If provided, will only return tracking categories for this company.
created_after
DateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_before
DateTime (ISO 8601)Optional
If provided, will only return objects created before this datetime.
cursor
StringOptional
The pagination cursor value.
expand
StringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_data
BooleanOptional
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_data
BooleanOptional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
modified_after
DateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_before
DateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
page_size
IntegerOptional
Number of results to return per page.
remote_fields
StringOptional
Deprecated. Use show_enum_origins.
remote_id
StringOptional
The API provider's ID for the given object.
show_enum_origins
StringOptional
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. Learn more
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
FreshBooks
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
category_type
Enumname
Stringparent_category
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstatus
EnumMicrosoft Dynamics 365 Business Central
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
category_type
Enumcompany
UUIDname
Stringparent_category
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
StringMicrosoft Dynamics Finance and Operations
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
category_type
Enumname
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
StringNetSuite
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
category_type
Enumcompany
UUIDname
Stringparent_category
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstatus
EnumQuickBooks Online
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
category_type
Enumname
Stringparent_category
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstatus
EnumSage Intacct
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
category_type
Enumcompany
UUIDname
Stringparent_category
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstatus
EnumWorkday
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
category_type
Enumname
Stringremote_id
StringXero
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
category_type
Enumname
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstatus
EnumGET
/tracking-categories/{id}
https://api.merge.dev/api/accounting/v1/tracking-categories/{id}
US
EU
APAC
Returns a TrackingCategory
object with the given id
.
Query & Path Parameters
expand
StringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
id
UUIDRequired
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
remote_fields
StringOptional
Deprecated. Use show_enum_origins.
show_enum_origins
StringOptional
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. Learn more
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
FreshBooks
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
category_type
Enumname
Stringparent_category
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstatus
EnumMicrosoft Dynamics 365 Business Central
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
category_type
Enumcompany
UUIDname
Stringparent_category
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
StringMicrosoft Dynamics Finance and Operations
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
category_type
Enumname
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
StringNetSuite
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
category_type
Enumcompany
UUIDname
Stringparent_category
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstatus
EnumQuickBooks Online
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
category_type
Enumname
Stringparent_category
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstatus
EnumSage Intacct
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
category_type
Enumcompany
UUIDname
Stringparent_category
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstatus
EnumWorkday
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
category_type
Enumname
Stringremote_id
StringXero
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
category_type
Enumname
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstatus
Enum