AlmondTill/G3N API

TaxJurisdiction

object type

A tax jurisdiction — ONE node of OUR canonical jurisdiction tree (roots = countries; full local depth for the US). SHARED-CANONICAL, ruled: AT builds and maintains this data centrally; merchants REFERENCE it (TaxRegistration nexus, ExemptionCertificate scopes, the calc) and never edit it — the wire is READ-ONLY (writes are kit-channel: the US+CA seed slice). The tree is the MUTABLE treeParent pointer; regime/countryCode/currencyCode ride the COUNTRY root only (descendants inherit by walk-up).

Fields

FieldTypeNotes
idID ID!The record’s id — a UUID the platform assigned when the record was created; every reference to this record uses it.
sysIdString String!The GLOBAL-namespace human-facing system id (TJ-…, account-wide, like the Account's).
typeString String!The kind of record — always TaxJurisdiction here.
captionString String!The record’s display name — what people see it called.
statusString String!The FSM state: active | inactive | doomed.
parentIdIDThe id of the record this one belongs to; a record at the top of your group names the group itself.
rootIdID ID!The shared-canonical listing ANCHOR — the country root's id (a root self-roots: rootId === id) / the owning jurisdiction; NEVER an org group.
createdAtString String!When the record was created, as a UTC timestamp.
updatedAtString String!When the record last changed, as a UTC timestamp.
revisionNumInt Int!How many times this record has been edited; the first save is 0.
revisionID ID!The OCC revision token — supply it on every mutation of this record; rotates on every write.
refCaptionsRefCaption [RefCaption!]!The server-composed captions of this record's declared references (the referenced-caption rule) — one row per referenced id; see RefCaption.
levelTaxJurisdictionLevel TaxJurisdictionLevel!The depth class — a child sits STRICTLY deeper than its tree parent (skips legal: cities under states). IMMUTABLE.
treeParentIDThe MUTABLE tree pointer — absent ⟺ a country root. Moves stay in-country.
regimeTaxRegimeCOUNTRY ROOTS ONLY: sales_tax (rates STACK down the chain) | vat_gst (single rate). Descendants inherit by walk-up.
countryCodeStringCOUNTRY ROOTS ONLY: ISO 3166-1 alpha-2 (uppercase) — also the one-live-tree-per-country GLOBAL uniqueness marker value.
currencyCodeStringCOUNTRY ROOTS ONLY: ISO 4217 (uppercase) — the currency TaxRate thresholds are minor units of.
codeStringOptional official geography code (ISO 3166-2 region / FIPS county / place code …) — seed-pipeline provenance; NOT an identity key.

Used by