APapaleo
NoShowPolicy

Get all no-show policies.

Get the list of no-show policies.<br>You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'.<br>For fine-grained clients, you must have this permission: 'core.no_show_policies.read'.

get/rateplan/v1/no-show-policies

Request

  • Base URL
    https://api.apaleo.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.apaleo.com/rateplan/v1/no-show-policies
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: settings.read, setup.read, setup.manage, admin

Query parameters

propertyIdstring

Filter no-show policies by the specified property

pageNumberinteger

Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.

pageSizeinteger

Items per page. Default: 500. Maximum: 500.

Response

Success.

countinteger required

Total count of items

Example response

{
  "noShowPolicies": [
    {
      "id": "MUC-FLEX",
      "code": "FLEX",
      "name": "No-Show Fee",
      "description": "100 Euro of the accommodation fees, for the complete stay. Reduced VAT applies.",
      "propertyId": "MUC",
      "fee": {
        "vatType": "Reduced",
        "fixedValue": {
          "amount": 100,
          "currency": "EUR"
        }
      }
    },
    {
      "id": "BER-NONREF",
      "code": "NONREF",
      "name": "No-Show Fee",
      "description": "100% of the accommodation fees, for the complete stay. Reduced VAT applies.",
      "propertyId": "BER",
      "fee": {
        "vatType": "Reduced",
        "percentValue": {
          "percent": 100,
          "limit": 1,
          "includeServiceIds": [
            "MUC-BRK"
          ]
        }
      }
    }
  ],
  "count": 2
}

Changes

No recorded changes to this operation across all 5 revisions of this API.