Company methods: dissolve, incorporate, register
The Company Verbs dissolve, incorporate, register as typed SDK methods, with inputs, result, refusals and an example.
Reference for Company, one group of Company methods.
Company.dissolve
Dissolve winds up a Company that holds no business: it files final returns and the certificate, and keeps every record. Verb page.
interface CompanyVerbs {
dissolve(input: CompanyDissolveInput, options?: SB.CallOptions): SB.Call<Company>
}Emits Company.dissolved.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
company | Company | required | The Company to wind up. |
reason | text | required | Why it ends, recorded as a Decision. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
company | Company | required | The dissolved Company, kept forever. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
| The record is not in a state that allows this Verb, so the call is refused. | refused | Read the record, run the Verb that moves it to an allowed state, then retry. | None. |
Example
import { $ } from 'startup-builder'
const company = await $.Company.dissolve({ company: 'company_28zYNZEno0', reason: 'Example reason' })Company.incorporate
Incorporate forms a Company in a chosen jurisdiction, with its founders, shares and registered agent on record. Verb page.
interface CompanyVerbs {
incorporate(input: CompanyIncorporateInput, options?: SB.CallOptions): SB.Call<Company>
}Emits Company.incorporated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
legalName | string | required | The registered name. |
jurisdiction | string | required | Where the Company forms. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
company | Company | required | The new Company. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The input does not match the schema of the operation. | invalid-input | Read the schema of the operation, then send every required field with the right type. | None. |
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
| The record is not in a state that allows this Verb, so the call is refused. | refused | Read the record, run the Verb that moves it to an allowed state, then retry. | None. |
Example
import { $ } from 'startup-builder'
const company = await $.Company.incorporate({ legalName: 'Leaseline Inc.', jurisdiction: 'US-DE' })Company.register
Register applies for a sales tax, VAT or GST registration in one jurisdiction and records the grant as a Credential. Verb page.
interface CompanyVerbs {
register(input: CompanyRegisterInput, options?: SB.CallOptions): SB.Call<CompanyRegisterOutput>
}Emits Company.registered.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
jurisdiction | string | required | Where to register, such as US-TX or EU-DE. |
kind | string | required | Which tax the registration collects. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
credential | Credential | required | The registration, with its number and filing frequency once granted. |
company | Company | required | The Company now registered in the jurisdiction. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
import { $ } from 'startup-builder'
const { credential, company } = await $.Company.register({ jurisdiction: 'US-TX', kind: 'salesTax' })