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"
  ]
}
'
import requests

url = "https://api.rootfi.dev/v3/core/syncs"

payload = {
"company_id": 1,
"integration_type": "XERO",
"full_sync": True,
"data_models_to_sync": ["ACCOUNTS", "CONTACTS"]
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
company_id: 1,
integration_type: 'XERO',
full_sync: true,
data_models_to_sync: ['ACCOUNTS', 'CONTACTS']
})
};

fetch('https://api.rootfi.dev/v3/core/syncs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.rootfi.dev/v3/core/syncs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'company_id' => 1,
'integration_type' => 'XERO',
'full_sync' => true,
'data_models_to_sync' => [
'ACCOUNTS',
'CONTACTS'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.rootfi.dev/v3/core/syncs"

payload := strings.NewReader("{\n \"company_id\": 1,\n \"integration_type\": \"XERO\",\n \"full_sync\": true,\n \"data_models_to_sync\": [\n \"ACCOUNTS\",\n \"CONTACTS\"\n ]\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("api_key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.rootfi.dev/v3/core/syncs")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"company_id\": 1,\n \"integration_type\": \"XERO\",\n \"full_sync\": true,\n \"data_models_to_sync\": [\n \"ACCOUNTS\",\n \"CONTACTS\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.rootfi.dev/v3/core/syncs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"company_id\": 1,\n \"integration_type\": \"XERO\",\n \"full_sync\": true,\n \"data_models_to_sync\": [\n \"ACCOUNTS\",\n \"CONTACTS\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "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"
  }
}
{
"error": {
"message": "<string>",
"code": "<string>",
"field": "<string>"
}
}
{
"error": {
"message": "<string>",
"code": "<string>",
"field": "<string>"
}
}
{
"error": {
"message": "<string>",
"code": "<string>",
"field": "<string>"
}
}
{
"error": {
"message": "<string>",
"code": "<string>",
"field": "<string>"
}
}

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