Update Invite Link

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.

You can update the invite link if you need to:

Change the company name.
Update the sync config for this company (includes specific scopes, custom fields or sync frequency).

Authorizations

api_key

string

header

required

Path Parameters

invite_link_id

string

required

The ID of the invite link to update

Body

application/json

The data of the invite link endpoint

integration_categories

enum<string>[]

required

The integration categories of the invite link

Available options:

ACCOUNTING,

PAYMENTS,

CRM,

ECOMMERCE,

CUSTOM

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,

HUBSPOT,

SALESFORCE,

PIPEDRIVE,

ZOHO_CRM

partner_id

string | null

A custom ID which can be used to identify the invite link or Company

sync_config

object[] | null

The sync configuration of the connection

sync_config.category

enum<string>

required

The category of the datamodel

Available options:

ACCOUNTING,

PAYMENTS,

CRM,

ECOMMERCE,

CUSTOM

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

sync_config.enabled

boolean

required

The status of the sync configuration

sync_config.frequency

enum<string>

required

The frequency of the sync configuration

Available options:

DAILY,

WEEKLY,

MONTHLY,

YEARLY

sync_config.interval

integer

required

The interval of the sync configuration

sync_config.scope_access

object

required

The scope access of the sync configuration

sync_config.custom_fields

string[] | null

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

sync_config.sync_from

string | null

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

Response

200 - application/json

The data of the invite link endpoint

data

object

required

The data of the invite link endpoint

data.company

object

required

The company of the invite link

data.integration_categories

enum<string>[]

required

The integration categories of the invite link

Available options:

ACCOUNTING,

PAYMENTS,

CRM,

ECOMMERCE,

CUSTOM

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,

HUBSPOT,

SALESFORCE,

PIPEDRIVE,

ZOHO_CRM

data.invite_link_id

string

required

The ID of the invite link

data.rootfi_created_at

string

required

The date at which RootFi first synced this data

data.rootfi_id

integer

required

The unique ID we assign for that data's information

data.rootfi_updated_at

string

required

The latest date at which RootFi updated this data

data.connections

object[] | null

The connections of the invite link

data.connections.category

enum<string>

required

The category of the connection

Available options:

ACCOUNTING,

PAYMENTS,

CRM,

ECOMMERCE,

CUSTOM

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.rate_limits

object

required

The rate limits of the connection

data.connections.rootfi_created_at

string

required

The date at which RootFi first synced this data

data.connections.rootfi_id

integer

required

The unique ID we assign for that data's information

data.connections.rootfi_updated_at

string

required

The latest date at which RootFi updated this data

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.sync_config

object[] | null

The sync configuration of the connection

data.connections.sync_config.category

enum<string>

required

The category of the datamodel

Available options:

ACCOUNTING,

PAYMENTS,

CRM,

ECOMMERCE,

CUSTOM

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.enabled

boolean

required

The status of the sync configuration

data.connections.sync_config.frequency

enum<string>

required

The frequency of the sync configuration

Available options:

DAILY,

WEEKLY,

MONTHLY,

YEARLY

data.connections.sync_config.interval

integer

required

The interval of the sync configuration

data.connections.sync_config.scope_access

object

required

The scope access of the sync configuration

data.connections.sync_config.custom_fields

string[] | null

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

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.

General

Server Side SDKs

Core API

Unified API

Update Invite Link

Authorizations

Path Parameters

Body

Response