Booking Notification Body

Hurray, you got a booking!

In the booking notification, you will find the following parameters, fields marked as required will always be present, and other fields may only be present if applicable to the specific booking.

ParameterTypeRequiredUsage
providerApartmentIdStringYesThe id of the apartment in your system
providerStringYesThe provider identifier at Holidu
arrivalLocalDate:
YYYY-MM-DD
YesThe arrival date of the guests
departureLocalDate:
YYYY-MM-DD
YesThe departure date of the guests
guestsArray of objectsYesList of guests' ages
guest.ageIntegerYesAge of the guest
customerObjectYesGuest's personal information
customer.genderStringYesGender
customer.firstNameStringYesFirst name
customer.lastNameStringYesLast name
customer.streetStringYesStreet name
customer.zipStringYesZIP code
customer.city StringYesCity of the guest
customer.countryStringYesCountry of the guest
customer.languageStringYesThe language that the guest speaks
customer.phoneStringYesPhone number of the guest
customer.emailStringYesEmail address of the guest
specialCustomerRequestStringThe special requests of the guest during the booking
guestReceiptObjectYesBreakdown of all the amounts paid or to be paid by the guest
guestReceipt.bareRentalPriceObjectYesPrice based on LOS or rates without extra costs
guestReceipt.bareRentalPrice.amountNumberYesPrice of the property
guestReceipt.bareRentalPrice.currencyStringYesCurrency used
guestReceipt.discountobjectDiscount object as defined through the discount endpoint
guestReceipt.discount.discountNameStringName of the used discount
guestReceipt.discount.discountPercentNumberPercentage of the discount
guestReceipt.discount.discountAmountobjectThe amount discounted calculated based on the base price of the property
guestReceipt.discount.discountAmount.amountNumberAmount
guestReceipt.discount.discountAmount.currencyStringCurrency
guestReceipt.costsarray of objectsObjects that were pushed in the extra cost endpoint and applied to the booking
guestReceipt.costs.idStringUnique id for every extra cost on your system, same as you pushed
guestReceipt.costs.nameStringName of the extra cost ( from Holidu's list )
guestReceipt.costs.basisOfCalculationStringDefining how the extra cost is calculated
guestReceipt.costs.paymentTimeStringPayment time of the extra cost
guestReceipt.costs.pricePerUnitObjectThe price of one unit
guestReceipt.costs.typeStringDefining if the extra cost is MANDATORY, SELECTABLE or ON_USAGEas explained in the extra costs API
guestReceipt.costs.pricePerUnit.amountNumberAmount
guestReceipt.costs.pricePerUnit.currencyStringCurrency
guestReceipt.costs.unitsSelectedIntegerNumber of units selected
guestReceipt.costs.totalPriceObjectThe total price of all the units selected
guestReceipt.costs.totalPrice.amountNumberAmount
guestReceipt.costs.totalPrice.currencyStringCurrency
guestReceipt.depositsArrayNO
guestReceipt.deposits.nameStringREFUNDABLE_SECURITY_DEPOSIT
guestReceipt.deposits.priceObject
guestReceipt.deposits.price.amountNumberCost of deposit
guestReceipt.deposits.price.currencyStringCurrency
guestReceipt.deposits.paymentTimeStringONSITE
paymentProcessingObjectYesJSON object describing payment handling/processing
paymentProcessing.paymentWithBookingObjectYesJSON object describing payment handling of costs with the booking
paymentProcessing.paymentWithBooking. paymentHandlerStringYesThe entity which is handling the payment. HOLIDU or PARTNER
paymentProcessing.paymentWithBooking. paymentMethodStringYesPayment method used
paymentProcessing.paymentWithBooking. creditCardDataObjectOnly present in case of PCI integration with Holidu
paymentProcessing.paymentWithBooking. paymentTotalWithBookingObjectYesJSON object describing the total amount which needs to be paid
paymentProcessing.paymentWithBooking. paymentTotalWithBooking.amountNumberYesThe total cost of the booking
paymentProcessing.paymentWithBooking. paymentTotalWithBooking.currencyStringYesThe currency used
paymentProcessing.paymentWithBooking. paymentRatesArrayYesJSON array describing the payment setup of the booking
paymentProcessing.paymentWithBooking. paymentRates.valueObjectYesJSON object describing the amounts
paymentProcessing.paymentWithBooking. paymentRates.value.amountNumberYesThe amount which needs to be paid
paymentProcessing.paymentWithBooking. paymentRates.value.currencyStringYesThe currency used
paymentProcessing.paymentWithBooking. paymentRates.dueDateLocalDate:
YYYY-MM-DD
YesThe due date of the payment described above
paymentProcessing.paymentOnsiteArray of objectsYes
paymentProcessing.paymentOnsite. paymentOnsite.amountNumberTotal amount which needs to be paid on site
paymentProcessing.paymentOnsite. paymentOnsite.currencyStringThe currency
{
  "providerApartmentId": "externalApartmentID",
  "provider:":"XXX"
  "arrival": "2022-04-29",
  "departure": "2022-05-04",
  "guests": [
    {
      "age": 25
    },
    {
      "age": 25
    },
    {
      "age": 25
    },
    {
      "age": 12
    },
    {
      "age": 8
    }
  ],
  "customer": {
    "gender": "MALE",
    "firstName": "First Name",
    "lastName": "Last Name",
    "street": "Street and number",
    "zip": "Zip code",
    "city": "City",
    "country": "Iso country code",
    "language": "Language of the customer",
    "phone": "phone number of customer",
    "email": "email of cusomter"
  },
  "specialCustomerRequest": "special request of the guest during booking",
  "guestReceipt": {
    "bareRentalPrice": {
      "amount": 705.88,
      "currency": "EUR"
    },
    "discount": {
      "discountName": "LastMinute",
      "discountPercent": 10,
      "discountAmount": {
        "amount": 70.51,
        "currency": "EUR"
      }
    },
    "costs": [
      {
        "id": "46323572_781803181",
        "name": "CLEANING",
        "basisOfCalculation": "PER_STAY",
        "paymentTime": "WITH_RATES",
        "type": "MANDATORY",
        "pricePerUnit": {
          "amount": 60.00,
          "currency": "EUR"
        },
        "unitsSelected": 1,
        "totalPrice": {
          "amount": 60.00,
          "currency": "EUR"
        }
      },
      {
        "id": "46323572_781803181",
        "name": "PET",
        "basisOfCalculation": "PER_PET",
        "paymentTime": "WITH_RATES",
        "type": "SELECTABLE",
        "pricePerUnit": {
          "amount": 20.00,
          "currency": "EUR"
        },
        "unitsSelected": 2,
        "totalPrice": {
          "amount": 40.00,
          "currency": "EUR"
        }
      },
      {
        "id": "46323572_781803181",
        "name": "BEDLINEN",
        "basisOfCalculation": "PER_UNIT",
        "paymentTime": "ONSITE",
        "type": "ON_USAGE",
        "pricePerUnit": {
          "amount": 10.00,
          "currency": "EUR"
        },
        "unitsSelected": null,
        "totalPrice": {
          "amount": 0.00,
          "currency": "EUR"
        }
      },
      {
        "id": "46323572_781803181",
        "name": "PARKING",
        "basisOfCalculation": "PER_STAY",
        "paymentTime": "ONSITE",
        "type": "SELECTABLE",
        "pricePerUnit": {
          "amount": 50.00,
          "currency": "DKK"
        },
        "unitsSelected": 1,
        "totalPrice": {
          "amount": 50.00,
          "currency": "DKK"
        }
      },
      {
        "id": "243234234",
        "name": "TOURIST_OR_CITY_TAX",
        "basisOfCalculation": "PER_STAY",
        "paymentTime": "WITH_RATES",
        "type": "MANDATORY",
        "pricePerUnit": {
          "amount": 50.00,
          "currency": "EUR"
        },
        "unitsSelected": 1,
        "totalPrice": {
          "amount": 50.00,
          "currency": "EUR"
        }
      }
    ],
    "deposits":[
    {
    "name":"REFUNDABLE_SECURITY_DEPOSIT",
    "price":{
    "amount":700.00,
    "currency":"EUR"},
  "paymentTime":"ONSITE"
}
]
  },
  "paymentProcessing": {
    "paymentWithBooking": {
      "paymentHandler": "PARTNER", // HOLIDU
      "paymentMethod": "CREDIT_CARD",
      "creditCardData": { // only present in booking notification with PCI

      },
      "paymentTotalWithBooking": {
        "amount": 785.37,
        "currency": "EUR"
      },
      "paymentRates": [
        {
          "value": {
            "amount": 628.30,
            "currency": "EUR"
          },
          "dueDate": "2022-01-31"
        },
        {
          "value": {
            "amount": 157.07,
            "currency": "EUR"
          },
          "dueDate": "2022-03-25"
        }
      ]
    },
    "paymentOnsite": [
      {
        "amount": 50.00,
        "currency": "DKK"
      }
    ]
  }
}