LOS Records

  1. Overview
  2. Search LOS records

Overview

Check out our guide: Understanding LOS Records

Parameters

Name Type Read/Write Description
rental Integer Read Rental’s ID related to the LOS record
account Integer Read Account’s ID related to the LOS record
id BigInteger Read Uniq identifier.
kind String Read LOS record’s kind. For possible values visit the enums section.
day Date Read Day for which this LOS record is valid.
min_occupancy Integer Read Minimum occupancy for which this LOS record is valid.
max_occupancy Integer Read Maximum occupancy for which this LOS record is valid.
original_currency String Read Original currency that LOS record was generated with (useful when using exchange_to_currency query param as a reference currency).
The list of codes can be found in the enums section.
currency String Read Requested currency of the LOS records, by default same as original_currency.
The list of codes can be found in the enums section.
exchange_rate Decimal Read The rate used to convert from original_currency to currency.
rates Array Read Starting from a one day length of stay, array lists rates up to 30 days. Rate will equal 0.0, if corresponding length is invalid with minimum_stay setting.
created_at Time Read LOS record’s creation time.

Search LOS records

Search parameters allow to filter LOS records by specified fields.

Example:

GET /los_records?rental_id=1&kinds=rental_price_before_special_offers,rental_price&exchange_currency_to=EUR

Response

{
  "links": {
    "los_records.rental": "https://www.bookingsync.com/api/v3/rentals/{los_records.rental}"
  },
  "los_records": [
    {
      "id": 705,
      "currency": "EUR",
      "day": "2016-07-13",
      "exchange_rate": "1.0",
      "kind": "final_price",
      "max_occupancy": 9,
      "min_occupancy": 9,
      "original_currency": "EUR",
      "rates": [
        "0.0",
        "50.0",
        "75.0",
        "100.0",
        "125.0",
        "150.0",
        "175.0",
        "200.0",
        "225.0",
        "250.0",
        "275.0",
        "300.0",
        "325.0",
        "350.0",
        "375.0",
        "400.0",
        "425.0",
        "450.0",
        "475.0",
        "500.0",
        "525.0",
        "550.0",
        "575.0",
        "600.0",
        "625.0",
        "650.0",
        "675.0",
        "700.0",
        "725.0",
        "750.0"
      ],
      "created_at": "2015-07-27T19:20:10Z",
      "links": {
        "rental": 1
      }
    }
  ],
  "meta": {
  }
}

Search Parameters

Name Type Default Description
exchange_to_currency String   Code of the currency in which the rates are to be returned.
The accepted codes can be found in the enums section.
kinds String   List of comma separated kinds. Returns only LOS records for this kind(s).
For possible values visit the enums section.
rental_id String   Required list of comma separated IDs. Returns only LOS records for this rental(s)
updated_since Time   Only LOS records updated after given time.