Sync Firm-Related

Get Overview and Transaction Limits

Returns various settings related to the Silverfin platform, such as the maximum number of supported analytical dimensions per transaction, supported locales for account names and the maximum amount of actions that can be submitted per request. <b>Required scope(s):</b> financials:transactions:sync

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

Request

  • Base URL
    https://live.getsilverfin.com
  • URL
    https://live.getsilverfin.com/api/v4/f/{firm_id}/syncs/settings
  • Auth
    OAuth 2
    Authorization code: https://live.getsilverfin.com/oauth/authorize
    Token URL: https://live.getsilverfin.com/oauth/token scopes: financials:transactions:sync

Path parameters

firm_idnumber required

The unique identifier of the firm.

Response

Successfully retrieved platform settings.

analytical_dimensionsnumber required

The maximum number of analytical dimensions allowed per transaction.

extra_fieldsnumber required

The maximum number of extra fields allowed per transaction.

localesstring[] required

List of supported locales for account names.

actions_per_requestnumber

The maximum number of actions that can be pushed in a single request.

Example response

{
  "locales": [
    "nl",
    "fr",
    "en",
    "de"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.