Chilkat Online Tools

Python / ORACLE Hospitality OPERA Cloud REST API Workflows / Post a Folio, required before checking out a guest

Back to Collection Items

import sys
import chilkat2

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = chilkat2.Http()

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "criteria": {
#     "reservationId": {
#       "idContext": "OPERA",
#       "id": 123,
#       "type": "Reservation"
#     },
#     "profileId": {
#       "idContext": "OPERA",
#       "id": 123,
#       "type": "Profile"
#     },
#     "fiscalFolioInstruction": "New",
#     "allFolioWindow": false,
#     "folioQueue": {
#       "generateFiscalFolio": false
#     },
#     "cashierId": 4,
#     "hotelId": "{{HotelId}}",
#     "eventType": "CheckOut",
#     "folioWindowNo": 1,
#     "correction": false,
#     "debitFolio": false
#   }
# }

json = chilkat2.JsonObject()
json.UpdateString("criteria.reservationId.idContext","OPERA")
json.UpdateInt("criteria.reservationId.id",123)
json.UpdateString("criteria.reservationId.type","Reservation")
json.UpdateString("criteria.profileId.idContext","OPERA")
json.UpdateInt("criteria.profileId.id",123)
json.UpdateString("criteria.profileId.type","Profile")
json.UpdateString("criteria.fiscalFolioInstruction","New")
json.UpdateBool("criteria.allFolioWindow",False)
json.UpdateBool("criteria.folioQueue.generateFiscalFolio",False)
json.UpdateInt("criteria.cashierId",4)
json.UpdateString("criteria.hotelId","{{HotelId}}")
json.UpdateString("criteria.eventType","CheckOut")
json.UpdateInt("criteria.folioWindowNo",1)
json.UpdateBool("criteria.correction",False)
json.UpdateBool("criteria.debitFolio",False)

http.SetRequestHeader("Content-Type","application/json")
http.SetRequestHeader("x-hotelid","{{HotelId}}")
# Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
http.SetRequestHeader("x-app-key","{{AppKey}}")

# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/csh/v0/hotels/{{HotelId}}/reservations/{{ReservationId}}/folios","application/json",json)
if (http.LastMethodSuccess == False):
    print(http.LastErrorText)
    sys.exit()

print(str(resp.StatusCode))
print(resp.BodyStr)

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-H "x-hotelid: {{HotelId}}"
	-H "x-app-key: {{AppKey}}"
	-d '{
    "criteria": {
        "reservationId": {
            "idContext": "OPERA",
            "id": {{ReservationId}},
            "type": "Reservation"
        },
        "profileId": {
            "idContext": "OPERA",
            "id": {{ProfileId}},
            "type": "Profile"
        },
        "fiscalFolioInstruction": "New",
        "allFolioWindow": false,
        "folioQueue": {
            "generateFiscalFolio": false
        },
        "cashierId": 4,
        "hotelId": "{{HotelId}}",
        "eventType": "CheckOut",
        "folioWindowNo": 1,
        "correction": false,
        "debitFolio": false
    }
}'
https://domain.com/csh/v0/hotels/{{HotelId}}/reservations/{{ReservationId}}/folios

Postman Collection Item JSON

{
  "name": "Post a Folio, required before checking out a guest",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{Token}}",
          "type": "string"
        }
      ]
    },
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "type": "text",
        "value": "application/json"
      },
      {
        "key": "x-hotelid",
        "type": "text",
        "value": "{{HotelId}}"
      },
      {
        "key": "x-app-key",
        "value": "{{AppKey}}",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\r\n    \"criteria\": {\r\n        \"reservationId\": {\r\n            \"idContext\": \"OPERA\",\r\n            \"id\": {{ReservationId}},\r\n            \"type\": \"Reservation\"\r\n        },\r\n        \"profileId\": {\r\n            \"idContext\": \"OPERA\",\r\n            \"id\": {{ProfileId}},\r\n            \"type\": \"Profile\"\r\n        },\r\n        \"fiscalFolioInstruction\": \"New\",\r\n        \"allFolioWindow\": false,\r\n        \"folioQueue\": {\r\n            \"generateFiscalFolio\": false\r\n        },\r\n        \"cashierId\": 4,\r\n        \"hotelId\": \"{{HotelId}}\",\r\n        \"eventType\": \"CheckOut\",\r\n        \"folioWindowNo\": 1,\r\n        \"correction\": false,\r\n        \"debitFolio\": false\r\n    }\r\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{HostName}}/csh/v0/hotels/{{HotelId}}/reservations/{{ReservationId}}/folios",
      "host": [
        "{{HostName}}"
      ],
      "path": [
        "csh",
        "v0",
        "hotels",
        "{{HotelId}}",
        "reservations",
        "{{ReservationId}}",
        "folios"
      ],
      "query": [
        {
          "key": null,
          "value": "",
          "disabled": true
        }
      ]
    }
  },
  "response": [
  ]
}