AlmondTill/G3N API

On this page

taxJurisdiction

query · in the family Tax jurisdiction

What it does

One tax jurisdiction — a place whose tax rules can apply to your sales.

A TaxJurisdiction by id — SHARED canonical data: AT builds and maintains it; every authenticated principal reads it (NO tenant binding — cross-tenant reading is the point); the wire is READ-ONLY (writes are platform-channel). A missing id reads as null.

Who may call it

Capability area: Reading your records — Looking up and listing the records of your organization.

Arguments

NameTypeRequiredNotes
idID ID!yesThe id of the record.

Returns

TaxJurisdiction — 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).

Example request

query ExampleTaxJurisdiction($id: ID!) {
  taxJurisdiction(id: $id) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    level
    treeParent
    regime
    countryCode
    currencyCode
    code
  }
}

Variables:

{
  "id": "01900000-0000-7000-8000-37386ae00000"
}

Example response

{
  "data": {
    "taxJurisdiction": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "TJ-EXMP-0000-000F",
      "type": "TaxJurisdiction",
      "caption": "Blue jeans",
      "status": "active",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "level": "country",
      "treeParent": "01900000-0000-7000-8000-e095a88d0000",
      "regime": "sales_tax",
      "countryCode": "CA",
      "currencyCode": "USD",
      "code": "BJ-001"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer