List Reservation entities.

Fetches a summarised list of all Reservation entities

GETRequest

import { RecranetApiClient } from "@recranet/sdk";

const client = new RecranetApiClient({ apiKey: process.env.RECRANET_API_KEY! });

const result = await client.reservations.summaries({
  organization: 0,
  dateFrom: new Date("2026-06-01"),
  dateTo: new Date("2026-06-01"),
});

Responses

200400

Response 200

Successful response

application/json

Example responseGenerated from schema

[
  {
    "id": 1000,
    "token": "fdffb9ad-eeba-40da-9592-23b2c6ee067a",
    "number": "2024-0001",
    "name": "Cash",
    "reference": "",
    "source": "web",
    "date": "2024-04-01T12:12:00Z",
    "dateFrom": "2024-05-09T00:00:00Z",
    "dateTo": "2024-05-12T00:00:00Z",
    "notes": "",
    "checkin": "2024-05-09T14:00:00Z",
    "checkout": "2024-05-12T11:00:00Z",
    "numOfDays": 1000,
    "numOfPersons": 1000,
    "preferredUnitForGuest": true,
    "totalPrice": 108.5,
    "balance": 108.5,
    "advance": 95,
    "status": "cancelled",
    "closed": false,
    "paymentStatus": "payment-due",
    "orderLinesTotal": 95,
    "supplementOrderLinesTotal": 13.5,
    "supplementOrderLinesIncludedTotal": 0,
    "depositOrderLinesTotal": 0,
    "paymentChargeLinesTotal": 0,
    "cancellationInsuranceChargeLinesTotal": 0,
    "taxTotal": 0,
    "confirmed": true,
    "cancelled": false,
    "denied": false,
    "locale": "nl",
    "created": "2024-07-02T14:05:53Z",
    "modified": "2024-07-02T14:05:53Z",
    "accommodation": {
      "id": 1000,
      "title": "Zandsteeg 58",
      "locale": "nl",
      "category": {
        "id": 1000,
        "title": "Vakantiewoningen",
        "description": "Vakantiewoningen",
        "locale": "nl"
      }
    },
    "accommodationUnit": {
      "id": 1000,
      "number": "Zandsteeg 58",
      "locale": "nl"
    },
    "groupReservation": {
      "id": 1000,
      "token": "f1070d5c-b408-45b5-904a-cbd2f5f87ffb"
    },
    "guest": {
      "id": 1000,
      "email": "johnny@example.com",
      "firstName": "Johnny",
      "surname": "Cash",
      "surnamePrefix": null,
      "salutation": "male",
      "phoneNumber": "+31612345678",
      "phoneNumberHome": "+31118202019",
      "phoneNumberWork": "+31118202019",
      "address": "Akkerstraat",
      "addressNo": "143",
      "postalCode": "5293AJ",
      "locality": "Gemonde",
      "country": "NL",
      "locale": "nl",
      "birthDate": "1992-07-02T00:00:00Z",
      "membership": null,
      "iban": null,
      "ibanAccountName": null,
      "bic": null
    },
    "guests": [
      {
        "id": 1000,
        "email": "jacqueline@example.com",
        "firstName": "Jacqueline",
        "surname": "Cash",
        "surnamePrefix": null,
        "salutation": "male",
        "phoneNumber": "+31612345678",
        "phoneNumberHome": "+31118202019",
        "phoneNumberWork": "+31118202019",
        "address": "Akkerstraat",
        "addressNo": "143",
        "postalCode": "5293AJ",
        "locality": "Gemonde",
        "country": "NL",
        "locale": "nl",
        "birthDate": "1992-07-02T00:00:00Z",
        "membership": null,
        "iban": null,
        "ibanAccountName": null,
        "bic": null
      }
    ],
    "ageGroupLines": [
      {
        "id": 1000,
        "description": "Volwassenen",
        "quantity": 2,
        "ageGroupSpecification": {
          "id": 1000
        }
      }
    ],
    "orderLines": [
      {
        "id": 1000,
        "description": "Volwassenen",
        "validFrom": "2024-05-09T00:00:00Z"
      }
    ]
  }
]

Response 400

Bad request

application/json

Example 1

{
  "statusCode": 400,
  "description": "Bad request",
  "errors": [
    "Bad request"
  ]
}

Query parameters

• organizationnumberrequired

  Organization ID

• dateFromstringrequired
• dateTostringrequired
• referenceDatestringoptional
• accommodationnumberoptional
• confirmedbooleanoptional
• modifiedSincestringoptional
• includeClosedbooleanoptional
• offsetnumberoptional
  Default: 0
• limitnumberoptional
  Default: 25

Returns

Array of object

Schema shown for 200 · application/json

Loading response fields…