AlmondTill/G3N API

On this page

resolveTaxJurisdictionByPostal

query · in the family Reading your records

What it does

Find the tax jurisdiction that applies at a postal code — type a ZIP, get the place.

Resolve a postal code to the tax jurisdiction(s) that apply there: ONE bounded read; the primary designation leads, straddling alternates follow. An unknown code — or a country without postal content — answers the honest empty resolution (primary null, alternates). Malformed input refuses VALIDATION/INVALID before any read. SHARED canonical data — no tenant scoping. Requires authentication.

What happens

Reads shared platform tax data. Most codes answer one jurisdiction; a code straddling city or district lines also lists the alternatives, with the usual designation first. An unknown code answers empty.

Who may call it

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

Arguments

NameTypeRequiredNotes
countryCodeString String!yesNo further notes.
postalString String!yesNo further notes.

Returns

TaxJurisdictionPostalResolution TaxJurisdictionPostalResolution! — One postal code's resolved tax jurisdictions: the usual designation first, the postal's other reachable jurisdictions after.

Example request

query ExampleResolveTaxJurisdictionByPostal($countryCode: String!, $postal: String!) {
  resolveTaxJurisdictionByPostal(countryCode: $countryCode, postal: $postal) {
    primary {
      id
      sysId
      type
      caption
      status
      parentId
      rootId
      createdAt
      updatedAt
      revisionNum
      revision
      level
      treeParent
      regime
      countryCode
      currencyCode
      code
    }
  }
}

Variables:

{
  "countryCode": "CA",
  "postal": "<postal>"
}

Example response

{
  "data": {
    "resolveTaxJurisdictionByPostal": {
      "primary": {
        "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

Used in