AlmondTill/G3N API

On this page

taxRate

query · in the family Tax rate

What it does

One tax rate row — the percentage a jurisdiction charges for a category, over time.

A TaxRate 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

TaxRate — A tax rate cell — ONE effective-dated (jurisdiction × category × window) cell of OUR canonical rate tables, carrying BOTH the rule outcome (treatment) AND the rate (integer parts-per-million — 6.625% = 66250). SHARED-CANONICAL + READ-ONLY on the wire (the ruling rides down from the tree; writes are kit-channel — the seed slice). A DATED_SCHEDULE: half-open [startAt, endAt) windows, splice-normalized PER (jurisdiction × category) sub-schedule — the record set IS the full rate history; supersede, never rewrite. exempt/zero_rated cells price at 0 (zero_rated keeps input credits — the distinction feeds remittance). compound = tax-on-tax; combined = the HST marker (this rate REPLACES the ancestor stack). An optional threshold scopes the rule to unit prices STRICTLY BELOW it (minor units of the country currency — the BC childrens-clothing shape).

Example request

query ExampleTaxRate($id: ID!) {
  taxRate(id: $id) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    category
    treatment
    ratePpm
    compound
    combined
    thresholdMinorUnits
    startAt
    endAt
  }
}

Variables:

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

Example response

{
  "data": {
    "taxRate": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "TX-EXMP-0000-000F",
      "type": "TaxRate",
      "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",
      "category": "standard",
      "treatment": "taxable",
      "ratePpm": 1,
      "compound": true,
      "combined": true,
      "thresholdMinorUnits": 1,
      "startAt": "2027-01-31T00:00:00.000Z",
      "endAt": "2027-01-31T00:00:00.000Z"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer