CLcloudbeds
Checks

Void a posted check end-to-end (ledger + payments + its gratuities) by its checkId

Voids the whole check: reverses each line (item / service charge / discount) and its tax/fee children on both CDC and DOMAIN, cascade-voids every gratuity linked to the check (each with its own tax children), and voids the anchored payments via the payments service. Idempotent — voiding an already-voided check returns 204.

delete/folio/v1/checks/{checkId}

Request

  • Base URL
    https://api.cloudbeds.com
  • URL
    https://api.cloudbeds.com/folio/v1/checks/{checkId}
  • Auth
    OAuth 2
    Authorization code: https://api.cloudbeds.com/auth/oauth/authorize
    Token URL: https://api.cloudbeds.com/auth/oauth/token scopes: write:item

Path parameters

checkIdstring required

The check's public checkId (partner-supplied or Cloudbeds-generated) returned by createCheck.

Headers

x-property-idstring required
Example:1,2,3

A numeric, comma-separated string representing the property IDs, sent in the header.

Response

Check voided (or already voided — idempotent).

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.