RArailz
Data
Data

POST /data/sync

Changed on

Initiates the synchronisation for a specific data type.

Request

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

Request body

businessNamestring required
serviceName'freshbooks' | 'quickbooks' | 'quickbooksDesktop' | 'xero' | 'oracleNetsuite' | 'sageBusinessCloud' | 'sageIntacct' | 'dynamicsBusinessCentral' | 'dynamics365Finance' | 'wave' | 'shopify' | 'square' | 'plaid' | 'myob' | 'zohoBooks' | 'byod' required
dataType'accountingTransactions' | 'accounts' | 'agedPayable' | 'agedReceivable' | 'attachments' | 'balanceSheets' | 'bankingReconciliation' | 'bankTransactions' | 'bankAccounts' | 'bankTransfers' | 'billCreditNotes' | 'billPayments' | 'bills' | 'budgets' | 'businessInfo' | 'businessValuations' | 'cashflowStatements' | 'creditScore' | 'customers' | 'deposits' | 'estimates' | 'financialBenchmarking' | 'financialForecasts' | 'financialRatios' | 'fraudRiskMetrics' | 'incomeStatements' | 'inventory' | 'invoiceCreditNotes' | 'invoicePayments' | 'invoices' | 'journalEntries' | 'journals' | 'probabilityOfDefault' | 'purchaseOrders' | 'refunds' | 'taxBenchmarking' | 'taxRates' | 'taxAuthority' | 'trackingCategories' | 'trialBalances' | 'vendors' | 'paymentMethods' | 'portfolioMetrics' | 'expenses' | 'contacts' | 'vendorBankAccounts' | 'customerBankAccounts' | 'billPaymentRequests' | 'payrollTransactions' | 'transactions' | 'products' | 'orders' | 'disputes' | 'bankAccounts' | 'bankTransactions' | 'bankAssets' required
fullSyncboolean

Example request

{
  "businessName": "Railz"
}

Response

connectionIdstring required
businessNamestring required
serviceName'quickbooks' | 'xero' | 'freshbooks' | 'quickbooksDesktop' | 'sageIntacct' | 'sageBusinessCloud' | 'oracleNetsuite' | 'dynamicsBusinessCentral' | 'dynamics365Finance' | 'wave' | 'zohoBooks' | 'myob' required
dataTypestring required
requestedOnstring date-time required

Example response

{
  "connectionId": "CON-94652dff-06ab-4b97-bd1b-f91adf7048c3",
  "businessName": "Railz",
  "serviceName": "quickbooks",
  "dataType": "balanceSheet",
  "requestedOn": "2021-03-18T08:16:51.233Z"
}

Changes

  • 5cdfae3fa1faRevision changes
    • breaking

      removed the enum value employees of the request property

    • 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 bankAccounts enum value to the request property

    • info

      added the new bankAccounts enum value to the request property

    • info

      added the new bankAssets enum value to the request property

    • info

      added the new bankTransactions enum value to the request property

    • info

      added the new bankTransactions enum value to the request property

    • info

      added the new billPaymentRequests enum value to the request property

    • info

      added the new budgets enum value to the request property

    • info

      added the new byod enum value to the request property

    • info

      added the new contacts enum value to the request property

    • info

      added the new customerBankAccounts enum value to the request property

    • info

      added the new dynamics365Finance enum value to the request property

    • info

      added the new expenses enum value to the request property

    • info

      added the new journals enum value to the request property

    • info

      added the new paymentMethods enum value to the request property

    • info

      added the new payrollTransactions enum value to the request property

    • info

      added the new portfolioMetrics enum value to the request property

    • info

      added the new taxAuthority enum value to the request property

    • info

      added the new vendorBankAccounts enum value to the request property

    • info

      added the new zohoBooks enum value to the request property