Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

parameter

type

description

mandatory?

link

Yes

user

integer

user credentials, 4-digit digits integer

Yes

password

string

password credentials

Yes

lodgings

Yes

lodging

You can send availability for 1 property or for multiple ones, using different <lodging> nodes.

Yes

lodging_id

integerproperty

ID, it will be a 8-digit digits integer

Yes

currency

string

EUR, USD… The currency of the PMSconfigured in Icnea.

Yes

dates

Yes

date

You can send different dates in the same call with different <date> nodes.

Yes

day

date

Date Day that you want to update prices or availability. Format : yyyy-mmMM-dd

Yes

rooms

Node → node information room

Yes

adds_on_stay

→ node information add_on_stay

No

room

This node is used to create all the rooms of the property.

If the property is a vacation rentals type (apartment, villa, house, etc) there will be only 1 room.
If the property is a hotel type (hotel, youth hotel, etc) then there can be multiple room types.

Code Block
languagexml
<room>
  <room_id>character(10)</room_id>
  <room_label>character(50)</room_label>
  <availability>integer(3)</availability>
  <room_units>
    <units>
      <unit_id>character(10)</unit_id>
      <availability>integer(3)</availability>
    </units>
  </room_units>
  <rates>...</rates>
  <adds_on_room>...</adds_on_room>
</room>

parameter

type

description

mandatory?

room_id

string

Yes

room_label

string

No

availability

integer

Yes

room_units

No

units

No

unit_id

string

No

availability

integer

No

rates

→ node information rate

Yes

adds_on_room

→ node information add_on_room

No

rate

This node is used to create all the rates that the property have.

They can be standard/non-refundable, or occupancy rates.

For example:

  • Standard 2pax rate

  • Non-refundable 2pax rate

  • Standard 4pax rate

  • etc

Code Block
languagexml
<rate>
  <rate_id>character(10)</rate_id>
  <rate_label>character(50)</rate_label>
  <people>integer(2)</people>
  <price>decimal</price>
  <discount>decimal</discount>
  <minimum_stay>integer(3)</minimum_stay>
  <rate_nights>integer(3)</rate_nights>
  <closed_to_arrival>false/true</closed_to_arrival>
  <closed_to_departure>false/true</closed_to_departure>
  <non_refundable>false/true</non_refundable>
</rate>

parameter

type

description

mandatory?

rate_id

string

Yes

rate_label

string

No

people

integer

Yes

price

decimal

Yes

discount

decimal

No

minimum_stay

integer

No

rate_nights

integer

No

closed_to_arrival

boolean

No

closed_to_departure

boolean

No

non_refundable

boolean

No

add_on_room

This node can be used to add suplements. Those suplements must be created in Icnea PMS, if they are not, they will not be saved.

Code Block
languagexml
<add_on_room>
  <add_on_room_id>integer(2)</add_on_room_id>
  <add_on_room_label>character(50)</add_on_room_label>
  <price>decimal</price>
  <price_per_person>false/true</price_per_person>
  <maximum>integer(3)</maximum>
</add_on_room>

The <adds_on_room> node is not mandatory, but if used, then there are some variables mandatory.

parameter

type

description

mandatory?

add_on_room_id

integer

Yes

add_on_room_label

string

No

price

decimal

Yes

price_per_person

boolean

Yes

maximum

integer

No

add_on_stay

This node is used to add extra fees besides the stay price.

At the moment, Icnea accepts 2 extra fees:

  • cleaning fee

  • booking fee

Code Block
languagexml
<add_on_stay>
  <add_on_stay_id>integer(2)</add_on_stay_id>
  <add_on_stay_label>character(50)</add_on_stay_label>
  <price>decimal</price>
  <price_per_person>false/true</price_per_person>
  <maximum>integer(3)</maximum>
  <required>false/true</required>
</add_on_stay>

The <adds_on_stay> node is not mandatory, but if used, then there are some variables mandatory:

parameter

type

description

mandatory?

add_on_stay_id

integer

Yes

add_on_stay_label

string

No

price

decimal

Yes

price_per_person

boolean

Yes

maximum

integer

No

required

boolean

Yes

...

Response:

If the update is successful, the answer will be:

...