Get Company

GET

core

companies

{company_id}

curl --request GET \
  --url https://api.rootfi.dev/v3/core/companies/{company_id} \
  --header 'api_key: <api-key>'

{
  "data": {
    "rootfi_id": 123,
    "rootfi_created_at": "2023-11-07T05:31:56Z",
    "rootfi_updated_at": "2023-11-07T05:31:56Z",
    "name": "Rootfi",
    "partner_id": "<string>",
    "invite_link": {
      "rootfi_id": 123,
      "rootfi_created_at": "2023-11-07T05:31:56Z",
      "rootfi_updated_at": "2023-11-07T05:31:56Z",
      "invite_link_id": "1",
      "integrations": [
        "ZOHO_BOOKS"
      ],
      "integration_categories": [
        "ACCOUNTING"
      ]
    },
    "connections": [
      {
        "rootfi_id": 123,
        "rootfi_created_at": "2023-11-07T05:31:56Z",
        "rootfi_updated_at": "2023-11-07T05:31:56Z",
        "integration_type": "ZOHO_BOOKS",
        "category": "ACCOUNTING",
        "connection_status": "HEALTHY",
        "sync_status": "IDLE",
        "sync_resume_at": "2023-11-07T05:31:56Z",
        "last_synced": "2023-11-07T05:31:56Z",
        "rate_limits": {
          "counters": {},
          "lastReset": {},
          "maxLimits": {}
        },
        "tally_last_active_at": "2023-11-07T05:31:56Z",
        "zoho_sub_calls_enabled": false,
        "sync_config": {
          "enabled": true,
          "interval": 1,
          "frequency": "DAILY",
          "data_model": "ACCOUNTS",
          "category": "ACCOUNTING",
          "scope_access": {
            "READ": true,
            "CREATE": true,
            "UPDATE": true,
            "DELETE": true
          },
          "sync_from": "2023-11-07T05:31:56Z",
          "custom_fields": [
            "<string>"
          ]
        }
      }
    ],
    "activity_log": [
      {
        "rootfi_id": 123,
        "rootfi_created_at": "2023-11-07T05:31:56Z",
        "rootfi_updated_at": "2023-11-07T05:31:56Z",
        "activity_type": "ORG_CREATED"
      }
    ]
  }
}

Authorizations

api_key

string

header

required

Path Parameters

company_id

integer

required

The ID of the company to retrieve

Response

200

application/json

The data of the company endpoint

data

object

required

The data of the company endpoint

data.rootfi_id

integer

required

The unique ID we assign for that data's information

data.rootfi_created_at

string

required

The date at which RootFi first synced this data

data.rootfi_updated_at

string

required

The latest date at which RootFi updated this data

data.name

string

required

Name of the company

Example:

"Rootfi"

data.partner_id

string | null

Unique identifier in your system.

data.invite_link

object

ID of the invite link in the platform database

data.connections

object[] | null

Connection details of the company

data.connections.rootfi_id

integer

required

The unique ID we assign for that data's information

data.connections.rootfi_created_at

string

required

The date at which RootFi first synced this data

data.connections.rootfi_updated_at

string

required

The latest date at which RootFi updated this data

data.connections.integration_type

enum<string>

required

The integration type of the connection

Available options:

ZOHO_BOOKS,

QUICKBOOKS_SANDBOX,

QUICKBOOKS,

XERO,

TALLY,

ROOTFI_SANDBOX,

SAGE_CLOUD_ACCOUNTING,

MS_DYNAMICS_365,

SAGE_ZA_CLOUD_ACCOUNTING,

MYOB_BUSINESS,

NETSUITE,

WAVE,

ODOO_ACCOUNTING,

WAFEQ,

MEKARI_JURNAL,

BUSY,

QOYOD,

STRIPE,

RAZORPAY,

PAYPAL,

SHOPIFY,

BIG_COMMERCE,

WOO_COMMERCE,

HUBSPOT,

SALESFORCE,

PIPEDRIVE,

ZOHO_CRM

data.connections.category

enum<string>

required

The integration category of the connection

Available options:

ACCOUNTING,

PAYMENTS,

CRM,

ECOMMERCE,

CUSTOM

data.connections.connection_status

enum<string>

required

The status of the connection

Available options:

HEALTHY,

DISCONNECTED,

EXPIRED,

PENDING

data.connections.sync_status

enum<string>

required

The status of the sync

Available options:

IDLE,

FETCHING,

SLEEPING,

PARSING,

RUNNING

data.connections.rate_limits

object

required

The rate limits of the connection

data.connections.zoho_sub_calls_enabled

boolean

required

The status to indicate if zoho sub calls should be enabled

Example:

false

data.connections.sync_resume_at

string | null

The date and time the sync will resume

data.connections.last_synced

string | null

The date and time the connection was last synced

data.connections.tally_last_active_at

string | null

The date and time the Tally connection was last active

data.connections.sync_config

object

The sync configuration of the connection

data.connections.sync_config.enabled

boolean

required

The status of the sync configuration

Example:

true

data.connections.sync_config.interval

integer

required

The interval of the sync configuration

Example:

1

data.connections.sync_config.frequency

enum<string>

required

The frequency of the sync configuration

Available options:

DAILY,

WEEKLY,

MONTHLY,

YEARLY

data.connections.sync_config.data_model

enum<string>

required

The data model of the sync configuration

Available options:

ACCOUNTS,

BANK_ACCOUNTS,

BILLS,

BILL_PAYMENTS,

COMPANY_INFO,

CONTACTS,

BILL_CREDIT_NOTES,

INVOICE_CREDIT_NOTES,

DOCUMENTS,

EXPENSES,

INVOICES,

INVOICE_PAYMENTS,

ITEMS,

LINE_ITEMS,

TAX_RATES,

JOURNAL_ENTRIES,

BANK_TRANSACTIONS,

JOURNAL_LINES,

PURCHASE_ORDERS,

SALES_ORDERS,

PHONE_NUMBERS,

ADDRESSES,

EXTERNAL_LINKS,

CONTACT_PERSONS,

INCOME_STATEMENT,

BALANCE_SHEET,

TRACKING_CATEGORIES,

CASH_FLOW_STATEMENT,

CURRENCIES,

PAYMENT_CUSTOMERS,

PAYMENT_INVOICES,

PAYMENT_LINE_ITEMS,

PAYMENT_ITEMS,

PAYMENT_ORDERS,

PAYMENT_TAX_RATES,

PAYMENT_DISPUTES,

PAYMENT_PAYMENTS,

PAYMENT_REFUNDS,

PAYMENT_PAYMENT_LINKS,

PAYMENT_PAYOUTS,

PAYMENT_ADDRESSES,

PAYMENT_PHONE_NUMBERS,

PAYMENT_EXTERNAL_LINKS,

PAYMENT_TRANSACTIONS,

PAYMENT_BALANCES,

ECOMMERCE_ORDERS,

ECOMMERCE_CUSTOMERS,

ECOMMERCE_PRODUCTS,

ECOMMERCE_LINE_ITEMS,

CRM_CONTACTS,

CRM_COMPANIES,

CRM_DEALS,

CRM_LEADS,

CRM_NOTES,

CRM_PIPELINES,

CRM_STAGES,

CRM_ACTIVITIES,

CRM_TASKS,

CRM_USERS,

CRM_EXTERNAL_LINKS,

CRM_PHONE_NUMBERS,

CRM_ADDRESSES

data.connections.sync_config.category

enum<string>

required

The category of the datamodel

Available options:

ACCOUNTING,

PAYMENTS,

CRM,

ECOMMERCE,

CUSTOM

data.connections.sync_config.scope_access

object

required

The scope access of the sync configuration

data.connections.sync_config.sync_from

string | null

The date from which the data should be synced. If not provided, it will sync all historical data.

data.connections.sync_config.custom_fields

string[] | null

The custom field names to fetch during syncing (for Netsuite, Hubspot only)

data.activity_log

object[] | null

Activity log of the company

Get All Companies Get One Company

curl --request GET \
  --url https://api.rootfi.dev/v3/core/companies/{company_id} \
  --header 'api_key: <api-key>'

{
  "data": {
    "rootfi_id": 123,
    "rootfi_created_at": "2023-11-07T05:31:56Z",
    "rootfi_updated_at": "2023-11-07T05:31:56Z",
    "name": "Rootfi",
    "partner_id": "<string>",
    "invite_link": {
      "rootfi_id": 123,
      "rootfi_created_at": "2023-11-07T05:31:56Z",
      "rootfi_updated_at": "2023-11-07T05:31:56Z",
      "invite_link_id": "1",
      "integrations": [
        "ZOHO_BOOKS"
      ],
      "integration_categories": [
        "ACCOUNTING"
      ]
    },
    "connections": [
      {
        "rootfi_id": 123,
        "rootfi_created_at": "2023-11-07T05:31:56Z",
        "rootfi_updated_at": "2023-11-07T05:31:56Z",
        "integration_type": "ZOHO_BOOKS",
        "category": "ACCOUNTING",
        "connection_status": "HEALTHY",
        "sync_status": "IDLE",
        "sync_resume_at": "2023-11-07T05:31:56Z",
        "last_synced": "2023-11-07T05:31:56Z",
        "rate_limits": {
          "counters": {},
          "lastReset": {},
          "maxLimits": {}
        },
        "tally_last_active_at": "2023-11-07T05:31:56Z",
        "zoho_sub_calls_enabled": false,
        "sync_config": {
          "enabled": true,
          "interval": 1,
          "frequency": "DAILY",
          "data_model": "ACCOUNTS",
          "category": "ACCOUNTING",
          "scope_access": {
            "READ": true,
            "CREATE": true,
            "UPDATE": true,
            "DELETE": true
          },
          "sync_from": "2023-11-07T05:31:56Z",
          "custom_fields": [
            "<string>"
          ]
        }
      }
    ],
    "activity_log": [
      {
        "rootfi_id": 123,
        "rootfi_created_at": "2023-11-07T05:31:56Z",
        "rootfi_updated_at": "2023-11-07T05:31:56Z",
        "activity_type": "ORG_CREATED"
      }
    ]
  }
}

General

Server Side SDKs

Core API

Unified API

Authorizations

Path Parameters

Response