Set Up Company
update_companySave the user's answers about their own business to their AccountsOS company: what kind of business it is (entity_type, for example sole_trader or ltd), the country it is registered in (ISO code such as GB, IE, US), the company or registration number, the name, what it does, the currency, the year-end month and VAT registration. Use it during setup, and when the user corrects one of these details. For a UK or Irish limited company with a registration number, call lookup_company and then link_company instead, which fills everything from the official register. Only pass what the user told you; never guess.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Registered/legal company name (the business being kept books for). | |
| company | No | Which company to read, by name or id, when the account has more than one (see list_companies). Leave it out to use the only company, or the default. | |
| country | No | ISO 3166-1 alpha-2 country code where the business is registered (for example GB, IE, US, AU, AE). Sets which tax rules apply. Refused once the company has bookkeeping entries. | |
| vat_number | No | VAT/GST registration number. Providing a number also marks the company VAT registered unless vat_registered is explicitly false. | |
| entity_type | No | Business structure (e.g. "ltd" for a UK limited company, "sole_trader", "llp", "fzco" for a UAE free-zone company). Use the value appropriate to the company's country. Drives which tax rules apply. | |
| trading_name | No | Trading name / "doing business as", if different from the registered name. | |
| company_number | No | Company/registration number (e.g. UK Companies House number, IE CRO number, DK CVR number). Setting this lets us sync filing deadlines from the registry. | |
| vat_registered | No | Whether the business is VAT/GST registered. Set true when the user confirms they are registered, false when they confirm they are not. Also false for a business whose sales are all VAT-exempt and that cannot reclaim VAT (an investment fund, a Belgian Article 44 exempt taxpayer): it files no periodic return, so keep its vat_number and pass vat_registered false. If a UK registration has been CANCELLED, pass vat_deregistration_date instead. | |
| business_summary | No | What the business does, in one plain sentence in the user's own words, e.g. "Mobile dog groomer" or "Two-person web design agency". Save it whenever the user says what they do: it tells categorisation and advice what kind of business this is. | |
| default_currency | No | ISO 4217 default currency code, e.g. GBP, EUR, USD, AED, DKK. Uppercased automatically. | |
| incorporation_date | No | Date the company was incorporated, YYYY-MM-DD. Pass it whenever the user tells you, and ALWAYS for a UK limited company with no company number yet (just incorporated, or not on Companies House yet): use today for "just incorporated". For such a company it sets up the estimated first-year deadlines (Corporation Tax registration, first confirmation statement, first accounts, first CT return) so the founder sees their first year mapped out; tell them what is coming and when. | |
| financial_year_end_month | No | Month (1-12) the financial year ends. Only set when the user tells you their year-end; do not guess. |