Overview

Scope

Property Get / Property Set

Get bookings due checkin

Endpoint

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

Lists the bookings that are due to be checked in today

Path Parameters

Response Example

Status: OK (200)

{
  "data": {
    "checkin": [
      {
        "contract_uid": 80,
        "arrival": "2019/10/25",
        "departure": "2019/10/26",
        "deposit_paid": 0,
        "tag": "33022729",
        "booked_in": 0,
        "bookedout": 0,
        "cancelled": 0,
        "invoice_uid": 29,
        "firstname": "partner",
        "surname": "partner",
        "property_uid": 1
      }
    ]
  },
  "meta": {
    "code": 200
  }
}

Get bookings check out

Endpoint

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

Bookings due to checkout today

Path Parameters

Response Example

Status: OK (200)

{
  "data": {
    "checkout": [
      {
        "contract_uid": 79,
        "arrival": "2019/10/23",
        "departure": "2019/10/25",
        "deposit_paid": 0,
        "tag": "15185494",
        "booked_in": 1,
        "bookedout": 0,
        "cancelled": 0,
        "invoice_uid": 28,
        "firstname": "asdf",
        "surname": "asdf",
        "property_uid": 1
      }
    ]
  },
  "meta": {
    "code": 200
  }
}

Get current residents

Endpoint

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

Path Parameters

Response Example

Status: OK (200)

{
  "data": {
    "resident": [
      {
        "contract_uid": 79,
        "arrival": "2019/10/23",
        "departure": "2019/10/25",
        "deposit_paid": 0,
        "tag": "15185494",
        "booked_in": 1,
        "bookedout": 0,
        "cancelled": 0,
        "invoice_uid": 28,
        "firstname": "asdf",
        "surname": "asdf",
        "property_uid": 1
      }
    ]
  },
  "meta": {
    "code": 200
  }
}

Get overview statistics

Endpoint

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

Path Parameters

Response Example

Status: OK (200)

{
  "data": {
    "statistic": [
      {
        "sts_checkin": 1,
        "sts_checkin_bookin": 0,
        "sts_checkout": 1,
        "sts_checkout_bookout": 0,
        "sts_resident": 1
      }
    ]
  },
  "meta": {
    "code": 200
  }
}