Preview how a folio adjustment (tax/fee/rate/room-revenue) would affect Smart Policy scheduled payments.

post/smart-policies/v1/payments/preview-adjustment

Request

Base URL
https://api.cloudbeds.com
URL
https://api.cloudbeds.com/smart-policies/v1/payments/preview-adjustment
Auth
OAuth 2
Authorization code: https://api.cloudbeds.com/auth/oauth/authorize
Token URL: https://api.cloudbeds.com/auth/oauth/token scopes: read:rate

Headers

x-property-idstring required

Example:1,2,3

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

Request body

reservationIdstring required

Reservation ID to preview the adjustment for.

Example request

{
  "reservationId": "12345",
  "adjustment": {
    "token": "tax_42",
    "amount": {
      "amount": "500",
      "currencyCode": "EUR"
    },
    "bookingRoomId": "555",
    "rateSourceId": "777"
  }
}

Response

Adjustment preview result.

resultType'SCHEDULED_PAYMENT_REDUCED' | 'SCHEDULED_PAYMENT_CANCELLED' | 'REFUND_REQUIRED' | 'NO_SCHEDULE_CHANGE' | 'NO_SMART_POLICY'

The outcome of the adjustment preview.

Example response

{
  "resultType": "SCHEDULED_PAYMENT_REDUCED",
  "newReservationTotal": {
    "amount": "12439",
    "currencyCode": "USD"
  },
  "alreadyPaid": {
    "amount": "12439",
    "currencyCode": "USD"
  },
  "refundRequired": {
    "amount": "12439",
    "currencyCode": "USD"
  },
  "scheduledPayments": [
    {
      "id": "1001",
      "originalAmount": {
        "amount": "12439",
        "currencyCode": "USD"
      },
      "newAmount": {
        "amount": "12439",
        "currencyCode": "USD"
      },
      "status": "REDUCED"
    }
  ]
}

Changes

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