Managed bank feeds

Get sync

The Get sync endpoint returns the sync status for a given 'syncId'.

A sync is a single execution that fetches bank transactions from a connected bank account and records them in the company's accounting software.

get/companies/{companyId}/connections/{connectionId}/bankFeedAccounts/{sourceAccountId}/managedBankFeeds/syncs/{syncId}

Request

Success

syncIdstring uuid required

The unique identifier for the sync.

clientIdstring uuid required

The ID of the client associated with the company that owns the source bank account.

companyIdstring uuid required

The ID of the company that owns the source bank account.

companyNamestring required

The name of the company that owns the source bank account.

dataConnectionIdstring uuid required

The ID of the target accounting data connection.

sourceAccountIdstring required

The ID of the source bank account from which transactions are fetched.

periodStartUtcstring date-time required

The start of the sync period.

periodEndUtcstring date-time required

The end of the sync period.

executionStartUtcstring date-time required

The UTC timestamp when the sync started executing.

statusstring required

The current status of the sync. Known values are Started, Failed, SuccessDataPushed, SuccessNoDataPushed, PartialSuccessDataPushed.

executionEndUtcstring date-time nullable

The UTC timestamp when the sync execution ended, if completed (i.e. status is any value other than Started).

errorMessagestring nullable

Error message if the sync failed.

errorCodestring nullable

Error code if the sync failed.

pushOperationKeysstring[] nullable

List of write operation keys associated with the sync, if the sync resulted in write attempts.

{
  "status": "SuccessDataPushed"
}