Documentación de la API

Introducción

La API de Lobby PMS ha sido implementada para aquellos desarrolladores que quieran integrar las funcionalidades de Lobby en una aplicación web, una APP nativa o un sistema de escritorio. Esta API está basada en la arquitectura de software REST. Los métodos implementados retornarán respuestas utilizando el formato jSON.

Autenticación

Para usar las funciones del API, es necesario autenticarse con un API Token único que nuestro sistema genera para cada usuario. Estos datos se pueden encontrar en la opción de perfil de usuario de la interfaz de configuraciones de Lobby PMS.

Token de pruebas

Puedes usar el siguiente token de autenticación para realizar pruebas de las funciones de la API: 633Sezblt49jkvRnjpnxWCgRfQa2BDb4KM07X3Z4RvawFrnbAAAIWL

Códigos de estados de respuesta

200 Respuesta estándar para peticiones correctas.
201 La petición ha sido completada y ha resultado en la creación de un nuevo recurso.
204 La petición se ha completado con éxito pero su respuesta no tiene ningún contenido.
206 La petición servirá parcialmente el contenido solicitado.
400 La solicitud contiene sintaxis errónea y no debería repetirse.
401 No autorizado
403 La solicitud fue legal, pero el servidor rehúsa responderla dado que el cliente no tiene los privilegios para hacerla.
404 Una petición fue hecha a una URI utilizando un método de solicitud no soportado por dicha URI.
422 La petición del navegador tiene el formato correcto, pero sus contenidos tienen algún error semántico que impide al servidor responder.
500 Error ineterno del servidor.
503 El servidor no puede responder a la petición del navegador porque está congestionado o está realizando tareas de mantenimiento.

Métodos

A continuación encontraras los metodos disponibles en en nuestra API

Obtener datos de la propiedad

Muestra la información básica de una propiedad, como puede ser el nombre, país, ciudad, zona horaria, moneda, etc.

GET https://api.lobbypms.com/api/v1/property
Párametros
api_token Obligatorio Su API Token en LobbyPMS
Ejemplo respuesta
{
    "data": {
        "id_establecimiento": 10001,
        "nombre_establecimiento": "Blue Hotel Plus",
        "numero_identificacion": "45520011",
        "ciudad": "Medellín",
        "codigo_migracion": "1111",
        "zona_horaria": "America/Bogota",
        "telefono": "24450207",
        "direccion": "sdasd",
        "pagina_web": "http://www.hotel-demo.com",
        "email": "luisramirez@maklik.co",
        "check_in": "15:00",
        "check_out": "16:00",
        "fecha_vencimiento": "2028-03-08 00:00:00",
        "moneda": "COP",
        "pais": "COLOMBIA",
        "tipo_cuenta": "Estándar Colombia II Full ",
        "tarifa": "141000.00",
        "plugins": {
            "comprobantes": 1,
            "motor": 1,
            "tours": 1
        }
    },
    "meta": []
}

Obtener permisos

Permite obtener los permisos asignados al usuario en la propiedad.

GET https://api.lobbypms.com/api/v1/grants
Párametros
api_token Obligatorio Su API Token en LobbyPMS
Ejemplo respuesta
{
    "data": {
        "pagos": 1,
        "caja": 1,
        "productos": 0,
        "checkout_con_deudas": 1,
        "permiso_calendario": 1,
        "permiso_actividad_diaria": 1,
        "permiso_tienda_ventas": 1,
        "permiso_tienda_compras": 1,
        "permiso_tienda_inventario": 1,
        "permiso_clientes": 1,
        "permiso_reportes": 1,
        "permiso_otros": 1,
        "permiso_tarifas_noche": 1,
        "checkin_estricto": 1,
        "permiso_estadisticas_producto": 1,
        "permiso_reportes_facturas": 1,
        "permiso_reportes_detallado": 1,
        "permiso_reportes_gastos": 1,
        "permiso_eliminar_descuentos": 1,
        "permiso_consolidado": 1,
        "permiso_ventas_extras": 1,
        "permiso_transacciones": 1,
        "permiso_reservas_canceladas": 1,
        "permiso_descuentos_realizados": 1,
        "permiso_ocupacion": 1,
        "permiso_estadisticas": 1,
        "permiso_hospedajes_pendientes": 1,
        "permiso_consolidado_mes": 1,
        "anular_cancelar_factura": 1,
        "permiso_impuestos": 1,
        "menu_estadisticas": 1,
        "curva_reservas": 1,
        "ocupacion_diaria": 1,
        "lead_days": 1,
        "nacionalidades": 1,
        "ventasmensuales": 1,
        "capacidad": 1,
        "alineacion_consumos": 0,
        "deshabilitar_descuentos": 0,
        "movimientos_efectivo": 1,
        "cargos_extra": 1,
        "control_caja": 1,
        "entrada_antigua": 0,
        "productos_servicios_vendidos": 1,
        "modificaciones_inventario": 1,
        "pagos_consumos": 1,
        "obligar_login": 1,
        "permiso_configuraraciones_caja": 1,
        "permiso_historial_turno": 1,
        "permiso_categorias_productos": 1,
        "permiso_centros_inventarios": 1,
        "permiso_listado_productos": 1,
        "permiso_control_stock": 1,
        "permiso_registrar_compra": 1,
        "permiso_historial_compras": 1,
        "permiso_proveedores": 1,
        "permiso_venta_tours": 1,
        "permiso_reportes_egresos": 1,
        "permiso_reportes_facturacion": 1,
        "permiso_reportes_gananciasperdidas": 1,
        "idioma": "en",
        "editar_caja": 1,
        "transferencias_caja": 1
    },
    "meta": []
}

Obtener usuarios

Permite obtener un listado de todas los usuarios de la propiedad identificando su respectivo rol.

GET https://api.lobbypms.com/api/v1/users
Párametros
api_token Obligatorio Su API Token en LobbyPMS
page Opcional Página de resultados
Ejemplo respuesta
{
    "data": [
        {
            "id_usuario": 2988,
            "usuario": "optiplus",
            "nombre_completo": "AdministradorO",
            "email": "luisramirez@maklik.co",
            "rol": "administrador",
            "eliminado": 0
        },
        {
            "id_usuario": 2989,
            "usuario": "recep1",
            "nombre_completo": "Recepción 1",
            "email": "laramirer@gmail.com",
            "rol": "colaborador",
            "eliminado": 0
        },
        ...
    ],
    "meta": {
        "total_records": 10,
        "current_page": 1,
        "records_per_page": 20,
        "total_pages": 1
    }
}

Obtener formas de pago

Permite obtener un listado de todas las formas de pago activas de la propiedad.

GET https://api.lobbypms.com/api/v1/payment-methods
Párametros
api_token Obligatorio Su API Token en LobbyPMS
page Opcional Página de resultados
Ejemplo respuesta
{
    "data": [
        {
            "id_forma_pago": 1769,
            "nombre": "Cash",
            "valor_cergo_extra": null,
            "control_caja": 1,
            "control_turno": 0
        },
        {
            "id_forma_pago": 1770,
            "nombre": "PayU",
            "valor_cergo_extra": null,
            "control_caja": null,
            "control_turno": 1
        },
        ...
    ],
    "meta": {
        "total_records": 10,
        "current_page": 1,
        "records_per_page": 20,
        "total_pages": 1
    }
}

Obtener cajas

Permite obtener el listado de cajas creadas en la propiedad con su respectivo estado actual y sus usuarios asociados.

GET https://api.lobbypms.com/api/v1/cash-points
Párametros
api_token Obligatorio Su API Token en LobbyPMS
page Opcional Página de resultados
Ejemplo respuesta
{
    "data": [
        {
            "id_caja": 2,
            "nombre_caja": "Recepción",
            "saldo": "733654.95",
            "usuarios": [
                {
                    "id_usuario": 2988,
                    "usuario": "optiplus",
                    "nombre_completo": "AdministradorO",
                    "email": "luisramirez@maklik.co",
                    "rol": "0"
                },
                {
                    "id_usuario": 2988,
                    "usuario": "optiplus",
                    "nombre_completo": "AdministradorO",
                    "email": "luisramirez@maklik.co",
                    "rol": "0"
                }
            ],
            "estatus": "abierta",
            "ultima_actualizacion": {
                "fecha": "2018-02-13 15:49:19",
                "tipo": "ingreso",
                "id_usuario": 2988
            }
        },
        {
            "id_caja": 3,
            "nombre_caja": "Bar",
            "saldo": "148570.05",
            "usuarios": [
                {
                    "id_usuario": 2991,
                    "usuario": "user2",
                    "nombre_completo": "user2",
                    "email": "user@user.com",
                    "rol": "0"
                },
                {
                    "id_usuario": 3060,
                    "usuario": "usuarioabc",
                    "nombre_completo": "UsuarioABC",
                    "email": "usuario@gmail.com",
                    "rol": "0"
                },
                {
                    "id_usuario": 2989,
                    "usuario": "recep1",
                    "nombre_completo": "Recepción 1",
                    "email": "laramirer@gmail.com",
                    "rol": "0"
                },
                {
                    "id_usuario": 3014,
                    "usuario": "admin2",
                    "nombre_completo": "admin2",
                    "email": "laram@gmai.com",
                    "rol": "0"
                }
            ],
            "estatus": "abierta",
            "ultima_actualizacion": {
                "fecha": "2018-02-08 17:38:46",
                "tipo": "traslado de saldo",
                "id_usuario": 2988
            }
        },
        ...
    ],
    "meta": {
        "total_records": 5,
        "current_page": 1,
        "records_per_page": 20,
        "total_pages": 1
    }
}

Obtener centros de inventario

Permite obtener un listado de todos los centros de inventarios creados en la propiedad con sus respectivos usuarios asociados.

GET https://api.lobbypms.com/api/v1/inventory-centers
Párametros
api_token Obligatorio Su API Token en LobbyPMS
page Opcional Página de resultados
Ejemplo respuesta
{
    "data": [
        {
            "id_centro_inventario": 4,
            "nombre_centro": "Bodega Central",
            "usuarios": [
                {
                    "id_usuario": 3014,
                    "usuario": "admin2",
                    "nombre_completo": "admin2",
                    "email": "laram@gmai.com",
                    "rol": "0"
                }
            ]
        },
        {
            "id_centro_inventario": 5,
            "nombre_centro": "Neveras",
            "usuarios": [
                {
                    "id_usuario": 2991,
                    "usuario": "user2",
                    "nombre_completo": "user2",
                    "email": "user@user.com",
                    "rol": "0"
                }
            ]
        },
        ...
    ],
    "meta": {
        "total_records": 9,
        "current_page": 1,
        "records_per_page": 20,
        "total_pages": 1
    }
}

Obtener productos

Permite obtener un listado de todos los productos y servicios para la venta que han sido configurados en el hotel. El listado se genera separando los productos por categoría.

GET https://api.lobbypms.com/api/v1/products
Párametros
api_token Obligatorio Su API Token en LobbyPMS
page Opcional Página de resultados
Ejemplo respuesta
{
    "data": [
        {
            "id_categoria_producto": 2358,
            "nombre": "Snacks",
            "eliminado": 0,
            "productos": [
                {
                    "id_servicio": 13762,
                    "nombre": "Pilsen",
                    "valor": "2.30",
                    "id_subcategoria": 278,
                    "estatus_venta": 0,
                    "status_stock": 0,
                    "unidad_medida": "botellas",
                    "componentes": [],
                    "variantes": [],
                    "stock": []
                },
                {
                    "id_servicio": 13763,
                    "nombre": "Michelada Aguila",
                    "valor": "4.00",
                    "id_subcategoria": 278,
                    "estatus_venta": 0,
                    "status_stock": 1,
                    "unidad_medida": "unidades",
                    "componentes": [
                        {
                            "id_componente_producto": 8,
                            "cantidad_componente": "2.000",
                            "valor": "0.00"
                        },
                        {
                            "id_componente_producto": 9,
                            "cantidad_componente": "1.000",
                            "valor": "90.00"
                        },
                        {
                            "id_componente_producto": 178,
                            "cantidad_componente": "12.000",
                            "valor": "0.00"
                        },
                        {
                            "id_componente_producto": 194,
                            "cantidad_componente": "4.451",
                            "valor": null
                        }
                    ],
                    "variantes": [
                        {
                            "nombre": "Verde",
                            "eliminado": 1
                        },
                        {
                            "nombre": "Sin hielo",
                            "eliminado": 0
                        },
                        {
                            "nombre": "Con hielo",
                            "eliminado": 0
                        }
                    ],
                    "stock": []
                },
                {
                    "id_servicio": 13764,
                    "nombre": "Papas naturales",
                    "valor": "1200.00",
                    "id_subcategoria": 279,
                    "estatus_venta": null,
                    "status_stock": 0,
                    "unidad_medida": "unidades",
                    "componentes": [],
                    "variantes": [
                        {
                            "nombre": "Verde",
                            "eliminado": 1
                        },
                        {
                            "nombre": "Azul",
                            "eliminado": 1
                        },
                        {
                            "nombre": "Roja",
                            "eliminado": 1
                        },
                        {
                            "nombre": "Dorada",
                            "eliminado": 1
                        }
                    ],
                    "stock": [
                        {
                            "id": 942,
                            "id_centro_inventario": 7,
                            "cantidad": "830.000",
                            "last_update": "2017-11-08 15:27:20",
                            "reorden": "2.00"
                        }
                    ]
                }
            ]
        },
        ...
    ],
    "meta": {
        "total_records": 9,
        "current_page": 1,
        "records_per_page": 20,
        "total_pages": 1
    }
}

Obtener gastos

Permite obtener los diferentes tipos de gastos configurados para un hotel.

GET https://api.lobbypms.com/api/v1/costs
Párametros
api_token Obligatorio Su API Token en LobbyPMS
page Opcional Página de resultados
Ejemplo respuesta
{
    "data": [
        {
            "id_costo": 2840,
            "nombre": "Tarjetas",
            "categorias": [
                {
                    "id_categoria_gasto": 1,
                    "nombre": "tipo1"
                },
                {
                    "id_categoria_gasto": 2,
                    "nombre": "Tipo b"
                }
            ]
        },
        {
            "id_costo": 2919,
            "nombre": "ENERGIA",
            "categorias": []
        },
        ...
    ],
    "meta": {
        "total_records": 7,
        "current_page": 1,
        "records_per_page": 20,
        "total_pages": 1
    }
}

Obtener ingresos

Permite obtener un listado de todos los ingresos de dinero en la propiedad. De manera opcional es posible obtener el listado de ingresos para un rango de fechas deseado

GET https://api.lobbypms.com/api/v1/incomes
Párametros
api_token Obligatorio Su API Token en LobbyPMS
start_date Opcional Fecha de inicio en formato YYYY-mm-dd hh:mm:ss UTC
end_date Opcional Fecha final en formato YYYY-mm-dd hh:mm:ss UTC
page Opcional Página de resultados
Ejemplo respuesta
{
    "data": [
        {
            "id_ingreso_reserva": 1,
            "id_reserva": null,
            "valor": "0.54",
            "fecha": "2017-03-21 06:12:03",
            "usuario_encargado": 2991,
            "id_venta_servicio": 524039,
            "id_producto": null,
            "id_caja": null,
            "forma_pago": ""
        },
        {
            "id_ingreso_reserva": 2,
            "id_reserva": null,
            "valor": "4.50",
            "fecha": "2017-03-21 06:12:03",
            "usuario_encargado": 2991,
            "id_venta_servicio": 524039,
            "id_producto": 13768,
            "id_caja": null,
            "forma_pago": ""
        },
        ...
    ],
    "meta": {
        "total_records": 1973,
        "current_page": 1,
        "records_per_page": 20,
        "total_pages": 99
    }
}

Obtener egresos

Permite obtener un listado de todos los egresos de dinero en la propiedad. De manera opcional es posible obtener el listado de egresos para un rango de fechas deseado.

GET https://api.lobbypms.com/api/v1/expenses
Párametros
api_token Obligatorio Su API Token en LobbyPMS
start_date Opcional Fecha de inicio en formato YYYY-mm-dd hh:mm:ss UTC
end_date Opcional Fecha final en formato YYYY-mm-dd hh:mm:ss UTC
page Opcional Página de resultados
Ejemplo respuesta
{
    "data": [
        {
            "id_egreso": 1,
            "fecha": "2017-02-16 03:12:53",
            "id_producto": 13761,
            "usuario": 2988,
            "valor": "300.00",
            "id_caja": 0,
            "forma_pago": "",
            "tipo_gasto": ""
        },
        {
            "id_egreso": 2,
            "fecha": "2017-02-16 03:12:53",
            "id_producto": 13764,
            "usuario": 2988,
            "valor": "-100.00",
            "id_caja": 0,
            "forma_pago": "",
            "tipo_gasto": ""
        },
        ...
    ],
    "meta": {
        "total_records": 157,
        "current_page": 1,
        "records_per_page": 20,
        "total_pages": 8
    }
}

Obtener cuartos

Devuelve los cuartos agrupados por categoría

GET https://api.lobbypms.com/api/v1/room-categories
Párametros
api_token Su API Token en LobbyPMS
page Opcional Página de resultados
Ejemplo respuesta
{
    "data": [
        {
            "id_categoria": 3129,
            "nombre": "Apartamentos",
            "capacidad_estandar": 2,
            "capacidad_adicional": 0,
            "prioridad": 1,
            "eliminado": 0,
            "tipo": "privada",
            "descripciones": [
                {
                    "descripcion": "Apartamento con 2 habitaciones, camas King y Queen size. Cada habitación Cuenta con baño Propio. AC y TV en cada habitaciones.",
                    "idioma": ""
                },
                {
                    "descripcion": "Loft with 2 bedrooms , King and queen size beds. Bathrooms in each bedroom. TV and AC in each room.",
                    "idioma": ""
                }
            ],
            "cuartos": [
                {
                    "id_cuarto": 90544,
                    "nombre": "Apto 201",
                    "prioridad": 1,
                    "eliminado": 0
                },
                {
                    "id_cuarto": 90545,
                    "nombre": "Apto 202",
                    "prioridad": 2,
                    "eliminado": 0
                },
                {
                    "id_cuarto": 90546,
                    "nombre": "Apto 203",
                    "prioridad": 3,
                    "eliminado": 0
                },
                {
                    "id_cuarto": 92984,
                    "nombre": "Apto 204",
                    "prioridad": 4,
                    "eliminado": 0
                },
                {
                    "id_cuarto": 92985,
                    "nombre": "Apto 205",
                    "prioridad": 5,
                    "eliminado": 0
                }
            ]
        },
        {
            "id_categoria": 2538,
            "nombre": "Doble",
            "capacidad_estandar": 2,
            "capacidad_adicional": 0,
            "prioridad": 1,
            "eliminado": 0,
            "tipo": "privada",
            "descripciones": [
                {
                    "descripcion": "Habitaciones dobles, camas King y Queen size. Cada habitación Cuenta con baño Propio. AC y TV en cada habitaciones.\r\n",
                    "idioma": ""
                },
                {
                    "descripcion": "Double room with Queen Size bed. AC and TV included.\r\n",
                    "idioma": ""
                }
            ],
            "cuartos": [
                {
                    "id_cuarto": 87867,
                    "nombre": "Estandar 1",
                    "prioridad": 1,
                    "eliminado": 0
                },
                {
                    "id_cuarto": 90543,
                    "nombre": "Estandar 2",
                    "prioridad": 123,
                    "eliminado": 0
                }
            ]
        },
        ...
    ],
    "meta": {
        "total_records": 20,
        "current_page": 1,
        "records_per_page": 20,
        "total_pages": 1
    }
}

Obtener reservas

Permite obtener un listado de reservas de la propiedad para un rango de fechas (check in) deseado.

GET https://api.lobbypms.com/api/v1/bookings
Párametros
api_token Obligatorio Su API Token en LobbyPMS
creation_date_from Obligatorio Fecha de inicio en formato YYYY-mm-dd hh:mm:ss UTC. La fecha en UTC debe coincidir con las 00:00:00 de la propiedad
creation_date_to Obligatorio Fecha de fin en formato YYYY-mm-dd hh:mm:ss UTC. La fecha en UTC debe coincidir con las 00:00:00 de la propiedad
check_in_from Opcional Fecha de inicio en formato YYYY-mm-dd hh:mm:ss UTC. La fecha en UTC debe coincidir con las 00:00:00 de la propiedad
check_in_to Opcional Fecha de fin en formato YYYY-mm-dd hh:mm:ss UTC. La fecha en UTC debe coincidir con las 00:00:00 de la propiedad
Ejemplo respuesta
{
    "data": [
        {
            "id_reserva": 687344,
            "fecha_creacion": "2017-11-09 00:00:00",
            "fecha_ingreso": "2018-01-18 05:00:00",
            "fecha_salida": "2018-01-21 05:00:00",
            "checkin_realizado": null,
            "checkout_realizado": null,
            "nota": "Importada desde archivo",
            "usuario_creacion": 2988,
            "numero_personas": 1,
            "ingresos": null,
            "factura_cliente": 624285,
            "agencia": "Booking.com",
            "cuarto": "202",
            "categoria": "Triples",
            "cliente": {
                "id_cliente": 624285,
                "email": "",
                "identificacion": "",
                "nombre": "Luis",
                "primer_apellido": "Ramirez",
                "segundo_apellido": "",
                "telefono": "",
                "direccion": null,
                "tipo_documento": "",
                "pais": ""
            },
            "total": "756,000.00",
            "pagado": "100,010.00"
        },
        {
            "id_reserva": 687345,
            "fecha_creacion": "2017-11-09 00:00:00",
            "fecha_ingreso": "2018-01-13 05:00:00",
            "fecha_salida": "2018-01-17 05:00:00",
            "checkin_realizado": null,
            "checkout_realizado": null,
            "nota": "Importada desde archivo",
            "usuario_creacion": 2988,
            "numero_personas": 1,
            "ingresos": null,
            "factura_cliente": 624286,
            "agencia": "Booking.com",
            "cuarto": "202",
            "categoria": "Triples",
            "cliente": {
                "id_cliente": 624286,
                "email": "",
                "identificacion": "",
                "nombre": "Luisfer",
                "primer_apellido": "Ramirez",
                "segundo_apellido": "",
                "telefono": "",
                "direccion": null,
                "tipo_documento": "",
                "pais": ""
            },
            "total": "1,008,000.00",
            "pagado": "150,000.00"
        },
        ...
    ],
    "meta": {
        "total_records": 44,
        "current_page": 1,
        "records_per_page": 20,
        "total_pages": 3
    }
}

Obtener reservas canceldas

Permite obtener un listado de reservas canceladas de la propiedad para un rango de fechas (check in) deseado.

GET https://api.lobbypms.com/api/v1/canceled-bookings
Párametros
api_token Obligatorio Su API Token en LobbyPMS
deleted_date_from Obligatorio Fecha de inicio de eliminación en formato YYYY-mm-dd hh:mm:ss UTC. La fecha en UTC debe coincidir con las 00:00:00 de la propiedad
deleted_date_to Obligatorio Fecha de fin de eliminación en formato YYYY-mm-dd hh:mm:ss UTC. La fecha en UTC debe coincidir con las 00:00:00 de la propiedad
check_in_from Opcional Fecha de inicio en formato YYYY-mm-dd hh:mm:ss UTC. La fecha en UTC debe coincidir con las 00:00:00 de la propiedad
check_in_to Opcional Fecha de fin en formato YYYY-mm-dd hh:mm:ss UTC. La fecha en UTC debe coincidir con las 00:00:00 de la propiedad
Ejemplo respuesta
{
    "data": [
        {
            "id_reserva_cancelada": 99976,
            "id_categoria": 2523,
            "id_cuarto": 87741,
            "fecha_cancelacion": "2018-01-10 22:02:53",
            "fecha_creacion": null,
            "fecha_ingreso": null,
            "fecha_salida": null,
            "checkin_realizado": 1,
            "checkout_realizado": 1,
            "nota": null,
            "fecha_check_in": "2018-05-24 12:15:29",
            "fecha_check_out": "2018-05-31 12:15:33",
            "usuario_creacion": 0,
            "numero_personas": 1,
            "ingresos": null,
            "descripcion_cancelacion": "",
            "agencia": null,
            "cuarto": "202",
            "categoria": "Triples",
            "nombre_cliente": "Doble",
            "apellido_cliente": "Wrew Sdo",
            "email_cliente": "laramirer@gmail.com",
            "motivo_cancelacion": "Cancelación oportuna del cliente",
            "total": 25
        },
        ...
    ],
    "meta": {
        "total_records": 44,
        "current_page": 1,
        "records_per_page": 20,
        "total_pages": 3
    }
}

Reporte In House

Permite obtener un listado de reservas con checkin realizado y sin checkout de la propiedad para un rango de fechas deseado.

GET https://api.lobbypms.com/api/v1/inhouse-report
Párametros
api_token Obligatorio Su API Token en LobbyPMS
Ejemplo respuesta
{
    "data": [
        {
            "id_reserva": 605737,
            "fecha_creacion": "2017-03-06 11:19:52",
            "fecha_ingreso": "2017-03-05 05:00:00",
            "fecha_salida": "2017-03-06 05:00:00",
            "checkin_realizado": 1,
            "checkout_realizado": null,
            "nota": "",
            "usuario_creacion": 2988,
            "numero_personas": 2,
            "huespedes": [
                {
                    "id_cliente": 633624,
                    "email": "ivandariovinam@gmail.com",
                    "identificacion": "",
                    "nombre": "ivan",
                    "primer_apellido": "",
                    "segundo_apellido": "",
                    "telefono": "",
                    "direccion": "",
                    "tipo_documento": "",
                    "pais": ""
                },
                {
                    "id_cliente": 809086,
                    "email": "",
                    "identificacion": "",
                    "nombre": "asdfad",
                    "primer_apellido": "",
                    "segundo_apellido": "",
                    "telefono": "",
                    "direccion": "",
                    "tipo_documento": "",
                    "pais": "ALEMANIA"
                }
            ],
            "ingresos": "31.00",
            "factura_cliente": 545360,
            "agencia": null,
            "cuarto": "201",
            "categoria": "Triples",
            "cliente": {
                "id_cliente": 545360,
                "email": "",
                "identificacion": "1232323",
                "nombre": "Carsdsad",
                "primer_apellido": "",
                "segundo_apellido": "",
                "telefono": "",
                "direccion": "",
                "tipo_documento": "",
                "pais": "ARGENTINA"
            },
            "total": 10.5,
            "pagado": "4010.50"
        },
        ...
    ],
    "meta": {
        "total_records": 44,
        "current_page": 1,
        "records_per_page": 20,
        "total_pages": 3
    }
}

Obtener detalles de una reserva

Permite obtener todos los detalles de cualquiera de las reservaciones realizadas para la propiedad.

GET https://api.lobbypms.com/api/v1/bookings/{bookingId}
Párametros
api_token Obligatorio Su API Token en LobbyPMS
bookingId Obligatorio Id de la reserva
Ejemplo respuesta
{
    "data": {
        "id_reserva": 764416,
        "fecha_creacion": "2018-01-25 14:56:02",
        "fecha_ingreso": "2018-02-14 05:00:00",
        "fecha_salida": "2018-02-17 05:00:00",
        "checkin_realizado": null,
        "checkout_realizado": null,
        "nota": "",
        "usuario_creacion": 2988,
        "ingresos": [
            {
                "id_ingreso_reserva": 727425,
                "id_reserva": 764416,
                "valor": "10000.00",
                "fecha": "2018-02-13 10:37:25",
                "usuario_encargado": 2988,
                "id_venta_servicio": 767456,
                "id_producto": 17219,
                "id_caja": 2,
                "forma_pago": "Cash"
            }
        ],
        "factura_cliente": {
            "id_cliente": 691245,
            "email": "",
            "identificacion": "",
            "nombre": "asdsd",
            "primer_apellido": "",
            "segundo_apellido": "",
            "telefono": "",
            "direccion": "",
            "tipo_documento": "",
            "pais": ""
        },
        "tarifas_por_dia": [
            {
                "id": 220218,
                "dia": "2018-02-14 10:00:00",
                "precio": "252000.00"
            },
            {
                "id": 220219,
                "dia": "2018-02-15 10:00:00",
                "precio": "252000.00"
            },
            {
                "id": 220220,
                "dia": "2018-02-16 10:00:00",
                "precio": "252000.00"
            }
        ],
        "descuentos": [],
        "impuesto_alojamiento": [],
        "agencia": null,
        "cliente": {
            "id_cliente": 691245,
            "email": "",
            "identificacion": "",
            "nombre": "asdsd",
            "primer_apellido": "",
            "segundo_apellido": "",
            "telefono": "",
            "direccion": "",
            "tipo_documento": "",
            "pais": ""
        },
        "huespedes": [
            {
                "id_cliente": 691245,
                "email": "",
                "identificacion": "",
                "nombre": "asdsd",
                "primer_apellido": "",
                "segundo_apellido": "",
                "telefono": "",
                "direccion": "",
                "tipo_documento": "",
                "pais": ""
            }
        ],
        "ventas": [
            {
                "id_venta_servicio": 767456,
                "fecha": "2018-02-13 15:37:25",
                "descripcion": "",
                "total_venta": "10000.00",
                "estatus": 1,
                "forma_pago": "Cash",
                "usuario": {
                    "id_usuario": 2988,
                    "usuario": "optiplus",
                    "nombre_completo": "AdministradorO",
                    "email": "luisramirez@maklik.co",
                    "rol": "0"
                },
                "productos": [
                    {
                        "id_venta_servicio": 767456,
                        "cantidad": "1.00",
                        "total": "0.95"
                    },
                    {
                        "id_venta_servicio": 767456,
                        "cantidad": "1.00",
                        "total": "10000.00"
                    }
                ],
                "impuestos": [
                    {
                        "id_impuesto_x_producto_x_venta": 37563,
                        "nombre_impuesto": "ICO",
                        "valor_impuesto": "8.00",
                        "total": "0.26"
                    },
                    {
                        "id_impuesto_x_producto_x_venta": 250643,
                        "nombre_impuesto": "ICO",
                        "valor_impuesto": "8.00",
                        "total": "741.00"
                    },
                    {
                        "id_impuesto_x_producto_x_venta": 251867,
                        "nombre_impuesto": "ICO",
                        "valor_impuesto": "8.00",
                        "total": "252.00"
                    },
                    {
                        "id_impuesto_x_producto_x_venta": 251868,
                        "nombre_impuesto": "IVA",
                        "valor_impuesto": "19.00",
                        "total": "599.00"
                    },
                    {
                        "id_impuesto_x_producto_x_venta": 251879,
                        "nombre_impuesto": "ICO",
                        "valor_impuesto": "8.00",
                        "total": "593.00"
                    },
                    {
                        "id": 2548,
                        "nombre_impuesto": "ICO",
                        "valor_impuesto": "8.00",
                        "total": "3.00"
                    },
                    {
                        "id": 2549,
                        "nombre_impuesto": "IVA",
                        "valor_impuesto": "19.00",
                        "total": "6.00"
                    }
                ]
            },
            ..
        ]
    },
    "meta": []
}

Obtener habitaciones vendidas por dia

Permite obtener la cantidad de habitaciones vendidas cada dia entre un rango de fechas deseado.

GET https://api.lobbypms.com/api/v1/sold-rooms
Párametros
api_token Obligatorio Su API Token en LobbyPMS
start_date Opcional Fecha de inicio en formato YYYY-mm-dd hh:mm:ss UTC
end_date Opcional Fecha final en formato YYYY-mm-dd hh:mm:ss UTC
page Opcional Página de resultados
Ejemplo respuesta
{
    "data": [
        {
            "dia": "2018-03-28 10:00:00",
            "habitaciones_vendidas": 1
        },
        {
            "dia": "2018-03-29 10:00:00",
            "habitaciones_vendidas": 5
        },
        ...
    ],
    "meta": {
        "total_records": 140,
        "current_page": "7",
        "records_per_page": 20,
        "total_pages": 7
    }
}

Obtener disponibilidad y tarifa de habitaciones:

Permite obtener la disponibilidad y la tarifa de una categoría de habitación para un rango de fechas deseado

GET https://api.lobbypms.com/api/v1/available-rooms
Párametros
api_token Obligatorio Su API Token en LobbyPMS
start_date Obligatorio Fecha de inicio en formato YYYY-mm-dd hh:mm:ss UTC
end_date Obligatorio Fecha final en formato YYYY-mm-dd hh:mm:ss UTC
id_categoria Opcional Id de la categoría que se desea consultar
page Opcional Página de resultados
Ejemplo respuesta
{
    "data": [
        {
            "fecha": "2018-01-01 10:00:00",
            "categorias": [
                {
                    "id_categoria": 2523,
                    "nombre": "Triples",
                    "capacidad_estandar": 3,
                    "cantidad_habitaciones: 3,
                    "habitaciones_disponibles": 2,
                    "precios": [
                        {
                            "cantidad_personas": 1,
                            "valor": 130000
                        },
                        {
                            "cantidad_personas": 2,
                            "valor": 130000
                        },
                        {
                            "cantidad_personas": 3,
                            "valor": 170000
                        }
                    ]
                },
                {
                    "id_categoria": 2538,
                    "nombre": "Dobles",
                    "capacidad_estandar": 2,
                    "cantidad_habitaciones: 5,
                    "habitaciones_disponibles": 2,
                    "precios": [
                        {
                            "cantidad_personas": 1,
                            "valor": 130000
                        },
                        {
                            "cantidad_personas": 2,
                            "valor": 130000
                        },
                        {
                            "cantidad_personas": 3,
                            "valor": 170000
                        }
                    ]
                },
                ...
            ]
        },
        ...
    ],
    "meta": {
        "total_records": 10,
        "current_page": 1,
        "records_per_page": 20,
        "total_pages": 1
    }
}

Obtener ingresos totales

Permite obtener el total de ingresos por categoría para un rango de fechas deseados.

GET https://api.lobbypms.com/api/v1/total-incomes
Párametros
api_token Obligatorio Su API Token en LobbyPMS
start_date Obligatorio Fecha de inicio en formato YYYY-mm-dd hh:mm:ss UTC
end_date Obligatorio Fecha final en formato YYYY-mm-dd hh:mm:ss UTC
Ejemplo respuesta
{
    "data": [
        {
            "type": "alojamiento",
            "value": 0
        },
        {
            "type": "extras",
            "value": "1600.00"
        },
        ...
    ],
    "meta": {
        "total_records": 6,
        "current_page": 1,
        "records_per_page": 20,
        "total_pages": 1
    }
}

Obtener egresos totales

Permite obtener el total de egresos por categoría para un rango de fechas deseados.

GET https://api.lobbypms.com/api/v1/total-expenses
Párametros
api_token Obligatorio Su API Token en LobbyPMS
start_date Obligatorio Fecha de inicio en formato YYYY-mm-dd hh:mm:ss UTC
end_date Obligatorio Fecha final en formato YYYY-mm-dd hh:mm:ss UTC
Ejemplo respuesta
{
    "data": [
        {
            "type": "Snacks",
            "value": "262904.00"
        },
        {
            "type": "Cervezas",
            "value": "489976.00"
        },
        ...
    ],
    "meta": {
        "total_records": 6,
        "current_page": 1,
        "records_per_page": 20,
        "total_pages": 1
    }
}

Obtener ocupación

Permite obtener datos estadísticos relacionados con la ocupación del hotel para un rango de fechas deseados.

GET https://api.lobbypms.com/api/v1/occupancy
Párametros
api_token Obligatorio Su API Token en LobbyPMS
start_date Obligatorio Fecha de inicio en formato YYYY-mm-dd hh:mm:ss UTC. La fecha en UTC debe coincidir con las 00:00:00 de la propiedad
end_date Obligatorio Fecha final en formato YYYY-mm-dd hh:mm:ss UTC. La fecha en UTC debe coincidir con las 00:00:00 de la propiedad
Ejemplo respuesta
{
    "data": [
        {
            "total_huespedes": 0,
            "ocupacion": 0,
            "capacidad_usada": 0,
            "fecha": "2018-02-01 05:00:00"
        },
        {
            "total_huespedes": 0,
            "ocupacion": 0,
            "capacidad_usada": 0,
            "fecha": "2018-02-02 05:00:00"
        },
        ...
    ],
    "meta": {
        "total_records": 22,
        "current_page": 1,
        "records_per_page": 20,
        "total_pages": 2
    }
}

Crear reservas

Permite crear reservas.

POST https://api.lobbypms.com/api/v1/bookings/create
Párametros
api_token Obligatorio Su API token en LobbyPMS
id_category Obligatorio Categoría de la habitación
start_date Obligatorio Fecha de inicio en formato YYYY-mm-dd hh:mm:ss UTC. La fecha en UTC debe coincidir con las 00:00:00 de la propiedad
end_date Obligatorio Fecha final en formato YYYY-mm-dd hh:mm:ss UTC. La fecha en UTC debe coincidir con las 00:00:00 de la propiedad
total_rooms Obligatorio Total de habitaciónes a reservar
total_adults Obligatorio Total de adultos
total_children Obligatorio Total de niños
holder_name Obligatorio Titular de la reserva
rates_per_day Opcional Define la tarifa por noche, debe ser un JSON. Ej: {"2018-07-20 05:00:00":10,"2018-07-21 05:00:00":11}
blocked Obligatorio Marca la reserva como un bloqueo, posibles valores: 1 ó 0. Si la reserva es un bloqueo, los campos total_adults, total_children y holder_name son opcionales.
Ejemplo respuesta
{
    "data": [
        {
            "idBooking": 955088,
            "idRoom": 90546
        },
        {
            "idBooking": 955089,
            "idRoom": 92984
        }
    ],
    "meta": []
}

Cancelar reservas

Permite cancelar reservas.

POST https://api.lobbypms.com/api/v1/bookings/cancel
Párametros
api_token Obligatorio Su API Token en LobbyPMS
bookings Obligatorio Id de las reservas a cancelar en formato JSON. Ej: [955082, 955083]
Ejemplo respuesta
{
    "data": [],
    "meta": []
}