Add a company

post

https://live.getsilverfin.com/api/v4/f/{firm_id}/companies

Add a company.
Required scope(s): administration:write

Path Params

firm_id

integer

required

Body Params

company_type

string

Can either be: regular, analytical, consolidation, sole_trader, personal

first_name

string

required ONLY for personal files

last_name

string

required ONLY for personal files

national_insurance_number

string

name

string

NOT required for personal files

periods_per_year

integer

NOT required for personal files, can either be 1,4,12 (monthly, quarterly, yearly)

accountancy_synchronisation_entity_id

integer

accountancy_synchronisation_reference

string

account_mapping_list_id

integer

administration_synchronisation_entity_id

integer

administration_synchronisation_reference

string

year_end

date

required

organisation_form

string

file_code

string

company_template_id

integer

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

For regular companies, it will use the firm's default company template.
For sole trader companies, it will use the firm's default sole trader template.
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:
- First personal company template having the Silverfin Personal Income Tax workflow as default
- First personal company template having the Silverfin Personal Income Tax workflow
- First personal company template

visible_for_contributors

boolean

vat_identifier

string

deprecated

Please use registration_number or vat_number instead

registration_number

string

vat_number

string

street

string

city

string

country

string

currency

string

custom[][namespace]

string

custom[][key]

string

custom[][value]

string

Headers

string

Content-Type

string

Response

201Successful response