v1

latestOpenAPI 3.0.02026-07-2418630310.7 KB

Sync Firm-Related

Get Syncable Companies List

This provide the list of silverfin companies currently configured to rely on this API sync. This list is paginated. <b>Required scope(s):</b> financials:transactions:sync

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

Path parameters

firm_idnumber required

The unique identifier of the firm.

Query parameters

per_pageinteger

The number of companies returned per page during the pagination

pageinteger

The page number used for paginating companies

Response

The list of companies configured with this Sync.

idinteger required

The uniq identifier of the company in Silverfin, this is later interpolated in the URL.

namestring required

The name of the company as it can be seen in 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.

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.

Example response

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