{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"d2cd8fbb-53e9-43cd-a4db-5f5757094634","name":"Clock PMS+ API Docs","description":"# Change log\n\nAll notable changes to the API will be documented here.\n\n- **\\[2026-03-30\\]**\n    \n    - **charge_template_schema_batch_charges** parameter was added to the [booking - VIEW](https://api-docs.clock-software.com/#126f6f40-e6c0-4131-98d2-702d8eaf7ee3) endpoint to expose the daily charges configured for the booking. The parameter is also permited for [booking - CREATE](https://api-docs.clock-software.com/#1c413339-c6e8-4eb4-8b0a-462a1f5a4829) / [booking - UPDATE](https://api-docs.clock-software.com/#559140b9-0043-493d-a31a-0f313854b748) endpoints.\n        \n- **\\[2026-02-18\\]**\n    \n    - Adults and children count added to the [occupancy_forecasts - VIEW](https://api-docs.clock-software.com/#32c25845-f209-4f8e-ad25-2ff6c38c5fa7) endpoint\n        \n    - **component_room_types_ids** parameter was added to [room_types - VIEW](https://api-docs.clock-software.com/#0c1502ba-ea9a-4bfa-9585-f82c1012368a) endpoint\n        \n    - **component_rooms_ids parameter** was added to [rooms - VIEW](https://api-docs.clock-software.com/#b678a0ad-b67e-4feb-80b5-d63d49ee4455) endpoint\n        \n- **\\[2025-11-25\\]**\n    \n    - New notificaiton event **folio_void** has been added. This event is triggered when a folio is voided. Since voiding can occur on both **open** and **closed** folios, a boolean parameter \"**closed**\" has been included in the message to help optimise API calls.\n        \n- **\\[2025-10-14\\]**\n    \n    - The POS charge transfer guide as been updated. The End of Day (EOD) process ([5. END OF DAY (EOD)](https://api-docs.clock-software.com/#cc654623-2e94-4b3d-8992-5ee83d53d380)) is changed;\n        \n- **\\[2025-10-10\\]**\n    \n    - [booking_charges_by_source - CREATE](https://api-docs.clock-software.com/#8870c9d6-6343-4188-ad4a-535dc77dd764) supports **charge_template_id** parameter;\n        \n- **\\[2025-09-24\\]**\n    \n    - New notificaiton event **booking_guests_update** has been added. The event is trigered upon change of guest details for active bookings (status is expected checked_in or checked_out)\n        \n\n---\n\nWelcome to Clock PMS+ API request/responce center.\n\nThe Clock API can give you a notification of certain events like booking creation, folio closing, etc. Notifications can be received through two methods: HTTP/S Push (Clock server makes a POST to a URL on your server) or Long Pooling (Your server listens on a URL on our server).\n\n**Useful links**\n\n- [Developers Center](https://developers.clock-software.com/)\n    \n- [Product updates](https://support.clock-software.com/support/solutions/9000116110).\n    \n- [Message Channels (PUSH, SQS..)](https://api-docs.clock-software.com/#message-channels-webhooks).\n    \n\n---\n\n**Ready to start?**\n\n\\=> If you want to become our partner and you are already familiar with the documentation or need a test (sandbox) account, please visit our [Developer portal](https://developers.clock-software.com/support/solutions/folders/9000197841).\n\n---\n\n# Authentication\n\nTo access the API, you need an 'api_user' and 'api_key' using the 'Digest access authentication' method.\n\n_API credentials example:_\n\n- API User: dummyapi\n    \n- API Secret key: 9e76358201fab9389db70ff16h3bb688\n    \n- Example Base API Url: sky-eu1.clock-software.com/base_api/11111/22222\n    \n\n_Terminology:_\n\n- sky-eu1 – Subscription region.\n    \n- base_api – The selected API type.\n    \n- 11111 – The customer subscription number.\n    \n- 22222 – The customer account number.\n    \n\nNote: Subscription ID and Account ID it can be found also as :subscription_id and :account_id abbreviations in our docs.\n\n---\n\n# Using parameters for data filtering\n\nAll URLs support parameter passing for filtering the result. Searching by 'Equal' (eq), 'Not equal'  \n(not_eq), 'Greater' (gt), 'Greater and equal' (gteq), 'Less' (lt), 'Less and equal' (lteq), and similar  \noperators are supported. For the full list of operators check this article :  \n[https://www.rubydoc.info/github/rails/rails/Arel/Predications](https://www.rubydoc.info/github/rails/rails/Arel/Predications)\n\n---\n\n### Before using special characters for filtering you need to encode them first\n\nExample: If you need to find the bookings with reference number #123 you need to use:\n\n```\nbookings?reference_number=#123(# is the encoded #)\n\n ```\n\ninstead of\n\n```\nbookings?reference_number=#123\n\n ```\n\n[Here](https://www.w3schools.com/tags/ref_urlencode.ASP) more information about URL encoding\n\n---\n\nSearching for an empty and NIL value is also supported.\n\nExamples:\n\n1. Searching for folios closed after a certain date-time using 'Greater or Equal' operator:  \n    **base_api/:subscription_id/:account_id/folios?closed_at.gteq=2014-12-30T06:34:58.623Z** Or ( any time zone )  \n    **base_api/:subscription_id/:account_id/folios?closed_at.gteq=22014-12-30T06:34:58.623+02:00**\n    \n2. Searching for folios with ID greater than 123:  \n    **base_api/:subscription_id/:account_id/folios?id.gt=123**\n    \n3. Searching for folios in a list of invoice numbers “456, 457, 458”:  \n    **base_api/:subscription_id/:account_id/folios?invoice_number\\[\\]=456&invoice_number\\[\\]=457&invoice_number\\[\\]=458**\n    \n4. Searching for Open (close_date is NIL), Valid (voided_at is NIL) folios  \n    **base_api/:subscription_id/:account_id/folios?close_date.eq&voided_at.eq**\n    \n5. Search for DoorKeys requested for deletion (deleted_at is NIL and delete_requested_at is NOT NIL)  \n    **pms_api/:subscription_id/:account_id/door_keys?deleted_at.eq&delete_requested_at.not_eq**\n    \n6. Search for Room Type WBE Rates ( wbe is True and bookable_type is “Pms::RoomType”)  \n    **/pms_api/:subscription_id/:account_id/rates?wbe.eq=true&bookable_type.eq=Pms::RoomType**\n    \n7. Search for bookings using guests details(all guests)  \n    **/pms_api/:subscription_id/:account_id/bookings?main_guest_free_text_search=Smith**\n    \n\n**!! Only attributes at the first object level can be used for filtering.**\n\n---\n\n# API rate limit\n\nThe rate limit is **5 calls** per second per API user. An 'HTTP/ 429 Too Many Requests' error will be returned, when this limit is exceeded\\*.\n\n**\\*If the limit is exceeded it is advisable to retry the requests which resulted in 'HTTP/ 429 Too Many Requests' with exponential backoff and max number of retries as the example bellow:**\n\ndelay = retry counter \\* 500 milliseconds\n\n1-st response 'HTTP/ 429 Too Many Requests'  \nset retry counter = 1  \ndelay = 500 milliseconds\n\n2-nd response 'HTTP/ 429 Too Many Requests'  \nset retry counter = 2  \ndelay = 1000 milliseconds\n\n...\n\nN-th response 'HTTP/ 429 Too Many Requests'  \nset retry counter = N  \ndelay = N\\*500 milliseconds\n\n---\n\n**Please note:**\n\n- **Other client errors (4xx, 5xx) indicate that you need to revise the request to correct the problem before trying again. Please do not retry them automatically**\n    \n- **To optimize the API usega please don't extract the full list of objects. Use the filter parameters to only get the data that you need. Thank you for your cooperation.**\n    \n\n---\n\n# Web Aplicaiton Firewall (WAF)\n\nThe WAF analyses each request to Clock PMS+ servers in order to identify threats and every suspicious behavior is considered as such!\n\nWAF banns every suspicious caller (IP) for 2 hours. If you are banned, please check your server logs for 403 HTTP errors. To avoid future bans you should carefully analyse your workflows and service behavior which led to error 403 and fix it to prevent them from reoccurring.\n\n---\n\n# Message channels (Webhooks)\n\nWith the Message Channels in the Clock API, you can get instant notifications of selected events. Three notification methods are used: **Pull**, **PUSH** and **SQS**.  \nPlease note that SQS message service is on-demand and they are not activated by default.  \nIf you want to activate it, please get in touch with the Support team at Clock Software and provide your account details.\n\n- **PULL**\n    \n\nThe 'Long polling' method is used.\n\n“Long polling is itself is not a true push; the long polling is a variation of the traditional polling technique, but it allows you to emulate a push mechanism when a real push is not possible, e.g.: sites with security policies that require the rejection of incoming HTTP/S Requests. With long polling, the client requests information from the server exactly as in normal polling, except it issues its HTTP/S requests (polls) at a much slower frequency. If the server does not have any information available for the client when the poll is received, instead of sending an empty response, the server holds the request open and waits for response information to become available. Once it does, the server immediately sends an HTTP/S response to the client, completing the open HTTP/S Request. In this way, the usual response latency (the time between when the information first becomes available and the next client request) otherwise associated with polling clients is eliminated.” - Wikipedia.  \nIf no messages are available, 304 http code will be returned in 30 seconds. In case of event – http code 200 will be returned.  \nWhen the Message Channel is used, the 'Check-After-Job' techniques implementation is strongly recommended: After finishing with the tasks related with the received event, check for new events through the REST methods.  \nExample: If you get a 'Folio Closed' event and export it to the accounting software, after the export itself check for newly closed folios using Folios Get URL.  \nThe Actual Event URL can be found by calling the Root URL.\n\n- **PUSH**\n    \n\nHTTP or HTTPS POST will be submitted to аn URL on your server.\n\nThe HTTP/S Push notification also has a retry feature (<u>max 3 retries with 20 seconds delay</u>) in case your URL is not reachable at the moment.\n\nA separate URL is required for each account (hotel/restaurant). To this end, a parameter, subdomain or domain for each account URL can be used. Example URL: [https://push.myhotel.com?account=123](https://push.myhotel.com?account=123)\n\n[Make sure your endpoint is ready to process Amazon SNS messages](https://docs.aws.amazon.com/sns/latest/dg/SendMessageToHttp.prepare.html)\n\n**Please Note: Only one webhook is supported per API user per account!**\n\n_Optionally the PUSH notifications may use Basic authentication for accessing your URL. If you want to have Basic authentication, you need to include the username and password in the endpoint URL as the bellow example:_\n\n[https://user:pass@ednpoint.com](https://user:pass@ednpoint.com)\n\nThe Push service uses the Amazon SNS service ([more info](https://aws.amazon.com/sns/?whats-new-cards.sort-by=item.additionalFields.postDateTime&whats-new-cards.sort-order=desc)). The POST request payload body contains an AWS SNS notification structure (json). An SNS notification contains:\n\n- Subject – it describes the event type. Example: “folio_close\", \"booking_new\", etc.\n    \n- Message – the message is in a json-formatted string and contains the ID of the object: booking_id, folio_id, etc. Example: \"Message\" : \"{\"booking_id\":999999}\"\n    \n\n_With the object ID, you can get object details using the base/pms API_\n\n**Setup of the push events**\n\n**Pre-requirements:**\n\n1. An URL for each account (hotel/restaurant) on your server.\n    \n2. Administrative access to the your Web server logs. You should be able to view POST payload body.\n    \n\nSetup\n\n1. You: Please use the [webhook create](https://api-docs.clock-software.com/#ee2ca591-aa14-40e9-89ca-52cbec2904b0) endpoint .\n    \n2. You: Check your Web server log, find the confirmation POST request. In the payload body, find the 'SubscribeURL' parameter. (an example of the request is located in the Appendix to this document).\n    \n3. You: Paste the 'SubscribeURL' in your browser and confirm the request.\n    \n4. You: Test the event notifications by creating a test booking.\n    \n\n**Keep in mind that for the initial confirmation your server logs need to be turned on and to include the full context of the payload.**\n\n- **SQS**\n    \n\nAmazon Simple Queue Service (Amazon SQS).\n\n[Read more about Amazon SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/welcome.html).\n\n**Events**\n\n| Event | Pull - example URL (The actual pull event url can be found by calling the root url) | Push - SNS notification parameters |\n| --- | --- | --- |\n| folio_close (on folio closing/document issuing) | [http://mbrocker.clock-software.com/sub/86f34135-bdb1-4cac-9d8d-da189a9e8a6d-936-folio_close](http://mbrocker.clock-software.com/sub/86f34135-bdb1-4cac-9d8d-da189a9e8a6d-936-folio_close) | Subject: \"folio_close\"  <br>Message: \"{\"folio_id\":888888}\" |\n| folio_update (on folio first level attribute change) | [http://mbrocker.clock-software.com/sub/86f34135-bdb1-4cac-9d8d-da189a9e8a6d-936-folio_update](http://mbrocker.clock-software.com/sub/86f34135-bdb1-4cac-9d8d-da189a9e8a6d-936-folio_update) | Subject: \"folio_update\"  <br>Message: \"{\"folio_id\":888888}\" |\n| folio_void (on folio void) | [http://mbrocker.clock-software.com/sub/86f34135-bdb1-4cac-9d8d-da189a9e8a6d-936-folio_void](http://mbrocker.clock-software.com/sub/86f34135-bdb1-4cac-9d8d-da189a9e8a6d-936-folio_void) | Subject: \"folio_void\"  <br>Message: \"{\"folio_id\":888888, \"closed\":true/false}\" |\n| folio_request (on folio fiscal request creation) | [http://mbrocker.clock-software.com/sub/86f34135-bdb1-4cac-9d8d-da189a9e8a6d-936-fiscal_request](http://mbrocker.clock-software.com/sub/86f34135-bdb1-4cac-9d8d-da189a9e8a6d-936-fiscal_request) | Subject: \"folio_fiscalize\"  <br>Message: \"{\"folio_id\":888888}\" |\n| folio_fiscalize (on folio fiscal request successful finish) | [http://mbrocker.clock-software.com/sub/86f34135-bdb1-4cac-9d8d-da189a9e8a6d-936-folio_fiscalize](http://mbrocker.clock-software.com/sub/86f34135-bdb1-4cac-9d8d-da189a9e8a6d-936-folio_fiscalize) | Subject: \"folio_fiscalize\"  <br>Message: \"{\"folio_id\":888888}\" |\n| housekeeping_changed (on room houskeeping status change) | [http://mbrocker.clock-software.com/sub/86f34135-bdb1-4cac-9d8d-da189a9e8a6d-936-housekeeping_changed](http://mbrocker.clock-software.com/sub/86f34135-bdb1-4cac-9d8d-da189a9e8a6d-936-housekeeping_changed) | Subject: \"housekeeping_changed\"  <br>Message: \"{\"room_id\":1111}\" |\n| booking_new (on booking creation) | [http://mbrocker.clock-software.com/sub/86f34135-bdb1-4cac-9d8d-da189a9e8a6d-936-booking_new](http://mbrocker.clock-software.com/sub/86f34135-bdb1-4cac-9d8d-da189a9e8a6d-936-booking_new) | Subject: \"booking_new\"  <br>Message: \"{\"booking_id\":999999}\" |\n| booking_update(on any booking first level attribute change) | [http://mbrocker.clock-software.com/sub/86f34135-bdb1-4cac-9d8d-da189a9e8a6d-936-booking_update](http://mbrocker.clock-software.com/sub/86f34135-bdb1-4cac-9d8d-da189a9e8a6d-936-booking_update) | Subject: \"booking_update\"  <br>Message: \"{\"booking_id\":999999}\" |\n| booking_expected(on booking status changed to 'expected') | [http://mbrocker.clock-software.com/sub/86f34135-bdb1-4cac-9d8d-da189a9e8a6d-936-booking_expected](http://mbrocker.clock-software.com/sub/86f34135-bdb1-4cac-9d8d-da189a9e8a6d-936-booking_expected) | Subject: \"booking_expected\"  <br>Message: \"{\"booking_id\":999999}\" |\n| booking_checked_in(on booking status changed to 'checked_in') | [http://mbrocker.clock-software.com/sub/86f34135-bdb1-4cac-9d8d-da189a9e8a6d-936-booking_checked_in](http://mbrocker.clock-software.com/sub/86f34135-bdb1-4cac-9d8d-da189a9e8a6d-936-booking_checked_in) | Subject: \"booking_checked_in\"  <br>Message: \"{\"booking_id\":999999}\" |\n| booking_checked_out(on booking status changed to 'checked_out') | [http://mbrocker.clock-software.com/sub/86f34135-bdb1-4cac-9d8d-da189a9e8a6d-936-booking_checked_out](http://mbrocker.clock-software.com/sub/86f34135-bdb1-4cac-9d8d-da189a9e8a6d-936-booking_checked_out) | Subject: \"booking_checked_out\"  <br>Message: \"{\"booking_id\":999999}\" |\n| booking_canceled (on booking status changed to 'canceled') | [http://mbrocker.clock-software.com/sub/86f34135-bdb1-4cac-9d8d-da189a9e8a6d-936-booking_canceled](http://mbrocker.clock-software.com/sub/86f34135-bdb1-4cac-9d8d-da189a9e8a6d-936-booking_canceled) | Subject: \"booking_canceled\"  <br>Message: \"{\"booking_id\":999999}\" |\n| booking_no_show(on booking status changed to 'no_show') | [http://mbrocker.clock-software.com/sub/86f34135-bdb1-4cac-9d8d-da189a9e8a6d-936-booking_no_show](http://mbrocker.clock-software.com/sub/86f34135-bdb1-4cac-9d8d-da189a9e8a6d-936-booking_no_show) | Subject: \"booking_no_show\"  <br>Message: \"{\"booking_id\":999999}\" |\n| confirmation_send(on booking confirmation send) | [http://mbrocker.clock-software.com/sub/86f34135-bdb1-4cac-9d8d-da189a9e8a6d-936-confirmation_send](http://mbrocker.clock-software.com/sub/86f34135-bdb1-4cac-9d8d-da189a9e8a6d-936-confirmation_send) | Subject: \"confirmation_send\"  <br>Message: \"{\"booking_id\":999999,\"emails\":\\[\"name@damain.com\"\\]}\" |\n| door_key_new(on new door key creation) | [http://mbrocker.clock-software.com/sub/86f34135-bdb1-4cac-9d8d-da189a9e8a6d-936-door_key_new](http://mbrocker.clock-software.com/sub/86f34135-bdb1-4cac-9d8d-da189a9e8a6d-936-door_key_new) | Subject: \"door_key_new\"  <br>Message: \"{\"door_key_id\":777777}\" |\n| door_key_update(on new door key processing) | [http://mbrocker.clock-software.com/sub/86f34135-bdb1-4cac-9d8d-da189a9e8a6d-936-door_key_update](http://mbrocker.clock-software.com/sub/86f34135-bdb1-4cac-9d8d-da189a9e8a6d-936-door_key_update) | Subject: \"door_key_update\"  <br>Message: \"{\"door_key_id\":777777}\" |\n| pos_order_new ( on order creation in POS) | [http://mbrocker.clock-software.com/sub/86f34135-bdb1-4cac-9d8d-da189a9e8a6d-936-pos_order_new](http://mbrocker.clock-software.com/sub/86f34135-bdb1-4cac-9d8d-da189a9e8a6d-936-pos_order_new) | Subject: \"pos_order_new\"  <br>Message: \"{\"order_id\":666666}\" |\n| booking_guests_update ( on guest update for active bookings (status in 'expected', 'checked_in', 'checked_out') | [http://mbrocker.clock-software.com/sub/86f34135-bdb1-4cac-9d8d-da189a9e8a6d-936-booking_guests_update](http://mbrocker.clock-software.com/sub/86f34135-bdb1-4cac-9d8d-da189a9e8a6d-936-pos_order_new) | Subject: \"booking_guests_update\"  <br>Message: \"{\"booking_id\":999999}\" |\n\n**HTTP/S Push – URL Confirmation**\n\n```\nPOST / HTTP/1.1x-amz-sns-message-type: SubscriptionConfirmationx-amz-sns-message-id: 165545c9-2a5c-472c-8df2-7ff2be2b3b1bx-amz-sns-topic-arn: arn:aws:sns:us-west-2:123456789012:MyTopicContent-Length: 1336Content-Type: text/plain; charset=UTF-8Host: example.comConnection: Keep-AliveUser-Agent: Amazon Simple Notification Service Agent{ \"Type\" : \"SubscriptionConfirmation\", \"MessageId\" : \"165545c9-2a5c-472c-8df2-7ff2be2b3b1b\", \"Token\" : \"2336412f37fb687f5d51e6e241d09c805a5a57b30d712f794cc5f6a988666d92768dd60a747ba6f3beb71854e285d6ad02428b09ceece29417f1f02d609c582afbacc99c583a916b9981dd2728f4ae6fdb82efd087cc3b7849e05798d2d2785c03b0879594eeac82c01f235d0e717736\", \"TopicArn\" : \"arn:aws:sns:us-west-2:123456789012:MyTopic\", \"Message\" : \"You have chosen to subscribe to the topic arn:aws:sns:us-west-2:123456789012:MyTopic.\\nTo confirm the subscription, visit the SubscribeURL included in this message.\",\"SubscribeURL\" : \"https://sns.us-west-2.amazonaws.com/?Action=ConfirmSubscription&TopicArn=arn:aws:sns:us-west-2:123456789012:MyTopic&Token=2336412f37fb687f5d51e6e241d09c805a5a57b30d712f794cc5f6a988666d92768dd60a747ba6f3beb71854e285d6ad02428b09ceece29417f1f02d609c582afbacc99c583a916b9981dd2728f4ae6fdb82efd087cc3b7849e05798d2d2785c03b0879594eeac82c01f235d0e717736\", \"Timestamp\" : \"2012-04-26T20:45:04.751Z\", \"SignatureVersion\" : \"1\", \"Signature\" : \"EXAMPLEpH+DcEwjAPg8O9mY8dReBSwksfg2S7WKQcikcNKWLQjwu6A4VbeS0QHVCkhRS7fUQvi2egU3N858fiTDN6bkkOxYDVrY0Ad8L10Hs3zH81mtnPk5uvvolIC1CXGu43obcgFxeL3khZl8IKvO61GWB6jI9b5+gLPoBc1Q=\", \"SigningCertURL\" : \"https://sns.us-west-2.amazonaws.com/SimpleNotificationService-f3ecfb7224c7233fe7bb5f59f96de52f.pem\" }\n\n ```\n\n**HTTP/S Push – Event Message Example (booking_new)**\n\n```\nPOST / HTTP/1.1x-amz-sns-message-type: Notificationx-amz-sns-message-id: 22b80b92-fdea-4c2c-8f9d-bdfb0c7bf324x-amz-sns-topic-arn: arn:aws:sns:us-west-2:123456789012:MyTopicx-amz-sns-subscription-arn: arn:aws:sns:us-west-2:123456789012:MyTopic:c9135db0-26c4-47ec-8998-413945fb5a96Content-Length: 773Content-Type: text/plain; charset=UTF-8Host: example.comConnection: Keep-AliveUser-Agent: Amazon Simple Notification Service Agent{ \"Type\" : \"Notification\", \"MessageId\" : \"22b80b92-fdea-4c2c-8f9d-bdfb0c7bf324\",\n\"TopicArn\" : \"arn:aws:sns:us-west-2:123456789012:MyTopic\",\"Subject\" : \"booking_new\",\"Message\" : \"{\\\"booking_id\\\":693926}\", \"Timestamp\" : \"2015-11-17T09:44:23.421Z\", \"SignatureVersion\" : \"1\", \"Signature\" : \"OcBCD+Wh4T1eWQxebQo8CnhM3CZJMtGSSYVw9OgSk5bera4QXO10yp0/x0XEHsL3hi5Z5B4daIJXEg0SeybsjgtCfqJ0z8WnJ/np5ErWLMK2ymPMZxJWVEQXM76shLUNBDvYEWhfeMPTCylGJVDD2YeaWZXh5M/oW6dQcxpetmoZkiahjmDsN3BQFvVbCpQ5zrfZZKBkULCo716KLKOlTMDRqK1uSSdZAbi95jOvZo9coq7vLwtn/rL2iKmmnOOh9C3Fmxegb1NvKz12B8Vxeh5l98zULb/6YhWoUVD+eAnu7dKmGuHhFhjvy+Fl1SF5TN0yI+C6/m+IEIHzi2tZVQ==\", \"SigningCertURL\" : \"https://sns.eu-west-1.amazonaws.com/SimpleNotificationService-bb750dd426d95ee9390147a5624348ee.pem\", \"UnsubscribeURL\" : \"https://sns.eu-west-1.amazonaws.com/?Action=Unsubscribe&SubscriptionArn=arn:aws:sns:eu-west-1:006467213368:PUSH_Ro_Test:fc851d44-40ec-40d5-88fc-acccfc7b5250\"}\n\n ```\n\n---\n\n# Data formats and standards\n\n| Type | Value |\n| --- | --- |\n| _DateTime_ | In JSON and XML, datetime is in an ISO 8601 format (with a time zone): \"2001-12-30T06:34:58.623Z” or \"2001-12-30T08:34:58.623+02:00”. In YAML, a 'space separated' UTC only format is used : “2001-12-30 06:34:58.6236040 Z”. All datetimes contain a time zone, so they can be converted to any other time zone without data being lost. |\n| _Date_ | A date is rendered in an ISO 8601 format: '2001-12-30'. All dates are converted from the datetime of an event to the accoount time zone and then time is stripped. Example: If a folio is closed on 31 Dec 2001 at 22:00 UTC and your time zone is +3, the folio date of closing will be 01 Jan 2002. |\n| _String_ | Up to 256 characters |\n| _Text_ | No size limitation |\n| _Decimal_ | Precision is set for each attribute. _Example: 15,4_ |\n| _Integer_ | Large-range integer : -9223372036854775808 to 9223372036854775807 |\n| _Boolean_ | 'true' / 'false' |\n| _'_cents' fields_ | All money field values are presented in sub-units in an integer format. Divide the value by 100 to get the currency unit value . Example: price_cents: 9091; currency: EUR is 90.91 EUR. There are several exceptions where 1 unit is not equal to 100 sub-units: BHD, CLF, IQD, JPY, KWD, LYD, MGA, MRO, OMR, TND, VND, VUV. In these cases, use their specific sub-unit ratio. |\n| _'_currency' fields_ | All currency fields are ISO 4217, three-letter codes. |\n| _Country fields_ | Country fields are ISO 3166-1 alpha-2 (two-letter country code). |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"8389346","team":464235,"collectionId":"d2cd8fbb-53e9-43cd-a4db-5f5757094634","publishedId":"SzKQzg2h","public":true,"publicUrl":"https://api-docs.clock-software.com","privateUrl":"https://go.postman.co/documentation/8389346-d2cd8fbb-53e9-43cd-a4db-5f5757094634","customColor":{"top-bar":"FFFFFF","right-sidebar":"130D59","highlight":"522F91"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2020-08-26T13:26:39.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/701de980625a32be8bdc40591dc8ff289df5caea5c0b46ec3a90438c96a32c1e","favicon":"https://res.cloudinary.com/postman/image/upload/v1597231634/team/tosj6abnuyyvff67s0vq.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://api-docs.clock-software.com/view/metadata/SzKQzg2h"}