Get sales

Obter Lista de Vendas

Descrição

Este endpoint recupera uma lista de vendas com diversos filtros opcionais, permitindo personalizar a busca por datas, membros, recebíveis, tipos de associação, e outras opções relacionadas a vendas.


Parâmetros da Requisição

ParâmetroTipoDescriçãoValor Padrão
idMemberInt32Filtra pelo ID de um membro específico.null
dateSaleStartdate-timeFiltra por data de início do registro da venda no formato yyyy-mm-dd.null
dateSaleEnddate-timeFiltra por data de término do registro da venda no formato yyyy-mm-dd.null
removalDateStartdate-timeFiltra por data de início de remoção da venda no formato yyyy-mm-dd.null
removalDateEnddate-timeFiltra por data de término de remoção da venda no formato yyyy-mm-dd.null
receivablesRegistrationDateStartdate-timeFiltra vendas com recebíveis registrados a partir de uma data específica.null
receivablesRegistrationDateEnddate-timeFiltra vendas com recebíveis registrados até uma data específica.null
showReceivablesbooleanFlag para exibir recebíveis e valores de venda sem considerar créditos.false
takeInt32Número total de registros a serem retornados (máximo de 100, padrão de 25).25
skipInt32Número total de registros a serem ignorados antes de começar a retornar resultados.0
onlyMembershipbooleanRetorna apenas vendas associadas a memberships (assinaturas).false
atLeastMonthlybooleanRemove memberships com menos de 30 dias (como no parâmetro antigo removeMonthly).false
flSwimmingbooleanFiltra memberships associadas à flag de natação.false
showOnlyActiveMembershipsbooleanRetorna apenas memberships ativas.false
showAllowLockerbooleanIndica se deve exibir vendas que permitem uso de armário.null
onlyTotalPassbooleanRetorna apenas vendas associadas a passes totais.null

Resposta

A resposta retorna uma lista de vendas com a seguinte estrutura:

CampoTipoDescrição
idSaleInt32Identificador único da venda.
dateSalestringData da venda no formato ISO yyyy-mm-ddTHH:mm:ss.
idMemberInt32ID do membro associado à venda.
amountDoubleValor total da venda.
statusstringStatus da venda (ex: active, removed).
membershipbooleanIndica se a venda está associada a uma assinatura.
flSwimmingbooleanIndica se a venda está associada a natação.
lockerAllowedbooleanIndica se a venda permite o uso de armários.
showOnlyActiveMembershipsbooleanIndica se a venda está ativa.

Observações

  • O parâmetro take limita o número de registros retornados, com um máximo de 100 registros por requisição.
  • O parâmetro skip pode ser utilizado para implementar paginação.
  • O endpoint suporta filtros avançados para vendas removidas, recebíveis e memberships ativas.
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!