Skip to main content
POST
/
core
/
syncs
Create Sync
curl --request POST \
  --url https://api.rootfi.dev/v3/core/syncs \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "company_id": 1,
  "integration_type": "XERO",
  "full_sync": true,
  "data_models_to_sync": [
    "ACCOUNTS",
    "CONTACTS"
  ]
}
'
{
  "data": {
    "rootfi_id": 1,
    "rootfi_company_id": 8422,
    "rootfi_updated_at": "2024-06-21T08:07:05.750Z",
    "rootfi_created_at": "2024-06-21T08:07:05.750Z",
    "start_time": "2024-06-21T08:07:05.000Z",
    "end_time": "2024-06-21T08:07:40.382Z",
    "integration_type": "ZOHO_BOOKS",
    "full_sync": true,
    "sync_type": "AUTO_SYNC",
    "config_mode": "READ",
    "sync_data_models": [
      "CUSTOM_ACCOUNT_TRANSACTIONS"
    ],
    "sync_id": "hjmm4d2HDHB60a2",
    "total_count": 3,
    "success_count": 3,
    "failed_count": 0,
    "running_count": 0,
    "pending_count": 0,
    "status": "SUCCESS"
  }
}

Authorizations

​
api_key
string
header
required

Body

application/json

The data of the invite link endpoint

​
company_id
integer
required

The ID of the company

Example:

1

​
integration_type
enum<string>
required

The type of integration

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
​
full_sync
boolean
required

Whether the sync is a full sync

Example:

true

​
data_models_to_sync
enum<string>[]
required

The sync data models of the sync.

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

Response

The data of the sync endpoint

​
data
coreSyncData · object
required

The data of the invite link endpoint