Merge Subpackage Tracking Categories API

openapi: 3.2.0
info:
  title: Accounting Subpackage Tracking Categories API
  version: 1.0.0
servers:
- url: https://api.merge.dev/api
- url: https://api-eu.merge.dev/api
- url: https://api-ap.merge.dev/api
tags:
- name: subpackage_trackingCategories
paths:
  /accounting/v1/tracking-categories:
    get:
      operationId: list
      summary: List
      description: Returns a list of `TrackingCategory` objects.{/* BEGIN_ACCOUNTING_TRACKINGCATEGORY_FETCH_SUPPORTED_FIELDS */}{/* END_ACCOUNTING_TRACKINGCATEGORY_FETCH_SUPPORTED_FIELDS */}
      tags:
      - subpackage_trackingCategories
      parameters:
      - name: category_type
        in: query
        description: If provided, will only return tracking categories with this type.
        required: false
        schema:
          $ref: '#/components/schemas/TrackingCategoriesGetParametersCategoryType'
      - name: company_id
        in: query
        description: If provided, will only return tracking categories for this company.
        required: false
        schema:
          type: string
      - name: created_after
        in: query
        description: If provided, will only return objects created after this datetime.
        required: false
        schema:
          type: string
          format: date-time
      - name: created_before
        in: query
        description: If provided, will only return objects created before this datetime.
        required: false
        schema:
          type: string
          format: date-time
      - name: cursor
        in: query
        description: The pagination cursor value.
        required: false
        schema:
          type: string
      - name: expand
        in: query
        description: Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
        required: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/TrackingCategoriesGetParametersExpandSchemaItems'
      - name: include_deleted_data
        in: query
        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/).
        required: false
        schema:
          type: boolean
      - name: include_remote_data
        in: query
        description: Whether to include the original data Merge fetched from the third-party to produce these models.
        required: false
        schema:
          type: boolean
      - name: include_shell_data
        in: query
        description: Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
        required: false
        schema:
          type: boolean
      - name: modified_after
        in: query
        description: If provided, only objects synced by Merge after this date time will be returned.
        required: false
        schema:
          type: string
          format: date-time
      - name: modified_before
        in: query
        description: If provided, only objects synced by Merge before this date time will be returned.
        required: false
        schema:
          type: string
          format: date-time
      - name: name
        in: query
        description: If provided, will only return tracking categories with this name.
        required: false
        schema:
          type: string
      - name: page_size
        in: query
        description: Number of results to return per page. The maximum limit is 100.
        required: false
        schema:
          type: integer
      - name: remote_fields
        in: query
        description: Deprecated. Use show_enum_origins.
        required: false
        schema:
          $ref: '#/components/schemas/TrackingCategoriesGetParametersRemoteFields'
      - name: remote_id
        in: query
        description: The API provider's ID for the given object.
        required: false
        schema:
          type: string
      - name: show_enum_origins
        in: query
        description: 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](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
        required: false
        schema:
          $ref: '#/components/schemas/TrackingCategoriesGetParametersShowEnumOrigins'
      - name: status
        in: query
        description: If provided, will only return tracking categories with this status.
        required: false
        schema:
          $ref: '#/components/schemas/TrackingCategoriesGetParametersStatus'
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      - name: X-Account-Token
        in: header
        description: Token identifying the end user.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedTrackingCategoryList'
  /accounting/v1/tracking-categories/{id}:
    get:
      operationId: retrieve
      summary: Retrieve
      description: Returns a `TrackingCategory` object with the given `id`.{/* BEGIN_ACCOUNTING_TRACKINGCATEGORY_FETCH_SUPPORTED_FIELDS */}{/* END_ACCOUNTING_TRACKINGCATEGORY_FETCH_SUPPORTED_FIELDS */}
      tags:
      - subpackage_trackingCategories
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: expand
        in: query
        description: Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
        required: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/TrackingCategoriesIdGetParametersExpandSchemaItems'
      - name: include_remote_data
        in: query
        description: Whether to include the original data Merge fetched from the third-party to produce these models.
        required: false
        schema:
          type: boolean
      - name: include_shell_data
        in: query
        description: Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
        required: false
        schema:
          type: boolean
      - name: remote_fields
        in: query
        description: Deprecated. Use show_enum_origins.
        required: false
        schema:
          $ref: '#/components/schemas/TrackingCategoriesIdGetParametersRemoteFields'
      - name: show_enum_origins
        in: query
        description: 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](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
        required: false
        schema:
          $ref: '#/components/schemas/TrackingCategoriesIdGetParametersShowEnumOrigins'
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      - name: X-Account-Token
        in: header
        description: Token identifying the end user.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrackingCategory'
components:
  schemas:
    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’s 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

        ### 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.'
      title: TrackingCategory
    TrackingCategoriesGetParametersStatus:
      type: string
      enum:
      - ''
      - ACTIVE
      - ARCHIVED
      title: TrackingCategoriesGetParametersStatus
    Status7d1Enum:
      type: string
      enum:
      - ACTIVE
      - ARCHIVED
      title: Status7d1Enum
    CategoryTypeEnum:
      type: string
      enum:
      - CLASS
      - DEPARTMENT
      title: CategoryTypeEnum
    TrackingCategoriesIdGetParametersShowEnumOrigins:
      type: string
      enum:
      - status
      title: TrackingCategoriesIdGetParametersShowEnumOrigins
    TrackingCategoriesIdGetParametersExpandSchemaItems:
      type: string
      enum:
      - company
      title: TrackingCategoriesIdGetParametersExpandSchemaItems
    TrackingCategoriesGetParametersShowEnumOrigins:
      type: string
      enum:
      - status
      title: TrackingCategoriesGetParametersShowEnumOrigins
    TrackingCategoryFieldMappings:
      type: object
      properties:
        organization_defined_targets:
          type: object
          additionalProperties:
            description: Any type
        linked_account_defined_targets:
          type: object
          additionalProperties:
            description: Any type
      title: TrackingCategoryFieldMappings
    TrackingCategoriesGetParametersRemoteFields:
      type: string
      enum:
      - status
      title: TrackingCategoriesGetParametersRemoteFields
    TrackingCategoriesGetParametersCategoryType:
      type: string
      enum:
      - ''
      - CLASS
      - DEPARTMENT
      title: TrackingCategoriesGetParametersCategoryType
    PaginatedTrackingCategoryList:
      type: object
      properties:
        next:
          type:
          - string
          - 'null'
        previous:
          type:
          - string
          - 'null'
        results:
          type: array
          items:
            $ref: '#/components/schemas/TrackingCategory'
      title: PaginatedTrackingCategoryList
    TrackingCategoriesIdGetParametersRemoteFields:
      type: string
      enum:
      - status
      title: TrackingCategoriesIdGetParametersRemoteFields
    TrackingCategoriesGetParametersExpandSchemaItems:
      type: string
      enum:
      - company
      title: TrackingCategoriesGetParametersExpandSchemaItems
  securitySchemes:
    tokenAuth:
      type: http
      scheme: bearer
      description: Token-based authentication with required prefix "Bearer"