Integração com POS - VHF-API

Documentação dos endpoints e JSONs de integração com o POS.

Endpoints

Endereço base http://{endereco-vhf-api}:{porta}

HOTEL

GET	/HotalApi/Frontoffice/Hotel/GetAll
Hotéis
Sem Parâmetros

GET	/HotalApi/Frontoffice/Hotel/Employees
Funcionários
Sem Parâmetros

GET	/HotalApi/Frontoffice/Hotel/Rooms/{IdHotel}/{Status_Reserva}
Quartos
Parâmetros
IdHotel ^{*Obrigatório}	Código identificador da Reserva
Status_Reserva^*^Obrigatório	Status da Reserva 0 - A Confirmar 1 - Confirmada 2 - Check-In 3 - Check-Out 4 - Pendente 5 - No-Show 6 - Cancelada 7 - Waiting List 8 - Em Tentativa

GET	/HotalApi/Frontoffice/Hotel/CompleteRooms/{IdHotel}/{Status_Reserva}
Quartos e Contas de Hóspedes
Parâmetros
IdHotel ^{*Obrigatório}	Código identificador do hotel
Status_Reserva^{*Obrigatório}	Status da Reserva 0 - A Confirmar 1 - Confirmada 2 - Check-In 3 - Check-Out 4 - Pendente 5 - No-Show 6 - Cancelada 7 - Waiting List 8 - Em Tentativa

POST	/HotalApi/Frontoffice/Hotel/Reservation
Status das Reservas
Parâmetros
Exemplo modelo Expandir origem { "ids": [ 36418, 36417, 36416, 36415, 36414 ] }

ACCOUNT

GET	/HotalApi/Frontoffice/Account/UHAccounts/{IdReservasFront}/{Status_Conta}
Contas de Hóspedes
Parâmetros
IdReservasFront ^{*Obrigatório}	Código identificador da Reserva
Status_Conta ^{*Obrigatório}	"OPEN" ou "CLOSED" para status da conta

GET	/HotalApi/Frontoffice/Account/EventAccounts/{IdHotel}/{Status_Conta}
Contas de Eventos
Parâmetros
IdHotel ^{*Obrigatório}	Código identificador da Reserva
Status_Conta ^{*Obrigatório}	"OPEN" ou "CLOSED" para status da conta

GET	/HotalApi/Frontoffice/Account/GroupAccounts/{IdHotel}/{Status_Conta}
Contas de Grupos
Parâmetros
IdHotel ^{*Obrigatório}	Código identificador da Reserva
Status_Conta ^{*Obrigatório}	"OPEN" ou "CLOSED" para status da conta

GET	/HotalApi/Frontoffice/Account/SparseAccounts/{IdHotel}/{Status_Conta}
Contas Avulsas
Parâmetros
IdHotel ^{*Obrigatório}	Código identificador da Reserva
Status_Conta ^{*Obrigatório}	"OPEN" ou "CLOSED" para status da conta

CONSUMPTION

PUT	/HotalApi/Frontoffice/Consumption/AccountStatus
Atualização de Status de Mesa
Parâmetros
Exemplo modelo Expandir origem { "IntegrationCode": "string", "Account": { "Id": "string" }, "Hotel": { "Id": "string" }, "Status": "string", "TableNumber": "string" }

Adição de Consumo

POST

/HotalApi/Frontoffice/Consumption/POSConsumption

Parâmetros

Exemplo modelo

{
    "HotelId": "string",
    "AccountId": "string",
    "PosNumber": "string",
    "PersonId": "string",
    "PersonName": "string",
    "Document": "string",
    "InvoiceDate": "2019-12-01T12:00:00.4491035-03:00",
    "ItensSubtotal": 0.00,
    "ServiceChargeSubtotal": 0.00,
    "DiscountSubtotal": 0.00,
    "InvoiceTotal": 0.00,
    "FiscalInvoice": {
        "FiscalInvoiceNumber": "string",
        "Serie": "string",
        "Key": "string",
        "AuthorizationProtocol": "string",
        "Model": "string"
    },
    "Payments": [{
            "IntegrationCode": "string",
            "Description": "string",
            "NSU": "string",
            "Parcel": 0,
            "Value": 0.00
        }
    ],
    "Items": [{
            "ProductId": "string",
            "Description": "string",
            "Amount": 01,
            "UnitaryValue": 0.00,
            "ServiceCharge": 0.00,
            "DiscountValue": 0.00,
            "TotalValue": 0.00
        }
    ]
}

Estorno de Consumo