Chilkat Online Tools

SQL Server / ORACLE Hospitality OPERA Cloud REST API Workflows / 18. Check-Out - postFolios (close folio)

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

    -- 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": 3,
    --     "hotelId": "{{HotelId}}",
    --     "eventType": "CheckOut",
    --     "folioWindowNo": 1,
    --     "correction": false,
    --     "debitFolio": false
    --   }
    -- }

    DECLARE @json int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'criteria.reservationId.idContext', 'OPERA'
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'criteria.reservationId.id', 123
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'criteria.reservationId.type', 'Reservation'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'criteria.profileId.idContext', 'OPERA'
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'criteria.profileId.id', 123
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'criteria.profileId.type', 'Profile'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'criteria.fiscalFolioInstruction', 'New'
    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'criteria.allFolioWindow', 0
    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'criteria.folioQueue.generateFiscalFolio', 0
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'criteria.cashierId', 3
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'criteria.hotelId', '{{HotelId}}'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'criteria.eventType', 'CheckOut'
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'criteria.folioWindowNo', 1
    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'criteria.correction', 0
    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'criteria.debitFolio', 0

    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'x-hotelid', '{{HotelId}}'
    -- Adds the "Authorization: Bearer <access_token>" header.
    EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'x-app-key', '{{AppKey}}'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://domain.com/csh/v0/hotels/{{HotelId}}/reservations/{{ReservationId}}/folios', 'application/json', @json
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @json
        RETURN
      END

    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    PRINT @iTmp0
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    PRINT @sTmp0
    EXEC @hr = sp_OADestroy @resp


    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @json


END
GO

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": 3,
        "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": "18. Check-Out - postFolios (close 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        \"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\": 3,\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": [
  ]
}