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": "Test Company",
  "integrations": ["ZOHO_BOOKS"]
}'
{
  "data": {
    "company": {
      "name": "RootFi",
      "rootfi_id": 1
    },
    "connections": [
      {
        "category": "ACCOUNTING",
        "integration_type": "XERO",
        "rate_limits": {
          "counters": {
            "concurrent": 0,
            "day": 4,
            "hour": 1,
            "minute": 1
          },
          "lastReset": {
            "day": "2024-01-28T11:00:17.087Z",
            "hour": "2024-01-29T05:10:40.896Z",
            "minute": "2024-01-29T05:10:40.896Z"
          },
          "maxLimits": {
            "concurrent_calls": 10,
            "per_minute": 500
          }
        },
        "rootfi_id": 1,
        "status": "HEALTHY",
        "sync_status": "IDLE"
      }
    ],
    "integration_categories": [
      "ACCOUNTING"
    ],
    "integrations": [
      "XERO"
    ],
    "invite_link_id": "1"
  }
}

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 the company that will be displayed in the Accounting platform.

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

Authorizations

api_key
string
headerrequired

Body

application/json
company_name
string | null

The name of the company

integration_categories
enum<string>[]
required

The integration categories of the invite link

Available options:
PAYMENTS,
ACCOUNTING,
CRM,
ECOMMERCE
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,
SHOPIFY,
STRIPE,
RAZORPAY,
PAYPAL,
HUBSPOT,
ZOHO_CRM,
PIPEDRIVE

Response

200 - application/json
data
object
required

The data of the invite link endpoint