Sales tax

Send finished sales tax returns to a connected filing service, which reports back when it has filed and paid.

List sales tax returns offered to a filing service

GET /tax-return-offers

Sends Vortex-Entity.

Returns the business's own offers, or for a platform only the offers made to its connection. Requires events:read.

Answers

  • 200 object. Offers, newest first.
  • 4XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what
  • 5XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what

Offer a finished period's sales tax return to a connected filing service

POST /tax-return-offers

Sends Idempotency-Key.

Freezes the prepared return (agency, period, tax collected, taxable sales, and every rate charged with its citation) and sends tax_return.offered to the connection's platform. One open offer per return. Requires journal:write, so only the business's own keys.

Body

FieldTypeAbout
agency_id requiredstring (uuid)
period_start requiredstring (date)
connection_id requiredstring (uuid)
pay_from_account_id requiredstring (uuid)

The bank or cash account the payment comes from, which SYNC posts it against when the return is filed.

Answers

  • 201 object. The offer.
  • 4XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what
  • 5XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what

Get an offered sales tax return

GET /tax-return-offers/{offer_id}

Sends Vortex-Entity.

Requires events:read. A platform sees only offers made to its connection.

Parameters

NameInTypeAbout
offer_id requiredpathstring (uuid)

Answers

  • 200 TaxReturnOffer. The offer and the frozen return.
  • 4XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what
  • 5XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what

Withdraw an offer the filing service hasn't filed

POST /tax-return-offers/{offer_id}/withdraw

Sends Idempotency-Key.

Sends tax_return.withdrawn. Requires journal:write.

Parameters

NameInTypeAbout
offer_id requiredpathstring (uuid)

Answers

  • 200 object. Withdrawn.
  • 4XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what
  • 5XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what

Report back on an offered return, as the filing service

POST /tax-return-offers/{offer_id}/report

Sends Vortex-Entity and Idempotency-Key.

Only the platform the return was offered to, through that connection. filed records the filing in SYNC and posts the payment from the account the business chose. Requires events:write.

Parameters

NameInTypeAbout
offer_id requiredpathstring (uuid)

Body

Answers

  • 200 TaxReturnOffer. The offer as it now stands.
  • 4XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what
  • 5XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what