Companies

Add a company

Add a company. <br> <b>Required scope(s):</b> administration:write

post/api/v4/f/{firm_id}/companies

Request

Base URL
https://live.getsilverfin.com
URL
https://live.getsilverfin.com/api/v4/f/{firm_id}/companies
Auth
OAuth 2
Authorization code: https://live.getsilverfin.com/oauth/authorize
Token URL: https://live.getsilverfin.com/oauth/token scopes: administration:write

Path parameters

firm_idinteger required

Headers

Acceptstring

Content-Typestring

Request body multipart/form-data

company_typestring

Can either be: regular, analytical, consolidation, sole_trader

first_namestring

required ONLY for personal files

last_namestring

required ONLY for personal files

national_insurance_numberstring

namestring required

The company's name.

periods_per_yearinteger required

Can either be 1, 4, 12 (monthly, quarterly, yearly)

accountancy_synchronisation_entity_idinteger

accountancy_synchronisation_referencestring

account_mapping_list_idinteger

administration_synchronisation_entity_idinteger

administration_synchronisation_referencestring

year_endstring date required

organisation_formstring

file_codestring

company_template_idinteger

If the ID is given, the company will use the company template identified by that ID. <br /> Otherwise:

<ul> <li>For regular companies, it will use the firm's default company template.</li> <li>For sole trader companies, it will use the firm's default sole trader template.</li> <li>For personal files (only considers active company templates - "can be manually added"), it will find a company template according to the following rules, in order: <ul> <li>First personal company template having the Silverfin Personal Income Tax workflow as default</li> <li>First personal company template having the Silverfin Personal Income Tax workflow</li> <li>First personal company template</li> </ul> </li> </ul>

visible_for_contributorsboolean

vat_identifierstring

Please use registration_number or vat_number instead

registration_numberstring

vat_numberstring

streetstring

citystring

countrystring

currencystring

custom[][namespace]string

custom[][key]string

custom[][value]string

Response

Successful response

idinteger

company_id

namestring

created_atstring