AlmondTill/G3N API

On this page

doomTaxRegistration

mutation · in the family Tax registration

What it does

Permanently retire your tax registration in a jurisdiction — the legal basis for collecting there.

Doom (terminal) a TaxRegistration by id; requires the unrestricted capability + the record's CURRENT revision. Deny-by-default + the referential_integrity / authority / occ guards; a doomed TaxRegistration is immutable + never deleted. The optional reason rides the transition events.

Careful

Doom is forever — a doomed record never comes back into use (its history remains readable). Anything still referencing it live will block the doom.

Who may call it

Capability area: Privacy and compliance — Tax and fiscal configuration, certificates and privacy requests.

Arguments

NameTypeRequiredNotes
idID ID!yesThe id of the record.
revisionID ID!yesThe revision id you read on the record; the change is refused if an edit landed in the meantime.
reasonStringnoNo further notes.

Returns

TaxRegistration TaxRegistration! — 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.

Example request

mutation ExampleDoomTaxRegistration($id: ID!, $revision: ID!, $reason: String) {
  doomTaxRegistration(id: $id, revision: $revision, reason: $reason) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    jurisdictionId
    registrationNumber
    code
  }
}

Variables:

{
  "id": "01900000-0000-7000-8000-37386ae00000",
  "revision": "01900000-0000-7000-8000-b7960e180000",
  "reason": "Correcting a miscount."
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "doomTaxRegistration": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "TN-EXMP-0000-000F",
      "type": "TaxRegistration",
      "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",
      "jurisdictionId": "01900000-0000-7000-8000-b50e54f50000",
      "registrationNumber": "<registration number>",
      "code": "BJ-001"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer