PMS (Property Management)

Mews, Opera (OXI, OHIP)

Good to know: Splitting your product into fundamental concepts, objects, or areas can be a great way to let readers deep dive into the concepts that matter most to them.

Sync Member

With this method you can synchronize a Peoplevine member to PMS.

Request

GET GET https://connect.peoplevine.com/pms/sync_member?auth_id=...&company=...&user=...&pass=...&host=...&member_id=

Parameter	Description
auth_id	Peoplevine integration account ID
company	Peoplevine company ID
user	Peoplevine user name
pass	Peoplevine user password
host	Optional. Values: region 1(default), region 2(UK)
member_id	Peoplevine member ID

Response

Success response

{
    "success": true,
    "reason": null,
    "message": null,
    "success_count": 1,
    "error_count": 0
}

Error response

{
    "success": false,
    "reason": "Member not found",
    "message": null,
    "success_count": 0,
    "error_count": 0
}

Sync Profiles

With this method you can synchronize new/updated PMS profiles to Peoplevine.

Request

GET GET https://connect.peoplevine.com/pms/sync_profiles?auth_id=...&company=...&user=...&pass=...&host=...&from=...

Parameter	Description
auth_id	Peoplevine integration account ID
company	Peoplevine company ID
user	Peoplevine user name
pass	Peoplevine user password
host	Optional. Values: region 1(default), region 2(UK)
from	Created/updated after date and time like 2022-08-10T00:00

Response

Success response - 4 profiles created or updated.

{
    "success": true,
    "reason": null,
    "message": null,
    "success_count": 4,
    "error_count": 0
}

Sync Reservation

With this method you can synchronize PMS reservations to Peoplevine.

Request

GET https://connect.peoplevine.com/pms/sync_reservations?auth_id=...&company=...&user=...&pass=...&host=...&from=

Parameter	Description
auth_id	Peoplevine integration account ID
company	Peoplevine company ID
user	Peoplevine user name
pass	Peoplevine user password
host	Optional. Values: region 1(default), region 2(UK)
from	Created/updated after date and time like 2022-08-10T00:00

Response

Success response - 5 reservation created or updated.

{
    "success": true,
    "reason": null,
    "message": null,
    "success_count": 5,
    "error_count": 0
}

Get rate plans

With this method you can get rate plans in PMS.

Request

GET https://connect.peoplevine.com/res/rateplans?auth_id=...&company=...&user=...&pass=...&host=...

Parameter	Description
auth_id	Peoplevine integration account ID
company	Peoplevine company ID
user	Peoplevine user name
pass	Peoplevine user password
host	Optional. Values: region 1(default), region 2(UK)

Response

{
    "ratePlans": [
        {
            "id": "ff5c31d9-7b91-4f49-8129-03962f4e9930",
            "name": "Weekend",
            "description": null,
            "is_active": true,
            "is_public": true
        },
        {
            "id": "f66d51b2-02f9-46f3-a196-06fb49a8104e",
            "name": "Full Board",
            "description": null,
            "is_active": true,
            "is_public": true
        },
        ...
    ],
    "success": true,
    "reason": null,
    "message": null
}        

Get room types

With this method you can get room types in PMS.

Request

GET https://connect.peoplevine.com/res/roomtypes?auth_id=...&company=...&user=...&pass=...&host=...

Parameter	Description
auth_id	Peoplevine integration account ID
company	Peoplevine company ID
user	Peoplevine user name
pass	Peoplevine user password
host	Optional. Values: region 1(default), region 2(UK

Response

{
    "roomTypes": [
        {
            "id": "e785b1c6-5ffa-490c-b146-ebd8a6e19fa9",
            "name": "Double room",
            "description": null,
            "minimum_occupancy": 0,
            "maximum_occupancy": 5
        },
        {
            "id": "c71d3e9b-03bd-425b-9dde-f63018e94a4e",
            "name": "King Double Room FR",
            "description": null,
            "minimum_occupancy": 0,
            "maximum_occupancy": 6
        },
        ...
    "success": true,
    "reason": null,
    "message": null
}        

Get products

With this method you can get products(services) in PMS.

Request

GET https://connect.peoplevine.com/res/products?auth_id=...&company=...&user=...&pass=...&host=...

Parameter	Description
auth_id	Peoplevine integration account ID
company	Peoplevine company ID
user	Peoplevine user name
pass	Peoplevine user password
host	Optional. Values: region 1(default), region 2(UK)

Response

{
    "products": [
        {
            "id": "00d64aa9-215c-46c2-988a-05d2a513790c",
            "name": "Early Check In",
            "description": null,
            "type": null,
            "charging": 2,
            "rate": {
                "net": 3.33,
                "sell": 4,
                "tax": 0.67,
                "taxes": {
                    "UK-2020-S": 0.67
                }
            }
        },
        {
            "id": "da776b36-9fe4-4120-873c-2cd9a5fb41ca",
            "name": "Parking",
            "description": null,
            "type": null,
            "charging": 2,
            "rate": {
                "net": 8.75,
                "sell": 10.5,
                "tax": 1.75,
                "taxes": {
                    "UK-2020-S": 1.75
                }
            }
        },
        ...
    ],
    "success": true,
    "reason": null,
    "message": null
}        

Sync Services

With this method you can synchronize PMS services(room types) to Peoplevine.

Request

GET https://connect.peoplevine.com/pms/sync_services?auth_id=...&company=...&user=...&pass=...&host=...

Parameter	Description
auth_id	Peoplevine integration account ID
company	Peoplevine company ID
user	Peoplevine user name
pass	Peoplevine user password
host	Optional. Values: region 1(default), region 2(UK)

Response

Sucess response - 13 room types created/updated

{
    "success": true,
    "reason": null,
    "message": null,
    "success_count": 13,
    "error_count": 0
}

Check Availability

With this method you can get availability from PMS.

Request

POST https://connect.peoplevine.com/res/get_availability?auth_id=...&company=...&user=...&pass=...&host=...

Parameter	Description
auth_id	Peoplevine integration account ID
company	Peoplevine company ID
user	Peoplevine user name
pass	Peoplevine user password
host	Optional. Values: region 1(default), region 2(UK)

Search for accomodation for 2 adults and 2 children ages 5 and 8

{
    "arrival": "2022-08-22",
    "departure": "2022-08-24",
    "adult_count": 2,
    "children": [5,8]
}

Response

Success response with offers

{
    "offers": [
        {
            "rate_plan_code": "ffe6e78a-63c4-49f9-bee4-ad650159a291",
            "rate_plan_name": "BK-00023",
            "room_type_code": "e785b1c6-5ffa-490c-b146-ebd8a6e19fa9",
            "room_type_name": "Double room",
            "currency": "GBP",
            "total": {
                "net": 155.569,
                "sell": 172,
                "tax": 16.431,
                "currency": "GBP",
                "taxes": {
                    "UK-2021-2.5%": 2.098,
                    "UK-2021-20%": 14.333
                }
            },
            "daily": null
        },
        ...
    ],
    "success": true,
    "reason": null,
    "message": null
}        

Create reservation

With this method you can create a new reservation PMS.

Request

POST https://connect.peoplevine.com/res/create_reservation?auth_id=...&company=...&user=...&pass=...&host=...

Parameter	Description
auth_id	Peoplevine integration account ID
company	Peoplevine company ID
user	Peoplevine user name
pass	Peoplevine user password
host	Optional. Values: region 1(default), region 2(UK)

Create a new reservation for 2 adults and one child 8 age for Peoplevine member with external(PMS ID) "b139d4df-9610-4427-b6b2-ad4200c3a9c5"

{
    "arrival": "2022-04-22",
    "departure": "2022-04-23",
    "adult_count": 2,
    "children": [
        8
    ],
    "id": "test001",
    "customer": "b139d4df-9610-4427-b6b2-ad4200c3a9c5",
    "rate_plan": "65b81bc8-a23c-4490-bd31-ad8700765216",
    "room_type": "e785b1c6-5ffa-490c-b146-ebd8a6e19fa9",
    "notes": "this is a test reservation",
    "currency": "GBP",
    "total": {
                "sell": 236.500,
                "tax": 23.598,
                "currency": "GBP",
                "taxes": {
                    "UK-2021-20%": 14.333
                }
    }
}

Response

Success response with PMS reservation ID

{
    "success": true,
    "reason": null,
    "message": "5fc6862d-750a-4650-9e92-ad57005878d2",
    "success_count": 1,
    "error_count": 0
}

Error response

{
    "success": false,
    "reason": "CreateReservation failed: {\"Message\":\"Invalid CustomerId.\",\"Details\":null}",
    "message": null,
    "success_count": 0,
    "error_count": 0
}

Add product to reservation

With this method you can add products(services) to reservation in PMS.

Request

POST https://connect.peoplevine.com/res/create_reservation?auth_id=...&company=...&user=...&pass=...&host=...

Parameter	Description
auth_id	Peoplevine integration account ID
company	Peoplevine company ID
user	Peoplevine user name
pass	Peoplevine user password
host	Optional. Values: region 1(default), region 2(UK)

Add product with PMS ID "da776b36-9fe4-4120-873c-2cd9a5fb41ca" to reservation with PMS ID "f6da0a18-3e52-4a8c-a4e7-ae78007bff0d"

{
    "reservation_id": "f6da0a18-3e52-4a8c-a4e7-ae78007bff0d",
    "count": 1,
    "from": "2022-04-22",
    "until": "2022-04-22",
    "product": {
        "id": "da776b36-9fe4-4120-873c-2cd9a5fb41ca",
        "rate": {
                "net": 8.75,
                "sell": 10.50,
                "tax": 1.75,
                "currency": "GBP",
                "taxes": {
                    "UK-2021-20%": 1.75
                }
            }
    }
}

Response

Success response

{
    "success": true,
    "reason": null,
    "message": null,
    "success_count": 1,
    "error_count": 0
}

Add payment to folio

With this method you can add a payment done in external system to profile folio in PMS.

Request

POST https://connect.peoplevine.com/pms/add_payment?auth_id=...&company=...&user=...&pass=...&host=...

Parameter	Description
auth_id	Peoplevine integration account ID
company	Peoplevine company ID
user	Peoplevine user name
pass	Peoplevine user password
host	Optional. Values: region 1(default), region 2(UK)

Update folio in PMS for profile "c64d628f-1f5e-4434-bb47-ae7500d68c17 with 100 payment done in Peoplevine

{
    "customer_id": "c64d628f-1f5e-4434-bb47-ae7500d68c17",
    "amount": 100,
    "currency": "USD",
    "notes": "Peoplevine payment"
}

Response

Success response

{
    "success": true,
    "reason": null,
    "message": null,
    "success_count": 1,
    "error_count": 0
}

Add charge to folio

With this method you can add a charge(expense) done in external system to profile folio in PMS.

Request

POST https://connect.peoplevine.com/pms/charge_folio?auth_id=...&company=...&user=...&pass=...&host=...

Parameter	Description
auth_id	Peoplevine integration account ID
company	Peoplevine company ID
user	Peoplevine user name
pass	Peoplevine user password
host	Optional. Values: region 1(default), region 2(UK)

Add $100 charge to customer with PMS ID "a0778fa2-27c7-43d1-ada8-ae68007e4e84"

{
    "customer_id": "a0778fa2-27c7-43d1-ada8-ae68007e4e84",
    "amount": 100,
    "currency": "USD",
    "notes": "charge 100 to folio"
}

Response

Success response

{
    "success": true,
    "reason": null,
    "message": null,
    "success_count": 1,
    "error_count": 0
}

Error response

{
    "success": false,
    "reason": "Credit card not found",
    "message": null,
    "success_count": 0,
    "error_count": 0
}

Cancel reservation

With this method you can cancel a reservation in PMS.

Request

POST https://connect.peoplevine.com/res/cancel_reservation?auth_id=...&company=...&user=...&pass=...&host=...

Parameter	Description
auth_id	Peoplevine integration account ID
company	Peoplevine company ID
user	Peoplevine user name
pass	Peoplevine user password
host	Optional. Values: region 1(default), region 2(UK)

Cancel reservation with PMS ID "24d3272a-1c16-4e57-b628-ae78007bb1b1"

{
    "reservation_id": "24d3272a-1c16-4e57-b628-ae78007bb1b1",
    "charge_fee": true,
    "notes": "cancel reason"
}

Response

Success response

{
    "success": true,
    "reason": null,
    "message": null,
    "success_count": 1,
    "error_count": 0
}

Error response

{
    "success": false,
    "reason": "CancelReservation failed: {\"Message\":\"Invalid ReservationIds.\",\"Details\":null}",
    "message": null,
    "success_count": 0,
    "error_count": 0
}