Create Invite Link

POST

core

invite_links

curl --request POST \
  --url https://api.rootfi.dev/v3/core/invite_links \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "company_name": "RootFi",
  "integrations": [
    "XERO"
  ],
  "integration_categories": [
    "ACCOUNTING"
  ],
  "sync_config": {
    "data_model": "ACCOUNTS",
    "enabled": true,
    "frequency": "DAILY",
    "interval": 1,
    "scope_access": {
      "READ": true,
      "CREATE": true,
      "UPDATE": true,
      "DELETE": true
    }
  }
}'

{
  "data": {
    "invite_link_id": "1",
    "integrations": [
      "XERO"
    ],
    "integration_categories": [
      "ACCOUNTING"
    ],
    "company": {
      "rootfi_id": 1,
      "name": "RootFi"
    },
    "connections": null
  }
}

An invite link contains API requests for generating and managing invite links, which can be used to connect end users to their preferred accounting platforms.

Company Name is the name of your customer’s company. This is the name that will be displayed in the RootFi dashboard. If left blank, your customer will be prompted to enter a company name when they connect their integration.

Integration is the name of the integration that you want to connect to. Integration Category is the category of the integrations that you want to connect to.

Authorizations

api_key

string

headerrequired

Body

application/json

company_name

string | null

The name of the company

integrations

enum<string>[] | null

The integrations of the invite link

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

integration_categories

enum<string>[]

required

The integration categories of the invite link

Available options:

PAYMENTS,

ACCOUNTING,

ECOMMERCE

sync_config

object | null

The sync configuration of the connection

Response

200 - application/json

data

object

required

The data of the invite link endpoint

data.rootfi_id

integer | null

The unique ID we assign for that data's information

data.rootfi_created_at

string | null

The date at which RootFi first synced this data

data.rootfi_updated_at

string | null

The latest date at which RootFi updated this data

data.invite_link_id

string

required

The ID of the invite link

data.integrations

enum<string>[]

required

The integrations of the invite link

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

data.integration_categories

enum<string>[]

required

The integration categories of the invite link

Available options:

PAYMENTS,

ACCOUNTING,

ECOMMERCE

data.company

object

required

The company of the invite link

data.connections

object[] | null

The connections of the invite link

data.connections.rootfi_id

integer

required

The ID of the connection

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

data.connections.status

enum<string>

required

The status of the connection

Available options:

HEALTHY,

DISCONNECTED,

EXPIRED,

PENDING

data.connections.sync_status

enum<string>

required

The sync status of the connection

Available options:

IDLE,

FETCHING,

SLEEPING,

PARSING,

RUNNING

data.connections.rate_limits

object

required

The rate limits of the connection

data.connections.category

enum<string>

required

The category of the connection

Available options:

PAYMENTS,

ACCOUNTING,

ECOMMERCE

data.connections.sync_config

object | null

The sync configuration of the connection

Get Invite Link Delete Invite Link

curl --request POST \
  --url https://api.rootfi.dev/v3/core/invite_links \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "company_name": "RootFi",
  "integrations": [
    "XERO"
  ],
  "integration_categories": [
    "ACCOUNTING"
  ],
  "sync_config": {
    "data_model": "ACCOUNTS",
    "enabled": true,
    "frequency": "DAILY",
    "interval": 1,
    "scope_access": {
      "READ": true,
      "CREATE": true,
      "UPDATE": true,
      "DELETE": true
    }
  }
}'

{
  "data": {
    "invite_link_id": "1",
    "integrations": [
      "XERO"
    ],
    "integration_categories": [
      "ACCOUNTING"
    ],
    "company": {
      "rootfi_id": 1,
      "name": "RootFi"
    },
    "connections": null
  }
}

Overview

Server Side SDKs

Core API

Unified API

Authorizations

Body

Response