paymentTerms

Requires at least one of the permissions customers:customer:read, payments:invoice:read, purchase:purchase_order:read, sales:quote:read, sales:sales_invoice:read, sales:sales_order:read, settings:tenant:read or suppliers:supplier:read.

The payment terms this organization offers. Returns the platform default set when the organization has not configured its own yet, so a picker is never empty.

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

query PaymentTerms {
  paymentTerms {
    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": "query PaymentTerms {\n  paymentTerms {\n    id\n    code\n    createdAt\n    description\n    isActive\n    isDefault\n  }\n}"
}
EOF

Response:

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

paymentTerms(
  includeInactive: Boolean
): [PaymentTerm!]!

Arguments

paymentTerms.includeInactive ● Boolean scalar

Set to true to include inactive terms. Defaults to false.

Type

PaymentTerm object

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