Void a dividend and reverse its journal entries

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

Voids a dividend and reverses its journals. Voiding never alters or deletes the original entries: it posts new reversing journals, one for the declaration and, where the dividend was paid, a second for the payment, each carrying the void reason. The reversals are dated the server date, so they fall in the current period rather than the original one. The dividend then moves to the voided state. A dividend that is already voided cannot be voided again.

The board resolution's allocation is not returned by voiding: the voided amount remains drawn down against the resolution.

Path parameters

idstringrequired

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

Body parameters

reasonstringoptional

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

min length: 1 · max length: 500

Response

200Dividend voided. Reversing journal entries created.

Show response fields

amountPenceinteger

idstring

statusstring

Error codes

400Dividend is already voided.

404Dividend not found.

409No accounting period set for this limited company.

RequestPOST/v1/dividends/{id}/voidcurl

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

Response200

{
  "success": true,
  "data": {
    "id": "div_4",
    "status": "voided",
    "amountPence": 800000
  }
}