paymentTermHolders

Requires at least one of the permissions customers:customer:list, customers:customer:read, suppliers:supplier:list or suppliers:supplier:read.

The records that hold a payment term as their default, one kind at a time, paged and searchable by name: the list behind each usage count. Customers need a customer read grant; suppliers and vendor accounts a supplier read grant; other partners either. Without it the call is refused and no names are returned.

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
cURL

query PaymentTermHolders($code: String!, $kind: PaymentTermHolderKind!) {
  paymentTermHolders(code: $code, kind: $kind) {
    limit
    page
    total
    items {
      id
      code
      name
      status
      explainedBySupplier
      kind
    }
  }
}

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query PaymentTermHolders($code: String!, $kind: PaymentTermHolderKind!) {\n  paymentTermHolders(code: $code, kind: $kind) {\n    limit\n    page\n    total\n    items {\n      id\n      code\n      name\n      status\n      explainedBySupplier\n      kind\n    }\n  }\n}",
  "variables": {
    "code": "string",
    "kind": "CUSTOMER"
  }
}
EOF

Variables:

{
  "code": "string",
  "kind": "CUSTOMER"
}

Response:

{
  "data": {
    "paymentTermHolders": {
      "limit": 0,
      "page": 0,
      "total": 0,
      "items": [
        {
          "id": "id",
          "code": "string",
          "name": "string",
          "status": "string",
          "explainedBySupplier": true,
          "kind": "CUSTOMER"
        }
      ]
    }
  }
}

paymentTermHolders(
  code: String!
  kind: PaymentTermHolderKind!
  limit: Int
  onlyUnexplained: Boolean
  page: Int
  search: String
): PaymentTermHolderPage!