Companies

Update a company

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

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

Request

  • Base URL
    https://live.getsilverfin.com
  • URL
    https://live.getsilverfin.com/api/v4/f/{firm_id}/companies/{company_id}
  • 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
company_idinteger required

Headers

Acceptstring
Content-Typestring

Request body multipart/form-data

first_namestring

required ONLY for personal files

last_namestring

required ONLY for personal files

national_insurance_numberstring
namestring

NOT required for personal files

periods_per_yearinteger

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

account_mapping_list_idinteger
administration_synchronisation_entity_idinteger
administration_synchronisation_referencestring
year_endstring date
organisation_formstring
file_codestring
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
organisation_formstring
countrystring
citystring
streetstring
file_codestring
company_typestring
periods_per_yearinteger
sync_referencestring
accountancy_synchronisation_referencestring
accountancy_synchronisation_entity_idinteger
accountancy_synchronisation_entity_typestring
account_mapping_list_idinteger
administration_synchronisation_referencestring
administration_synchronisation_entity_idinteger
company_template_idinteger
folder_namestring
vatstring
visible_for_contributorsboolean
currencystring
group_idsinteger[]
year_endstring
first_namestring
last_namestring
national_insurance_numberstring

Changes

No recorded changes to this operation across all 2 revisions of this API.