addedInput schema / properties / region
Added value: +{
+ "description": "Optional state or province code, for sub-national sales tax. Held for CA (13 provinces and territories), US (51 states incl. DC). E.g. 'ON' (Ontario) with country CA, or 'CA' (California) with country US. Answered from that state's or province's own cited rate; US figures are the state rate only — local sales taxes are not included.",
+ "examples": [
+ "ON",
+ "CA",
+ "NY"
+ ],
+ "maxLength": 2,
+ "minLength": 2,
+ "pattern": "^[A-Za-z]{2}$",
+ "type": "string"
+}
addedOutput schema / properties / region
Added value: +{
+ "additionalProperties": false,
+ "description": "Present only when region was passed: the state or provincial sales tax, with its OWN source and date",
+ "properties": {
+ "code": {
+ "description": "State or province code",
+ "type": "string"
+ },
+ "combinedRate": {
+ "description": "What a buyer pays in total: in Canada the provincial rate plus the 5% GST (or the single HST); in the US the state rate (local taxes not included)",
+ "type": "number"
+ },
+ "dataVerifiedOn": {
+ "description": "ISO date the regional rate was last checked",
+ "type": "string"
+ },
+ "effectiveFrom": {
+ "description": "ISO date the rate took effect",
+ "type": "string"
+ },
+ "mayBeStale": {
+ "description": "True when that date is over a year old, or the rate is unverified",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "What applies there, in a sentence",
+ "type": "string"
+ },
+ "source": {
+ "description": "Authority the regional rate was verified against — says 'not verified' when it was not",
+ "type": "string"
+ },
+ "sourceUrl": {
+ "description": "https link to the authority page — present only for verified rates",
+ "type": "string"
+ },
+ "standardRate": {
+ "description": "The state or provincial rate alone, as a fraction",
+ "type": "number"
+ },
+ "taxName": {
+ "description": "The tax's name, e.g. 'Ontario HST'",
+ "type": "string"
+ }
+ },
+ "required": [
+ "code",
+ "name",
+ "taxName",
+ "standardRate",
+ "combinedRate",
+ "effectiveFrom",
+ "source",
+ "dataVerifiedOn",
+ "mayBeStale"
+ ],
+ "type": "object"
+}
addedOutput schema / properties / relatedFact
Added value: +{
+ "additionalProperties": false,
+ "description": "One sourced background fact about the country's consumption tax; the figures do not depend on it. Absent when no sourced fact fits.",
+ "properties": {
+ "context": {
+ "description": "Present on a state or provincial answer: the fact is about the country as a whole",
+ "enum": [
+ "national"
+ ],
+ "type": "string"
+ },
+ "country": {
+ "description": "2-letter ISO code of the country the fact is about",
+ "type": "string"
+ },
+ "detail": {
+ "description": "Longer supporting detail, when the corpus has it",
+ "type": "string"
+ },
+ "fact": {
+ "description": "The fact, in one or two sentences",
+ "type": "string"
+ },
+ "kind": {
+ "description": "'origin' = when the tax began and what it replaced; 'anniversary' = the same, on the anniversary of its start date; 'story' = a dated story from the facts corpus",
+ "enum": [
+ "origin",
+ "story",
+ "anniversary"
+ ],
+ "type": "string"
+ },
+ "more": {
+ "description": "The tool that returns the full sourced fact set for this country",
+ "enum": [
+ "tax_facts"
+ ],
+ "type": "string"
+ },
+ "sourceName": {
+ "description": "Who the fact is sourced to",
+ "type": "string"
+ },
+ "sourceUrl": {
+ "description": "Link to that source — always present",
+ "type": "string"
+ },
+ "topic": {
+ "description": "Which tax the fact is about",
+ "enum": [
+ "gst",
+ "income",
+ "company",
+ "cgt",
+ "super",
+ "studentloan",
+ "general"
+ ],
+ "type": "string"
+ },
+ "verifiedDate": {
+ "description": "ISO date the fact was last checked against its source, when recorded",
+ "type": "string"
+ }
+ },
+ "required": [
+ "kind",
+ "topic",
+ "country",
+ "fact",
+ "sourceName",
+ "sourceUrl",
+ "more"
+ ],
+ "type": "object"
+}
addedOutput schema / properties / sourceUrl
Added value: +{
+ "description": "https link to the authority page the rate was verified against. Present only on rate answers backed by a verified ledger row — absent (never empty) otherwise, so its presence is itself the claim",
+ "type": "string"
+}