Company routes: submit · StartupBuilder

Reference for Company, one group of Company routes.

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.

Text

POST /{namespace}/companies/submit

Body, as JSON: the inputs. 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

Terminal

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

JSON

{
  "api": "https://api.sb/leaseline.app",
  "taxReturn": {
    "$id": "https://api.sb/leaseline.app/documents/document_af2wijcmRy",
    "$type": "Document",
    "form": "document"
  },
  "payment": {
    "$id": "https://api.sb/leaseline.app/transactions/txn_XoxtZe3CQI",
    "$type": "Transaction",
    "kind": "charge",
    "amount": {
      "amount": 29,
      "currency": "USD"
    }
  },
  "company": {
    "$id": "https://api.sb/leaseline.app/companies/company_28zYNZEno0",
    "$type": "Company",
    "name": "Leaseline",
    "legalName": "Leaseline Inc.",
    "jurisdiction": "US-DE",
    "status": "forming"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Company.submit",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Company.submitCopy Anchor Link

Company.submit