Chilkat Online Tools

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

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; 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": 5,
    ;         "currencyCode": "USD"
    ;       },
    ;       "transactionCode": 4510,
    ;       "applyRoutingInstructions": false
    ;     },
    ;     "reservationId": {
    ;       "idContext": "OPERA",
    ;       "id": 123,
    ;       "type": "Reservation"
    ;     },
    ;     "cashierId": 4,
    ;     "hotelId": "{{HotelId}}",
    ;     "postIt": false
    ;   }
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateInt(json,"criteria.charges.postingQuantity",1)
    CkJsonObject::ckUpdateBool(json,"criteria.charges.usePackageAllowance",0)
    CkJsonObject::ckUpdateInt(json,"criteria.charges.price.amount",5)
    CkJsonObject::ckUpdateString(json,"criteria.charges.price.currencyCode","USD")
    CkJsonObject::ckUpdateInt(json,"criteria.charges.transactionCode",4510)
    CkJsonObject::ckUpdateBool(json,"criteria.charges.applyRoutingInstructions",0)
    CkJsonObject::ckUpdateString(json,"criteria.reservationId.idContext","OPERA")
    CkJsonObject::ckUpdateInt(json,"criteria.reservationId.id",123)
    CkJsonObject::ckUpdateString(json,"criteria.reservationId.type","Reservation")
    CkJsonObject::ckUpdateInt(json,"criteria.cashierId",4)
    CkJsonObject::ckUpdateString(json,"criteria.hotelId","{{HotelId}}")
    CkJsonObject::ckUpdateBool(json,"criteria.postIt",0)

    CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
    CkHttp::ckSetRequestHeader(http,"x-hotelid","{{HotelId}}")
    ; Adds the "Authorization: Bearer <access_token>" header.
    CkHttp::setCkAuthToken(http, "<access_token>")
    CkHttp::ckSetRequestHeader(http,"x-app-key","{{AppKey}}")

    resp.i = CkHttp::ckPostJson3(http,"https://domain.com/csh/v0/hotels/{{HotelId}}/reservations/{{ReservationId}}/charges","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure

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": 5,
                "currencyCode": "USD"
            },
            "transactionCode": 4510,
            "applyRoutingInstructions": false
        },
        "reservationId": {
            "idContext": "OPERA",
            "id": {{ReservationId}},
            "type": "Reservation"
        },
        "cashierId": 4,
        "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",
        "type": "text",
        "value": "{{AppKey}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\r\n    \"criteria\": {\r\n        \"charges\": {\r\n            \"postingQuantity\": 1,\r\n            \"usePackageAllowance\": false,\r\n            \"price\": {\r\n                \"amount\": 5,\r\n                \"currencyCode\": \"USD\"\r\n            },\r\n            \"transactionCode\": 4510,\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\": 4,\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": [
  ]
}