Link

On-the-room charge and payment postings

POS app fetches checked-in reservation of the guest and posts charges to the guest folio.

Search the room

To find the room where charges should be added, access the Booking API.

GET /booking/v1/reservations

There are a variety of filters and which ones you use depends on you. Most likely, you will want to limit the reservation to be in-house and then search for room number or guest name (full-text search). You might get more than one reservation as a response; you must pick the relevant reservation.

Search the folio

The Finance API lets you access folios, invoices, and the hotel’s sub-ledger. The first one you’ll need is:

GET /finance/v1/folios

Add the reservationId as a query parameter and type as Guest, and either get the main folio or use any custom logic to find the folio you want to add the charges or payments to.

You must get the first folio that contains AddCharge in allowedActions. If no such folio exists, then you’ll have to create a new folio.

POST /finance/v1/folios

Once you identified the folio to use, you can perform different actions. The most useful being:

POST /finance/v1/folio-actions/{folioId}/charges

Posting charges when the hotel owns the POS

When the POS is owned and operated by the hotel, you post the charge by using the following API endpoint:

POST /finance/v1/folio-actions/{folioId}/charges

Example

{
   "serviceType":"FoodAndBeverages",
   "vatType":"NormalCovid19",
   "subAccountId":"BER-BRKF",
   "name":"Breakfast",
   "amount":{
      "amount":23.0,
      "currency":"EUR"
   },
   "receipt":"BSPHEDWU-1-1"
}

Third-party POS

When the hotel does not own the POS outlet, and the guest wants to add the charge to the room, you post a single transitory charge with the correct amount, receipt, and name using the following API endpoint:

POST /finance/v1/folio-actions/{folioId}/transitory-charges

Transitory charges never have VAT. VAT is collected by the company that is offering the service, and it also needs to provide detailed receipts and invoices to the guests. The value of receipt should be the receipt or bon number from the POS. You must post the charge to the current or previous business date. You cannot add charges to future dates.

Example

{
   "name":"FlowersAndYou",
   "amount":{
      "amount":13.0,
      "currency":"EUR"
   },
   "receipt":"R23412"
}

You can also refund a transitory charge if there was some error. For example, if you posted 50 euros transitory charge for an excursion, and you want to delete it, add the same charge but insert -50.

Post payments

The payment of the charges can be settled through interim billing or during the check-out at the front desk.