Sales tax
Send finished sales tax returns to a connected filing service, which reports back when it has filed and paid.
GET /tax-return-offersList sales tax returns offered to a filing servicePOST /tax-return-offersOffer a finished period's sales tax return to a connected filing serviceGET /tax-return-offers/{offer_id}Get an offered sales tax returnPOST /tax-return-offers/{offer_id}/withdrawWithdraw an offer the filing service hasn't filedPOST /tax-return-offers/{offer_id}/reportReport back on an offered return, as the filing service
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
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
| Field | Type | About |
|---|---|---|
agency_id required | string (uuid) | |
period_start required | string (date) | |
connection_id required | string (uuid) | |
pay_from_account_id required | string (uuid) | The bank or cash account the payment comes from, which SYNC posts it against when the return is filed. |
Answers
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
| Name | In | Type | About |
|---|---|---|---|
offer_id required | path | string (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
| Name | In | Type | About |
|---|---|---|---|
offer_id required | path | string (uuid) |
Answers
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
| Name | In | Type | About |
|---|---|---|---|
offer_id required | path | string (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

