Skip to content
View as Markdown

Get the presence report (night register).

GET/api/reports/presence

Returns the guests present per night, as one entry per day in date order. Only guests who are actually checked in are counted, split per age group; group on reservationNumber to ignore the age groups. A guest counts from the check-in day up to but not including the registered check-out day, and a stay without a registered check-out keeps counting, so a forgotten check-out keeps that guest in the register every night after. Days run from midnight UTC, so a check-in or check-out registered just after local midnight can land on the neighbouring day. Paging is on reservations, so a stay is never split across pages and X-Total-Count is the number of reservations. Every page repeats all days in the range and fills them with the reservations of that page only, so the days must be merged across pages: an empty items array on a single page does not mean nobody was present. Once every page is merged, a day with nobody present keeps an empty items array, so “nobody there” differs from “not delivered”.

  • dateFromstringrequired
  • dateTostringoptional
  • groupedbooleanoptional
    Default: false
  • includeCancelledbooleanoptional
    Default: false
  • accommodationCategorynumberoptional
  • offsetnumberoptional
    Default: 0
  • limitnumberoptional
    Default: 25

Array of object

Schema shown for 200 · application/json

  • datestringoptional
  • itemsobject[]optional
    Show array — 13 properties
    • reservationIdnumberoptional
    • reservationNumberstringoptional
    • reservationNamestringoptional
    • reservationAccommodationTitlestringoptional
    • reservationAccommodationUnitNumberstringoptional
    • reservationDateFromstringoptional
    • reservationDateTostringoptional
    • ageGroupSpecificationDescriptionstringoptional
    • numOfPersonsnumberoptional
    • guestLocalitystringoptional
    • guestCountrystringoptional
    • guestDocumentTypestringoptional
    • modifiedstringoptional

      The reservation timestamp. It also moves for edits unrelated to the register, so it helps spot changes but is not a change filter.