Get One 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.

Authorizations

api_key

string

header

required

Path Parameters

invite_link_id

string

required

The ID of the invite link you want to retrieve.

Response

200 - application/json

Response object for the get one invite link endpoint.

request_timestamp

string

required

The time at which the request was received by the server

response_timestamp

string

required

The time at which the response was sent by the server

request_id

string

required

The unique ID of the request

data

object

required

data.invite_link_id

string

required

Unique ID of the invite link in the platform database

data.integrations

enum<string>[]

required

Integrations list the company is allowed to connect to

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

object

required

The companies of the invite link.

data.rootfi_id

number | null

The unique ID we assign for that data's information

data.rootfi_company_id

number | null

The RootFi designated id for the company

data.rootfi_organisation_id

number | null

The RootFi designated id for the organisation

data.rootfi_integration_type

enum<string>

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

string | null

The latest date at which RootFi updated this data

data.rootfi_created_at

string | null

The date at which RootFi first synced this data

data.metadata

string | null

Metadata of the invite link

General

Server Side SDKs

Core API

Unified API

Get One Invite Link

Authorizations

Path Parameters

Response