Jump to Content
Documentation
Community
Academy
Platform
Feedback
STL Documentation
Recipes
API Documentation
Documentation
Community
Academy
Platform
Feedback
Log In
API Documentation
Log In
Moon (Dark Mode)
Sun (Light Mode)
STL Documentation
Recipes
API Documentation
Authorize
Search
JUMP TO
Silverfin API (Production)
Get Started
Postman Library Setup
Authentication
OAuth application scopes
Access Token & Refresh Token
post
Authorize
get
Account Mapping Lists
List all mappings in an account mapping list.
get
List all account mapping lists
get
Accountancy Synchronisation Entities
List all accountancy synchronisation entities
get
Accounts
Update a batch of accounts
post
Get content of an account
get
Update an account
post
List all company accounts
get
Create new account
post
App
Destroy an app link
delete
List all links for the current app & user
get
Register an app link
post
Target URL parameters
Budgets
List account ids of a given budget
get
List end dates of a given budget
get
List budget entries for given account_ids and end_dates
get
Details of a given budget
get
List all budgets
get
Companies
Get the people of a company
get
Update the people of a company
post
List all archived companies
get
List all companies
get
Add a company
post
Get custom company parameters
get
Post a custom property to a company
post
List all followers of a company
get
Add a follower to a company by id
post
Remove a follower from a company by id
delete
Archive a company
delete
Get details on a specific company
get
Update a company
post
List all users that have access to a company
get
Add a user to a company by id
post
Remove a user from a company by id
delete
Unarchive a company
post
Company Templates
List all client templates
get
Exports
Get content of an export file instance
get
List all export file instances
get
Create a new export file instance
post
List all export files
get
Get details of an export pdf instance
get
Move an export pdf instance to the documents
post
List all export pdf instances
get
Create a new export pdf instance
post
Financials
Get all custom parameters of an account for this period
get
Post a custom property to an account
post
Delete a custom property from an account
delete
Get information about the account values for this period
get
Adapt information for the account for this period
post
List values of all accounts for this period
get
Destroy an adjustment
delete
Update an adjustment
post
List all adjustments
get
Create a new adjustment
post
List all analytical dimensions
get
List all balances
get
Get all open transactions
get
Delete a period specific document.
delete
Replace a period specific document.
post
List all documents uploaded to templates.
get
Get all custom parameters of a permanent text
get
Post a custom property to a permanent text
post
Get detail of a permanent text for this period
get
Update Permanent Text
post
Get all results of a permanent text for this period
get
Get all sign markers in a permanent text for this period
get
List all permanent texts
get
Create a permanent text
post
Delete a custom property from a reconciliation
delete
Get all custom parameters of a reconciliation for this period
get
Post a custom property to a reconciliation
post
Get detail of a reconciliation text for this period
get
Update the starring status of a reconciliation for this period
post
Get all results of a reconciliation for this period
get
Get all sign markers in a reconciliation text for this period
get
List all reconciliations
get
List all results in a specific report
get
List all reports for a specific period
get
Groups
List all companies in a group
get
Add a company to a group by id
post
Delete a company from a group by id
delete
Delete a group
delete
Delete a user from a group by id
delete
List all users in a group
get
Add a user to a group by id
post
List all groups
get
Create a group
post
Live Export Documents
Upload document for live document in export pdf instance
post
List all live export documents
get
Add a new live export document
post
Get a live export document
get
Update a live export document
post
Periods
Get custom period parameters
get
Post a custom property to a period
post
Get information about a single period
get
Updates which periods should be public
post
List all periods of a company
get
Add a period
post
Permanent
Destroy a permanent document
delete
Get details for a single permanent document
get
Update a permanent document
post
Create a permanent document
post
Destroy a permanent folder
delete
Get content of permanent folder
get
Update a permanent folder
post
Create a permanent folder
post
Delete a permanent mail
delete
Move permanent mail
post
Remarks
List all comments for a specific remark
get
Post a new comment to a specific remark
post
Flag a remark as done or undone
post
Delete a remark
delete
List all remarks in a specific period
get
Create a new remark in a period
post
Templates
Remove an account template
delete
Show all properties of a certain account template
get
Update an existing account template
post
List all account templates in this firm
get
Create a new account template
post
List all existing export file templates
get
Create a new export file template
post
Get details of an export file template
get
Update an existing export file template
post
Delete an export file template
delete
List all permanent texts active in this firm
get
Get details of a reconciliation template
get
Update a reconciliation template
post
Remove a reconciliation template
delete
List all reconciliations active in this firm
get
Create a new reconciliation
post
Initiate a liquid test run
post
Check results of a liquid test run
get
Lint Liquid code
post
Remove a shared part from an account template
delete
Add a shared part to an account template
post
Remove a shared part from an export file
delete
Add a shared part to an export file
post
Remove a shared part from a reconciliation
delete
Add a shared part to a reconciliation
post
Delete a shared part
delete
Get detail of a shared part
get
Update a shared part
post
List all shared parts
get
Add a shared part
post
User
Returns current user information
get
Returns current user email
get
Get details on the firm of the user
get
Users
Activate an inactive user
post
List all companies a user has access to
get
Add a company to a user by id
post
Remove a company from a user by id
delete
Put a user to inactive
delete
Update a user
post
List all active users
get
Add a user
post
List all inactive users
get
Webhooks
Webhook events
Destroy a webhook
delete
List all company webhooks
get
Register a webhook.
post
Workflows
Add a FirmWorkflow into the company
post
List all active (non-archived) FirmWorkflows in this Firm
get
Archive a workflow
post
Reactivate a workflow
post
List all reconciliations in a workflow
get
Get workflow status
get
List all workflows in a specific period
get
Silverfin SyncAPI
Get Started with the SyncAPI
Silverfin Terms Dictionary
The customer Flow in Silverfin
API usage limits
Code Example - Recipes
Authentication
OAuth application SyncAPI scopes
Access Token & Refresh Token
post
Authorize
get
Firm-Related
Get Overview and Transaction Limits
get
Update Sync References
post
Get Syncable Companies List
get
Company-Specific
Get Sync Information
get
Update Sync Settings for a Company
post
Opening Balances and Retained Earnings
Submit Bookkeeping Transactions
post
Reset Bookkeeping Data
delete
Webhooks
Webhook events
List all sync webhooks
get
Register a webhook.
post
Destroy a webhook
delete
Powered by
Authorize
get
https://live.getsilverfin.com/oauth/authorize
Authorize
Language
Shell
Node
Ruby
PHP
Python
RESPONSE
Click
Try It!
to start a request and see the response here!