Checks

Void a check

Marks a check as void so it is no longer treated as payable, optionally recording why. The check record and its accounting transaction are kept; only the voided flag changes. Voiding a check that is already void succeeds and changes nothing.

DELETE

https://api.portal.magicdoor.com/company-app/checks/{checkId}/void

Authorization

Authorizationstringrequired

Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Path parameters

checkIdstringrequired

The check to void. A Snowflake id sent as a decimal string.

example: 1830472847398404096

Body

application/json

A body is required, but every property in it is optional.

voidReasonstring

Why the check is being voided. Stored on the check and returned as voidReason. At most 900 characters.

Response

204 · The check is void. No body is returned.

401 · The access token is missing, expired, or does not belong to a property manager.

404 · No check with that id exists for the caller's company.

Request

curl --request DELETE \
  --url 'https://api.portal.magicdoor.com/company-app/checks/1830472847398404096/void' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "voidReason": "Printed on the wrong stock"
}'

Body

{
  "voidReason": "Printed on the wrong stock"
}