TOTVS Hospitalidade

Árvore de páginas

Versões comparadas

Versão antiga 7

changes.mady.by.user Usuário desconhecido (isabel.abreu)

Gravado em

comparado com

Nova versão 8

changes.mady.by.user Usuário desconhecido (isabel.abreu)

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Comentário: Migration of unmigrated content due to installation of a new plugin

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

Endpoints

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

HOTEL

Hotéis

Estado
colourBlue
titleGET

/HotalApi/Frontoffice/Hotel/GetAll
Sem Parâmetros
Funcionários

Estado
colourBlue
titleGET

/HotalApi/Frontoffice/Hotel/Employees 
Sem Parâmetros
Quartos

Estado
colourBlue
titleGET

/HotalApi/Frontoffice/Hotel/Rooms/{IdHotel}/{Status_Reserva}    
Parâmetros
IdHotel *ObrigatórioCó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

Quartos e Contas de Hóspedes

Estado
colourBlue
titleGET

/HotalApi/Frontoffice/Hotel/CompleteRooms/{IdHotel}/{Status_Reserva} 
Parâmetros
IdHotel *ObrigatórioCó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

Status das Reservas

Estado
colourGreen
titlePOST

 /HotalApi/Frontoffice/Hotel/Reservation
Parâmetros
Bloco de código
languagejs
themeEmacs
titleExemplo modelo
collapsetrue
{
    "ids": [ 36418, 36417, 36416, 36415, 36414 ]
}

ACCOUNT

Contas de Hóspedes

Estado
colourBlue
titleGET

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

Estado
colourBlue
titleGET

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

Estado
colourBlue
titleGET

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

Estado
colourBlue
titleGET

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


CONSUMPTION

Atualização de Status de Mesa

Estado
colourYellow
titlePUT

 /HotalApi/Frontoffice/Consumption/AccountStatus
Parâmetros
Bloco de código
languagejs
themeEmacs
titleExemplo modelo
collapsetrue
{
    "IntegrationCode": "string",
    "Account": {
        "Id": "string"
    },
    "Hotel": {
        "Id": "string"
    },
    "Status": "string",
    "TableNumber": "string"
}
Adição de Consumo

Estado
colourGreen
titlePOST

 /HotalApi/Frontoffice/Consumption/POSConsumption
Parâmetros
Bloco de código
languagejs
themeEmacs
titleExemplo modelo
collapsetrue
{
    "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
        }
    ]
}
Table Filter
id1597235375754_-2054077453
Estorno de Consumo

Estado
colourGreen
titlePOST

 /HotalApi/Frontoffice/Consumption/POSReversal
Parâmetros
Bloco de código
languagejs
themeEmacs
titleExemplo modelo
collapsetrue
{
    "HotelId": "string",
    "AccountId": "string",
    "PosNumber": "string",
    "FiscalInvoice": {
        "FiscalInvoiceNumber": "string",
        "Serie": "string",
        "Key": "string",
        "AuthorizationProtocol": "string",
        "Model": "string"
    }
}



Informações
Todos os endpoints necessitam de autorização de acesso