Reservation
idcodeCode of the reservation in ImmobiNet (the one shown in the application and given to the customer). null if it has none.
external_codeCode of the reservation in an external system (e.g. the OTA confirmation code).
statusdeleted when deleted_at is set, whatever the status: this is the case of every reservation deleted or
cancelled in the application (cancelled, cancelled with a penalty, turned into an owner hold, to be
handled). Otherwise the status of the reservation:
awaiting_down_payment, confirmed, checked_in, checked_out, handled (managed by a channel). The values
cancelled, reversed (cancelled with a penalty), owner_hold (turned into a hold of the owner) and
to_be_handled (received from a channel, not yet handled) appear only for some reservations received from a channel,
which have no deleted_at.
A status defined by the agency and not listed here is returned with its own name: treat unknown values as
valid.
updated_atLast modification time.
deleted_atTime the reservation was deleted or cancelled in the application (status is then deleted); null otherwise
property_idarrivaldeparturecontact_idId of the customer's contact (see /api/v1/contacts); null if the customer has no contact (only a typed name, which the API does not expose). Name, email and the other data of the customer are in the contact.
Amounts in euro.
channelChannel the reservation comes from.
Links to the guest area of the reservation, one for each language of the installation: the key is the language code (as language of the contacts, e.g. it, en), the value the link in that language. Pick the one of the guest's language (customer → /contacts/{id} → language). The whole field is null if the guest area is not available, the reservation is deleted (deleted_at set) or the guest area cannot be opened for it (e.g. access blocked after arrival or departure), or if the API user cannot see customers' personal data (anagrafica_personale_tutti privilege), because the link opens the customer's full data (it is null even when the customer's name is shown). The guest area can stop being accessible over time (access blocked after arrival or departure) without the reservation changing, so a link read earlier may no longer work and updated_since does not report it. Read it when needed, do not store it.
Custom fields defined by the agency (key → value). Empty object if there are none.
ReservationGuests
adultsteenagerschildreninfantsReservationAmounts
stayPrice of the stay (sum of the components that make the price).
totalTotal to be paid, all components included. Does not include security_deposit.
down_paymentDown payment (the Italian caparra) asked to confirm the reservation, an advance on the price. null if not set.
security_depositSecurity deposit (the Italian cauzione), a guarantee that is not part of total. null if not set.

