markCommissionPayoutPaid

Requires permission commissions:commission:update.

Settles a payout: marks it and all its commissions paid. A payout that is already settled cannot be marked again. Requires permission to update commissions.

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 MarkCommissionPayoutPaid($input: MarkPayoutPaidInput!) {
  markCommissionPayoutPaid(input: $input) {
    id
    repName
    status
    createdAt
    commissionCount
    paidAt
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation MarkCommissionPayoutPaid($input: MarkPayoutPaidInput!) {\n  markCommissionPayoutPaid(input: $input) {\n    id\n    repName\n    status\n    createdAt\n    commissionCount\n    paidAt\n  }\n}",
  "variables": {
    "input": {
      "payoutId": "string"
    }
  }
}
EOF

Variables:

{
  "input": {
    "payoutId": "string"
  }
}

Response:

{
  "data": {
    "markCommissionPayoutPaid": {
      "id": "id",
      "repName": "string",
      "status": "LOCKED",
      "createdAt": "2025-01-15T00:00:00Z",
      "commissionCount": 0,
      "paidAt": "2025-01-15T00:00:00Z"
    }
  }
}

markCommissionPayoutPaid(
  input: MarkPayoutPaidInput!
): CommissionPayout!

Arguments

markCommissionPayoutPaid.input ● MarkPayoutPaidInput! non-null input

The payout and an optional payment reference.

Type

CommissionPayout object

A payout settling a rep's commissions for a period.