List bookings

Get all bookings by property id

Scope

Property Get / Property Set

List bookings

Endpoint

GET https://yourdomain.com/bookyflow/api/listbooking/{{property_id}}/

Path Parameters

Parameter	Description
`{{property_id}}`	(Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "listbooking": [
      {
        "contract_uid": 79,
        "arrival": "2019/10/23",
        "departure": "2019/10/26",
        "contract_total": 50,
        "tag": "15185494",
        "currency_code": "EUR",
        "booked_in": 1,
        "bookedout": 0,
        "deposit_required": "50",
        "deposit_paid": 0,
        "special_reqs": "",
        "timestamp": "2019-10-23 11:00:23",
        "cancelled": 0,
        "invoice_uid": 28,
        "property_uid": 1,
        "approved": 1,
        "last_changed": "2019-10-23 13:09:50",
        "firstname": "asdf",
        "surname": "asdf",
        "tel_landline": "asdf",
        "tel_mobile": "asdf",
        "email": "asdf@test.com",
        "imgColor": "green",
        "TxtStatus": "Current Resident"
      },
      {
        "contract_uid": 61,
        "arrival": "2019/09/12",
        "departure": "2019/09/13",
        "contract_total": 84,
        "tag": "98880359",
        "currency_code": "EUR",
        "booked_in": 0,
        "bookedout": 0,
        "deposit_required": "16.8",
        "deposit_paid": 1,
  ...
  (Response truncated for brevity)
}

Get booking dates

Endpoint

GET https://yourdomain.com/bookyflow/api/listbooking/{{property_id}}/{{contract_id}}/arr-dep

Path Parameters

Parameter	Description
`{{property_id}}`	(Required parameter)
`{{contract_id}}`	(Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "listbookingarrdep": [
      {
        "BOOKING_ARRIVAL": "Thursday, 20 June 2019",
        "BOOKING_DEPARTURE": "Friday, 21 June 2019",
        "NUM_NIGHTS": 1,
        "BOOKINGTYPE": "Internet",
        "BOOKERSUSERNAME": "partner",
        "SPECIALREQS": ""
      }
    ]
  },
  "meta": {
    "code": 200
  }
}

Get booking guest details

Endpoint

GET https://yourdomain.com/bookyflow/api/listbooking/{{property_id}}/{{contract_id}}/guest

Path Parameters

Parameter	Description
`{{property_id}}`	(Required parameter)
`{{contract_id}}`	(Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "listbookingguest": [
      {
        "GUEST_FIRSTNAME": "qwer",
        "GUEST_SURNAME": "qwer",
        "GUEST_HOUSE": "qwer",
        "GUEST_STREET": "qwer",
        "GUEST_TOWN": "qwer",
        "GUEST_REGION": "Baden-Wurttemberg",
        "GUEST_COUNTRY": "Germany",
        "GUEST_POSTCODE": "qwer",
        "GUEST_TEL_LANDLINE": "qwer",
        "GUEST_TEL_MOBILE": "qwer",
        "GUEST_VAT_NUMBER": "",
        "EMAIL_LINK": "mailto:qwer@test.com?subject=Booking number 12670079 @ Fawlty Towers&body=Dear Qwer Qwer RE Booking number 12670079",
        "EMAIL_ADDRESS": "qwer@test.com",
        "GUEST_IMAGE": "/joomla_portal/bookyflow/assets/images/noimage.gif"
      }
    ]
  },
  "meta": {
    "code": 200
  }
}

Get booking room details

Endpoint

GET https://yourdomain.com/bookyflow/api/listbooking/{{property_id}}/{{contract_id}}/rooms

Path Parameters

Parameter	Description
`{{property_id}}`	(Required parameter)
`{{contract_id}}`	(Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "listbookingrooms": [
      {
        "_BOOKYFLOW_COM_MR_EB_ROOM_NAME": "Room name",
        "RINFO_NAME": "asdf",
        "_BOOKYFLOW_COM_MR_LISTTARIFF_RATETITLE": "Tariff title",
        "RINFO_TARIFF": "",
        "_BOOKYFLOW_COM_MR_EB_ROOM_NUMBER": "Room",
        "RINFO_NUMBER": "03",
        "_BOOKYFLOW_COM_MR_EB_ROOM_FLOOR": "Floor",
        "RINFO_ROOM_FLOOR": "",
        "_BOOKYFLOW_COM_MR_EB_ROOM_MAXPEOPLE": "Max people",
        "RINFO_MAX_PEOPLE": "2",
        "_BOOKYFLOW_COM_MR_EB_ROOM_CLASS_ABBV": "Room/property type",
        "TYPE": "Room 4 Poster bed"
      },
      {
        "_BOOKYFLOW_COM_MR_EB_ROOM_NAME": "Room name",
        "RINFO_NAME": "",
        "_BOOKYFLOW_COM_MR_LISTTARIFF_RATETITLE": "Tariff title",
        "RINFO_TARIFF": "Tariff",
        "_BOOKYFLOW_COM_MR_EB_ROOM_NUMBER": "Room",
        "RINFO_NUMBER": "02",
        "_BOOKYFLOW_COM_MR_EB_ROOM_FLOOR": "Floor",
        "RINFO_ROOM_FLOOR": "",
        "_BOOKYFLOW_COM_MR_EB_ROOM_MAXPEOPLE": "Max people",
        "RINFO_MAX_PEOPLE": "2",
        "_BOOKYFLOW_COM_MR_EB_ROOM_CLASS_ABBV": "Room/property type",
        "TYPE": "Room Double beds"
      }
    ]
  },
  "meta": {
    "code": 200
  }
}

Get booking balance details

Endpoint

GET https://yourdomain.com/bookyflow/api/listbooking/{{property_id}}/{{contract_id}}/payment

Path Parameters

Parameter	Description
`{{property_id}}`	(Required parameter)
`{{contract_id}}`	(Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "listbookingpayment": [
      {
        "SINGLE_PERSON_SUPPLIMENT": "0.00\u20ac",
        "ROOM_TOTAL": "105.00\u20ac",
        "DEPOSITPAID": "No",
        "BOOKING_DEPOSIT_REQUIRED": "42.50\u20ac",
        "BOOKING_CONTRACT_TOTAL": "212.50\u20ac",
        "BOOKING_DEPOSIT_REF": null,
        "TAX": "21.00\u20ac",
        "EXTRASOPTIONSVALUE": "86.50\u20ac",
        "GRAND_TOTAL": "212.50\u20ac",
        "REMAINDER_TO_PAY": "158.50\u20ac"
      }
    ]
  },
  "meta": {
    "code": 200
  }
}

Get booking notes

Endpoint

GET https://yourdomain.com/bookyflow/api/listbooking/{{property_id}}/{{contract_id}}/notes

Path Parameters

Parameter	Description
`{{property_id}}`	(Required parameter)
`{{contract_id}}`	(Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "listbookingnotes": [
      {
        "NOTE": " Room 4 Poster bed has been discounted from 100.00\u20ac to 70.00\u20ac  Room Double beds has been discounted from 80.00\u20ac to 56.00\u20ac ",
        "DATETIME": "2019-05-29 13:39:35",
        "EDITLINK": "http://localhost/joomla_portal/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=editnote&note_id=4&contract_uid=26",
        "EDITTEXT": "Edit note",
        "DELETELINK": "http://localhost/joomla_portal/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=deletenote&note_id=4&contract_uid=26",
        "DELETETEXT": "Delete note"
      },
      {
        "NOTE": "Payment method :  cheque",
        "DATETIME": "2019-05-29 13:39:43",
        "EDITLINK": "http://localhost/joomla_portal/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=editnote&note_id=5&contract_uid=26",
        "EDITTEXT": "Edit note",
        "DELETELINK": "http://localhost/joomla_portal/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=deletenote&note_id=5&contract_uid=26",
        "DELETETEXT": "Delete note"
      },
      {
        "NOTE": "bob hi<br/>",
        "DATETIME": "2019-05-29 13:39:35",
        "EDITLINK": "http://localhost/joomla_portal/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=editnote&note_id=6&contract_uid=26",
        "EDITTEXT": "Edit note",
        "DELETELINK": "http://localhost/joomla_portal/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=deletenote&note_id=6&contract_uid=26",
        "DELETETEXT": "Delete note"
      }
    ]
  },
  "meta": {
    "code": 200
  }
}

Get bookings between dates

Endpoint

GET https://yourdomain.com/bookyflow/api/listbooking/{{property_id}}/{{bookings_get_start_date}}/{{bookings_get_end_date}}

Path Parameters

Parameter	Description
`{{property_id}}`	(Required parameter)
`{{bookings_get_start_date}}`	(Required parameter)
`{{bookings_get_end_date}}`	(Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "listbookingdate": [
      {
        "contract_uid": 56,
        "arrival": "2019/09/11",
        "departure": "2019/09/13",
        "contract_total": 340,
        "tag": "19289180",
        "currency_code": "EUR",
        "booked_in": 0,
        "bookedout": 0,
        "deposit_required": "68",
        "deposit_paid": 0,
        "special_reqs": "",
        "timestamp": "2019-09-02 14:20:21",
        "cancelled": 0,
        "invoice_uid": 15,
        "property_uid": 1,
        "approved": 1,
        "last_changed": "2019-09-02 16:20:22",
        "firstname": "asdf",
        "surname": "asdf",
        "tel_landline": "asdf",
        "tel_mobile": "asdf",
        "email": "asdf@test.com",
        "imgColor": "red",
        "TxtStatus": "Has not arrived"
      },
      {
        "contract_uid": 60,
        "arrival": "2019/09/11",
        "departure": "2019/09/12",
        "contract_total": 84,
        "tag": "91758497",
        "currency_code": "EUR",
        "booked_in": 0,
        "bookedout": 0,
        "deposit_required": "16.8",
        "deposit_paid": 1,
  ...
  (Response truncated for brevity)
}