tax23 ops

Tax API

Tax rates, jurisdictions, and invoice tax computation.

Queries

QUERY

adminTenantTaxPolicies

#

List the tax policies of a specific tenant (PlatformAdmin only). Mirrors taxPolicies but takes the target tenant from the argument instead of the request context, so platform admins can inspect a tenant they're not impersonating. Used by the admin tenant detail page.

Arguments

  • tenantId!
  • input!

    Default

    {
  "vertical": null,
  "taxType": null,
  "activeOnly": false,
  "search": null,
  "pagination": {
    "limit": 10,
    "page": 1,
    "after": null
  }
}
Returns!
QUERY

taxExemptions

#

List tax exemptions for the current tenant.

Returns[!]!
QUERY

taxPolicies

#

List tax policies for the current tenant.

Arguments

  • input!

    Default

    {
  "vertical": null,
  "taxType": null,
  "activeOnly": false,
  "search": null,
  "pagination": {
    "limit": 10,
    "page": 1,
    "after": null
  }
}
Returns!
QUERY

taxPolicy

#

Get a single tax policy with its rates.

Arguments

  • idString!
Returns!
QUERY

taxPolicyVersions

#

Get all versions of a tax policy by key.

Arguments

  • policyKeyString!
Returns[!]!
QUERY

taxProviderConfigs

#

List all tax provider configs for the current tenant.

Arguments

  • activeOnlyBoolean!

    Default

    true
Returns[!]!
QUERY

taxZones

#

List tax zones for the current tenant.

Arguments

  • input!

    Default

    {
  "countryCode": null,
  "adminRegionId": null,
  "cityId": null,
  "activeOnly": false,
  "search": null,
  "pagination": {
    "limit": 10,
    "page": 1,
    "after": null
  }
}
Returns!

Mutations

MUTATION

activateTaxPolicy

#

Activate a tax policy version (deactivates other versions with the same key).

Arguments

  • idString!
Returns!
MUTATION

createTaxExemption

#

Create a tax exemption rule.

Arguments

  • input!
Returns!
MUTATION

createTaxPolicy

#

Create a new tax policy with optional inline rates.

Arguments

  • input!
Returns!
MUTATION

createTaxProviderConfig

#

Create a tax engine provider configuration for the tenant.

Arguments

  • input!
Returns!
MUTATION

createTaxRate

#

Add a tax rate to a policy.

Arguments

  • input!
Returns!
MUTATION

createTaxZone

#

Create a new tax zone (jurisdiction). The (country, admin_region, city) chain is validated by a trigger on tax.zones — inconsistent FKs surface as a Postgres error here.

Arguments

  • input!
Returns!
MUTATION

deactivateTaxPolicy

#

Deactivate a tax policy version.

Arguments

  • idString!
Returns!
MUTATION

deleteTaxExemption

#

Delete a tax exemption.

Arguments

  • idString!
ReturnsBoolean!
MUTATION

deleteTaxProviderConfig

#

Delete (deactivate) a tax provider config.

Arguments

  • idString!
ReturnsBoolean!
MUTATION

deleteTaxRate

#

Delete a tax rate.

Arguments

  • idString!
ReturnsBoolean!
MUTATION

deleteTaxZone

#

Soft-delete a tax zone (sets active = false).

Arguments

  • idString!
ReturnsBoolean!
MUTATION

updateTaxExemption

#

Update a tax exemption.

Arguments

  • idString!
  • input!
Returns!
MUTATION

updateTaxPolicy

#

Update an existing tax policy.

Arguments

  • idString!
  • input!
Returns!
MUTATION

updateTaxProviderConfig

#

Update a tax engine provider configuration.

Arguments

  • idString!
  • input!
Returns!
MUTATION

updateTaxRate

#

Update a tax rate.

Arguments

  • idString!
  • input!
Returns!
MUTATION

updateTaxZone

#

Update an existing tax zone. Geographic consistency is enforced by the trg_tax_zones_validate_geography trigger.

Arguments

  • idString!
  • input!
Returns!