Enums
Valores fixos e enumeradores aceitos e retornados pela API Sales.
PaymentForm
Meios de pagamento aceitos e retornados em Payments[].PaymentForm. Trata-se de um enum fixo do sistema:
| Valor | Nome | Descrição |
|---|---|---|
0 | Undefined | Indefinido |
101 | Invoice | Faturado |
102 | Government | Governamental / Empenho |
103 | Cash | Dinheiro |
104 | Credit | Crédito |
105 | CreditCard | Cartão de crédito online |
106 | CreditCardOffline | Cartão de crédito offline |
107 | Deposit | Depósito bancário |
108 | Transfer | Transferência bancária |
109 | BankSlip | Boleto bancário |
110 | Reward | Pontos / Recompensa |
111 | Check | Cheque |
112 | Balcony | Balcão |
113 | TransferOnline | Transferência online |
114 | Pix | PIX |
115 | Wallet | Carteira digital |
206 | PrePaid | Pré-pago |
207 | Guarantee | Garantia |
208 | GuaranteeCustomer | Garantia do cliente |
PaymentState
Status do pagamento em Payments[].PaymentState:
| Valor | Nome | Descrição |
|---|---|---|
0 | Undefined | Indefinido |
1 | InProgress | Em andamento |
2 | Authorized | Autorizado |
3 | Refused | Recusado |
4 | Confirmed | Confirmado |
5 | Canceled | Cancelado |
6 | Error | Erro no processamento |
7 | InPaymentByCustomer | Aguardando pagamento pelo cliente |
8 | InAnalysis | Em análise de risco / antifraude |
Campos de ProductDetail por Tipo de Transação
No retorno do Details, o objeto Transaction.ProductDetail contém exatamente uma das propriedades preenchida, dependendo do TransactionType:
TransactionType | Propriedade em ProductDetail | Classe / Tipo |
|---|---|---|
1 (AirReservation) | AirReservationDetail | Detalhes da reserva aérea original |
100 (AirTicket) | AirTicketDetail | Detalhes do bilhete aéreo emitido |
1000 (Emd) | AirEmdDetail | Detalhes de bilhete EMD |
2 (Hotel) | HotelReservationDetail | Detalhes da reserva de hotel |
3 (Car) | CarReservationDetail | Detalhes da locação de veículo |
4 (Insurance) | InsuranceReservationDetail | Detalhes do seguro viagem |
5 (Services) | ServiceReservationDetail | Detalhes de serviços / transfers |
6 (Bus) | BusReservationDetail | Detalhes da passagem rodoviária |
7 (Cruise) | CruiseReservationDetail | Detalhes do cruzeiro marítimo |
9 (OTA) | OtaOrderDetail | Detalhes do pedido da loja online |
11 (ServiceTax) | ServiceTaxDetail | Detalhes da taxa de serviço |
12 (Basket) | BasketDetail | Detalhes de pacote / cesta |
13 (Corporate) | ServiceOrderDetail | Detalhes da ordem de serviço corporativa |
15 (Circuit) | CircuitReservationDetail | Detalhes do circuito turístico |
16 (Chip) | ChipReservationDetail | Detalhes do chip de telefonia |
Além da propriedade específica do produto, ProductDetail sempre inclui metadados comuns:
SalesChannel(integer) eSalesChannelDescription(string): Canal de venda da transação.InsertType(integer) eInsertTypeDescription(string): Tipo de inserção do registro.InsertDate(stringdate-time): Data e hora de inserção original.Provider(ProviderDetail): Dados do fornecedor / GDS / consolidador que emitiu.
TransactionTypes
Usado no filtro TransactionTypes do List e retornado em TransactionType.
| Valor | Nome | Descrição |
|---|---|---|
0 | Undefined | Indefinido |
1 | AirReservation | Reserva aérea (AIR) |
100 | AirTicket | Bilhete aéreo (TKT) |
2 | Hotel | Hotel (HTL) |
3 | Car | Carro (CAR) |
4 | Insurance | Seguro |
5 | Services | Serviços |
6 | Bus | Ônibus |
7 | Cruise | Cruzeiro |
9 | OTA | Loja Online / Pedidos OTA |
11 | ServiceTax | Taxa de serviço (TS) |
12 | Basket | Cesta (Basket) |
13 | Corporate | Ordem de Serviço Corporativa (Corporate) |
15 | Circuit | Circuito |
16 | Chip | Chip telefonia |
1000 | Emd | Bilhete EMD |
TransactionStates
Usado no filtro TransactionStates do List e retornado em TransactionState.
| Valor | Nome | Descrição |
|---|---|---|
0 | Undefined | Indefinido |
1 | New | Nova |
2 | Reserved | Reservada |
3 | Issuing | Em emissão |
4 | Issued | Emitida |
5 | Canceled | Cancelada |
6 | OnRequest | Sob consulta |
7 | PreSale | Pré-venda |
8 | TechicalError | Erro técnico |
9 | Rejected | Rejeitada |
10 | Quote | Cotação |
11 | Pending | Pendente |
12 | CanceledQuote | Cotação cancelada |
FilterDateType
Define qual data da transação é usada nos filtros DateFrom / DateTo do List.
| Valor | Nome | Descrição |
|---|---|---|
1 | LastUpdate | Data da última atualização |
2 | Create | Data de criação |
3 | Insert | Data de inserção |
FilterLinkType
Filtra transações pelo vínculo com uma transação "pai" (Parent).
| Valor | Nome | Descrição |
|---|---|---|
0 | Any | Todas |
1 | OnlyWithParent | Somente com transação pai |
2 | OnlyWithoutParent | Somente sem transação pai |
ImportState (Status da Transação)
Usado no corpo da requisição do Change (rq.ImportState) e retornado no cabeçalho das transações:
| Valor | Nome | Descrição no backend | Papel no fluxo de integração |
|---|---|---|---|
0 | Undefined | Não definido / padrão do List | Valor padrão retornado no cabeçalho de listagem. |
1 | NotImported | Não importado (marcação removida) | Permite estornar a importação para que a venda seja reprocessada. |
2 | Imported | Importado (registrado no servidor) | Marca a venda como importada, excluindo-a das consultas de itens pendentes. |
FilterImportState (Filtro do List)
Usado exclusivamente no filtro FilterImportState da requisição do List:
| Valor | Nome | Descrição do filtro SQL |
|---|---|---|
0 | Any | Retorna todas as transações, sem verificar a tabela de exportação. |
1 | OnlyNotImported | Recomendado: retorna apenas as transações que não possuem registro de exportação para a sua credencial. |
2 | OnlyImported | Retorna apenas as transações que já foram marcadas como importadas pela sua credencial. |
Prefixos de UniqueId
| Prefixo | Produto | Detalhamento |
|---|---|---|
AIR | Reserva aérea | Aéreo (AIR / TKT) |
TKT | Bilhete aéreo emitido (e-ticket) | Aéreo (AIR / TKT) |
TS | Taxa de serviço | Taxas de serviço (TS) |
HTL | Hotel | Hotel (HTL) |
CAR | Locação de carro | Carro (CAR) |
Campos Fixos vs. Campos Cadastráveis
Para orientar os desenvolvedores de integração:
1. Valores fixos (Enums de código)
Estes campos possuem valores estritamente tipados e pré-definidos no backend da API. Não são customizáveis por clientes ou agências:
TransactionType(15 tipos)TransactionState(13 status)PaymentForm(19 meios de pagamento)PaymentState(9 status de pagamento)LinkType(4 tipos de relacionamento: Child, Parent, Related, SubRelated)FilterDateType(3 tipos de data: LastUpdate, Create, Insert)ProductDetail(15 propriedades tipadas fixas no modelo C#)
2. Campos cadastráveis (Configurados dinamicamente no sistema)
Estes campos não possuem valores fixos universais; eles variam dependendo da agência, consolidador ou cliente corporativo:
CorporateFields(CorporateField[]): Campos de política corporativa criados pela agência (Centro de Custo, Projeto, Matrícula, Motivo de Viagem, Menor Tarifa Recusada etc.).DynamicFields(DynamicField[]): Campos dinâmicos adicionais configurados na emissão.BackofficeDetail: Códigos de amarração cadastral para sincronização com ERPs (Código de Cliente, Código de Fornecedor, Código Wooffice).