createOrUpdateOrganizationTaxConfig

Requires at least one of the permissions products:tax:update or settings:tenant:update.

Creates or updates the organization's tax configuration, including its default sales and purchase tax groups. Needs the tax update permission, or the tenant settings update permission.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation CreateOrUpdateOrganizationTaxConfig($input: CreateOrganizationTaxConfigurationInput!) {
  createOrUpdateOrganizationTaxConfig(input: $input) {
    id
    gstNumber
    createdAt
    defaultPurchaseTaxGroupId
    defaultSalesTaxGroupId
    defaultTaxCalculation
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation CreateOrUpdateOrganizationTaxConfig($input: CreateOrganizationTaxConfigurationInput!) {\n  createOrUpdateOrganizationTaxConfig(input: $input) {\n    id\n    gstNumber\n    createdAt\n    defaultPurchaseTaxGroupId\n    defaultSalesTaxGroupId\n    defaultTaxCalculation\n  }\n}",
  "variables": {
    "input": {
      "defaultTaxCalculation": "ADDITIVE",
      "taxSystemType": "string"
    }
  }
}
EOF

Variables:

{
  "input": {
    "defaultTaxCalculation": "ADDITIVE",
    "taxSystemType": "string"
  }
}

Response:

{
  "data": {
    "createOrUpdateOrganizationTaxConfig": {
      "id": "id",
      "gstNumber": "string",
      "createdAt": "2025-01-15T00:00:00Z",
      "defaultPurchaseTaxGroupId": "string",
      "defaultSalesTaxGroupId": "string",
      "defaultTaxCalculation": "ADDITIVE"
    }
  }
}

createOrUpdateOrganizationTaxConfig(
  input: CreateOrganizationTaxConfigurationInput!
): OrganizationTaxConfiguration!

Arguments

createOrUpdateOrganizationTaxConfig.input ● CreateOrganizationTaxConfigurationInput! non-null input

The tax configuration, including the default tax groups.

Type

OrganizationTaxConfiguration object

The organization's tax configuration.