AlmondTill/G3N API

On this page

taxJurisdictions

query · in the family Tax jurisdiction

What it does

The tax jurisdictions — the places whose tax rules the platform maintains.

countryCode: ISO 3166-1 alpha-2 (uppercase) — resolves ONE country tree via the GLOBAL uniqueness marker (an unseeded country reads as an empty page). ABSENT = the whole canonical family, country by country in ascending code order. PAGINATED: limit clamps to [1, 200], default 100; nextToken = the prior page's cursor, verbatim (malformed/foreign → VALIDATION/INVALID). Doomed records DROP per page — walk until nextToken is null. STRUCTURED FILTER + SORT: filter = AND across clauses, OR within a clause's values; sort = one declared field, asc/desc. The declared TaxJurisdiction roster: caption (text) · level (enum) · country (country) · postal (postal) · createdAt (date) · updatedAt (date). An illegal filter/sort refuses VALIDATION/INVALID NAMING the exact problem (an unknown field teaches the roster). A filtered/sorted read evaluates its whole SCOPE server-side, returns the EXACT matchCount, and its nextToken binds to THE ONE scope + filter + sort that minted it — replaying it elsewhere refuses. Absent both, the unfiltered lane is unchanged (matchCount null).

What happens

Reads only.

Who may call it

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

Arguments

NameTypeRequiredNotes
countryCodeStringnoNo further notes.
filterFilterInputnoWhich records to answer — clauses over the family’s filterable fields (the FilterInput type and the paging guide carry the grammar).
sortSortInputnoThe order to answer in — one declared field and a direction (the SortInput type carries the grammar).
limitIntnoHow many records to answer at most; a page may hold fewer.
nextTokenStringnoThe cursor from the previous page, passed back exactly as received.

Returns

TaxJurisdictionPage TaxJurisdictionPage! — One page of the taxJurisdictions listing — the records + the opaque resume cursor.

This is a page: items holds the records and nextToken the cursor for the next page — pass it back verbatim until it is null. See paging.

Example request

query ExampleTaxJurisdictions($countryCode: String) {
  taxJurisdictions(countryCode: $countryCode) {
    items {
      id
      sysId
      type
      caption
      status
      parentId
      rootId
      createdAt
      updatedAt
      revisionNum
      revision
      level
      treeParent
      regime
      countryCode
      currencyCode
      code
    }
    nextToken
    matchCount
  }
}

Variables:

{
  "countryCode": "CA"
}

Example response

{
  "data": {
    "taxJurisdictions": {
      "items": [
        {
          "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"
        }
      ],
      "nextToken": "<the cursor from the previous page>",
      "matchCount": 1
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer