Skip to main content

updateSalesSettings

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

Updates the sales settings: default salesperson, payment terms and tax rate, discounts and their ceiling, approval for large orders and its threshold, quotations, and whether shipping needs an invoice first. Returns the saved settings. Needs settings:sales:update, or settings:tenant:update.

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:

mutation UpdateSalesSettings($input: SalesSettingsInput!) {
  updateSalesSettings(input: $input) {
    id
    createdAt
    category
    dataType
    description
    enteredBy
  }
}

Variables:

{
  "input": {}
}

Response:

{
  "data": {
    "updateSalesSettings": [
      {
        "id": "id",
        "createdAt": "2025-01-15T00:00:00Z",
        "category": "ACCOUNTING",
        "dataType": "ARRAY",
        "description": "string",
        "enteredBy": "string"
      }
    ]
  }
}
updateSalesSettings(
  input: SalesSettingsInput!
): [TenantSetting!]!

Arguments​

updateSalesSettings.input ● SalesSettingsInput! non-null input​

The sales settings to change; fields left out stay as they are.

Type​

TenantSetting object​

A setting of the organization.