Menu
Platform
AI
App store purchases
Credits
Database
Flags
Generated Assets
Jobs and cron
Localization
Monitoring
Notifications
Payments
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
List tax threshold statuses
Lists where the environment's consumer sales stand against each jurisdiction's digital-services tax registration threshold, per its own…
Lists where the environment's consumer sales stand against each jurisdiction's digital-services tax registration threshold, per its own window. EU and UK have no threshold and are not tracked.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/tax_threshold_statuses - Scope
billing:read - Effect
read— nothing is written. - Collection tax_threshold_statuses
- Query
page_size,page_token - Pagination the answer carries
tax_threshold_statusesand, when there is more,next_page_token
#Request
| Field | Type | What it is |
|---|---|---|
parent | string | The parent to list in. Required. |
page_size | int32 | At most this many; default 50, clamped to 1000. |
page_token | string | next_page_token of the previous page. |
#Response
| Field | Type | What it is |
|---|---|---|
tax_threshold_statuses | TaxThresholdStatus[] | The page. |
next_page_token | string | The token of the next page; empty on the last page. |
#TaxThresholdStatus
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/tax_threshold_statuses/{threshold}, the threshold's id (au-gst, us-tx). |
uid | string | The threshold's id, as in name. Output only. |
meta | ResourceMeta | Resource metadata; not set for a computed view. |
region_code | string | The jurisdiction's country, upper-case ISO 3166-1 alpha-2. Output only. |
subdivision_code | string | The jurisdiction's subdivision (a US state, TX); empty for a country. Output only. |
tax_name | string | The tax the threshold registers for, for example GST. Output only. |
currency_code | string | The threshold's currency, upper-case ISO 4217. Output only. |
threshold_amount | string | The amount that triggers registration, integer minor units of currency_code; "0" when the threshold is a transaction count only. Output only. |
threshold_transaction_count | int64 | The transaction count that triggers registration; 0 when none. Output only. |
window_kind | string | rolling_12_months, calendar_year, or prior_or_current_calendar_year. Output only. |
window_start_time | timestamp | The start (inclusive) of the window the figures below cover. Output only. |
window_end_time | timestamp | The end of the window (the moment of the read for a rolling window). Output only. |
sales_amount | string | The consumer paid sales in the window, net of tax, in currency_code minor units. Business sales (a tax id was given) are excluded. Output only. |
sales_transaction_count | int64 | The number of those sales. Output only. |
percent | int32 | How close the sales are to the threshold, in whole percent (the higher of the amount and the count); it can exceed 100. Output only. |
alerted_percent | int32 | The highest alert level (70, 90, 100) already sent for this window; 0 if none. Output only. |
unconverted_currency_codes | string[] | Currencies of sales that could not be converted into currency_code (no rate in the rate table) and so are not counted in sales_amount. Output only. |
source_url | string | The authority page the threshold comes from. Output only. |
effective_time | timestamp | When the threshold row took effect. Output only. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only. |
create_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.INVALID_FIELD— A field failed validation.
Every error arrives in the body Errors describes.
#Examples
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/tax_threshold_statuses" \
-H "Authorization: Bearer $SYLPHX_API_KEY"