API In this document you will find all the API methods we provide along with explanations for parameters and response examples.
\nAPI structure Endpoint:
\n\nHTTPS: Our API requires HTTPS. We'll respond with an appropriate error if you're not using it.
\nRequest Format: HTTP GET and POST (Content-Type: application/json)
\nResponse Format: JSON
\nOAuth 2.0 is the industry-standard protocol for authorization. OAuth 2.0 focuses on client developer simplicity while providing specific authorization flows for web applications, desktop applications, mobile phones, and living room devices.
\nOAuth 2.0 is a protocol that allows your application, after granted the correct authorization, to request (create/read/update/delete) This without getting and/or storing their password.
\nDescription: To enable connection to our API and access to client data, as well as perform payment operations, the following credentials are required:
\nAzure Directory ID of the client (Tenant):
Description: Unique identifier of the client's Azure directory.
\nFormat: Alphanumeric string.
\nExample: \"abcdefgh-1234-5678-ijkl-mnopqrstuvwx\"
\nApplication ID registered in the client's Azure (app_id):
Description: Unique identifier of the application registered in the client's Azure directory.
\nFormat: Alphanumeric string.
\nExample: \"12345678-abcd-efgh-ijkl-9876543210ab\"
\nValue of the Azure application's secret (secret_value):
Description: Secret key associated with the application registered in the client's Azure for authentication purposes.
\nFormat: Alphanumeric string.
\nExample: \"s3cr3t0p4ssw0rd\"
\nNote: These credentials are necessary to establish a connection with our API and access client data, as well as perform payment operations. Please ensure to keep these credentials confidential and do not share them with any other entities or individuals involved.
\nYou can authenticate requests using an OAuth access token.
\nDescription: To obtain the access token required for connecting to the API, two pieces of information are needed:
\nAccess Token URL:
\nDescription: The URL where the access token can be obtained.
\nExample: \"https://login.microsoftonline.com/tenant/oauth2/v2.0/token\"
\nScope:
\nDescription: The scope parameter defines the level of access requested for the API.
\nExample: \"https://api.businesscentral.dynamics.com/.default\"
\nNote: To obtain the access token, you will need to make a request to the Access Token URL, providing the necessary credentials and specifying the desired scope. The Access Token URL contains the placeholder, which should be replaced with the actual tenant ID or directory ID of the client. The resulting URL will be used to retrieve the access token required for authentication and authorization when making API calls.
\nHTTP methods The norayhtlBooking API accepts the standard HTTP methods: GET, POST, PATCH, PUT, and DELETE.
\nMake a GET request to retrieve data. GET requests will never cause an update or change to your data because they’re safe and idempotent. Use a POST request to send data to the client to perform specific actions, such as recording payment lines. For example, make a POST request to the corresponding endpoint, providing the necessary data in the request body. This allows you to send the required information to the client program, prompting it to execute the desired action, such as recording payment lines, using the provided data.
\nBusiness central standar API calls are documented in: https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/
\nThe documentation itself contains calls like Get company, that will be necessary to know the company ID (companyID) that is used in our API calls.
\nTo always get English responses regardless of the client configuration, it is neccessary to add this header:
Key: Accept-Language
Value: en-US
When the request is a POST the header needed is:
\nKey: Content-Type
Value: application/json
When the request is PATCH or DELETE the POST header is needed plus the header below:
\nKey: If-Match
Value: *
Business central have webhooks integration, to know more about it the official microsoft documentation is in the link below:
\n\nThe default Webhooks URL is: https://{businesscentralPrefix}/api/v2.0/subscriptions
\nTo implement Webhooks with our APIs, the default URL is: https://{businesscentralPrefix}/api/{APIPublisher}/{APIGroup}/{APIVersion}/subscriptions
\nThe tenant and environment name values vary according to the server, in a link like this:
https://api.businesscentral.dynamics.com/v2.0/12345678-90ab-cdef-1234-567890abcdef/ServerName/api/< api publisher >/
The tenant would be 12345678-90ab-cdef-1234-567890abcdefand environment name would be ServerName.
The ID specified in the different functions like bookingStatus or checkout refers to the SystemID of the required data.
\nFor example:
https://api.businesscentral.dynamics.com/v2.0/< tenant >/< environment name >/api/< api publisher >/room/v1.0/companies(< company ID >)/lockRooms( < Room ID > )
The Room ID is the System ID of the selected Room.
In the GET functions you can apply certain filters to access the information more accurately.
\nThe table below contains all the operators that can be use and the ones not supported:
\nFor more details you can visit the Microsoft filtering documentation
\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"29402044","collectionId":"8e0ea5d7-6977-4953-beea-1a689b0c2d9e","publishedId":"2s9YCAQ9rx","public":true,"customColor":{"top-bar":"6689CC","right-sidebar":"404040","highlight":"F4B237"},"publishDate":"2024-01-30T10:07:24.000Z"},"item":[{"name":"Noray Htl","item":[{"name":"booking","item":[{"name":"bookings","id":"aadcfb2c-fe12-4c8f-8b4d-b80fc6eedcf1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":"System table: Booking HTL
Page in Business Central: Bookings HTL
Returns the list of bookings with its associated data.
\nIt is possible to expand its content with the method $expand, with guests, rating(bookingValues), hotel item entries (hotelItemEntries) and room.
\nPARAMS
\n","urlObject":{"protocol":"https","path":["v2.0","{tenant}","{environmentName}","api","noray","booking","v1.0","companies({companyId})","bookings"],"host":["api","businesscentral","dynamics","com"],"query":[],"variable":[]}},"response":[{"id":"cad73bee-a06d-411b-96b5-608d7ced7a65","name":"200","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.businesscentral.dynamics.com/v2.0/System table: Booking Additional Serv. HTL
Page in Business Central: Booking Additional Serv. HTL
Returns the status of the selected booking.
\nThe status can be any of this values:
\nBooking
\nPencil Booking
\nOccupancy
\nCheckout
\nCancelled
\nNo-Show
\nModifies the value of bookingNotes in the selected booking.
\nPARAMS
\n","urlObject":{"protocol":"https","path":["v2.0","{tenant}","{environmentName}","api","noray","booking","v1.0","companies({companyId})","bookings(System table: Municipality HTL
Page in Business Central: Municipality HTL
System table: Guest HTL
Page in Business Central: Guest HTL
Returns the list of guest with its associated data.
\nPARAMS
\n","urlObject":{"protocol":"https","path":["v2.0","{tenant}","{environmentName}","api","noray","booking","v1.0","companies({companyId})","guests"],"host":["api","businesscentral","dynamics","com"],"query":[],"variable":[]}},"response":[{"id":"de034024-ec84-4f7c-96bf-d2f15980f618","name":"200","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"If-Match","value":"*","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"bookingNo\": \"RH0000003\",\r\n \"lineNo\": 1,\r\n \"contactNo\": \"CO0000028\",\r\n \"name\": \"Client name\",\r\n \"firstName\": \"Client\",\r\n \"middleName\": \"\",\r\n \"surname\": \"name\",\r\n \"age\": 52,\r\n \"sex\": \"Male\",\r\n \"address\": \"\",\r\n \"postCode\": \"\",\r\n \"municipalityNo\": \"\",\r\n \"phone\": \"123456789\",\r\n \"documentType\": \"NIF/NIE\",\r\n \"documentNo\": \"12345678A\",\r\n \"dateIssued\": \"0001-01-01\",\r\n \"expirationDate\": \"0001-01-01\",\r\n \"familityRelationship\": \" \",\r\n \"email\": \"client@client.com\",\r\n \"nacionality\": \"ESP\",\r\n \"originatingNo\": \"114\",\r\n \"mobilePhoneNo\": \"\",\r\n \"birthDate\": \"1970-01-01\",\r\n \"allowMailList\": false,\r\n \"categoryNo\": \"REP\",\r\n \"resident\": false,\r\n \"arrivalDate\": \"2022-08-31\",\r\n \"departureDate\": \"2022-09-01\",\r\n \"invoicedBoardBasis\": \"MP\",\r\n \"totalStays\": 0,\r\n \"specialDate1\": \"0001-01-01\",\r\n \"specialDateDescription1\": \"\",\r\n \"specialDate2\": \"0001-01-01\",\r\n \"specialDateDescription2\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.businesscentral.dynamics.com/v2.0/< tenant >/< environment name >/api/< api publisher >/booking/v1.0/companies(< company ID >)/guests"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; odata.metadata=minimal; odata.streaming=true"},{"key":"Content-Encoding","value":"br"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Authorization"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"ms-correlation-x","value":"95e12384-2d4d-c038-25e7-18dedf7ef801"},{"key":"mise-correlation-id","value":"f88848d7-f279-4161-ad00-d42d05982d71"},{"key":"OData-Version","value":"4.0"},{"key":"Access-Control-Expose-Headers","value":"Date, Content-Length, Server, OData-Version"},{"key":"Access-Control-Expose-Headers","value":"ms-correlation-x"},{"key":"request-id","value":"39bca68c-b9eb-41bf-9b98-a8adde7af6cb"},{"key":"x-content-type-options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Date","value":"Wed, 26 Jul 2023 10:19:27 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"@odata.context\": \"https://api.businesscentral.dynamics.com/v2.0/Modifies the selected guest data.
\n","urlObject":{"protocol":"https","path":["v2.0","{tenant}","{environmentName}","api","noray","booking","v1.0","companies({companyId})","guests(Adds an existing guest from another booking in the current booking.
\nThe bookingNo value in the body is the no of the booking that contains the original guest, the booking that will have the inserted guest is the one that is setted in the URL as ID in the booking(ID) part.
\nThe booking only can be in Booking or Pencil Booking Status to be able to insert guest.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientId","value":"{clientID}"},{"key":"accessTokenUrl","value":"Insert a guest in the selected booking.
\nThe booking only can be in Booking or Pencil Booking Status to be able to insert guest.
\nEach value max size is 30 characters.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientId","value":"{clientID}"},{"key":"accessTokenUrl","value":"