v1

latestOpenAPI 3.0.02026-07-2418630310.7 KB
Sync Company-Specific

Update Sync Settings for a Company

Allows you to modify sync settings for a company, such as financial years, computations to be performed by Silverfin, and the retained earnings account.

Each "year" can be configured to make Silverfin compute opening balances and retained earnings automatically for you. You can read more about it on Opening Balances and Retained Earnings page.

<b>Required scope(s):</b> financials:transactions:sync

post/api/v4/f/{firm_id}/syncs/companies/{company_id}/settings

Path parameters

firm_idnumber required

The unique identifier of the firm.

company_idnumber required

The unique identifier of the company.

Request body

Example request

{
  "retained_earnings_account": {
    "number": "1234567890",
    "name": "John Doe"
  }
}

Response

Sync settings updated successfully.

object required