get https://evo-integracao-api.w12app.com.br/api/v2/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âmetro | Tipo | Descrição | Valor Padrão |
---|---|---|---|
idMember | Int32 | Filtra pelo ID de um membro específico. | null |
dateSaleStart | date-time | Filtra por data de início do registro da venda no formato yyyy-mm-dd . | null |
dateSaleEnd | date-time | Filtra por data de término do registro da venda no formato yyyy-mm-dd . | null |
removalDateStart | date-time | Filtra por data de início de remoção da venda no formato yyyy-mm-dd . | null |
removalDateEnd | date-time | Filtra por data de término de remoção da venda no formato yyyy-mm-dd . | null |
receivablesRegistrationDateStart | date-time | Filtra vendas com recebíveis registrados a partir de uma data específica. | null |
receivablesRegistrationDateEnd | date-time | Filtra vendas com recebíveis registrados até uma data específica. | null |
showReceivables | boolean | Flag para exibir recebíveis e valores de venda sem considerar créditos. | false |
take | Int32 | Número total de registros a serem retornados (máximo de 100, padrão de 25). | 25 |
skip | Int32 | Número total de registros a serem ignorados antes de começar a retornar resultados. | 0 |
onlyMembership | boolean | Retorna apenas vendas associadas a memberships (assinaturas). | false |
atLeastMonthly | boolean | Remove memberships com menos de 30 dias (como no parâmetro antigo removeMonthly ). | false |
flSwimming | boolean | Filtra memberships associadas à flag de natação. | false |
showOnlyActiveMemberships | boolean | Retorna apenas memberships ativas. | false |
showAllowLocker | boolean | Indica se deve exibir vendas que permitem uso de armário. | null |
onlyTotalPass | boolean | Retorna apenas vendas associadas a passes totais. | null |
Resposta
A resposta retorna uma lista de vendas com a seguinte estrutura:
Campo | Tipo | Descrição |
---|---|---|
idSale | Int32 | Identificador único da venda. |
dateSale | string | Data da venda no formato ISO yyyy-mm-ddTHH:mm:ss . |
idMember | Int32 | ID do membro associado à venda. |
amount | Double | Valor total da venda. |
status | string | Status da venda (ex: active , removed ). |
membership | boolean | Indica se a venda está associada a uma assinatura. |
flSwimming | boolean | Indica se a venda está associada a natação. |
lockerAllowed | boolean | Indica se a venda permite o uso de armários. |
showOnlyActiveMemberships | boolean | Indica 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.