The tips are part of the restaurant bill settle and hence they should be transferred to the customers folio to be payed latter on. Please check the example how that can be done.
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Discounts are frequently provided to the guests. They can be transfer in the following ways according to the customer's reporting needs probably you can let the user to chose which one to use:
\n- \n
- Transfer the discounted prices of the items - No discount charge is required; \n
- Transfer the total discount value with revenue category 'discount' - One charge per bill per VAT group are needed; \n
- Transfer the discounts separately for every item group / revenue category - Separate charge for each item group / revenue category and VAT group is needed; \n
Occasionally the transfer charges have to be voided or refunded. When that is necessary we advise you to handle the void / refund by transferring charge with positive price and negative qty matching the void / refund. This approach will work perfectly even if the folio to which the charges were transferred is closed.
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"The following hints will help you to design the interface in way which will ensure its efficiency and usability for the users.
\n","event":[{"listen":"prerequest","script":{"id":"98539fa4-ebac-4d6e-a87a-7811d4006fab","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"24c9ef6d-4331-4092-b91d-a0ddd8d4c20a","type":"text/javascript","exec":[""]}}],"_postman_id":"98024b42-cf76-42a2-be6d-071ac92dda62","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Find checked_in bookings with period including today's date.\nUsing:
\n- \n
- Room - Specify the room name/number to find the bookings checked in into them; \n
- Guest name, phone or e-mail address - Please note you can search only by the name, phone, e-mail of the main guest of the booking; \n
- Identity tag - Identity tags may be added to the bookings for easier booking identification. However, the identity tags are optional. \n
Please note the response may contain more than one bookings and you would let the user to select which one to use!
\nIf additional booking details are required for precise guests identification you can use bookings endpoint in order to fetch them using the id of the booking
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Search by guest name, phone or e-mail address*
\n","type":"text/plain"},"key":"main_guest_free_text_search","value":"taylor"},{"disabled":true,"description":{"content":"Search by booking identity tag*
\n","type":"text/plain"},"key":"identity_tag","value":"123"},{"disabled":true,"description":{"content":"The parameters are alternative (OR) ones, when combined the response will contain all checd_in bookings matchin some of the parameters!!!
\n","type":"text/plain"},"key":"*","value":"IMPORTANT"},{"key":"room_name","value":"130"}],"variable":[]}},"response":[{"id":"e5b8b8f0-3b33-4009-a029-21a334fac73f","name":"2.1. Find Booking","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://sky-eu1.clock-software.com/pms_api/80226/11919/bookings/find_in_hotel?main_guest_free_text_search=smith&room_name=130","protocol":"https","host":["sky-eu1","clock-software","com"],"path":["pms_api","80226","11919","bookings","find_in_hotel"],"query":[{"key":"main_guest_free_text_search","value":"smith"},{"key":"identity_tag","value":"100","disabled":true},{"key":"room_name","value":"130"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 13 Jul 2021 09:01:14 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self'"},{"key":"X-Frame-Options","value":"sameorigin"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Fri, 01 Jan 1990 00:00:00 GMT"},{"key":"Set-Cookie","value":"app_config=BAhJIg17IjEiOnt9fQY6BkVU--7ee9a9c3f24b6ede332fbbb13201a7ab8d6584e1; path=/; expires=Sat, 13 Jul 2041 09:01:14 -0000; HttpOnly"},{"key":"Set-Cookie","value":"_session_id=LzZuaE4vVmMwdWtJV3JycWpXQmZ1ZExYeUkwUmh5Q1l0a3pDS0RIL1JZWm5Pb0tEMWNVdmwyTVFrWngxSUQ1djZWY2QxL1N6cjNxMmtmdXRTM05YOVZKbmhWTFRtQnlyQitOMTZ5N3ZETnEzcUIrUmJ0TmhLUlM0RUlaYlN5dWkvd0diSjRZM3BzVnN4R3UvWXE1dTdFRGx2cFIyYUxxcFYxOUVuNGo0dDZFPS0tdVl2cjdqSnR2aUJkb3piY1Nla0J5QT09--881300e65c33ec3ef655d9eb41d2b3adaf9f5680; path=/; HttpOnly; SameSite=Strict"},{"key":"Set-Cookie","value":"_session_id_x=UVZqZlZrWGtsOWtRcHltN24wTjhucHlBbVh3bERjT1ZXbjJVZjV0RVA2b0V4K2o5Z3plZGxZd2w1eVNBZ0VIeS0tOUpRS25NWm1hdnU4RFRqbHRLTTQ1UT09--9337fb19056094f1bb0a69f8f71a35c6aeeefe17; path=/; expires=Tue, 13 Jul 2021 21:01:14 -0000; HttpOnly; SameSite=Strict"},{"key":"X-Request-Id","value":"d94a2cfe-6278-482b-9340-0c028ef4f523"},{"key":"X-Runtime","value":"0.579113"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"\t{\n\t\t\"id\": 188,\n\t\t\"number\": \"12187\",\n\t\t\"arrival\": \"2021-07-13\",\n\t\t\"departure\": \"2021-07-16\",\n\t\t\"room_number\": \"130\",\n\t\t\"room_type\": \"APP\",\n\t\t\"accept_charges\": true,\n\t\t\"guest_title\": \"Mr.\",\n\t\t\"guest_first_name\": \"Oscar\",\n\t\t\"guest_last_name\": \"Moore\",\n\t\t\"guest_phone_number\": \"+2555666666\",\n\t\t\"guest_e_mail\": \"o.moore@gmail.com\"\n\t},\n\t{\n\t\t\"id\": 214,\n\t\t\"number\": \"12189\",\n\t\t\"arrival\": \"2021-07-12\",\n\t\t\"departure\": \"2021-07-18\",\n\t\t\"room_number\": \"101\",\n\t\t\"room_type\": \"DBL\",\n\t\t\"accept_charges\": false,\n\t\t\"guest_title\": \"Mr.\",\n\t\t\"guest_first_name\": \"John\",\n\t\t\"guest_last_name\": \"Smith\",\n\t\t\"guest_phone_number\": \"+2555800000\",\n\t\t\"guest_e_mail\": \"john.s@gmail.com\"\n\t}\n]"}],"_postman_id":"be0b6c3c-ecbe-4fe0-85ef-f40a6a93f4b5"},{"name":"2.2. Booking - allocate folio","id":"02a0f17d-f521-4339-b293-7265ab4e6753","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sky-eu1.clock-software.com/pms_api/80226/11919/bookings/25334365/folios/default","description":"The booking ID is found using 2.1 or 2.2 and now the defoult booing folio shoud be allocated.\nUse defoult_booking_folio to get a single open, valid folio suitable for charging
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Use the charge - BULK CREATE endpoint to create all charges at once with the details you already have in the charge template mapping
\nPlease use \"charge_template_id\" from the created mapping (1.1. Charge template mappings) in your request together with the \"service_date\". However, the parameters configured in the charge template can still be overridden. For example, if \"text\": \"Test charge\" is included, it will override the \"text\" value configured in the charge template.
\nPlease note: If some of the required parameters for charge creation are not configured in the used charge template, an error will be returned. The required parameters are:
\n- \n
\"revenue_group\"
\n \n\"price\"
\n \n\"text\"
\n \n
PLEASE NOTE: charge - BULK CREATE endpoint supports up to 100 charges to be created at once if you need to create more than 100 charges you will need to separate them in different calls. If you try to create more than 100 charges you will receive
\n \"error\": \"Charges exceeds the limit!\"\n\nFor invoicing purposes in Clock, you can also use the field \"print_text\" when sending the charges in order to add the bill number to it. This way, the hotel team will have the option to group the charges from 1 bill in the invoice generated in Clock. The idea is to not have a multi-page invoice if there are a lot of charges transfered to the hotel invoice.
By having the item name in the filed \"text\" and the bill number in the field \"print_text\", the hotel team will have the option to provide a detailed or a summarised invoice.
Transfer charges (restaurant or other extra services) to the room folio is a frequently used and demanded feature by the hotel guests which established it as a standard.
\n","event":[{"listen":"prerequest","script":{"id":"4ac37a02-8f6b-48e7-8560-a955348c0dc0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"56c71369-7f6f-4d91-9594-3db8a36f6aad","type":"text/javascript","exec":[""]}}],"_postman_id":"c55206e0-6304-4eda-b706-fd7def7d50b8","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Use chargeable_folios_companies endpoint to get the list of all chargeable company folios in Clock PMS. The folios should be created for the company in advance and should be open and valid. The companies should accept charges(boolean field accept_charge_transfers = true). Using parameter accept_charge_transfers_only=false you can also get all folios metching the search even if company's parameter accept_charge_transfers=false
\nPlease note it is very likely to have more than one company folio matching your search criteria and the user shall select the right one!
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"required
\n","type":"text/plain"},"key":"name","value":"test"},{"disabled":true,"description":{"content":"default value is 'true'
\n","type":"text/plain"},"key":"accept_charge_transfers_only","value":"'true' / 'false'"}],"variable":[]}},"response":[{"id":"e433f87f-ad6c-402e-9b63-bd28f2f5bbc8","name":"3.1. Company search","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://sky-eu1.clock-software.com/base_api/80226/11919/companies/chargeable_folios?name=test","protocol":"https","host":["sky-eu1","clock-software","com"],"path":["base_api","80226","11919","companies","chargeable_folios"],"query":[{"key":"name","value":"test","description":"required"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 18 Jun 2021 10:43:06 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self'"},{"key":"X-Frame-Options","value":"sameorigin"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Fri, 01 Jan 1990 00:00:00 GMT"},{"key":"Set-Cookie","value":"app_config=BAhJIg17IjEiOnt9fQY6BkVU--7ee9a9c3f24b6ede332fbbb13201a7ab8d6584e1; path=/; expires=Tue, 18 Jun 2041 10:43:06 -0000; HttpOnly"},{"key":"Set-Cookie","value":"_session_id=Uzg1YUZiMFd1S2wzSFE0RXQxSHVUbXo3VkczL0NDelFmNTA1VHhUcDE0aFNZeXJlS2thRENXMWd6eTBtdmptOWdvOTh3cWZIVWl1Z0g2WUlJWmY4MzRyM3Z2R0xZNGl6K1VWVUVkOGxLWFVYNVkzOEJHbWp1NEp6citWZjU5dWlkZG81RE9CeXM0d0VOcXZtMFh5VUdWQiswWkJ4WjA5QjNtWTN1NWpiV3NnPS0tS3c5b2xmZnppbkNZbS9OWExPbXJ4Zz09--91804727daab42b49878726693bb06aa896341d0; path=/; HttpOnly; SameSite=Strict"},{"key":"Set-Cookie","value":"_session_id_x=WC81alhURUgxZDlGVzlRNkRZYzUrYlJ2TkZzTXduWlhUeGpERGRpZ05CQjUzd29yTTJ6c3MwVTZmL0MrY3pKMS0tdmg3SHNUMzc5SnJRZjFRM25Fd2hNUT09--590468f6865333bd9d987bbef0b585ef09185226; path=/; expires=Fri, 18 Jun 2021 22:43:06 -0000; HttpOnly; SameSite=Strict"},{"key":"X-Request-Id","value":"dd6cd38a-9832-4979-9a3c-ec184a529a28"},{"key":"X-Runtime","value":"0.158273"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"company_name\": \"My Test Company\",\n \"folio_name\": \"\",\n \"folio_id\": 13415564\n },\n {\n \"company_name\": \"My Test Company\",\n \"folio_name\": \"Management\",\n \"folio_id\": 16094854\n },\n {\n \"company_name\": \"My Test Company\",\n \"folio_name\": \"Monthly Invoicing\",\n \"folio_id\": 16094857\n }\n]"}],"_postman_id":"465efc03-befe-4366-930c-782ccb1b716c"},{"name":"3.2. Company - charge create","id":"810be613-e268-4aeb-8b7d-dfa8b34df264","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"charges\": [\n\t\t{\n \"charge_template_id\": 948387,\n\t\t\t\"text\": \"Tea\",\n\t\t\t\"service_date\": \"2022-01-08\",\n\t\t\t\"revenue_category\": \"bevarage\",\n\t\t\t\"price\": 2.0,\n\t\t\t\"currency\": \"EUR\",\n\t\t\t\"tax_rate\": 0.2,\n \"qty\": 2,\n\t\t\t\"print_text\": \"Bill # 123\"\n\t\t},\n\t\t{\n \"charge_template_id\": 948387,\n\t\t\t\"text\": \"Sandwitch\",\n\t\t\t\"service_date\": \"2022-01-08\",\n\t\t\t\"revenue_category\": \"food\",\n\t \"price\": 3.0,\n\t\t\t\"currency\": \"EUR\",\n\t\t\t\"tax_rate\": 0.2,\n\t\t\t\"print_text\": \"Bill # 123\"\n\t\t},\n\t\t{\n \"charge_template_id\": 948387,\n\t\t\t\"text\": \"Coke\",\n\t\t\t\"service_date\": \"2022-01-08\",\n\t\t\t\"price\": 3.0,\n\t\t\t\"print_text\": \"Bill # 123\"\n\t\t}\n\t]\n}","options":{"raw":{"language":"json"}}},"url":"https://sky-eu1.clock-software.com/base_api/80226/11919/folios/13184661/charges/bulk","description":"\n
Please note a folio shouldn't contain more than 5000 charges
\n\n
Use the folio_id of the selected folio from 3.1. with the charge - BULK CREATE endpoint to create all charges at once with the details you already have in the charge template mapping
\nPlease use \"charge_template_id\" from the created mapping (1.1. Charge template mappings) in your request together with the \"service_date\". However, the parameters configured in the charge template can still be overridden. For example, if \"text\": \"Test charge\" is included, it will override the \"text\" value configured in the charge template.
\nPlease note: If some of the required parameters for charge creation are not configured in the used charge template, an error will be returned. The required parameters are:
\n- \n
- \"revenue_group\" \n
- \"price\" \n
- \"text\" \n
PLEASE NOTE: charge - BULK CREATE endpoint supports up to 100 charges to be created at once if you need to create more than 100 charges you will need to separate them in different calls. If you try to create more than 100 charges you will receive
\n \"error\": \"Charges exceeds the limit!\"\n\nTransfer charges to a company folio is highly demanded and it is highly advisable to be added to your interface.
\n","event":[{"listen":"prerequest","script":{"id":"590fec11-4e5b-4e42-9493-ceff853cce30","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c4aa01b5-95e0-4964-9255-461d5524baa6","type":"text/javascript","exec":[""]}}],"_postman_id":"d6c32f15-0855-4f5d-8433-e0c59f110179","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Use chargeable_folios_events endpoint to get the list the folios which can be charged for the events created in Clock PMS matching your search criteria.
\nPlease note it is very likely to have more than one event folio matching your search criteria and the user shall select the right one!
\nCompany parameter Accept charge transfers control:\nThe optional parameter accept_charge_transfers_only will check the Accept charge transfers parameter state of the company the event is associated with. - accept_charge_transfers_only=false - will return the folios for all events regardless of Accept charge transfers parameter configuration - Default behavior of the endpoint
\naccept_charge_transfers_only=true - will return only the folios for events associated with companies with Accept charge transfers parameter set to true.
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"posible values:\nexpected\nchecked_in\nchecked_out
\n","type":"text/plain"},"key":"checkin_status","value":"checked_in"},{"disabled":true,"description":{"content":"default value is 'false'
\n","type":"text/plain"},"key":"accept_charge_transfers_only","value":"'true' / 'false'"}],"variable":[]}},"response":[{"id":"3068b877-0a11-4d4f-ac8e-7415a4d4712a","name":"4.1. Event search","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://sky-eu1.clock-software.com/pms_api/80226/11919/events/chargeable_folios?name=team&arrival.gt=2020-01-01&departure.lt=2021-08-01&checkin_status=expected","protocol":"https","host":["sky-eu1","clock-software","com"],"path":["pms_api","80226","11919","events","chargeable_folios"],"query":[{"key":"Atleast one of the bellow parameters is required","value":" ","type":"text","disabled":true},{"key":"name","value":"team"},{"key":"arrival.gt","value":"2020-01-01"},{"key":"departure.lt","value":"2021-08-01"},{"key":"checkin_status","value":"expected","description":"posible values:\nexpected\nchecked_in\nchecked_out"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 18 Jun 2021 10:41:13 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self'"},{"key":"X-Frame-Options","value":"sameorigin"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Fri, 01 Jan 1990 00:00:00 GMT"},{"key":"Set-Cookie","value":"app_config=BAhJIg17IjEiOnt9fQY6BkVU--7ee9a9c3f24b6ede332fbbb13201a7ab8d6584e1; path=/; expires=Tue, 18 Jun 2041 10:41:13 -0000; HttpOnly"},{"key":"Set-Cookie","value":"_session_id=TVBZM3FTdU9sUzNyaXl5TDVoN1p6TDNWREh0ZCtneFBuYmdIWEVRVnQ2VkcvaWplOWt4RUJ2dCs2Uk1qdnVyaUtvVDhkeTlUVVFVM1NrRHd5Tm8rZS9xeTltU2RUOFJyemx1a0dvRjRndGRFdGJnMWg5MWRxZnZuaC9TSW5QRFd4ZTVUWnZudUxQdXNJNllHYWc0dUxyTjZvQVNTYUNsWUFiU0RyeHZNcVhZPS0tREx6RkYrY1ZFWk5pZ2JEd0RFTWRCUT09--d22fae1348de748ea83dabb9d898a853bfba22a7; path=/; HttpOnly; SameSite=Strict"},{"key":"Set-Cookie","value":"_session_id_x=M0t6TzJwbVAxM0Q0Zm1uSGQrVWJ2MEdET01KUzBSQ0FpSE5Jc0NiMjAvRmZxZkdlSFc0VzU5OG9RYm5yS0ptNS0tdW5iM2dKUktnODBDbFdKOCtTZlVtUT09--0a3261dc01b81444004b7a215f28c2c26696268d; path=/; expires=Fri, 18 Jun 2021 22:41:13 -0000; HttpOnly; SameSite=Strict"},{"key":"X-Request-Id","value":"c6fbab5e-d8d3-47bd-8fc8-07facd9b945a"},{"key":"X-Runtime","value":"0.113724"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"event_name\": \"Team building\",\n \"checkin_status\": \"expected\",\n \"arrival\": \"2020-08-09\",\n \"departure\": \"2020-08-12\",\n \"folio_name\": \"Room charges\",\n \"folio_id\": 16094810\n },\n {\n \"event_name\": \"Team building\",\n \"checkin_status\": \"expected\",\n \"arrival\": \"2020-08-09\",\n \"departure\": \"2020-08-12\",\n \"folio_name\": \"\",\n \"folio_id\": 16094829\n },\n {\n \"event_name\": \"Team building\",\n \"checkin_status\": \"expected\",\n \"arrival\": \"2020-09-25\",\n \"departure\": \"2020-09-26\",\n \"folio_name\": \"Catering charges\",\n \"folio_id\": 16094811\n }\n]"}],"_postman_id":"ab90f574-e920-4e4a-873c-58efb5692a7b"},{"name":"4.2. Event - charge create","id":"8a002af5-a427-42f7-9dea-c897046c410d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"charges\": [\n\t\t{\n \"charge_template_id\": 948387,\n\t\t\t\"text\": \"Tea\",\n\t\t\t\"service_date\": \"2022-01-08\",\n\t\t\t\"revenue_category\": \"bevarage\",\n\t\t\t\"price\": 2.0,\n\t\t\t\"currency\": \"EUR\",\n\t\t\t\"tax_rate\": 0.2,\n \"qty\": 2,\n\t\t\t\"print_text\": \"Bill # 123\"\n\t\t},\n\t\t{\n \"charge_template_id\": 948387,\n\t\t\t\"text\": \"Sandwitch\",\n\t\t\t\"service_date\": \"2022-01-08\",\n\t\t\t\"revenue_category\": \"food\",\n\t \"price\": 3.0,\n\t\t\t\"currency\": \"EUR\",\n\t\t\t\"tax_rate\": 0.2,\n\t\t\t\"print_text\": \"Bill # 123\"\n\t\t},\n\t\t{\n \"charge_template_id\": 948387,\n\t\t\t\"text\": \"Coke\",\n\t\t\t\"service_date\": \"2022-01-08\",\n\t\t\t\"price\": 3.0,\n\t\t\t\"print_text\": \"Bill # 123\"\n\t\t}\n\t]\n}","options":{"raw":{"language":"json"}}},"url":"https://sky-eu1.clock-software.com/base_api/80226/11919/folios/13184661/charges/bulk","description":"\n
Please note a folio shouldn't contain more than 5000 charges
\n\n
Use the folio_id of the selected folio from 4.1. with the charge - BULK CREATE endpoint to create all charges at once with the details you already have in the charge template mapping
\nPlease use \"charge_template_id\" from the created mapping (1.1. Charge template mappings) in your request together with the \"service_date\". However, the parameters configured in the charge template can still be overridden. For example, if \"text\": \"Test charge\" is included, it will override the \"text\" value configured in the charge template.
\nPlease note: If some of the required parameters for charge creation are not configured in the used charge template, an error will be returned. The required parameters are:
\n- \n
- \"revenue_group\" \n
- \"price\" \n
- \"text\" \n
PLEASE NOTE: charge - BULK CREATE endpoint supports up to 100 charges to be created at once if you need to create more than 100 charges you will need to separate them in different calls. If you try to create more than 100 charges you will receive
\n \"error\": \"Charges exceeds the limit!\"\n\nTransfer charges to an event folio is highly demanded and it is highly advisable to be added to your interface.
\n","event":[{"listen":"prerequest","script":{"id":"d508992b-a8d1-433b-bc71-8195e6ee2898","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3c9ff1f1-1c9b-4978-a5a8-b651b09dcc30","type":"text/javascript","exec":[""]}}],"_postman_id":"c413031a-11d9-4bda-b5fc-1f9bcd61c52f","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"The daily revenue is transferred to a designated company record that will hold it.
\nThis company must be created in advance, and its ID stored in the service configuration.
\nPlease note that users of the Clock Hospitality Cloud do not have direct access to the company ID.
\nIdeally, your integration should allow users to search for and select the company by name using the Companies endpoint.
\nBefore transferring the daily revenue and payments, create a folio associated with the selected company — this folio will serve as the target for the transfer.
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"\n
Please note a folio shouldn't contain more than 5000 charges
\n\n
Use the folio_id of the folio created with 5.1 and charge - BULK CREATE endpoint to create all charges at once with the details you already have in the charge template mapping
\nPlease use \"charge_template_id\" from the created mapping in your request together with the \"service_date\". However, the parameters configured in the charge template can still be overridden. For example, if \"text\": \"Test charge\" is included, it will override the \"text\" value configured in the charge template.
\nPlease note: If some of the required parameters for charge creation are not configured in the used charge template, an error will be returned. The required parameters are:
\n- \n
\"revenue_group\"
\n \n\"price\"
\n \n\"text\"
\n \n
PLEASE NOTE: charge - BULK CREATE endpoint supports up to 100 charges to be created at once if you need to create more than 100 charges you will need to separate them in different calls. If you try to create more than 100 charges you will receive
\n \"error\": \"Charges exceeds the limit!\"\n\nTO AVOID REVENUE DUPLICATIONS the charges already transferred to booking, company or event folio should be excluded! In order not to exceed the API calls limit it is recommended do the end of day revenue transfer when the financial day is over and no ongoing transfers are expected!
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Use the ID of the folio created with 5.1 and folio_credit_items endpoint in order to transfer the payments received against those charges.
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Close the EOD transfer folio.
Once you are ready transferring revenue and payments for the given date, close the folio created with 5.1. Using it's ID!
The API user needs the right “Folio: Close” granted. Additionally the right “Folio: Close folio with outstanding balance” may be granted depending on business needs. Optional parameter “document_type_id” can be passed to close folio as invoice. However document close is a fiscalisation event and if fiscalization service is used, “document_type_id” must be used of a document type configured NOT TO BE FISCALIZED to avoid DOUBLE FISCALISATION!
\n!!! Please note this step is very important for the usability of the interface and shouldn't be skipped !!!
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"This option allows the customer to generate consolidated reports in Clock PMS, representing the complete revenue and payments.
\nTo ensure accurate revenue encapsulation, the End of Day (EOD) transfer should be performed through a separate Clock POS account.
\nThe customer must request activation of the Clock POS account separately. Once activated, the following configurations should be completed:
\n- \n
Create and map a new charge template (menu item) for the End of Day process;
\n \nEnsure the Clock POS account has tax settings identical to the Clock PMS account to maintain revenue figure consistency;
\n \nConfigure the Auto Revenue Date Offset so that the revenue date changes only after the End of Day (EOD) figures have been transferred.
\n
For example, set the Auto Revenue Date Offset to 7 if the EOD transfer is expected to complete by 6:00 AM. \nActivate the integration from the AppConnector for the newly created POS account. Note: You will receive a new set of API credentials and URLs to configure in your system.
\n \n
The process it really easy and straight forward with the following steps.
\n","event":[{"listen":"prerequest","script":{"id":"ae449194-dc66-479c-bab7-631ac8ac0755","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b45f6c70-e1e7-41f5-8b17-5292cb50cdf9","type":"text/javascript","exec":[""]}}],"_postman_id":"cc654623-2e94-4b3d-8992-5ee83d53d380","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"The daily revenue is transferred to a designated company that will hold it. The company must be created in advanced and it's ID stored in the service's configurations. Before the revenue and payments are transferred create a folio to which they will be transferred.
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"\n
Please note a folio shouldn't contain more than 5000 charges
\n\n
Use the folio_id of the folio created with 5.1 and charge - BULK CREATE endpoint to create all charges at once with the details you already have in the charge template mapping
\nPlease use \"charge_template_id\" from the created mapping (1.1. Charge template mappings) in your request together with the \"service_date\". However, the parameters configured in the charge template can still be overridden. For example, if \"text\": \"Test charge\" is included, it will override the \"text\" value configured in the charge template.
\nPlease note: If some of the required parameters for charge creation are not configured in the used charge template, an error will be returned. The required parameters are:
\n- \n
- \"revenue_group\" \n
- \"price\" \n
- \"text\" \n
PLEASE NOTE: charge - BULK CREATE endpoint supports up to 100 charges to be created at once if you need to create more than 100 charges you will need to separate them in different calls. If you try to create more than 100 charges you will receive
\n \"error\": \"Charges exceeds the limit!\"\n\nTO AVOID REVENUE DUPLICATIONS the charges already transferred to booking, company or event folio should be excluded! In order not to exceed the API calls limit it is recommended do the end of day revenue transfer when the financial day is over and no ongoing transfers are expected!
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Use the ID of the folio created with 5.1 and folio_credit_items endpoint in order to transfer the payments received against those charges.
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Close the EOD transfer folio.
Once you are ready transferring revenue and payments for the given date, close the folio created with 5.1. Using it's ID!
The API user needs the right “Folio: Close” granted. Additionally the right “Folio: Close folio with outstanding balance” may be granted depending on business needs. Optional parameter “document_type_id” can be passed to close folio as invoice. However document close is a fiscalisation event and if fiscalization service is used, “document_type_id” must be used of a document type configured NOT TO BE FISCALIZED to avoid DOUBLE FISCALISATION!
\n!!! Please note this step is very important for the usability of the interface and shouldn't be skipped !!!
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"This option will allow the customer to generate consolidated reports in Clock PMS representing the complete revenue and payments. The process it really easy and straight forward with the steps below.
\n","event":[{"listen":"prerequest","script":{"id":"ae449194-dc66-479c-bab7-631ac8ac0755","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b45f6c70-e1e7-41f5-8b17-5292cb50cdf9","type":"text/javascript","exec":[""]}}],"_postman_id":"95be6354-f4c9-4733-8196-b37ef92ca3bb","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Following the next simple steps you will be able to transfer charges from your system (POS, SPA, Parking, Video On demand, etc.) efficiently
\n","_postman_id":"71b3d681-0df9-414f-923a-3749bdb8386c","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"We recommend that you implement Subresource Integrity (SRI) to ensure that the files you are loading from Adyen have not been manipulated or tampered with by malicious actors.
\nTo use the SRI hash, you need to add an integrity attribute when specifying or elements. Browsers will also check for the crossorigin attribute to ensure that the origin allows Cross-Origin Resource Sharing (CORS). If a browser detects that the file's hash does not match the specified hash, the browser will not load the resource. To know which browsers support SRI, refer to this browser compatibility list.
Create a DOM container element on your checkout page where you want Drop-in to be rendered and give it a descriptive id. We strongly recommend that you don't put it in an iframe element, because it may cause issues.
\nIf you are using JavaScript frameworks such as Vue or React, make sure that you use references instead of selectors and that you don't re-render the DOM element.
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"9a1f63a0-55f3-4e1b-a64d-7b9db64f7389"},{"name":"3. Create payment session","id":"ac1900ad-7128-4789-935d-a946af115e02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"return_url\": \"https://your-company.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sky-eu1.clock-software.com/rest_api/adyen_psp/80226/11919/dropin_token_sessions","description":"Your server should call the designated endpoint of the Clock PMS API to create the payment session details required for Drop-in initialization.\nWhen the session is created pass the details from the API response to your check-out page!
\n- \n
\"return_url\" in the request is required as it will be used is a redirect is required during the tokenisation process for 3DS.
\n \nYou need to store the value of \"credit_card_id\" form the response. credit_card_id will hold the created token and you will need it once the booking is created to associate the tokenized card with the booking.
\n \n
Once you create the token session parameters using the API you simply need to initialize the Drop-in script using the session details from the API response.
\n","urlObject":{"query":[{"disabled":true,"description":{"content":"Use the session_id value returned from Clock PMS API
\n","type":"text/plain"},"key":"session_id","value":""},{"disabled":true,"description":{"content":"Use the session_date value returned from Clock PMS API
\n","type":"text/plain"},"key":"session_data","value":""},{"disabled":true,"description":{"content":"Use the client_key value returned from Clock PMS API
\n","type":"text/plain"},"key":"clientKey","value":""},{"disabled":true,"description":{"content":"Use the env value returned from Clock PMS API
\n","type":"text/plain"},"key":"environment","value":""},{"disabled":true,"description":{"content":"Create an event handler, called when the payment is completed
\n","type":"text/plain"},"key":"onPaymentCompleted(result, component)","value":""}],"variable":[]}},"response":[],"_postman_id":"dde85bb5-ef6f-4013-9495-d52a4a57f305"},{"name":"5. Redirect handling","id":"b7fdabea-6c83-45c2-996d-8a04d96ff048","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"|","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"text"}}},"description":"Some payment methods like iDEAL, and some 3D Secure flows will redirect the shopper back to your website. When the shopper comes back to your website, show them the payment result, based on the result code. To get the resultCode, you need to create an instance of AdyenCheckout after the redirect, as described below.
\nThe shopper comes back to the returnUrl specified when creating the payment session. The returnUrl has query parameters appended to it, which you need to handle the redirect:
\n- \n
- sessionId: the unique identifier for the shopper's payment session. \n
- redirectResult: details you need to submit to handle the redirect.\nIf the shopper doesn't return to you website, you don't get a redirectResult. You don't need to do anything to handle the redirect in this case. \n
// The return URL has query parameters related to the payment session.\nhttps://your-company.com/?sessionId=CSD9CAC34EBAE225DD&redirectResult=X6XtfGC3!Y...\nExtract the values from the query string parameters and create a function which handles the redirect result. The function needs to:
\n- \n
- Create an instance of Drop-in using the sessionId value you extracted.
!!!PLEASE NOTE: You don't need to use Clock PMS API to generate new session details. You need to reinitialize the Drop-in configuration with the existing session, use only the sessionId query parameter added to your returnUrl \n - Submit the redirectResult value you extracted from the returnUrl. \n
// Function to parse URL parameters\nfunction getURLParameter(name) {\n return decodeURIComponent((new RegExp('[?|&]' + name + '=' + '([^&;]+?)(&|#|;|$)').exec(location.search) || [null, ''])[1].replace(/\\+/g, '%20')) || null;\n}\n// Create an instance of AdyenCheckout to handle the shopper returning to your website.\n// Configure the instance with the sessionId you extracted from the returnUrl.\nasync function initializeCheckout() {\n const sessionId = getURLParameter('sessionId');\n const redirectResult = getURLParameter('redirectResult');\n\n const configuration = {\n session: {\n id: sessionId,\n },\n // other configuration options...\n };\n\n try {\n const checkout = await AdyenCheckout(configuration);\n\n if (redirectResult) {\n checkout.submitDetails({details: {redirectResult}});\n }\n // Proceed with further actions, e.g., mount the Drop-in\n } catch (error) {\n console.error(\"Error initializing Adyen Checkout:\", error);\n }\n}\n\n// Execute the checkout initialization\ninitializeCheckout();\nIf the shopper doesn't return to your website, don't call submitDetails, because the result doesn't change when you attempt the request.
\nAfter you submit the redirectResult value, Drop-in calls the onPaymentCompleted(result, component) event. Use the result code in result.resultCode to inform the shopper.
\nThe onError event returns an object which contains details about the error:
\nThe error object may contain additional fields inherited from the Error() constructor.
\n{\n onError: (error, component) => {\n console.error(error.name, error.message, component);\n }\n}\nCreate the booking using the standard booking - CREATE endpoint
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"f48762f7-75d9-4b1c-bf82-65c092a8cd59"},{"name":"7. Assign created token to the booking","id":"c72f6a0e-d561-4db1-bbef-ba11b958f17b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"|","header":[],"description":"Use the standard booking_credit_cards - CREATE endpoint to assign the created token to the booking you just created. You will need the following parameters to do so:
\n- \n
- The \"booking_id\" of the newly created booking with step 7. Create booking. \n
- \"credit_card_id\" received with the API response in step 3. Create payment session. \n
If your booking guarantee policy requires not only tokenisation of the credit card but also a payment use the standard booking_credit_cards - CHARGE endpoint to do so.\nYou will need the following parameters do so:
\n- \n
- The \"booking_id\" of the booking the token is associated with, step 8. Assign created token to the booking. \n
- \"credit_card_id\" received with the API response in step 3. Create payment session. \n
This guide is designed to help developers which are aiming to integrate Clock PMS Payment Enablement Service into their custom Booking Engines. The process is quite straight forward and involves the below steps:
\nImportant note: The integration process uses combined elements from the infrastructure of Clock PMS and Adyen in a specific way. Please follow only this guide and not Adyen's technical documentation!
\n\n","event":[{"listen":"prerequest","script":{"id":"89164dde-0ccb-4b78-8dd5-32a36655e4d9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8cbf0b36-b52e-475e-a61d-5c107785ffe1","type":"text/javascript","exec":[""]}}],"_postman_id":"b1656854-fe9a-4b44-af45-7567969f9381","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"
Proper Accounting Data Synchronization is very important for the Hospitality Industry
\nIn the dynamic world of hospitality, ensuring accurate and efficient financial management is crucial for the success of any hotel or accommodation business. One of the key components in achieving this is the proper synchronization of accounting data between Clock PMS+ and your financial system. The below explores the critical aspects of accounting data sync, focusing on the configuration of the PMS system and the collection of data via the PMS system API.
\n- \n
Configuration of the PMS System:
\n- \n
Revenue Accounting Code/s Configuration. The account codes in Clock PMS+ are defined as new field/s for the charge templates.
\n- \n
Navigate to menu Settings -> All Settings -> Charge Custom Fields > and create the necessary Revenue accounting code field/s with Type: string. Once the Revenue accounting code field/s are created you can start defining the account codes for the list of charge templates.
\n \nNavigate to menu Settings -> All Settings -> Charge Templates and Edit each charge template and fill in the respective account codes. Note: Keep in mind the datev_account field needs to be filled in before posting charges to booking/folios. However, if you already have charges created you can still update their Datev account values using the Charge Custom Field Check Report.
\n \n
\nPayment Accounting Codes Configuration. Navigate to menu Settings -> All Settings -> General ledger accounts, review the existing configurations and create new ones specifying the attributes on the screen. Note : The first match the system finds will assign the payment code. For example, if code 123 is configured for Payment type = Bank and code 456 is configured for the combination Payment type = Bank and Payment subtype = National Bank the system will find the first match and the code will be 123. However, you can use the Sort order (ascending) to configure how the code configuration would apply and if the code 123 has Sort order = 2 and 456 with Sort Order = 1 the latter will match first and 123 will be the default one for the bank payments. Unlike the Revenue accounting code, the change to the General ledger account code will immediately affect the General ledger account of the payments.
\n \n
\nAccounting Data Sync. When syncing data between Clock PMS+ and your financial system, several common data streams are typically involved to ensure accurate and efficient integration. Here are the most common data streams
\n- \n
Revenue. charges_log endpoint exposes detailed information for all charges for a given revenue date together with their taxes. Please note: The revenue corrections and voids are exposed as negative or reverse charges. ;
\n \nPayments. credit_item_logs endpoint exposes detailed information for all payments collected/refunded for a given revenue date. The refunds are exposed as negative payments;
\n \nAdvanced payments and deposits. Here you can find more information about deposits, advanced payments the difference between the two and how to operate with them:
\n- \n
Advanced payments - When the advanced payments are used the value of the advanced payments registered and used for the day are registered as revenue and hence they should be already processed with the rest of the revenue. The Advance payment charges are always with revenue_group = deposit. Newly received advanced payments are exposed as positive charges while the consumption of the advanced payments are negative charges;
\n \nDeposits - The deposits are handled as payments in open folios. Those payments may be registered in two types of folios:
\n- \n
non-deposit folios and you can collect the information about those payments using folio_ledger for a given revenue date using deposits_in_advance_from_non_deposit_folios from date array.
\n \ndeposit folios from the collected payments you can collect the folio where the payment is registered and check if the folios is a deposit one (deposit = true)
\n \n
\n
\nClosed folios and issued invoices. folios - VIEW LIST endpoint may be used to get the list of IDs of folios which have to be synchronised. The results may be filtered so the list of IDs will contain only the ones which have to be synchronised. Information about every folio ID is fetched using folio - VIEW endpoint. Additionally you can add the document_type in your filters if only certain document types are needed;
\n \nAccounts Receivable. It represents the money owed to the hotel by the clients who have received services or goods but have not yet and those are represented with invoices and the correction documents associated with invoices:
\n- \n
Invoices - Use folios endpoint to get the list of folios filtered with payed=false&close_date=current_date(yyyy-mm-dd format) parameters. The result will contain closed folios which are not paid and are forming the accounts receivable. Once you start collecting the details for the individual folios you need contragent_billing_info to identify the customer. To calculate the amount subtract the payments registered for the folio from the folio value. Of course, you can pull all other details needed for the proper AR registration from the endpoint;
\n \nCorrection documents - The list of correction documents for a given date may be easily collected using folios endpoint with parameters payed=false&close_date=current_date(yyyy-mm-dd format). Once you start collecting the details for the individual folios you need client_folio_id to identify the folio_id the current folio is correcting as well as the folio value. Of course, you can pull all other details needed for the proper AR registration from the endpoint;
\n \n
\nLiabilities - The liabilities are all charges which are not paid and charged to folios which are still open. The liabilities can be collected using folio_ledger for a given revenue date using debts_open_folios from date array.
\n \n
\n
Configure the respective activity provider in Clock PMS+. Open > Settings > Actovity Providers and create new provider from type GENERIC. Give the provider a name and define the activity buttons display names for the different Clock PMS+ screens (Booking, Event and MyBookingPortal). If your system provide SPA services define...\"Book a SPA\" instead of \"Book with system X\" so it will be more intuitive for the staff and guetss. Configure the URLs for request (new), update and cancel of activity. The configured URL will be loaded in an iFrame so the staff member may complete the activity operation in your service where you can request all necessary details. Please the following parameters may be added in the URL configurations for better process handling:
\n- \n
%{activity_provider} - will add the uuid of the activity to be used with activity andpoints;
\n \n%{provider_uuid} - the provider uuid will be added to the URL to be used with activity_providers andpoint;
\n \n%{booking_number} - the booking number will be added so you can search for the related booking usig bookings endpoint;
\n \n%{event_number} - the event number will be added so you can search for the related event usig events endpoint
\n \n%{reference_id} - the reference_id updated when the acivity was completed will be added so the related records in your system may be easier identified;
\n \n%{cancel_reference_id} - the cancel_reference_id will be added to the URL for a reference with your system.
\n \n
The activities may be asosciated with booking and event and hence they are started from one of those.
\nFrom the Activities section select Edit Activities to access the fully fledged Activities Screen.
\nFrom the Activities screen you can create new activity by selecting one of the options at the left (The names as defined in the Activity provider configuration).
\nWhen an option is selected the user will be forwarded to your system to lead the booking process in an iFrame.
\nPlease note the URL may include additional parameters like activity_uuid as described in Activity provider configuration so you can identify which activity to update after the process is over.
\nExample update request:
\n{\n \"activity\": {\n \"start_time\": \"2024-08-28T10:00:00.000+03:00\",\n \"end_time\": \"2024-08-23T11:00:00.000+03:00\",\n \"description\": \"Stone massage with Alice\",\n \"reference_id\": \"SPA.119\"\n }\n}\n\nThe information you updated the activity will apear in the activity line in the activity section of the boking / event.
\nIf the process fails the activity should be udapted as failed as descrivbed here.
\nYou can also charge the booking / event with the cost of the additional activity or keep the charges at your end untill the activity is completed and than decide if it will be paid on spot or the charges will be transfered to Clock PMS+. In both cases please follow our charges transfer guide.
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"db6e9b67-9481-46ea-ae00-200fba6cf497"},{"name":"UPDATE Activity Process","id":"074d80b6-ac39-4aba-b721-8d0d1a373ee2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"|","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"html"}}},"description":"As everything related to the guest stay is a subject of a change and the activities are not an exception.
\nFrom the Activities screen the existign actiities may be updated.
\nWhen an option is selected the user will be forwarded to your system to lead the udpated process in an iFrame.
\nPlease note the URL may include additional parameters like activity_uuid as described in Activity provider configuration so you can preload some of the details of the activity as well as to identify which activity to update after the process is over.
\nPlease note: If udpate is not supoprted in the given situation or at all you can simply communicate by displaying the proper message in the iFrame
\nExample update request:
\n{\n \"activity\": {\n \"start_time\": \"2024-08-28T14:00:00.000+03:00\",\n \"end_time\": \"2024-08-23T15:00:00.000+03:00\",\n \"description\": \"Stone massage with Alice\",\n \"reference_id\": \"SPA.119\"\n }\n}\n\nThe information you updated the activity will apear in the activity line in the activity section of the boking / event.
\nIf you deal with the charges they can be adjusted following our charges transfer guide.
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"074d80b6-ac39-4aba-b721-8d0d1a373ee2"},{"name":"CANCEL Activity Process","id":"2bb03f36-a700-444f-8406-e866af8caced","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"|","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"html"}}},"description":"From the Activities screen the existign actiities may be canceled.
\nWhen an option is selected the user will be forwarded to your system to lead the cancelation process in an iFrame.
\nPlease note the URL may include additional parameters like activity_uuid as described in Activity provider configuration so you can preload some of the details of the activity as well as to identify which activity to update after the process is over.
\nPlease note: If cancel is not supoprted in the given situation or at all you can simply communicate by displaying the proper message in the iFrame
\nExample update request:
\n{\n \"activity\": {\n \"start_time\": \"2024-08-28T14:00:00.000+03:00\",\n \"end_time\": \"2024-08-23T15:00:00.000+03:00\",\n \"description\": \"Stone massage with Alice\",\n \"reference_id\": \"SPA.119\",\n \"cancel_reference_id\": \"CANCEL_SPA.119\"\n }\n}\n\nThe apearance of the activity change after the cancelation in the activity section of the boking / event.
\nThe colourign of the record is more grey as well as the update and cancell buttons are not active anymore.
\nIf you deal with the charges they can be adjusted following our charges transfer guide.
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"2bb03f36-a700-444f-8406-e866af8caced"}],"id":"adc6cb83-f9b8-43b8-b7e7-3e692832a41b","description":"A hotel stay is more than just a room; it’s a comprehensive experience. Additional activities often represent significant revenue streams for hotels and must be well-organized. These activities typically involve planning, scheduling, and booking resources at specific times, making them key milestones in the guest’s daily schedule.
\nOur API is designed to seamlessly integrate additional activity vendors directly with hotel bookings and events. These activities, often offered by third-party vendors, are not directly related to the room stay but greatly enhance the overall guest experience. Examples include:
\n- \n
SPA treatments
\n \nGuided tours of local attractions
\n \nRestaurant reservations
\n \n
The activity infrastructure allows activity vendors to link their services to hotel bookings and MICE (Meetings, Incentives, Conferences, and Exhibitions) events, providing guests with a convenient and enriched stay through diverse and personalized experiences.
\nThe activity is at first created in Clock PMS+. Than the booking process is handled by the provider in an iFrame. At the end the final status of the activity is updated via the API. The following scenarious are currently suported:
\n\nHow does the entire process looks like?
\nSteps of the process:
\n- \n
USER: Selects the “Edit Activity” button in the Activities section of the Booking / Event. There selects one of the available Activity options on the left(Specific names are configured for every provider);
\n \nClock PMS: The Clock PMS+ Opens the defined URL + parameters for the provider in an Iframe;
\n \nActivity Provider: Fetches the activity details via the API (using activity_uuid) and guides the user in the process;
\n \nUSER: Makes the necessary selections and completes the activity booking process;
\n \nActivity Provider: Updates the activity with the process outcome
\n \nUSER : Can can tstart update / cancel processes which may be handles the same way as new activity.
\n \n
The following guide will help you easily integrate your system with Clock PMS+ activities:
\n","_postman_id":"adc6cb83-f9b8-43b8-b7e7-3e692832a41b","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Send the encrypted data received by the client-side encryption script to get the Credit Card token. Save the token and save it with the booking and charge it if necessary.
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Save the token with the booking which you have created.
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Specify the amount which you want to charge the credit card with.\nThe credit card will be charged via the activated payment provide in ClockPMS+.
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"The guide describes how you can use the standard ClockPMS+ credit card and payment infrastructure together with your custom build web reservation system (WRS).
\n\n
\n\nPLEASE NOTE:
\nThe customer's server receives the already encrypted block and therefore it is not necessary to undergo a PCI DSS audit.
\nHowever you still need to complete a self-assessment questionnaire (SAQ A-EP) on annual basis.
\n
The higher class SAQ-D can be also used in case you have already completed it!You can find the SAQ A-EP in the PCI's document library:
\nhttps://www.pcisecuritystandards.org/docume>nt_library
\nFor more info on the Javascript method, please visit:
\n
https://www.pcisecuritystandards.org/pdfs/b>est_practices_securing_ecommerce.pdf
\n
Via the credit_cards endpoint, customers can add (tokenize) credit cards to the system. Credit cards, however, have to have client-side encryption. To enable client-side encryption of credit cards, we have prepared special javascript to be generated for each account. The javascript can be added on the customer's credit card page.
\nHere are the details:
\n- \n
- The hotel wants to create their own WRS, in which guests can enter their credit cards details. But what the same doesn't want is to undergo a PCI DSS audit or make their own payment interfaces. \n
- The customer creates a credit card collection page (it has to be https) by adding special tags (data-encrypted-name) to the form fields. \n
- Takes the path to the specially generated JS library from Settings - Credit Card - Client-Side Encryption for API integrations \n
- Places the library in the form for credit cards in the WRS. \n
Example:
\n<script src=\"https://sky-eu1.clock-software.com/subscriptions/:s_id/:a_id/credit_cards_client_side_encryptions\"></script>\n- \n
- The guest enters their CC details in the already-mentioned form. \n
- ClockPMS+ client side encryption library encrypts the data in one block which is sent to the customer's server. \n
- With this method the encrypted block MUST NOT be saved. \n
- Instead, the encrypted block is sent to ClockPMS+ server and a Token is returned using the credit_card_token endpoint (example:credit_card_token - CREATE). If the Token is needed at a later stage, it can be saved (to charge the token and guarantee the booking for example). \n
- Bookings are created and the above Token can be added to them using booking_credit_cards endpoint (booking_credit_cards - CREATE). \n
- You can add some charges the already tokenized card using charge_token endpoint (booking_credit_cards - CHARGE) \n
- Sample of customer's forms HTML can be found bellow: \n
<html><head><meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\">\n \n </head>\n\n <body onclick=\"rng_seed_time();\" onkeypress=\"rng_seed_time();\">\n <form id=\"clock_encrypted_form\" action=\"https://sky-eu1.clock-software.com/examples/company_url_to_store_crypted_block\" accept-charset=\"UTF-8\" method=\"post\">\n\n <label>Card number</label>\n <input type=\"text\" id=\"\" size=\"20\" autocomplete=\"off\" required=\"required\" data-encrypted-name=\"number\">\n <hr>\n\n <label>Holder name</label>\n <input type=\"text\" id=\"\" value=\" \" size=\"50\" autocomplete=\"off\" required=\"required\" data-encrypted-name=\"holder_name\">\n <hr>\n\n <label>Brand</label>\n <select id=\"\" data-encrypted-name=\"brand\" autocomplete=\"off\" required=\"required\">\n <option value=\"\"></option>\n <option value=\"visa\">Visa</option>\n <option value=\"master_card\">Master card</option>\n </select>\n <hr>\n\n <label>Expire</label>\n <select id=\"\" data-encrypted-name=\"expire_month\" autocomplete=\"off\" required=\"required\">\n <option value=\"\"></option>\n <option value=\"01\">01</option>\n <option value=\"02\">02</option>\n <option value=\"03\">03</option>\n <option value=\"04\">04</option>\n <option value=\"05\">05</option>\n <option value=\"06\">06</option>\n <option value=\"07\">07</option>\n <option value=\"08\">08</option>\n <option value=\"09\">09</option>\n <option value=\"10\">10</option>\n <option value=\"11\">11</option>\n <option value=\"12\">12</option>\n </select>\n\n <label> / </label>\n <select id=\"\" data-encrypted-name=\"expire_year\" autocomplete=\"off\" required=\"required\">\n <option value=\"\"></option>\n <option value=\"2019\">2019</option>\n <option value=\"2020\">2020</option>\n <option value=\"2021\">2021</option>\n <option value=\"2022\">2022</option>\n <option value=\"2023\">2023</option>\n <option value=\"2024\">2024</option>\n <option value=\"2025\">2025</option>\n <option value=\"2026\">2026</option>\n <option value=\"2027\">2027</option>\n <option value=\"2028\">2028</option>\n <option value=\"2029\">2029</option>\n <option value=\"2030\">2030</option>\n <option value=\"2031\">2031</option>\n <option value=\"2032\">2032</option>\n <option value=\"2033\">2033</option>\n <option value=\"2034\">2034</option>\n </select>\n <hr>\n\n <label>CVC</label>\n <input type=\"text\" id=\"\" size=\"4\" maxlength=\"4\" autocomplete=\"off\" required=\"required\" data-encrypted-name=\"csv\">\n <span>CSV, CVC2, CVV2, CID, etc.</span>\n <hr>\n\n <label>Billing address</label>\n <input type=\"text\" id=\"\" size=\"20\" autocomplete=\"off\" required=\"required\" data-encrypted-name=\"billing_address\">\n <hr>\n\n <label>Country</label>\n <input type=\"text\" id=\"\" size=\"20\" autocomplete=\"off\" required=\"required\" data-encrypted-name=\"country\">\n <hr>\n\n <label>City</label>\n <input type=\"text\" id=\"\" size=\"20\" autocomplete=\"off\" required=\"required\" data-encrypted-name=\"city\">\n <hr>\n\n <label>State</label>\n <input type=\"text\" id=\"\" size=\"20\" autocomplete=\"off\" required=\"required\" data-encrypted-name=\"state\">\n <hr>\n\n <label>Zip</label>\n <input type=\"text\" id=\"\" size=\"20\" autocomplete=\"off\" required=\"required\" data-encrypted-name=\"Zip\">\n <hr>\n\n <button type=\"submit\">Send</button>\n </form>\n\n <script src=\"https://sky-eu1.clock-software.com/subscriptions/:s_id/:a_id/credit_cards_client_side_encryptions\" data-clock-encrypted-form-debug=\"1\"></script>\n \n\n</body></html>\nIt takes a token, i.e. a credit card has been already added and the token is available to be added to the booking.
You have to know the token which already have been added to the booking, so that the booking can be charged. It takes a value and returns execution flag complete: true, as well as payment_service – the service used for making the payment (it is automatically selected among the available active services)*
This article explains how to identify, classify, and process Accounts Receivable (AR) changes using the Clock PMS+ API.
\nIt is intended for partners building accounting or ERP integrations.
\nOverview
\nChanges in Accounts Receivable (AR) can be reliably detected using the folio_ledger endpoint.
Each AR change represents one of the following business events:
\n- \n
Issuance of a new AR invoice
\n \nIssuance of an AR correction (debit or credit)
\n \nCancellation of an AR invoice or correction
\n \nPayment applied to an AR invoice
\n \n
\n
Step 1: Identify Folios Affecting Accounts Receivable
\n- \n
GET /folio_ledger/{date}
\n \nInspect the
\nitemsarray in the response. \ndebts_in_close_folios.cents <> 0
\n \n
Only folios matching this condition should be processed further.
\n\n
Step 2: Determine the Type of AR Change
\nOnce a folio affecting AR is identified, determine which type of AR change occurred.
\n\n
1. New Accounts Receivable Invoice
\nTo check whether a new AR invoice was issued, make the following API call:
\nGET /folios?close_date={date_from_folio_ledger}&id={folio_id_from_folio_ledger}\n\nIf the response is not empty, a new AR invoice exists.
\nData to collect for the transfer:
\n- \n
Invoice number
\n \nCustomer (debtor) details
\n \nAmounts and currency
\n \n
\n
2. AR Correction Document (Debit or Credit)
\nCorrections (debit or credit notes) are always linked to a previously issued AR invoice.
\n\n\n
Important:
\nCorrection folios are represented as changes in debts_in_close_folios of the master folio.
This check is therefore essential to correctly identify AR corrections.
\nTo identify a correction document, use:
\nGET /folios?close_date={date_from_folio_ledger}&client_folio_id={folio_id_from_folio_ledger}\n\nIf the response is not empty, the AR change is caused by a correction document.
\nData to collect for the transfer:
\n- \n
Correction document number
\n \nCustomer (debtor) details
\n \nCorrected amounts
\n \n
\n
3. Cancellation of an AR Invoice or Correction
\nCancellations are identified by the voided_at timestamp.
3.1 Cancelled AR Invoice
\nGET /folios?voided_at.gteq={date_from_folio_ledger}&id={folio_id_from_folio_ledger}\n\n3.2 Cancelled AR Correction
\nGET /folios?voided_at.gteq={date_from_folio_ledger}&client_folio_id={folio_id_from_folio_ledger}\n\nIf either call returns data, a previously issued AR document has been cancelled.
\nData to collect for the transfer:
\n- \n
Cancelled document number
\n \nCustomer (debtor) details
\n \nReference to the original document
\n \n
\n
4. Payment Applied to an AR Invoice
\nTo identify payments applied to an AR invoice, call:
\nGET /payment_logs/{date_from_folio_ledger}/credit_item_logs?folio_id={folio_id_from_folio_ledger}\n\nIf payments are found, they may be transferred to the accounting system depending on the customer’s requirements.
\n\n\n
Important:
\nPayments are often synchronized via a separate payment interface.
\nDuplications must be avoided if payments are already handled elsewhere.
\n\n
Summary
\n\n
Best Practices
\n- \n
Always start with the
\nfolio_ledgerendpoint to detect AR changes. \nTreat new invoices, corrections, cancellations, and payments as separate accounting events.
\n \nAvoid double-posting payments when a dedicated payment synchronization already exists.
\n \nUse the folio ID from the ledger as the primary reference for all follow-up API calls.
\n \n
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"
<!DOCTYPE html>\n<html lang=\"en\">\n <head>\n <meta charset=\"utf-8\">\n <title>\n Booking POST Example\n </title>\n </head>\n <body>\n <h1>Clock PMS - PMS API - Booking POST Example</h1>\n <hr/>\n <form action=\"https://sky-eu1.clock-\n software.com/pms_api/2020/1695 /bookings.yaml \" method=\"post\">\n <h2>Required fields</h2>\n Arrival: <input type=\"text\" name=\"booking[arrival]\" value=\"2015-10-31\"><br>\n Departure: <input type=\"text\" name=\"booking[departure]\" value=\"2015-11-05\"><br>\n <hr/>\n RoomTypeID: <input type=\"text\" name=\"booking[arrival_room_type_id]\"\n value=\"39\"><br>\n <h3>AND/OR</h3>\n RoomID: <input type=\"text\" name=\"booking[arrival_room_id]\" value=\"2160\"><br>\n <hr/>\n GuestLastName: <input type=\"text\" name=\"booking[guest_last_name]\"\n value=\"Smith\"><br>\n <h3>AND/OR</h3>\n GuestEMail: <input type=\"text\" name=\"booking[guest_e_mail]\"\n value=\"smith@test.com\"><br>\n <h3>AND/OR</h3>\n GuestPhoneNumber: <input type=\"text\" name=\"booking[guest_phone_number]\"\n value=\"442 987 6574\"><br>\n <hr/>\n <input type=\"submit\" value=\"Submit\">\n </form>\n </body>\n</html>\n<!DOCTYPE html>\n<html lang=\"en\">\n <head>\n <meta charset=\"utf-8\">\n <title>\n Booking PUT Example\n </title>\n </head>\n <body>\n <h1>Clock PMS - PMS API - Booking PUT Example</h1>\n <hr/>\n <form action=\"https://sky-eu1.clock-\n software.com/pms_api/2020/1695 /bookings/5181.yaml \" method=\"post\">\n <input name=\"_method\" type=\"hidden\" value=\"patch\">\n Arrival: <input type=\"text\" name=\"booking[arrival]\" value=\"2015-10-31\"><br>\n Departure: <input type=\"text\" name=\"booking[departure]\" value=\"2015-11-\n 05\"><br>\n <hr/>\n <input type=\"submit\" value=\"Submit\">\n </form>\n </body>\n</html>\n<!DOCTYPE html>\n<html lang=\"en\">\n <head>\n <meta charset=\"utf-8\">\n <title>\n Payment POST Example\n </title>\n </head>\n <body>\n <h1>Clock PMS - Base API - Payment POST Example</h1>\n <hr/>\n <form action=\"https://sky-eu1.clock-\n software.com/base_api/2020/1695/folios/8888 /credit_items.xml \" method=\"post\">\n <h2>Required fields</h2>\n price: <input type=\"text\" name=\"credit_item[value]\" value=\"5.55\"><br>\n currency: <input type=\"text\" name=\"credit_item[currency]\" value=\"USD\"><br>\n payment_type: <input type=\"text\" name=\"credit_item[payment_type]\"\n value=\"cash\"><br>\n <h2>Optional fields</h2>\n text: <input type=\"text\" name=\"credit_item[text]\" value=\"Test Payment by\n API\"><br>\n payment_sub_type: <input type=\"text\" name=\"credit_item[payment_sub_type]\"\n value=\"Some Sub Payment\"><br>\n reference_id: <input type=\"text\" name=\"credit_item[reference_id]\"\n value=\"Some reference identifiers\"><br>\n reference_text: <input type=\"text\" name=\"credit_item[reference_text]\"\n value=\"Some reference text\"><br>\n <hr/>\n <input type=\"submit\" value=\"Submit\">\n </form>\n </body>\n</html>\n<!DOCTYPE html>\n<html lang=\"en\">\n <head>\n <meta charset=\"utf-8\">\n <title>\n Charge POST Example\n </title>\n </head>\n <body>\n <h1>Clock PMS - Base API - Charge POST Example</h1>\n <hr/>\n <form action=\"https://sky-eu1.clocksoftware.com/base_api/2020/1695/folios/8888/charges.xml\" method=\"post\">\n <h2>Required fields</h2>\n Text: <input type=\"text\" name=\"charge[text]\" value=\"Test Charge\"><br>\n Price: <input type=\"text\" name=\"charge[price]\" value=\"1.50\"><br>\n Currency: <input type=\"text\" name=\"charge[currency]\" value=\"EUR\"><br>\n Service Date: <input type=\"text\" name=\"charge[service_date]\" value=\"2015-\n 10-31\"><br>\n Revenue Group: <input type=\"text\" name=\"charge[revenue_group]\"\n value=\"extra\"><br>\n <h2>Optional fields</h2>\n Qty: <input type=\"text\" name=\"charge[qty]\" value=\"1\"><br>\n Tax Percent: <input type=\"text\" name=\"charge[tax_rate]\" value=\"20\"><br>\n Tax Code: <input type=\"text\" name=\"charge[tax_code]\" value=\"700-700\"><br>\n Revenue Category: <input type=\"text\" name=\"charge[revenue_category]\"\n value=\"Test Revenue Category\"><br>\n Inventory Code: <input type=\"text\" name=\"charge[inventory_code]\" value=\"TEST00001\"><br>\n <hr/>\n <input type=\"submit\" value=\"Submit\">\n </form>\n </body>\n</html>\nSubmit a request to create a webhook.
\nImportant: Make sure that you enter the correct endpoint URL when creating a new webhook, as you can't delete it within the next 48 hours!
\nMake sure that you have enabled the logs on your end as the subscription confirmation will be located there. Once you receive it, follow the link to confirm your subscription.
\nHint: In case you missed the subscription confirmation or it was not logged simply send the same request with exactly the same endpoint!
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Checks if there is a webhook subscription for the API user sending the request
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Delete the webhook for the specific API user.
\nIt is not possible to submit a delete request within 48 hours of the PUSH/Webhook creation!
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Here you can find more information about the PUSH/Webhooks.
\nYou are able to activate/deactivate or check the current status of the PUSH/Webhooks directly through the API.
\nKindly note that only one webhook is supported per API user.
\nIf you need to change the URL, you will need to submit a delete request. The delete request can be done at least 48 hours after the webhook was created and confirmed.
\n","_postman_id":"e1f0e7d4-b2d1-4e10-af4b-3726e74f24bf","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Credit items (payments) associated with Folio.
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Get a specific credit item from a folio.
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Creates a new Payment in the folio.
\n- \n
Required parameters: value, currency, payment_type, payment_sub_type*.
\n \nOptional parameters: reference, text.
\n'* If you don't need to send payemnt sub-type use \"payment_sub_type\": \"\"
\n \n
DEPRECATED: reference_id, reference_text
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Find each custom payment purchase by ID\nMore info
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Complete the purchase. Use this method for successful payments. Required parameters: pms_token (found in redirect URL) transaction_reference (some id/number from payment service for reference)\nMore info
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Payment types are fixed: cash, card, bank, debit, on-line, check, vaucher, other, transfer,\ncross_account_transfer
\n","event":[{"listen":"prerequest","script":{"id":"610b780f-62a0-41d7-b53e-190482b530b7","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e06003e0-eb97-4559-8146-0ce7195f26b0","type":"text/javascript","exec":[""]}}],"_postman_id":"af023b10-3adb-4665-92e2-088551fd62a4","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Get folio fiscalization details.
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Update folio fiscalization details.
\nfiscal_request_code – free text field ( no length limitations ). Printed on the bottom of the folio. The label of the field can be customized by the user in Clock PMS settings.
\nfiscal_response_code – free text field ( no length limitations ). Printed on the bottom of the folio. The label of the field can be customized by the user in Clock PMS settings. If this field is not null, the folio is considered as fiscalized by the system. The setting “Wait for folio fiscalization before printing” in Clock PMS/POS, depends on this field also.
\nNote: If fiscal QR is necessary, it can be used qr_code_text field from the folios endpoint.
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Based on Clock PMS/POS API you can build a fiscal interface to comply with the local fiscal requirements.
\nYou can use the notificaiton suported by Clock PMS APi and monitor for folio_close even top trigger the fiscalization. In the event notification you will receive the ID of the closed folio so you can call back the API and fetch all the data which you need. Along with the other fields the folio supports 2 dedicated fields for local fiscal requirements (fiscalization). The fields are dedicated for integration with fiscal interfaces.
\n","_postman_id":"5a39f078-77ad-461e-8e06-317bebff70e9","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"The KID number is generated automatically during the folio close process. You can fetch the KID number using the id of the closed folio.
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Index of all folios. Returns ID list (Array of folio IDs.).
\nAccepts parameters ('folio' attributes) for filtering.
\nIf you wish to GET folios for a period, please use created_at param.
\nExample: sky-eu1.clock-software.com/base_api/s:id/a:id/folios?created_at.gt=2019-03-18T12:16:37Z
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Get folio details.
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Voiding folio.
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Get taxes from a folio.
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Get a specific tax from a folio.
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Closing a folio action.
The API user needs the right “Folio: Close” granted. Additionally the right “Folio: Close folio with outstanding balance” may be granted depending on business needs. Optional parameter “document_type_id” can be passed to close folio as invoice. The possible document_type_ids may be fetched using document_types - VIEW endpoint.
Using this endpoint you can initiate a payment transaction on a payment terminal. Please note the transaction should be completed on the specified payment terminal. The list of available terminals may be found useing payment_terminals endpoint. The sucesfull (200) respose will contain a transaction_id which you can use to chekc the transaction status with credit_card_transaction - GET endpoint.
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Important: Folios are the main financial objects in Clock. They are used for recording charges, credit items (payments) and calculating taxes (VAT, etc.).
\nFolio status: the folio can be 'open' or 'closed'
\n- \n
- Open folios : folio attributes and charges can be changed. An open folio can be considered\nto be an active customer account or open bill. 'close_date' is nil. \n
- Closed folio : folio attributes and charges cannot be changed. Closed folios can be\nconsidered to be issued documents, an invoice or closed bill. 'close_date' is not nil. \n
Validity status: a folio can be 'voided' or 'valid'
\n- \n
Voided folios : invalidated folios by users. Usually these folios are issued by mistake and\ntherefore voided. 'voided_at' is not nil.
\n \nValid folios : 'voided_at' is nil.
\n \n
Get a list of the charge templates.
\nCharge templates (PMS) / Menu Items (POS) for an account.
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Get specific charge template details by its ID.
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"The parameters from / to are mandatory.
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Get the charges from a folio.
\nPlease note: \"discount_rate\" will have a value only for the discount charges created using the standard discount functionality of Clock PMS+ and null for all other charges
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Get a specific charge from a folio.
\nPlease note: \"discount_rate\" will have a value only for the discount charges created using the standard discount functionality of Clock PMS+ and null for all other charges
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"\n
IMPORTANT NOTICE: A folio is limited to a maximum of 15,000 charges. Once this limit is reached, the folio will be automatically blocked and will not accept any further charges!
\n\n
Creates new charges to the guest bill.
\n\n
When the \"charge_template_id\" is included in the request, the charge will be created using the charge template with the given ID. Only the \"service_date\" for the charge needs to be added to the request. However, the parameters configured in the charge template can still be overridden. For example, if \"text\": \"Test charge\" is included, it will override the \"text\" value configured in the charge template.
\nPlease note: If some of the required parameters for charge creation are not configured in the used charge template, an error will be returned. The required parameters are:
\n- \n
\"revenue_group\"
\n \n\"price\"
\n \n\"text\"
\n \n
\n
IMPORTANT NOTICE: A folio is limited to a maximum of 15,000 charges. Once this limit is reached, the folio will be automatically blocked and will not accept any further charges.
\n\n
When the \"charge_template_id\" is included in the request, the charge will be created using the charge template with the given ID. Only the \"service_date\" for the charge needs to be added to the request. However, the parameters configured in the charge template can still be overridden. For example, if \"text\": \"Test charge\" is included, it will override the \"text\" value configured in the charge template.
\nPlease note: If some of the required parameters for charge creation are not configured in the used charge template, an error will be returned. The required parameters are:
\n- \n
\"revenue_group\"
\n \n\"price\"
\n \n\"text\"
\n \n
\n
Create multiple(up to 100) charges guest bill with a single call. The charges will either be successful (code 200) or will fail with the respective error code and description
\nPLEASE NOTE: the endpoint supports up to 100 charges to be created at once if you need to create more than 100 charges you will need to separate them in different calls. If you try to create more than 100 charges you will receive
\n \"error\": \"Charges exceeds the limit!\"\n\nVoiding charge from folio.
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Charges (Services, Products, etc.) related to a Folio. Charges represent the CURRENT state of attributes for a posted service/product. Previous versions (changes) of charges are not present in the Charges object. Find the full history of charge in the 'Charge Log' object.Use the POST method with the same URL to create a new charge.
\n- \n
- The right 'Charges: Create' should be granted to the API user. \n
- Upon the successful charge creation, the new charge itself will be retuned. Otherwise the error\n code 500 and its description will be returned. \n
- The Folio 'Closed Status' should be 'Open' and 'Validity status' should be 'Valid', so that charges can be accepted, \n
Modifiers (for each charge record)\nEach charge can contain several 'modifiers'. Modifiers are elements INCUDED in the charge price.\nExamples:Modifiers in PMS can be the City Tax included in the price but not posted as a separate\ncharge. Modifiers in POS can be a 'Extra cheese' price add-on to a 'Pizza' product.\nOften modifiers can have purely a 'Descriptive' meaning and no price. As in POS: 'Medium beaked'\nused as a steak descriptor.
\n","event":[{"listen":"prerequest","script":{"id":"91517eb3-78f5-497a-880e-671a331b8d81","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"604550d9-962d-447d-a26d-1154923fb67c","type":"text/javascript","exec":[""]}}],"_postman_id":"80210736-48c1-41ce-bf31-5ba5ec255b93","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Get the available users from Clock PMS+.
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Get specific user details.
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Users of the system.
\n","event":[{"listen":"prerequest","script":{"id":"ae543a42-1f8a-4a8e-bda6-6b60a0ae35ee","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"003ef23e-221d-4c50-9c8b-536234f49d55","type":"text/javascript","exec":[""]}}],"_postman_id":"0169f381-ad93-4dc2-bb34-45563f7d0f53","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Index of all companies (Array of company IDs.). It returns an ID\nlist. It can be filtered by parameters
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Get specific company details.
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Adding a company.
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Update the details of an existing company.
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Using the parameter \"archived\": true / false you can archive or re-activate a specific company.
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Get a list of all folios associated with the company. You can use parameters for data filtering.
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"Create a new company folio.
\n","auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":"