CLcloudbeds
Gratuities

Void a posted gratuity by its gratuityId

Voids a single gratuity (as returned at post time) — reverses its tip line and its tax children on both CDC and DOMAIN. Idempotent: voiding an already-voided gratuity returns 204. The gratuityId is not re-issued after void.

delete/folio/v1/gratuities/{gratuityId}

Request

  • Base URL
    https://api.cloudbeds.com
  • URL
    https://api.cloudbeds.com/folio/v1/gratuities/{gratuityId}
  • 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

gratuityIdstring required

The public gratuityId of the gratuity to void, as returned at post time.

Headers

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

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

Response

Gratuity voided (or already voided — idempotent).

unknown required

Changes

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