Chilkat Online Tools

PowerBuilder / ORACLE Hospitality OPERA Cloud REST API Workflows / Get the reservation folio

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp

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

loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

loo_QueryParams = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat.JsonObject")

loo_QueryParams.UpdateInt("folioWindowNo",1)
loo_QueryParams.UpdateString("reservationBalanceOnly","false")
loo_QueryParams.UpdateString("fetchInstructions","Payment")
loo_QueryParams.UpdateString("fetchInstructions","Postings")
loo_QueryParams.UpdateString("fetchInstructions","Transactioncodes")
loo_QueryParams.UpdateString("fetchInstructions","Totalbalance")

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

loo_Resp = loo_Http.QuickRequestParams("GET","https://domain.com/csh/v0/hotels/{{HotelId}}/reservations/{{ReservationId}}/folios",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_QueryParams
    return
end if

Write-Debug string(loo_Resp.StatusCode)
Write-Debug loo_Resp.BodyStr
destroy loo_Resp


destroy loo_Http
destroy loo_QueryParams

Curl Command

curl -G -d "folioWindowNo=1"
	-d "reservationBalanceOnly=false"
	-d "fetchInstructions=Payment"
	-d "fetchInstructions=Postings"
	-d "fetchInstructions=Transactioncodes"
	-d "fetchInstructions=Totalbalance"
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-H "x-hotelid: {{HotelId}}"
	-H "x-app-key: {{AppKey}}"
https://domain.com/csh/v0/hotels/{{HotelId}}/reservations/{{ReservationId}}/folios

Postman Collection Item JSON

{
  "name": "Get the reservation folio",
  "protocolProfileBehavior": {
    "disableBodyPruning": true
  },
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{Token}}",
          "type": "string"
        }
      ]
    },
    "method": "GET",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "type": "text",
        "value": "application/json"
      },
      {
        "key": "x-hotelid",
        "value": "{{HotelId}}",
        "type": "text"
      },
      {
        "key": "x-app-key",
        "value": "{{AppKey}}",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{HostName}}/csh/v0/hotels/{{HotelId}}/reservations/{{ReservationId}}/folios?folioWindowNo=1&reservationBalanceOnly=false&fetchInstructions=Payment&fetchInstructions=Postings&fetchInstructions=Transactioncodes&fetchInstructions=Totalbalance",
      "host": [
        "{{HostName}}"
      ],
      "path": [
        "csh",
        "v0",
        "hotels",
        "{{HotelId}}",
        "reservations",
        "{{ReservationId}}",
        "folios"
      ],
      "query": [
        {
          "key": "folioWindowNo",
          "value": "1"
        },
        {
          "key": "includeFolioHistory",
          "value": "false",
          "disabled": true
        },
        {
          "key": "guestPayOnly",
          "value": "Y",
          "disabled": true
        },
        {
          "key": "reservationBalanceOnly",
          "value": "false"
        },
        {
          "key": "fetchInstructions",
          "value": "Account",
          "disabled": true
        },
        {
          "key": "fetchInstructions",
          "value": "Payee",
          "disabled": true
        },
        {
          "key": "fetchInstructions",
          "value": "Windowbalances",
          "disabled": true
        },
        {
          "key": "fetchInstructions",
          "value": "Payment"
        },
        {
          "key": "fetchInstructions",
          "value": "Postings"
        },
        {
          "key": "fetchInstructions",
          "value": "Transactioncodes"
        },
        {
          "key": "fetchInstructions",
          "value": "Totalbalance"
        },
        {
          "key": "fetchInstructions",
          "value": "Reservation",
          "disabled": true
        }
      ]
    }
  },
  "response": [
  ]
}