Void a dividend and reverse its journal entries

POST https://app.speybooks.com/api/v1/dividends/{id}/void

Voids a dividend and reverses all associated journal entries (both the declaration and payment journals if paid). The dividend status changes to voided. This action is irreversible.

Path parameters

id string required

Dividend ID (e.g. div_1). Must use the dividend prefix.

Body parameters

reason string optional

Reason for voiding (max 500 characters). Recorded in the reversal journal metadata.

min length: 1 · max length: 500

Response

200 Dividend voided. Reversing journal entries created.

Show response fields

voided boolean

Error codes

400 Dividend is already voided.

404 Dividend not found.

Request POST /v1/dividends/{id}/void curl

curl -X POST https://api.speybooks.com/v1/dividends/div_5/void \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{ "reason": "Incorrect amount" }'

Response 200

{
  "success": true,
  "data": {
    "voided": true
  }
}