deactivatePaymentTerm

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

Deactivates a payment term. Inactive terms are left out of paymentTerms unless includeInactive is true. The current default cannot be deactivated: choose another default first.

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 DeactivatePaymentTerm($id: ID!) {
  deactivatePaymentTerm(id: $id) {
    id
    code
    createdAt
    description
    isActive
    isDefault
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation DeactivatePaymentTerm($id: ID!) {\n  deactivatePaymentTerm(id: $id) {\n    id\n    code\n    createdAt\n    description\n    isActive\n    isDefault\n  }\n}",
  "variables": {
    "id": "id"
  }
}
EOF

Variables:

{
  "id": "id"
}

Response:

{
  "data": {
    "deactivatePaymentTerm": {
      "id": "id",
      "code": "string",
      "createdAt": "2025-01-15T00:00:00Z",
      "description": "string",
      "isActive": true,
      "isDefault": true
    }
  }
}

deactivatePaymentTerm(
  id: ID!
): PaymentTerm!

Arguments

deactivatePaymentTerm.id ● ID! non-null scalar

The ID of the payment term to deactivate.

Type

PaymentTerm object

An organization's payment term, such as Net 30, that sets when an invoice is due.