latestOpenAPI 3.0.02026-08-10233809957.8 KB
5cdfae3fa1fa
Data
Fetch Status of Data Syncs
Supported for:
freshbooks quickbooks xero oracleNetsuite sageBusinessCloud sageIntacct dynamicsBusinessCentral dynamics365Finance wave shopify square plaid myob zohoBooks byod
get/v2/data/syncStatus
Query parameters
connectionUuidstring required
Unique connection identifier.
offsetnumber
limitnumber
startDatestring
endDatestring
dataType'attachments' | 'accountingTransactions' | 'agedReceivable' | 'agedPayable' | 'billPaymentRequests' | 'bankTransactions' | 'bankAccounts' | 'bankTransfers' | 'bankingReconciliation' | 'balanceSheets' | 'bills' | 'budgets' | 'billCreditNotes' | 'billPayments' | 'businessInfo' | 'businessValuations' | 'cashflowStatements' | 'accounts' | 'creditScore' | 'customers' | 'deposits' | 'estimates' | 'fraudRiskMetrics' | 'financialBenchmarking' | 'portfolioMetrics' | 'financialRatios' | 'financialForecasts' | 'incomeStatements' | 'inventory' | 'invoices' | 'invoiceCreditNotes' | 'invoicePayments' | 'journalEntries' | 'journals' | 'purchaseOrders' | 'probabilityOfDefault' | 'refunds' | 'taxBenchmarking' | 'taxRates' | 'taxAuthority' | 'trackingCategories' | 'trialBalances' | 'vendors' | 'paymentMethods' | 'expenses' | 'contacts' | 'vendorBankAccounts' | 'customerBankAccounts' | 'payrollTransactions'
reportFrequencystring
currentStatusstring
accountingMethod'cash' | 'accrual'
orderBystring
requestIdstring
Response
Example response
{
"meta": {
"connectionUuid": "CON-396d5daa-26b2-4979-89b6-cafb2c298155",
"businessName": "Railz",
"serviceName": "xero"
},
"data": [
{
"dataType": "BalanceSheet",
"lastSyncDate": "2021-04-01T00:31:00Z",
"lastUpdatedDate": "2021-04-01T00:31:00Z",
"reports": [
{
"startDate": "2021-03-01T00:00:00Z",
"endDate": "2021-03-31T00:00:00Z",
"lastSuccessfulSync": "2021-04-01T00:31:00Z",
"reportFrequency": "month",
"currentStatus": "success",
"latestReportId": "6070149d1d685e6cf0583e36",
"latestSuccessfulReportId": "601077f5914dac670966f660",
"accountingMethod": "accrual",
"reconstructed": true
}
]
}
]
}