deletePaymentTerm

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

Deletes a payment term: it leaves the settings list and every picker, and no new document can use it. Documents created before the delete keep the term, its label and their due dates. The code cannot be reused. The current default cannot be deleted: 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 DeletePaymentTerm($id: ID!) {
  deletePaymentTerm(id: $id)
}

cURL

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

Variables:

{
  "id": "id"
}

Response:

{
  "data": {
    "deletePaymentTerm": true
  }
}

deletePaymentTerm(
  id: ID!
): Boolean!

Arguments

deletePaymentTerm.id ● ID! non-null scalar

The ID of the payment term to delete.

Type

Boolean scalar

The Boolean scalar type represents true or false.