AlmondTill/G3N API

TaxRegistration

object type

A tax registration — the org's NEXUS declaration for ONE jurisdiction: tax computes ONLY where the org holds an ACTIVE registration (the calc gate). The OPERATIONAL semantics: active = the org collects there · inactive = a lapsed/suspended registration (resumable) · doomed = deregistered. ONE live registration per (org × jurisdiction) — the pair marker; the PAIR is IMMUTABLE at birth (re-register = create + doom). jurisdictionId refs the SHARED canonical tree. Physical-nexus seeding from PFLs and economic-nexus tracking are spec-deferred.

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 group-scoped human-facing system id (TN-…).
typeString String!The kind of record — always TaxRegistration here.
captionString String!The record’s display name — what people see it called.
statusString String!The FSM state: active | inactive | doomed.
parentIdID ID!The registering Organization; for a TaxRegistration parentId!== rootId.
rootIdID ID!The org-group family root.
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.
jurisdictionIdID ID!The registered TaxJurisdiction. IMMUTABLE at birth (the pair is the identity + its uniqueness marker).
registrationNumberStringOptional permit/registration number issued by the jurisdiction. Editable (corrections are real).
codeStringOptional mutable merchant reference code; uniqueness NOT enforced.

Used by