List Tracking Categories

GET 
/accounting/tracking-categories

Returns a list of Tracking Categories.

Request

Query Parameters

credentialId daterequired

The ID of the credential.

pageNumber string

The page number of the results. Default is 1.

pageSize int32

The maximum number of results to show on a page. Default is 50. Maximum is 100.

remoteId string

Used to filter tracking categories with this third-party application ID.

trackingCategoryName string

Used to filter tracking categories with the exact tracking category name.

trackingCategoryNameContains string

Used to filter tracking categories whose tracking category names contain the provided value.

trackingCategoryNameNotEquals string

Used to filter tracking categories whose tracking category name to exclude.

trackingCategoryStatus string

Used to filter tracking categories with the exact tracking category status.

trackingCategoryType string

Used to filter tracking categories with the exact tracking category type.

parentCategoryId string

Used to filter tracking categories with this parent tracking category ID.

companyId string

Used to filter tracking categories with this company ID.

createdAtMin date

Filter objects created after a specified date.

createdAtMax date

Filter objects created before a specified date.

updatedAtMin date

Filter objects last updated after a specified date.

updatedAtMax date

Filter objects last updated before a specified date.

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

Responses

200

200

application/json

Schema

Schema

trackingCategories

object[]

Array [

id string

remoteId string

trackingCategoryName string

trackingCategoryStatus string

trackingCategoryType string

parentCategoryId

companyId

remoteDeleted boolean

Default value: true

createdAt string

updatedAt string

]

Example (from schema)

{
  "trackingCategories": [
    {
      "id": "00000000-0000-0000-0000-00000000",
      "remoteId": "5000000000000243015",
      "trackingCategoryName": "Test Class 1",
      "trackingCategoryStatus": "ACTIVE",
      "trackingCategoryType": "CLASS",
      "parentCategoryId": {},
      "companyId": {},
      "remoteDeleted": false,
      "createdAt": "2024-02-22T11:17:32.963Z",
      "updatedAt": "2024-02-22T13:53:25.986Z"
    }
  ]
}

Result

{
  "trackingCategories": [
    {
      "id": "00000000-0000-0000-0000-00000000",
      "remoteId": "5000000000000243015",
      "trackingCategoryName": "Test Class 1",
      "trackingCategoryStatus": "ACTIVE",
      "trackingCategoryType": "CLASS",
      "parentCategoryId": null,
      "companyId": null,
      "remoteDeleted": false,
      "createdAt": "2024-02-22T11:17:32.963Z",
      "updatedAt": "2024-02-22T13:53:25.986Z"
    }
  ]
}

400

400

application/json

Schema

Schema

object

Example (from schema)

{}

Result

{}

Loading...