Obter Lista de Vendas

Descrição

Este endpoint retorna as vendas registradas no sistema, podendo ser filtradas por membro, datas, status, tipos de venda, entre outros parâmetros.
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.).

🔑 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	string (date-time)	Filtra por data de início do registro da venda no formato `yyyy-mm-dd`.	null
dateSaleEnd	string (date-time)	Filtra por data de término do registro da venda no formato `yyyy-mm-dd`.	null
removalDateStart	string (date-time)	Filtra por data de início de remoção da venda no formato `yyyy-mm-dd`.	null
removalDateEnd	string (date-time)	Filtra por data de término de remoção da venda no formato `yyyy-mm-dd`.	null
receivablesRegistrationDateStart	string (date-time)	Filtra vendas com recebíveis registrados a partir de uma data específica.	null
receivablesRegistrationDateEnd	string (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
updateDate	string (date-time)	Filtra vendas com atualização a partir desta data.	null

📤 Estrutura da Resposta

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

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).
receivables	array	Lista de recebíveis associados à venda (parcelas, pagamentos, etc.). (Retornado somente se `showReceivables = true`)

🧩 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 `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.
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 `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 `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.

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.

Basic Auth

Envie suas requisições HTTP com um cabeçalho

Authorization

que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password

Exemplo:

Authorization: Basic *****************

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200OK

application/json

Success

Body

Exemplo

{
    "idSale": 0,
    "idMember": 0,
    "idEmployee": 0,
    "idProspect": 0,
    "idResponsible": 0,
    "idMemberResponsible": 0,
    "cpFresponsible": "string",
    "idEmployeeSale": 0,
    "saleDate": "2019-08-24T14:15:22.123Z",
    "saleDateServer": "2019-08-24T14:15:22.123Z",
    "idPersonal": 0,
    "corporatePartnershipName": "string",
    "coporatePartnershipId": 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
        }
    ],
    "receivables": [
        {
            "idReceivable": 0,
            "description": "string",
            "registrationDate": "2019-08-24T14:15:22.123Z",
            "dueDate": "2019-08-24T14:15:22.123Z",
            "receivingDate": "2019-08-24T14:15:22.123Z",
            "competenceDate": "2019-08-24T14:15:22.123Z",
            "cancellationDate": "2019-08-24T14:15:22.123Z",
            "ammount": 0,
            "ammountPaid": 0,
            "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"
                }
            ],
            "status": {
                "id": 0,
                "name": "string"
            },
            "currentInstallment": 0,
            "totalInstallments": 0,
            "authorization": "string",
            "payerName": "string",
            "idMemberPayer": 0,
            "idProspectPayer": 0,
            "idBranchMember": 0,
            "idResponsible": 0,
            "idMemberResponsible": 0,
            "cpfResponsible": "string",
            "idSale": 0,
            "bankAccount": {
                "id": 0,
                "name": "string"
            },
            "paymentType": {
                "id": 0,
                "name": "string"
            },
            "invoiceDetails": [
                {
                    "invoiceNumber": "string",
                    "issuedAmount": 0,
                    "status": "string",
                    "sendDate": "2019-08-24T14:15:22.123Z",
                    "canceledDate": "2019-08-24T14:15:22.123Z",
                    "urlPdf": "string",
                    "idInvoiceType": 0,
                    "invoiceType": "string"
                }
            ],
            "fees": 0,
            "conciliated": true,
            "logTef": {
                "authorization": "string",
                "tefId": "string",
                "merchantCheckoutGuid": "string"
            },
            "tid": "string",
            "nsu": "string",
            "updateDate": "2019-08-24T14:15:22.123Z",
            "chargeDate": "2019-08-24T14:15:22.123Z",
            "idReceivableFrom": 0,
            "transactionToken": "string",
            "idRevenueCenter": 0,
            "cardAcquirer": "string",
            "cardFlag": "string",
            "creditDetails": [
                {
                    "idCredit": 0,
                    "idCancelationCredit": 0,
                    "idBranchOrigin": 0,
                    "ammount": 0,
                    "branchDocument": "string",
                    "idSaleOrigin": 0,
                    "idReceivableOrigin": 0
                }
            ],
            "cancellationDescription": "string",
            "source": "string",
            "saleDate": "2019-08-24T14:15:22.123Z"
        }
    ],
    "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"
        }
    ]
}

🟠400Bad Request

Get sales

Obter Lista de Vendas#

Descrição#

🔑 Parâmetros da Requisição#

📤 Estrutura da Resposta#

🧩 Estrutura do Objeto saleItens#

🧩 Estrutura do Objeto receivables#

🧩 Estrutura do Objeto invoiceDetails#

🧩 Estrutura do Objeto creditDetails#

Observações#

Requisição