Merge · Schema

TrackingCategory

# The TrackingCategory Object ### Description 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. ### Usage Example Fetch from the `GET TrackingCategory` endpoint and view a company's tracking category.

IntegrationsPlatformUnified APIAgent HandlerLLM Gateway

Properties

Name Type Description
id string
remote_id stringnull The third-party API ID of the matching object.
created_at string The datetime that this object was created by Merge.
modified_at string The datetime that this object was modified by Merge.
name stringnull The tracking category's name.
status object The tracking category's status.
category_type object The tracking category’s type.
parent_category stringnull
company stringnull The company the GeneralLedgerTransaction belongs to.
remote_was_deleted boolean 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 cove
field_mappings object
View JSON Schema on GitHub

JSON Schema

merge-trackingcategory-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TrackingCategory",
  "title": "TrackingCategory",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "remote_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "The third-party API ID of the matching object."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime that this object was created by Merge."
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime that this object was modified by Merge."
    },
    "name": {
      "type": [
        "string",
        "null"
      ],
      "description": "The tracking category's name."
    },
    "status": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/Status7d1Enum"
        },
        {
          "type": "null"
        }
      ],
      "description": "The tracking category's status."
    },
    "category_type": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/CategoryTypeEnum"
        },
        {
          "type": "null"
        }
      ],
      "description": "The tracking category\u2019s type."
    },
    "parent_category": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid"
    },
    "company": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The company the GeneralLedgerTransaction belongs to."
    },
    "remote_was_deleted": {
      "type": "boolean",
      "description": "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](https://docs.merge.dev/integrations/hris/supported-features/)."
    },
    "field_mappings": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/TrackingCategoryFieldMappings"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "description": "# The TrackingCategory Object\n### Description\nA `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.\n\n### Usage Example\nFetch from the `GET TrackingCategory` endpoint and view a company's tracking category."
}