Skip to main content
GET
Tax report for a period

Authorizations

Authorization
string
header
required

Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.

Headers

X-1Club-Chart-Image
enum<string>

Send png to have each picture carry its PNG (png, base64, at 2x) beside the SVG, for a client that shows images but does not draw SVG.

Available options:
png

Query Parameters

from
string<date>
required

First day of the period (YYYY-MM-DD), on the organization's clock.

to
string<date>
required

Last day of the period, inclusive.

clubId
integer

Only the sales of this club.

billingEntityId
integer

Only the sales of this selling company, for an organization that trades through more than one.

revenueAccountId
integer

Only the sales filed to this revenue account. A sale stored with no account counts as the default account.

sections
enum<string>
default:account

What the report is sectioned by.

Available options:
account,
rate,
club
rows
enum<string>
default:day

A row per day or per month within each section.

Available options:
day,
month
charts
enum<string>
default:none

Whether the answer carries pictures, as chart (and moreCharts) beside its figures - none (the default), the one chart of the answer, or every one. Opt-in, so a caller that never draws one pays nothing for it; the figures are the same either way.

Available options:
none,
summary,
all

Response

The tax report

period
object
chart
object

A picture of the answer, drawn from its own figures (never a second computation) in the caller's language: a member of staff's own when they chose one, otherwise the organization's. Present only when the request asks with charts=summary or charts=all (the default is none), and when the answer has something to draw. Every figure it shows is in alt and in the answer itself.

moreCharts
object[]

With charts=all: every other picture the answer can draw, after chart.

timezone
string

The clock the days are read on.

currency
string
sections
enum<string>
Available options:
account,
rate,
club
rows
enum<string>
Available options:
day,
month
groups
object[]

One per revenue account, tax rate or club, as sections asks.

total
object
byRate
object[]