Chilkat Online Tools

Ruby / ORACLE Hospitality OPERA Cloud REST API Workflows / Add a charge to the folio

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# 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": {
#     "charges": {
#       "postingQuantity": 1,
#       "usePackageAllowance": false,
#       "price": {
#         "amount": 10,
#         "currencyCode": "USD"
#       },
#       "transactionCode": 1000,
#       "applyRoutingInstructions": false
#     },
#     "reservationId": {
#       "idContext": "OPERA",
#       "id": 123,
#       "type": "Reservation"
#     },
#     "cashierId": 5,
#     "hotelId": "{{HotelId}}",
#     "postIt": false
#   }
# }

json = Chilkat::CkJsonObject.new()
json.UpdateInt("criteria.charges.postingQuantity",1)
json.UpdateBool("criteria.charges.usePackageAllowance",false)
json.UpdateInt("criteria.charges.price.amount",10)
json.UpdateString("criteria.charges.price.currencyCode","USD")
json.UpdateInt("criteria.charges.transactionCode",1000)
json.UpdateBool("criteria.charges.applyRoutingInstructions",false)
json.UpdateString("criteria.reservationId.idContext","OPERA")
json.UpdateInt("criteria.reservationId.id",123)
json.UpdateString("criteria.reservationId.type","Reservation")
json.UpdateInt("criteria.cashierId",5)
json.UpdateString("criteria.hotelId","{{HotelId}}")
json.UpdateBool("criteria.postIt",false)

http.SetRequestHeader("Content-Type","application/json")
http.SetRequestHeader("x-hotelid","{{HotelId}}")
# Adds the "Authorization: Bearer <access_token>" header.
http.put_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}}/charges","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

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": {
        "charges": {
            "postingQuantity": 1,
            "usePackageAllowance": false,
            "price": {
                "amount": 10,
                "currencyCode": "USD"
            },
            "transactionCode": 1000,
            "applyRoutingInstructions": false
        },
        "reservationId": {
            "idContext": "OPERA",
            "id": {{ReservationId}},
            "type": "Reservation"
        },
        "cashierId": 5,
        "hotelId": "{{HotelId}}",
        "postIt": false
    }
}'
https://domain.com/csh/v0/hotels/{{HotelId}}/reservations/{{ReservationId}}/charges

Postman Collection Item JSON

{
  "name": "Add a charge to the folio ",
  "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        \"charges\": {\r\n            \"postingQuantity\": 1,\r\n            \"usePackageAllowance\": false,\r\n            \"price\": {\r\n                \"amount\": 10,\r\n                \"currencyCode\": \"USD\"\r\n            },\r\n            \"transactionCode\": 1000,\r\n            \"applyRoutingInstructions\": false\r\n        },\r\n        \"reservationId\": {\r\n            \"idContext\": \"OPERA\",\r\n            \"id\": {{ReservationId}},\r\n            \"type\": \"Reservation\"\r\n        },\r\n        \"cashierId\": 5,\r\n        \"hotelId\": \"{{HotelId}}\",\r\n        \"postIt\": false\r\n    }\r\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{HostName}}/csh/v0/hotels/{{HotelId}}/reservations/{{ReservationId}}/charges",
      "host": [
        "{{HostName}}"
      ],
      "path": [
        "csh",
        "v0",
        "hotels",
        "{{HotelId}}",
        "reservations",
        "{{ReservationId}}",
        "charges"
      ]
    }
  },
  "response": [
  ]
}