POST
/
sync

Authorizations

api_key
string
header
required

Body

application/json

Request body for creating an Sync

company_id
number
required

Name of the company you are sending this Sync to. Useful identifier for you to internally reference this company.

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

Whether or not to perform a full sync

data_models_to_sync
enum<string>[]
required

The data models to sync

Available options:
ACCOUNTS,
BALANCE_SHEET,
BANK_ACCOUNTS,
BANK_TRANSACTIONS,
BILL_CREDIT_NOTES,
BILL_PAYMENTS,
BILLS,
CASH_FLOW_STATEMENT,
COMPANY_INFO,
CONTACTS,
CURRENCIES,
EXPENSES,
INCOME_STATEMENT,
INVOICE_CREDIT_NOTES,
INVOICE_PAYMENTS,
INVOICES,
ITEMS,
JOURNAL_ENTRIES,
PURCHASE_ORDERS,
SALES_ORDERS,
TAX_RATES,
TRACKING_CATEGORIES

Response

200 - application/json
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

The response data of the delete invite link endpoint