Sign in

v1

latestOpenAPI 3.0.02026-07-2418630310.7 KB
Sync Company-Specific

Get Sync Information

Retrieves the current synchronization state for a specific company. <b>Required scope(s):</b> financials:transactions:sync

get/api/v4/f/{firm_id}/syncs/companies/{company_id}/info

Path parameters

firm_idnumber required

The unique identifier of the firm.

company_idnumber required

The unique identifier of the company.

Response

Successfully retrieved sync information.

sync_pointstring required

A unique string representing a sync point used to track sync states.

sync_start_atstring date required

The date at which the company is configured to start on Silverfin.

sync_referencestring required

The sync reference used by the company. This is the uniq identifier in the third party sync supplied throught the POST /sync_references endpoint.

Example response

{
  "sync_point": "f9a7c6df341325822e3ea264cfe39e5ef8c73aa4",
  "sync_reference": "company-123"
}