Accommodation
The accommodation is the main resource of the application.
The accommodation object contains all the information about the accommodation, and the state of the certificates.
Properties
id
Unique identifier for the accommodation.
| Type | Format |
|---|---|
string | uuid |
slug
Unique identifier for the accommodation used in the URL.
| Type | Format |
|---|---|
string | /^[a-z0-9]{3,6}$/ |
name
The name of the accommodation.
| Type | Format |
|---|---|
string | Nothing special |
providerName
This name of the accommodation provider.
| Type | Format |
|---|---|
string or null | Nothing special |
providerTaxNumber
This tax number of the accommodation provider.
| Type | Format |
|---|---|
string or null | /^\d{8}-\d-\d{2}$/ |
postalCode
This postal code of the accommodation.
| Type | Format |
|---|---|
string or null | /^\d{4}$/ |
locality
This locality of the accommodation.
| Type | Format |
|---|---|
string or null | /^[A-Z]{2}$/ |
reportingId
The reporting id of the accommodation. Provided by NTAK system.
| Type | Format |
|---|---|
string or null | /^[A-Z0-9]{8}$/* |
* We are just assuming this format is constant
active
It defines the accommodation actively sending the reports to NTAK.
| Type | Format |
|---|---|
boolean | Nothing special |
hasLiveCertificate
It defines the accommodation has verified certificate.
| Type | Format |
|---|---|
boolean | Nothing special |
hasPendingCertificate
It defines the accommodation has certificate that needs to be verified.
| Type | Format |
|---|---|
boolean | Nothing special |
dailyCloseUrl
PMS endpoint where NTAK.guru will fetches the data for the daily close report.
| Type | Format |
|---|---|
string | url |
callbackUrl
PMS endpoint where NTAK.guru sends the webhook.
| Type | Format |
|---|---|
string or null | url |
expireAt
The expiration date of the verified certificate.
| Type | Format |
|---|---|
string or null | Y-m-d\TH:i:sP |
createdAt
The date when was the accommodation registered into NTAK.guru.
| Type | Format |
|---|---|
string | Y-m-d\TH:i:sP |