Skip to content

by Startups.Studio

OverviewCompany

Company.submit

POST /{namespace}/companies/submit

Submit files one tax return for a jurisdiction and its Periods, pays the tax due, and keeps the return as a Document.

Noun: Company
Mode: do
Event: Company.submitted

You, to your agent

Submit my company with a period.

curl -X POST https://api.sb/shiftnote.app/companies/submit \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"jurisdiction":"US-TX","kind":"salesTax","periods":["period_1"]}'

import { $ } from 'startup-builder'

const { taxReturn, payment, company } = await $.Company.submit({ jurisdiction: 'US-TX', kind: 'salesTax', periods: ['period_1'] })

npx startup-builder do Company.submit --json '{"jurisdiction":"US-TX","kind":"salesTax","periods":["period_1"]}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Company.submit({ jurisdiction: 'US-TX', kind: 'salesTax', periods: ['period_1'] })"
  }
}

Inputs

Input	Type	Required	Description
`jurisdiction`	`string`	required	Where the return is filed, such as `US-TX`.
`kind`	`string`	required	What the return reports: sales tax, VAT, GST, income, franchise tax, or an information return.
`periods`	list of Period	required	The locked Periods the return covers: one month, a quarter or a year.

Outputs

Output	Type	Required	Description
`taxReturn`	Document	required	The return as submitted, with the authority’s confirmation.
`payment`	Transaction		The payment of the tax due; none for an information return.
`company`	Company	required	The Company that filed the return.

Effects

Emits Company.submitted.
Performed by the Finance Lead.
One-way (money): it waits out its delay window, and runs in the send and do modes.
Computes the return from the Orders, Entries and payouts of its Periods.
A return with a sworn declaration waits for the signature of the Human the legal floor names.
Completes the return Task the registration created for the same jurisdiction and Periods.

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.submit

When it waits

Gate	Default
Decision class	Medium: one-way, bounded (money)
Delay window	1 business hour, in which a watcher can pause, redirect or cancel it; then it runs.
Limit	The spend Limit of the Permission or Mandate 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`.