Get sales
GET
https://evo-integracao-api.w12app.com.br/api/v2/sales
🌐 API Reference/Sales
Obter Lista de Vendas
Descrição
A resposta pode incluir também informações sobre itens da venda (serviços, produtos, matrículas) e recebíveis (parcelas, pagamentos, status de cobrança, etc.).
OBS. Disponível para uso com chave de acesso de filial e também com chave de acesso de ADM Geral.
🔑 Parâmetros da Requisição
| Parâmetro | Tipo | Descrição |
|---|---|---|
| idBranch | int32 | Filtra pelo ID de uma unidade/filial específica. |
| idMember | int32 | Filtra pelo ID de um membro específico. |
| dateSaleStart | string (date-time) | Filtra por data de início do registro da venda no formato yyyy-mm-dd. |
| dateSaleEnd | string (date-time) | Filtra por data de término do registro da venda no formato yyyy-mm-dd. |
| removalDateStart | string (date-time) | Filtra por data de início de remoção da venda no formato yyyy-mm-dd. |
| removalDateEnd | string (date-time) | Filtra por data de término de remoção da venda no formato yyyy-mm-dd. |
| receivablesRegistrationDateStart | string (date-time) | Filtra vendas com recebíveis registrados a partir de uma data específica. |
| receivablesRegistrationDateEnd | string (date-time) | Filtra vendas com recebíveis registrados até uma data específica. |
| updatedReceivableStartDate | string (date-time) | Filtra vendas cujos recebíveis foram atualizados a partir de uma data específica. |
| updatedReceivableEndDate | string (date-time) | Filtra vendas cujos recebíveis foram atualizados até uma data específica. |
| showReceivables | boolean | Flag para exibir recebíveis e valores de venda sem considerar créditos. default: false |
| take | int32 | Número total de registros a serem retornados (máximo de 100, padrão de 25). default: 25 |
| skip | int32 | Número total de registros a serem ignorados antes de começar a retornar resultados. default: 0 |
| onlyMembership | boolean | Retorna apenas vendas associadas a memberships (assinaturas). default: false |
| atLeastMonthly | boolean | Remove memberships com menos de 30 dias (como no parâmetro antigo removeMonthly). default: false |
| flSwimming | boolean | Filtra memberships associadas à flag de natação. default: false |
| showOnlyActiveMemberships | boolean | Retorna apenas memberships ativas. default: false |
| showAllowLocker | boolean | Indica se deve exibir vendas que permitem uso de armário. |
| onlyTotalPass | boolean | Retorna apenas vendas associadas a passes totais. |
| updateDate | string (date-time) | Filtra vendas com atualização a partir desta data. |
📤 Estrutura da Resposta
| Campo | Tipo | Descrição |
|---|---|---|
| idSale | int32 | Identificador único da venda. |
| idMember | int32 | ID do aluno vinculado à venda; |
| idEmployee | int32 | ID do funcionário associado. |
| idProspect | int32 | ID do prospect vinculado (se aplicável). |
| idEmployeeSale | int32 | ID do funcionário responsável pela venda. |
| saleDate | string (date-time) | Data em que a venda foi realizada. |
| saleDateServer | string (date-time) | Data da venda registrada pelo servidor. |
| idPersonal | int32 | ID do personal trainer vinculado à venda (se aplicável). |
| corporatePartnershipName | string | Nome da parceria corporativa vinculada (se aplicável). |
| coporatePartnershipId | int32 | ID da parceria corporativa. |
| removed | boolean | Indica se a venda foi removida/cancelada. |
| idEmployeeRemoval | int32 | ID do funcionário que realizou a remoção (se houver). |
| removalDate | string (date-time) | Data da remoção da venda (se houver). |
| idBranch | int32 | ID da filial onde a venda foi registrada. |
| observations | string | Observações relacionadas à venda. |
| idSaleRecurrency | int32 | Identificador de recorrência da venda (se aplicável). |
| saleSource | int32 | Origem da venda |
| idSaleMigration | string | Código de referência em caso de migração de vendas. |
| saleItens | array | Lista de itens associados à venda (produtos, serviços ou matrículas). |
| member | object | Aluno/membro associado à venda. Ver mais abaixo. |
| receivables | arrayobject | Lista de recebíveis associados à venda (parcelas, pagamentos, etc.). (Retornado somente se showReceivables = true) |
| responsibles | arrayobject | Lista de responsáveis associados à venda. |
| registrationKind | string | Tipo de registro associado à venda (renewal para recorrência ou null para nova venda). |
🧩 Estrutura do Objeto saleItens
| Campo | Tipo | Descrição |
|---|---|---|
| idSaleItem | int32 | ID do item da venda. |
| idSale | int32 | ID da venda associada. |
| description | string | Descrição do item. |
| item | string | Nome do item vendido. |
| itemValue | number | Valor unitário do item. |
| saleValue | number | Valor total do item na venda. |
| saleValueWithoutCreditValue | number | Valor total sem créditos aplicados. |
| quantity | int32 | Quantidade do item vendido. |
| idMembership | int32 | ID da matrícula (se aplicável). |
| idMembershipRenewed | int32 | ID da matrícula renovada (se aplicável). |
| numMembers | int32 | Quantidade de alunos vinculados ao item. |
| idProduct | int32 | ID do produto vendido (se aplicável). |
| idService | int32 | ID do serviço vendido (se aplicável). |
| corporatePartnershipName | string | Nome da parceria corporativa associada ao item. |
| coporatePartnershipId | int32 | ID da parceria corporativa associada ao item. |
| membershipStartDate | date-time | Data de início da matrícula (quando aplicável). |
| discount | number | Valor do desconto aplicado. |
| corporateDiscount | number | Valor do desconto corporativo aplicado. |
| tax | number | Valor de imposto. |
| voucher | string | Código de voucher aplicado. |
| accountingCode | string | Código contábil do item. |
| municipalServiceCode | string | Código de serviço municipal. |
| flReceiptOnly | boolean | Indica se o item é apenas de recibo. |
| idSaleItemMigration | string | Identificador do item em processo de migração. |
| flSwimming | boolean | Indica se o item dá acesso à piscina. |
| flAllowLocker | boolean | Indica se o item dá direito a armário. |
| idMemberMembership | int32 | ID do vínculo de matrícula do aluno. |
| valueNextMonth | number | Valor que será cobrado no próximo mês. |
🧩 Estrutura do objeto member
| Campo | Tipo | Descrição |
|---|---|---|
idMember | int32 | Identificador único do membro. |
firstName | string | Primeiro nome do membro. |
lastName | string | Sobrenome do membro. |
registerName | string | Nome registrado do membro no cadastro. |
registerLastName | string | Sobrenome registrado do membro no cadastro. |
usePreferredName | boolean | Indica se o sistema deve utilizar o nome preferencial do membro. |
document | string | Documento de identificação do membro. |
country | string | País informado no cadastro do membro. |
address | string | Endereço do membro. |
state | string | Estado do endereço do membro. |
city | string | Cidade do endereço do membro. |
passport | string | null |
zipCode | string | CEP do endereço do membro. |
complement | string | null |
neighborhood | string | Bairro do endereço do membro. |
number | string | Número do endereço. |
idMemberMigration | string | null |
registrationKind | string | Tipo de registro do membro (ex.: renewal para recorrência e null para nova venda). |
idFirstMemberMembership | int32 | Identificador da primeira matrícula (membership) do membro. |
contacts | array | Lista de contatos cadastrados para o membro. Ver estrutura abaixo. |
responsibles | array | Lista de responsáveis vinculados ao membro. Ver estrutura abaixo. |
diasRenovacao | int32 | Quantidade de dias considerados para renovação do contrato do membro. |
🧩 Estrutura do Objeto receivables
| Campo | Tipo | Descrição |
|---|---|---|
| idReceivable | int32 | ID do título gerado. |
| description | string | Descrição do recebível. |
| registrationDate | date-time | Data de registro do recebível. |
| dueDate | date-time | Data de vencimento. |
| receivingDate | date-time | Data de recebimento. |
| competenceDate | date-time | Data de competência. |
| cancellationDate | date-time | Data de cancelamento (se aplicável). |
| ammount | number | Valor do título. |
| ammountPaid | number | Valor pago. |
| responsibles | arrayobject | Responsáveis associados ao recebimento. |
| status | object | Status do recebível (contém id e name). |
| currentInstallment | int32 | Número da parcela atual. |
| totalInstallments | int32 | Total de parcelas. |
| authorization | string | Código de autorização da transação. |
| payerName | string | Nome do pagador. |
| idMemberPayer | int32 | ID do aluno pagador. |
| idProspectPayer | int32 | ID do prospect pagador. |
| idBranchMember | int32 | ID da filial do aluno. |
| idSale | int32 | ID da venda associada. |
| bankAccount | object | Conta bancária utilizada (id, name). |
| paymentType | object | Tipo de pagamento utilizado (id, name). |
| invoiceDetails | array | Lista de notas fiscais associadas. |
| fees | number | Valor de taxas aplicadas. |
| conciliated | boolean | Indica se o recebível foi conciliado. |
| logTef | object | Dados de TEF (transações eletrônicas de fundos). |
| tid | string | Identificador da transação. |
| nsu | string | Número sequencial único. |
| updateDate | date-time | Data da última atualização. |
| chargeDate | date-time | Data da cobrança. |
| idReceivableFrom | int32 | ID do título de origem. |
| transactionToken | string | Token da transação. |
| idRevenueCenter | int32 | ID do centro de receita. |
| cardAcquirer | string | Nome da adquirente do cartão. |
| cardFlag | string | Bandeira do cartão. |
| creditDetails | array | Detalhes de créditos associados. |
| cancellationDescription | string | Motivo do cancelamento. |
| source | string | Origem do recebível. |
| saleDate | date-time | Data da venda associada ao recebível. |
🧩 Estrutura do Objeto receivables.responsibles
| Campo | Tipo | Descrição |
|---|---|---|
| idResponsible | int32 | ID do responsável financeiro. |
| idMember | int32 | ID do membro ao qual o responsável está vinculado. |
| name | string | Nome do responsável. |
| cpf | string | CPF do responsável. |
| string | E-mail do responsável. | |
| phone | string | Telefone do responsável. |
| observation | string | Observações adicionais sobre o responsável. |
| idMemberResponsible | int32 | ID do membro que atua como responsável. |
| acessFiti | boolean | Indica se o responsável possui acesso ao Fiti. |
| financialResponsible | boolean | Indica se é o responsável financeiro. |
| personType | string | Tipo de pessoa do responsável (ex.: Física ou Jurídica). |
| document | string | Documento do responsável (CPF ou CNPJ, conforme o tipo de pessoa). |
🧩 Estrutura do Objeto receivables.invoiceDetails
| Campo | Tipo | Descrição |
|---|---|---|
| invoiceNumber | string | Número da nota fiscal. |
| issuedAmount | number | Valor emitido na nota. |
| status | string | Status da nota fiscal. |
| sendDate | date-time | Data de envio da nota. |
| canceledDate | date-time | Data de cancelamento (se aplicável). |
| urlPdf | string | Link para o PDF da nota fiscal. |
| idInvoiceType | int32 | ID do tipo de nota fiscal. |
| invoiceType | string | Tipo de nota fiscal. |
🧩 Estrutura do Objeto receivables.logTef
| Campo | Tipo | Descrição |
|---|---|---|
| authorization | string | Código de autorização TEF. |
| tefId | string | ID TEF. |
| merchantCheckoutGuid | string | GUID do checkout do lojista. |
🧩 Estrutura do Objeto receivables.creditDetails
| Campo | Tipo | Descrição |
|---|---|---|
| idCredit | int32 | ID do crédito. |
| idCancelationCredit | int32 | ID do crédito de cancelamento. |
| idBranchOrigin | int32 | ID da filial de origem. |
| ammount | number | Valor do crédito. |
| branchDocument | string | Documento da filial. |
| idSaleOrigin | int32 | ID da venda de origem. |
| idReceivableOrigin | int32 | ID do título de origem. |
🧩 Estrutura do Objeto responsibles
| Campo | Tipo | Descrição |
|---|---|---|
| idResponsible | int32 | ID do responsável financeiro. |
| idMember | int32 | ID do membro ao qual o responsável está vinculado. |
| name | string | Nome do responsável. |
| cpf | string | CPF do responsável. |
| string | E-mail do responsável. | |
| phone | string | Telefone do responsável. |
| observation | string | Observações adicionais sobre o responsável. |
| idMemberResponsible | int32 | ID do membro que atua como responsável. |
| acessFiti | boolean | Indica se o responsável possui acesso ao Fiti. |
| financialResponsible | boolean | Indica se é o responsável financeiro. |
| personType | string | Tipo de pessoa do responsável (ex.: Física ou Jurídica). |
| document | string | Documento do responsável (CPF ou CNPJ, conforme o tipo de pessoa). |
Request
Query Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://evo-integracao-api.w12app.com.br/api/v2/sales?idBranch=undefined&idMember=undefined&dateSaleStart=undefined&dateSaleEnd=undefined&removalDateStart=undefined&removalDateEnd=undefined&receivablesRegistrationDateStart=undefined&receivablesRegistrationDateEnd=undefined&updatedReceivableStartDate=undefined&updatedReceivableEndDate=undefined&showReceivables=undefined&take=undefined&skip=undefined&onlyMembership=undefined&atLeastMonthly=undefined&flSwimming=undefined&showOnlyActiveMemberships=undefined&showAllowLocker=undefined&onlyTotalPass=undefined&updateDate=undefined' \
--header 'Authorization: Basic <encoded-value>'Response Response Example
200 - Example 1
{
"idSale": 0,
"idMember": 0,
"idEmployee": 0,
"nameEmployee": "string",
"idProspect": 0,
"idResponsible": 0,
"idMemberResponsible": 0,
"cpfResponsible": "string",
"idEmployeeSale": 0,
"updateDate": "2019-08-24T14:15:22.123Z",
"nameEmployeeSale": "string",
"saleDate": "2019-08-24T14:15:22.123Z",
"saleDateServer": "2019-08-24T14:15:22.123Z",
"timeZone": "string",
"idPersonal": 0,
"removed": true,
"idEmployeeRemoval": 0,
"removalDate": "2019-08-24T14:15:22.123Z",
"idBranch": 0,
"observations": "string",
"idSaleRecurrency": 0,
"saleSource": 0,
"idSaleMigration": "string",
"idCartToken": "string",
"saleItens": [
{
"idSaleItem": 0,
"idSale": 0,
"description": "string",
"item": "string",
"itemValue": 0,
"saleValue": 0,
"saleValueWithoutCreditValue": 0,
"quantity": 0,
"idMembership": 0,
"idMembershipRenewed": 0,
"numMembers": 0,
"idProduct": 0,
"idService": 0,
"corporatePartnershipName": "string",
"coporatePartnershipId": 0,
"membershipStartDate": "2019-08-24T14:15:22.123Z",
"discount": 0,
"corporateDiscount": 0,
"tax": 0,
"voucher": "string",
"accountingCode": "string",
"municipalServiceCode": "string",
"flReceiptOnly": true,
"idSaleItemMigration": "string",
"flSwimming": true,
"flAllowLocker": true,
"idMemberMembership": 0,
"valueNextMonth": 0
}
],
"member": {
"idMember": 0,
"firstName": "string",
"lastName": "string",
"registerName": "string",
"registerLastName": "string",
"usePreferredName": true,
"document": "string",
"country": "string",
"address": "string",
"state": "string",
"city": "string",
"passport": "string",
"zipCode": "string",
"complement": "string",
"neighborhood": "string",
"number": "string",
"idMemberMigration": "string",
"registrationKind": "string",
"idFirstMemberMembership": 0,
"contacts": [
{
"idPhone": 0,
"idMember": 0,
"idEmployee": 0,
"idProspect": 0,
"idProvider": 0,
"idContactType": 1,
"contactType": "string",
"ddi": "string",
"description": "string"
}
],
"responsibles": [
{
"idResponsible": 0,
"idMember": 0,
"name": "string",
"cpf": "string",
"email": "string",
"phone": "string",
"observation": "string",
"idMemberResponsible": 0,
"acessFiti": true,
"financialResponsible": true,
"personType": "string",
"document": "string",
"cep": "string",
"adress": "string",
"number": "string",
"complement": "string",
"district": "string",
"city": "string",
"state": "string"
}
],
"diasRenovacao": 0
},
"prospect": {
"idProspect": 0,
"idBranch": 0,
"branchName": "string",
"firstName": "string",
"lastName": "string",
"registerName": "string",
"registerLastName": "string",
"usePreferredName": true,
"document": "string",
"rg": "string",
"cellphone": "string",
"email": "string",
"gympassId": "string",
"registerDate": "2019-08-24T14:15:22.123Z",
"gender": "string",
"birthDate": "2019-08-24T14:15:22.123Z",
"signupType": "string",
"mktChannel": "string",
"conversionDate": "2019-08-24T14:15:22.123Z",
"idMember": 0,
"currentStep": "string",
"address": "string",
"city": "string",
"complement": "string",
"neighborhood": "string",
"state": "string",
"country": "string",
"zipCode": "string",
"number": "string",
"temperature": "string",
"notes": "string",
"interests": [
"string"
],
"financiallyResponsibles": [
{
"idResponsible": 0,
"idMember": 0,
"name": "string",
"cpf": "string",
"email": "string",
"phone": "string",
"observation": "string",
"idMemberResponsible": 0,
"acessFiti": true,
"financialResponsible": true,
"personType": "string",
"document": "string",
"cep": "string",
"adress": "string",
"number": "string",
"complement": "string",
"district": "string",
"city": "string",
"state": "string"
}
]
},
"receivables": [
{
"idReceivable": 0,
"registrationDate": "2019-08-24T14:15:22.123Z",
"dueDate": "2019-08-24T14:15:22.123Z",
"receivingDate": "2019-08-24T14:15:22.123Z",
"cancellationDate": "2019-08-24T14:15:22.123Z",
"ammount": 0,
"ammountPaid": 0,
"status": {
"id": 0,
"name": "string"
},
"currentInstallment": 0,
"totalInstallments": 0,
"authorization": "string",
"idSale": 0,
"paymentType": {
"id": 0,
"name": "string"
},
"logTef": {
"authorization": "string",
"tefId": "string",
"merchantCheckoutGuid": "string"
},
"tid": "string",
"nsu": "string",
"cardFlag": "string",
"creditDetails": [
{
"idCredit": 0,
"idCancelationCredit": 0,
"idBranchOrigin": 0,
"ammount": 0,
"branchDocument": "string",
"idSaleOrigin": 0,
"idReceivableOrigin": 0
}
],
"transactionToken": "string",
"updateDate": "2019-08-24T14:15:22.123Z"
}
],
"registrationKind": "string"
}Modified at 2026-05-15 04:38:45