CLcloudbeds
Adjustment

postAdjustment

Changed on

Adds an adjustment to a reservation

post/postAdjustment

Request

  • Base URL
    https://api.cloudbeds.com/api/v1.3
  • URL
    https://api.cloudbeds.com/api/v1.3/postAdjustment
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization code
      Scopes: write:adjustment

Request body application/x-www-form-urlencoded

propertyIDstring nullable

Property ID

reservationIDstring

Reservation identifier

type'rate' | 'product' | 'fee' | 'tax'

Apply Adjustment to

amountnumber

Adjustment amount

notesstring nullable

Adjustment notes

itemIDstring nullable

Apply Adjustment to. Identifier for: product, tax, fee. Not for rate

serviceDatestring date nullable

Adjustment service date in the property timezone, format YYYY-MM-DD. Must be within the reservation's check-in and check-out dates. When omitted, the current date and time are used. A past date requires permission to post adjustments for past dates; a future date creates an unposted transaction.

Response

200 Response

successboolean

Returns if the request could be completed

messagestring nullable

To be used in case any error occurs (if success = false). If success = true, it does not exist.

Changes