Data
Data

GET /data/syncStatus

Changed on

Gets the synchronization status of all data types for each business connection.

Request

  • Base URL
    https://api.railz.ai
  • Auth
    HTTP bearer

Query parameters

businessNamestring required
Example:Railz
serviceName'freshbooks' | 'quickbooks' | 'quickbooksDesktop' | 'xero' | 'oracleNetsuite' | 'sageBusinessCloud' | 'sageIntacct' | 'dynamicsBusinessCentral' | 'dynamics365Finance' | 'wave' | 'shopify' | 'square' | 'plaid' | 'myob' | 'zohoBooks' | 'byod' required
offsetnumber
limitnumber
Example:100
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

Response

Example response

{
  "meta": {
    "serviceName": "xero",
    "businessName": "Demo Business"
  },
  "data": [
    {
      "connectionId": "CON-94652dff-06ab-4b97-bd1b-f91adf7048c3",
      "dataTypes": [
        {
          "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
            }
          ]
        }
      ]
    }
  ]
}

Changes

    • breaking

      the query request parameter dataType was restricted to a list of enum values

    • warning

      added the new dynamics365Finance enum value to the ///// response property for the response status

    • warning

      added the new dynamicsBusinessCentral enum value to the ///// response property for the response status

    • warning

      added the new freshbooks enum value to the ///// response property for the response status

    • warning

      added the new myob enum value to the ///// response property for the response status

    • warning

      added the new oracleNetsuite enum value to the ///// response property for the response status

    • warning

      added the new quickbooks enum value to the ///// response property for the response status

    • warning

      added the new quickbooksDesktop enum value to the ///// response property for the response status

    • warning

      added the new sageBusinessCloud enum value to the ///// response property for the response status

    • warning

      added the new sageIntacct enum value to the ///// response property for the response status

    • warning

      added the new wave enum value to the ///// response property for the response status

    • warning

      added the new xero enum value to the ///// response property for the response status

    • warning

      added the new zohoBooks enum value to the ///// response property for the response status

    • info

      added the new enum value accountingTransactions to the query request parameter dataType

    • info

      added the new enum value accounts to the query request parameter dataType

    • info

      added the new enum value agedPayable to the query request parameter dataType

    • info

      added the new enum value agedReceivable to the query request parameter dataType

    • info

      added the new enum value attachments to the query request parameter dataType

    • info

      added the new enum value balanceSheets to the query request parameter dataType

    • info

      added the new enum value bankAccounts to the query request parameter dataType

    • info

      added the new enum value bankTransactions to the query request parameter dataType

    • info

      added the new enum value bankTransfers to the query request parameter dataType

    • info

      added the new enum value bankingReconciliation to the query request parameter dataType

    • info

      added the new enum value billCreditNotes to the query request parameter dataType

    • info

      added the new enum value billPaymentRequests to the query request parameter dataType

    • info

      added the new enum value billPayments to the query request parameter dataType

    • info

      added the new enum value bills to the query request parameter dataType

    • info

      added the new enum value budgets to the query request parameter dataType

    • info

      added the new enum value businessInfo to the query request parameter dataType

    • info

      added the new enum value businessValuations to the query request parameter dataType

    • info

      added the new enum value byod to the query request parameter serviceName

    • info

      added the new enum value cashflowStatements to the query request parameter dataType

    • info

      added the new enum value contacts to the query request parameter dataType

    • info

      added the new enum value creditScore to the query request parameter dataType

    • info

      added the new enum value customerBankAccounts to the query request parameter dataType

    • info

      added the new enum value customers to the query request parameter dataType

    • info

      added the new enum value deposits to the query request parameter dataType

    • info

      added the new enum value dynamics365Finance to the query request parameter serviceName

    • info

      added the new enum value estimates to the query request parameter dataType

    • info

      added the new enum value expenses to the query request parameter dataType

    • info

      added the new enum value financialBenchmarking to the query request parameter dataType

    • info

      added the new enum value financialForecasts to the query request parameter dataType

    • info

      added the new enum value financialRatios to the query request parameter dataType

    • info

      added the new enum value fraudRiskMetrics to the query request parameter dataType

    • info

      added the new enum value incomeStatements to the query request parameter dataType

    • info

      added the new enum value inventory to the query request parameter dataType

    • info

      added the new enum value invoiceCreditNotes to the query request parameter dataType

    • info

      added the new enum value invoicePayments to the query request parameter dataType

    • info

      added the new enum value invoices to the query request parameter dataType

    • info

      added the new enum value journalEntries to the query request parameter dataType

    • info

      added the new enum value journals to the query request parameter dataType

    • info

      added the new enum value paymentMethods to the query request parameter dataType

    • info

      added the new enum value payrollTransactions to the query request parameter dataType

    • info

      added the new enum value portfolioMetrics to the query request parameter dataType

    • info

      added the new enum value probabilityOfDefault to the query request parameter dataType

    • info

      added the new enum value purchaseOrders to the query request parameter dataType

    • info

      added the new enum value refunds to the query request parameter dataType

    • info

      added the new enum value taxAuthority to the query request parameter dataType

    • info

      added the new enum value taxBenchmarking to the query request parameter dataType

    • info

      added the new enum value taxRates to the query request parameter dataType

    • info

      added the new enum value trackingCategories to the query request parameter dataType

    • info

      added the new enum value trialBalances to the query request parameter dataType

    • info

      added the new enum value vendorBankAccounts to the query request parameter dataType

    • info

      added the new enum value vendors to the query request parameter dataType

    • info

      added the new enum value zohoBooks to the query request parameter serviceName

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status