Pular para o conteúdo principal

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:

ValorNomeDescrição
0UndefinedIndefinido
101InvoiceFaturado
102GovernmentGovernamental / Empenho
103CashDinheiro
104CreditCrédito
105CreditCardCartão de crédito online
106CreditCardOfflineCartão de crédito offline
107DepositDepósito bancário
108TransferTransferência bancária
109BankSlipBoleto bancário
110RewardPontos / Recompensa
111CheckCheque
112BalconyBalcão
113TransferOnlineTransferência online
114PixPIX
115WalletCarteira digital
206PrePaidPré-pago
207GuaranteeGarantia
208GuaranteeCustomerGarantia do cliente

PaymentState​

Status do pagamento em Payments[].PaymentState:

ValorNomeDescrição
0UndefinedIndefinido
1InProgressEm andamento
2AuthorizedAutorizado
3RefusedRecusado
4ConfirmedConfirmado
5CanceledCancelado
6ErrorErro no processamento
7InPaymentByCustomerAguardando pagamento pelo cliente
8InAnalysisEm 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:

TransactionTypePropriedade em ProductDetailClasse / Tipo
1 (AirReservation)AirReservationDetailDetalhes da reserva aérea original
100 (AirTicket)AirTicketDetailDetalhes do bilhete aéreo emitido
1000 (Emd)AirEmdDetailDetalhes de bilhete EMD
2 (Hotel)HotelReservationDetailDetalhes da reserva de hotel
3 (Car)CarReservationDetailDetalhes da locação de veículo
4 (Insurance)InsuranceReservationDetailDetalhes do seguro viagem
5 (Services)ServiceReservationDetailDetalhes de serviços / transfers
6 (Bus)BusReservationDetailDetalhes da passagem rodoviária
7 (Cruise)CruiseReservationDetailDetalhes do cruzeiro marítimo
9 (OTA)OtaOrderDetailDetalhes do pedido da loja online
11 (ServiceTax)ServiceTaxDetailDetalhes da taxa de serviço
12 (Basket)BasketDetailDetalhes de pacote / cesta
13 (Corporate)ServiceOrderDetailDetalhes da ordem de serviço corporativa
15 (Circuit)CircuitReservationDetailDetalhes do circuito turístico
16 (Chip)ChipReservationDetailDetalhes do chip de telefonia

Além da propriedade específica do produto, ProductDetail sempre inclui metadados comuns:

  • SalesChannel (integer) e SalesChannelDescription (string): Canal de venda da transação.
  • InsertType (integer) e InsertTypeDescription (string): Tipo de inserção do registro.
  • InsertDate (string date-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.

ValorNomeDescrição
0UndefinedIndefinido
1AirReservationReserva aérea (AIR)
100AirTicketBilhete aéreo (TKT)
2HotelHotel (HTL)
3CarCarro (CAR)
4InsuranceSeguro
5ServicesServiços
6BusÔnibus
7CruiseCruzeiro
9OTALoja Online / Pedidos OTA
11ServiceTaxTaxa de serviço (TS)
12BasketCesta (Basket)
13CorporateOrdem de Serviço Corporativa (Corporate)
15CircuitCircuito
16ChipChip telefonia
1000EmdBilhete EMD

TransactionStates​

Usado no filtro TransactionStates do List e retornado em TransactionState.

ValorNomeDescrição
0UndefinedIndefinido
1NewNova
2ReservedReservada
3IssuingEm emissão
4IssuedEmitida
5CanceledCancelada
6OnRequestSob consulta
7PreSalePré-venda
8TechicalErrorErro técnico
9RejectedRejeitada
10QuoteCotação
11PendingPendente
12CanceledQuoteCotação cancelada

FilterDateType​

Define qual data da transação é usada nos filtros DateFrom / DateTo do List.

ValorNomeDescrição
1LastUpdateData da última atualização
2CreateData de criação
3InsertData de inserção

FilterLinkType​

Filtra transações pelo vínculo com uma transação "pai" (Parent).

ValorNomeDescrição
0AnyTodas
1OnlyWithParentSomente com transação pai
2OnlyWithoutParentSomente 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:

ValorNomeDescrição no backendPapel no fluxo de integração
0UndefinedNão definido / padrão do ListValor padrão retornado no cabeçalho de listagem.
1NotImportedNão importado (marcação removida)Permite estornar a importação para que a venda seja reprocessada.
2ImportedImportado (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:

ValorNomeDescrição do filtro SQL
0AnyRetorna todas as transações, sem verificar a tabela de exportação.
1OnlyNotImportedRecomendado: retorna apenas as transações que não possuem registro de exportação para a sua credencial.
2OnlyImportedRetorna apenas as transações que já foram marcadas como importadas pela sua credencial.

Prefixos de UniqueId​

PrefixoProdutoDetalhamento
AIRReserva aéreaAéreo (AIR / TKT)
TKTBilhete aéreo emitido (e-ticket)Aéreo (AIR / TKT)
TSTaxa de serviçoTaxas de serviço (TS)
HTLHotelHotel (HTL)
CARLocação de carroCarro (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).