Get Tracking Categories

curl --request POST \
  --url https://api.rootfi.dev/accounting/tracking_categories/all \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "take": 10,
  "skip": 0,
  "orderBy": {
    "name": "asc"
  },
  "filter": {
    "name": {
      "eq": "Test Name"
    }
  }
}'

{
  "data": {
    "data": [
      {
        "rootfi_id": 123,
        "rootfi_company_id": 123,
        "rootfi_organisation_id": 1,
        "rootfi_integration_type": "QUICKBOOKS_SANDBOX",
        "rootfi_updated_at": "2023-10-26T16:14:59.673Z",
        "rootfi_created_at": "2023-10-26T16:14:59.685Z",
        "platform_id": "5000000000000279513",
        "parent_id": "5000000000000279512",
        "name": "Test Name",
        "status": "ACTIVE",
        "has_children": false,
        "updated_at": "2023-01-17T00:00:00.000Z",
        "raw_data": {
          "Id": "5000000000000279513",
          "Name": "City in France",
          "Active": true,
          "domain": "QBO",
          "sparse": false,
          "MetaData": {
            "CreateTime": "2023-04-11T02:52:31-07:00",
            "LastUpdatedTime": "2023-04-11T02:52:31-07:00"
          },
          "SubClass": true,
          "ParentRef": {
            "value": "5000000000000279512"
          },
          "SyncToken": "0",
          "FullyQualifiedName": "France:City in France"
        }
      }
    ],
    "total_count": 1
  },
  "request_timestamp": "2023-10-27T05:05:28.522Z",
  "response_timestamp": "2023-10-27T05:05:28.522Z",
  "request_id": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b"
}

POST

accounting

tracking_categories

all

curl --request POST \
  --url https://api.rootfi.dev/accounting/tracking_categories/all \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "take": 10,
  "skip": 0,
  "orderBy": {
    "name": "asc"
  },
  "filter": {
    "name": {
      "eq": "Test Name"
    }
  }
}'

{
  "data": {
    "data": [
      {
        "rootfi_id": 123,
        "rootfi_company_id": 123,
        "rootfi_organisation_id": 1,
        "rootfi_integration_type": "QUICKBOOKS_SANDBOX",
        "rootfi_updated_at": "2023-10-26T16:14:59.673Z",
        "rootfi_created_at": "2023-10-26T16:14:59.685Z",
        "platform_id": "5000000000000279513",
        "parent_id": "5000000000000279512",
        "name": "Test Name",
        "status": "ACTIVE",
        "has_children": false,
        "updated_at": "2023-01-17T00:00:00.000Z",
        "raw_data": {
          "Id": "5000000000000279513",
          "Name": "City in France",
          "Active": true,
          "domain": "QBO",
          "sparse": false,
          "MetaData": {
            "CreateTime": "2023-04-11T02:52:31-07:00",
            "LastUpdatedTime": "2023-04-11T02:52:31-07:00"
          },
          "SubClass": true,
          "ParentRef": {
            "value": "5000000000000279512"
          },
          "SyncToken": "0",
          "FullyQualifiedName": "France:City in France"
        }
      }
    ],
    "total_count": 1
  },
  "request_timestamp": "2023-10-27T05:05:28.522Z",
  "response_timestamp": "2023-10-27T05:05:28.522Z",
  "request_id": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b"
}

curl --request POST \
  --url https://api.rootfi.dev/accounting/tracking_categories/all \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "take": 10,
  "skip": 0,
  "orderBy": {
    "name": "asc"
  },
  "filter": {
    "name": {
      "eq": "Test Name"
    }
  }
}'

Authorizations

api_key

string

header

required

Body

application/json

take

integer | null

skip

integer | null

orderBy

accountingtrackingCtegoriesOrderBy · object

Show child attributes

orderBy.rootfi_updated_at

enum<string> | null

Available options:

asc,

desc

orderBy.rootfi_created_at

enum<string> | null

Available options:

asc,

desc

orderBy.name

enum<string> | null

Available options:

asc,

desc

orderBy.status

enum<string> | null

Available options:

asc,

desc

orderBy.parent_id

enum<string> | null

Available options:

asc,

desc

orderBy.has_children

enum<string> | null

Available options:

asc,

desc

orderBy.updated_at

enum<string> | null

Available options:

asc,

desc

filter

accountingtrackingCtegoriesFilterFields · object

Show child attributes

filter.rootfi_id

numberOperator · object

Show child attributes

filter.rootfi_id.gt

number<double> | null

filter.rootfi_id.lt

number<double> | null

filter.rootfi_id.eq

number<double> | null

filter.rootfi_id.in

number<double> | null

filter.rootfi_company_id

numberOperator · object

Show child attributes

filter.rootfi_company_id.gt

number<double> | null

filter.rootfi_company_id.lt

number<double> | null

filter.rootfi_company_id.eq

number<double> | null

filter.rootfi_company_id.in

number<double> | null

filter.rootfi_updated_at

dateOperator · object

Show child attributes

filter.rootfi_updated_at.eq

string<date-time> | null

filter.rootfi_updated_at.gt

string<date-time> | null

filter.rootfi_updated_at.lt

string<date-time> | null

filter.rootfi_created_at

dateOperator · object

Show child attributes

filter.rootfi_created_at.eq

string<date-time> | null

filter.rootfi_created_at.gt

string<date-time> | null

filter.rootfi_created_at.lt

string<date-time> | null

filter.platform_id

stringOperator · object

Show child attributes

filter.platform_id.eq

string | null

filter.platform_id.ne

string | null

filter.rootfi_integration_type

stringOperator · object

Show child attributes

filter.rootfi_integration_type.eq

string | null

filter.rootfi_integration_type.ne

string | null

filter.name

stringOperator · object

Show child attributes

filter.name.eq

string | null

filter.name.ne

string | null

filter.status

stringOperator · object

Show child attributes

filter.status.eq

string | null

filter.status.ne

string | null

filter.parent_id

stringOperator · object

Show child attributes

filter.parent_id.eq

string | null

filter.parent_id.ne

string | null

filter.has_children

booleanOperator · object

Show child attributes

filter.has_children.eq

boolean | null

filter.has_children.in

number<double> | null

filter.updated_at

dateOperator · object

Show child attributes

filter.updated_at.eq

string<date-time> | null

filter.updated_at.gt

string<date-time> | null

filter.updated_at.lt

string<date-time> | null

Response

200 - application/json

data

accountingtypesgetTrackingCategoriesResponseData · object

required

Show child attributes

data.data

accountingtypesTrackingCategoryFields · object[]

required

Show child attributes

data.data.platform_id

string

required

The accounting platforms ID for the tracking category

data.data.parent_id

string

required

The identifier for this item’s parent

data.data.name

string

required

The name of the tracking category

data.data.status

enum<string>

required

indicates the current state of the tracking category.

Available options:

ACTIVE,

ARCHIVED,

UNKNOWN

data.data.has_children

boolean

required

this boolean indicates if it has sub categories

data.data.updated_at

string<date-time>

required

The last ISO 8601 timestamp that the data was updated at

data.data.raw_data

object

required

The raw data of the tracking category

data.data.rootfi_id

number<double> | null

The unique ID we assign for that data's information

data.data.rootfi_company_id

number<double> | null

The RootFi designated id for the company

data.data.rootfi_organisation_id

number<double> | null

The RootFi designated id for the organisation

data.data.rootfi_integration_type

enum<string> | null

The accounting platform from which the data is being retrieved

Available options:

ZOHO_BOOKS,

QUICKBOOKS_SANDBOX,

QUICKBOOKS,

XERO,

TALLY,

SAGE_CLOUD_ACCOUNTING,

MS_DYNAMICS_365,

SAGE_ZA_CLOUD_ACCOUNTING,

MYOB_BUSINESS,

WAVE,

ODOO_ACCOUNTING,

NETSUITE,

WAFEQ,

MEKARI_JURNAL,

BUSY,

ROOTFI_SANDBOX,

QOYOD

data.data.rootfi_updated_at

string<date-time> | null

The latest date at which RootFi updated this data

data.data.rootfi_created_at

string<date-time> | null

The date at which RootFi first synced this data

data.total_count

integer

required

Total Count of response object

request_timestamp

string<date-time>

required

The time at which the request was received by the server

response_timestamp

string<date-time>

required

The time at which the response was sent by the server

request_id

string

required

The unique ID of the request

Get All Tracking Categories Overview

⌘I

General

Server Side SDKs

Core API

Unified API

Get Tracking Categories

Authorizations

Body

Response