Company methods: submit
The Company Verbs submit as typed SDK methods, with inputs, result, refusals and an example.
Reference for Company, one group of Company methods.
Company.submit
Submit files one tax return for a jurisdiction and its Periods, pays the tax due, and keeps the return as a Document. Verb page.
interface CompanyVerbs {
submit(input: CompanySubmitInput, options?: SB.CallOptions): SB.Call<CompanySubmitOutput>
}Emits Company.submitted.
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. |
Returns
| 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. |
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 { taxReturn, payment, company } = await $.Company.submit({ jurisdiction: 'US-TX', kind: 'salesTax', periods: ['period_VEVuYACTsH'] })