Sync
Create Sync
Initialise a single sync
POST
/
core
/
syncs
Authorizations
api_key
string
headerrequiredBody
application/json
The data of the invite link endpoint
company_id
integer
requiredThe ID of the company
integration_type
enum<string>
requiredThe 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
requiredWhether the sync is a full sync
data_models_to_sync
enum<string>[]
requiredThe 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
200 - application/json
The data of the sync endpoint
data
object
requiredThe data of the invite link endpoint