Skip to content

by Startups.Studio

OverviewCompany

Company.register

POST /{namespace}/companies/register

Register applies for a sales tax, VAT or GST registration in one jurisdiction and records the grant as a Credential.

Noun: Company
Mode: do
Event: Company.registered

You, to your agent

Register my company.

curl -X POST https://api.sb/quietcopy.com/companies/register \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"jurisdiction":"US-TX","kind":"salesTax"}'

import { $ } from 'startup-builder'

const { credential, company } = await $.Company.register({ jurisdiction: 'US-TX', kind: 'salesTax' })

npx startup-builder do Company.register --json '{"jurisdiction":"US-TX","kind":"salesTax"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Company.register({ jurisdiction: 'US-TX', kind: 'salesTax' })"
  }
}

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.

Outputs

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.

Effects

Emits Company.registered.
Performed by the Finance Lead.
One-way: it waits out its delay window, and runs in the send and do modes.
The tax-filing Workflow calls it when sales cross a threshold, totaled across every Startup the Company holds.
Collection starts on the first Order placed after the authority grants the Credential.
Creates the recurring return Task at the frequency the authority assigns.

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.	Company.register

When it waits

Gate	Default
Decision class	Medium: one-way, bounded
Delay window	1 business hour, in which a watcher can pause, redirect or cancel it; then it runs.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.