Private preview of the new site. Not live.

taxes.salesReport

Sales tax report for a period (owner or office), shop local dates, from and to inclusive. Uses the shop's basis (shops.setTaxReportBasis) unless basis is given. accrual: invoices sent in the period, with sales, taxable sales, tax billed, and tax collected so far. cash: money collected in the period through Doing Work (payments minus refunds, tips left out), with the tax share of it. Grouped by the tax name, jurisdiction and rate on each invoice. Untaxed sales are one row with no rate. Void invoices are left out. For filing, check the numbers against your own records.

WhoAgents can call this
RESTGET /v1/tax-rates/report
MCP tooltaxes_salesReport
Writesno
AreaInvoices and payments (unlimited)

When to use it

Sales tax report for a period (owner or office), shop local dates, from and to inclusive. Uses the shop's basis (shops.setTaxReportBasis) unless basis is given.

What to tell the owner

Tell them what you found in plain words. Don't read back raw fields.

Input

FieldTypeRequired
shop_idstring (uuid)yes
fromstring (date)yes
tostring (date)yes
basisstring (one of accrual, cash)no

Example

GET https://doingwork.work/v1/tax-rates/report?shop_id=00000000-0000-4000-8000-000000000000&from=...&to=...

Output

JSON. The response shape isn't published yet; read the fields you need and ignore the rest. Errors are {code, message, status}.

Errors

CodeStatusWhat to do
invalid_input, invalid_token, rate_limitedCan happen on any call. See errors.