> ## Documentation Index
> Fetch the complete documentation index at: https://developer.hellgate.io/llms.txt
> Use this file to discover all available pages before exploring further.

# SettlementEvent

> Signals a settlement activity on a payment.

Sent by Commerce when a settlement activity occurs on a payment.

`ce-type: SettlementEvent`

## Payload

<ParamField body="account_id" type="string" required>
  UUID of the account.
</ParamField>

<ParamField body="settlement_item_id" type="string" required>
  UUID of the settlement item.
</ParamField>

<ParamField body="settlement_report_id" type="string" required>
  UUID of the settlement report this item belongs to.
</ParamField>

<ParamField body="payment_id" type="string">
  UUID of the related payment.
</ParamField>

<ParamField body="type" type="string" required>
  Type of settlement activity.

  Allowed values: `CHARGEBACK`, `COMMISSION`, `FEE`, `OTHER`, `PAYMENT`, `PAYOUT`, `REFUND`, `REJECT`
</ParamField>

<ParamField body="currency_code" type="string" required>
  ISO 4217 currency code.
</ParamField>

<ParamField body="date" type="string" required>
  Settlement date. Format: ISO 8601 date-time.
</ParamField>

<ParamField body="gross_credit_amount" type="number" required>
  Gross credit amount.
</ParamField>

<ParamField body="gross_debit_amount" type="number" required>
  Gross debit amount.
</ParamField>

<ParamField body="net_credit_amount" type="number" required>
  Net credit amount.
</ParamField>

<ParamField body="net_debit_amount" type="number" required>
  Net debit amount.
</ParamField>

<ParamField body="commission" type="number" required>
  Commission amount applied to this settlement item.
</ParamField>