Checks

Delete a check

Removes a check record. By default the accounting transaction the check paid is deleted with it; send deleteTransactions: false to keep the transaction and remove only the check.

DELETE

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

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 delete. A Snowflake id sent as a decimal string.

example: 1830472847398404096

Body

application/json

The body may be omitted entirely, in which case the transaction is deleted along with the check.

deleteTransactionsboolean

Whether to also delete the accounting transaction named by the check's transactionId. false deletes only the check and leaves the money movement recorded.

default: true

Response

204 · The check was deleted. 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' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "deleteTransactions": false
}'

Body

{
  "deleteTransactions": false
}