Invitations

Serviço responsável pelas operações de consulta, venda e cancelamento de convites.

GetInvitations

Consulta os convites disponíveis.

Parâmetros

Nome	Tipo	Descrição
data	InvitationsData	Dados para consulta dos convites.

Retorno

Tipo	Descrição
PlanResult[]	Retorna os convites disponíveis.

GetMapLocations

Consulta os locais disponíveis de um mapa para uma determinada data.

Parâmetros

Nome	Tipo	Descrição
data	MapLocationsData	Dados para consulta de disponibilidade dos locais do mapa.

Retorno

Tipo	Descrição
MapLocationResult[]	Retorna dados dos locais do mapa para a data informada.

GetAvailableQuantity

Consulta a quantidade disponível do convite para uma determinada data.

Parâmetros

Nome	Tipo	Descrição
data	AvailableQuantityData	Dados para consulta da quantidade disponível do convite para uma determinada data.

Retorno

Tipo	Descrição
AvailableQuantityResult	Retorna a quantidade disponível do convite. Se não houver limite de compra, retorna nulo. Se o convite estiver esgotado, retorna 0. Caso possua um ou mais convites disponíveis, retorna a quantidade disponível.

GetSales

Consulta convites comprados, com seus detalhes e código.

Parâmetros

Nome	Tipo	Descrição
data	SalesData	Dados para consulta de convites comprados.

Retorno

Tipo	Descrição
SaleResult[]	Retorna os dados dos convites comprados.

Sell

Realiza vendas de convites.

Parâmetros

Nome	Tipo	Descrição
data	SellData	Dados para a realizar a venda.

Retorno

Tipo	Descrição
SellResult	Retorna dados dos convites adquiridos.

CancelSale

Cancela uma venda de convite efetuada.

Parâmetros

Nome	Tipo	Descrição
data	CancelData	Dados do cancelamento da venda.

Retorno

Tipo	Descrição
Boolean	Retorna verdadeiro se o cancelamento ocorreu com sucesso.

GetInvitationPrint

Imprime convites comprados.

Parâmetros

Nome	Tipo	Descrição
data	InvitationPrintData	Dados para impressão do convite.

Retorno

Tipo	Descrição
InvitationPrintResult[]	Retorna o conteúdo em bytes do PDF da impressão do convite.

GetParcels

Retorna as parcelas possíveis para venda

Parâmetros

Nome	Tipo	Descrição
data	ParcelData	Dados para receber o parcelamento

Retorno

Tipo	Descrição
ParcelResult[]	Os parcelamentos possíveis para venda

Error codes

Códigos de erro retornados pelo serviço

Valores

Nome	Valor	Descrição
InvitationNotFound	1	Fornecido como parâmetro um convite que não foi encontrado.
InvalidInvitationQuantity	2	Fornecido como parâmetro uma quantidade de convites inválida.
SaleAlreadyUsed	3	Fornecido como parâmetro uma venda que possui convites já utilizados no parque.
InvalidAccessCode	4	O código de acesso informado é inválido.
InvalidVoucher	5	Fornecido um voucher que não possui ao menos um pacote com convite.
VoucherCodeAlreadyUsed	6	Código do voucher informado já existe.
SaleNotFound	7	Fornecido como parâmetro uma venda que não foi encontrada.
SaleAlreadyCanceled	8	Fornecido como parâmetro uma venda que já foi cancelada.
SaleCapacityExceeded	9	A capacidade de vendas dos convites informados foi excedida.
SaleValuesDiffer	10	Valores totais da venda diferem do somatório dos valores dos itens.
SaleValuesDifferFromPayments	11	Valor pago total da venda difere do somatório dos valores dos pagamentos informados.
PaymentValueGreaterThanSale	12	Valor pago é maior que o valor da venda.
InvalidPeriod	13	Período informado inválido
InvalidSaleEdit	14	Informado para edição uma venda que não tem origem de convite integrado ou o usuário de edição é diferente do utilizado para a venda.
UnavailableVisitDate	15	A data informada não está disponível para visita.
UnavailableSalePlan	16	O plano de vendas não está disponível.
MissingPayment	17	Informado um valor a ser pago e não informado o pagamento.
TitleNotFound	18	Fornecido como parâmetro um título que não foi encontrado.
RequiredCreditCard	19	Nenhum cartão de crédito foi informado.
InvalidPaymentMode	20
UnavailableCloud	21	Não é possível estabelecer conexão com o data center do sistema.
UnavailableMultiVendas	22	Não é possível estabelecer conexão com o servidor de consumo do sistema.
PaymentFail	23	Falha no pagamento.
IndentificationRequired	24	Identificação de convite necessária.
InvalidPackage	25	Convite inválido.
InvalidTitle	26	Título inválido.
NoSalePlans	27	Não há planos de venda para a data requerida.
MapNotFound	28	Mapa não encontrado.
MapLocationNotFound	29	Local do mapa não encontrado.
MapLocationInvalidInvitationQuantity	30	Quantidade de convites inválida para mapas de ocupação. A quantidade máxima de convites para mapa de ocupação deve ser sempre igual a 1.
IntegrationNotEnabled	31	Integração não habilitada no MultiClubes.
TefCancelFailed	32	Falha no cancelamento do pagamento.
SalePlanPaymentNotConfigured	33	Pagamento do plano de venda não configurado.
OneMoreSalePlan	34	Há mais de um plano de venda envolvido na venda.
InvalidParcelQuantity	35	Quantidade parcelas maior do que a quantidade maxima configurada.
InvalidValueOfParcel	36	Valor por parcela inválido.
AutenticationKeyMissing	901	Chave de autenticação não informada.
AutenticationKeyInvalid	902	Fornecido como parâmetro uma chave de autenticação inválida. Este erro ocorre quando, a chave não é encontrada, quando a chave informada está incorreta ou quando o usuário associado a chave não possui permissão para utilizar a API.
IntegrationDisabled	903	A integração com o aplicativo está desativada. Este erro ocorre devido a configuração na administração do servidor.