createPaymentTerm

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

Creates a payment term, such as net 30, for the organization. The term code is yours to choose and is checked for validity. A term cannot be created as the default while it is inactive.

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 CreatePaymentTerm($input: CreatePaymentTermInput!) {
  createPaymentTerm(input: $input) {
    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 CreatePaymentTerm($input: CreatePaymentTermInput!) {\n  createPaymentTerm(input: $input) {\n    id\n    code\n    createdAt\n    description\n    isActive\n    isDefault\n  }\n}",
  "variables": {
    "input": {
      "code": "string",
      "kind": "COD",
      "label": "string",
      "netDays": 0
    }
  }
}
EOF

Variables:

{
  "input": {
    "code": "string",
    "kind": "COD",
    "label": "string",
    "netDays": 0
  }
}

Response:

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

createPaymentTerm(
  input: CreatePaymentTermInput!
): PaymentTerm!

Arguments

createPaymentTerm.input ● CreatePaymentTermInput! non-null input

The payment term to create.

Type

PaymentTerm object

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