NAV Navbar
shell

Cover PMS POS API

Get Token

curl --location --request POST "https://app.cover.is/api/public/v1/epos/1/token" \
  --form "username=username-from-pos-settings" \
  --form "password=password-from-pos-settings"

POST https://app.cover.is/api/public/v1/epos/1/token

Body

Get Available Rooms to Charge

curl --location --request GET "https://app.cover.is/api/public/v1/epos/1/room" \
  --header "x-auth-token: token-received-from-login"

GET https://app.cover.is/api/public/v1/epos/1/room

Get rooms that can be charged. You will see here currently checked_in rooms

Headers

Charge Room

curl --location --request POST "https://app.cover.is/api/public/v1/epos/1/room/41559/charge" \
  --header "x-auth-token: token-received-from-login" \
  --header "Content-Type: application/json" \
  --data "{
  \"id\":\"47383064\",
  \"receiptId\":\"47383064\",
  \"date\":\"2019-05-01T21:13:57.890Z\",
  \"amount\":11.2,
  \"details\": [
    {
      \"name\":\"Drambuie\",
      \"price\":6.3,
      \"amount\":2,
      \"productId\":1147027,
      \"vatPercentage\":23.0,
      \"productGroupName\":\"Liquors\",
      \"totalPriceWithoutVat\":5.12
    },
    {
      \"name\":\"Jameson\",
      \"price\":4.9,
      \"amount\":1,
      \"productId\":1147074,
      \"vatPercentage\":23.0,
      \"productGroupName\":\"Shorts\",
      \"totalPriceWithoutVat\":3.98
    }
  ],
  \"vatDetails\": [
    {
      \"vat\":2.1,
      \"name\":\"23.0%\",
      \"taxClass\":false,
      \"priceWithVat\":11.2,
      \"vatPercentage\":23.0,
      \"priceWithoutVat\":9.1
    }
  ],
  \"floorId\":18839,
  \"guestName\":\"Tom O'Morchoe\",
  \"waiterName\":\" \",
  \"paymentDetails\": [
    {
      \"tips\":0.0,
      \"type\":\"Add to Room\",
      \"amount\":11.2,
      \"paymentTypeTypeId\":9
    }
  ],
  \"liteserverReceiptId\":null
}"

POST https://app.cover.is/api/public/v1/epos/1/room/41559/charge

Charge room for specified amount

receiptId should be unique at least for that room. It can be used for Void operation

details array is optional.

If details is specified:

  1. all extras aggregated by productGroupName
  2. if there is mapped extra, it would be added to room.
  3. if there is no mapped extra, it would be created with vatPercentage tax and added to room

If details is not specified, all amount will go to 'Bar' extra

Headers

Void charge for room

curl --location --request DELETE "https://app.cover.is/api/public/v1/epos/1/room/41559/charge/47383064" \
  --header "x-auth-token: token-received-from-login" \
  --header "Content-Type: application/json"

DEL https://app.cover.is/api/public/v1/epos/1/room/41559/charge/47383064

Headers