Get sales

Obtener Lista de Ventas

Descripción

Este endpoint devuelve las ventas registradas en el sistema, pudiendo filtrarse por miembro, fechas, estado, tipos de venta, entre otros parámetros.
La respuesta puede incluir también información sobre los ítems de la venta (servicios, productos, membresías) y recibos (cuotas, pagos, estado de cobro, etc.).

OBS. Disponible para uso con clave de acceso de sucursal y también con clave de acceso de ADM General.

🔑 Parámetros de la Solicitud

Parámetro	Tipo	Descripción
idBranch	int32	Filtra por ID de una unidad/sucursal específica.
idMember	int32	Filtra por ID de un miembro específico.
dateSaleStart	string (date-time)	Filtra por fecha de inicio del registro de la venta en formato `yyyy-mm-dd`.
dateSaleEnd	string (date-time)	Filtra por fecha de fin del registro de la venta en formato `yyyy-mm-dd`.
removalDateStart	string (date-time)	Filtra por fecha de inicio de eliminación de la venta en formato `yyyy-mm-dd`.
removalDateEnd	string (date-time)	Filtra por fecha de fin de eliminación de la venta en formato `yyyy-mm-dd`.
receivablesRegistrationDateStart	string (date-time)	Filtra ventas con recibos registrados a partir de una fecha específica.
receivablesRegistrationDateEnd	string (date-time)	Filtra ventas con recibos registrados hasta una fecha específica.
updatedReceivableStartDate	string (date-time)	Filtra ventas cuyos recibos fueron actualizados a partir de una fecha específica.
updatedReceivableEndDate	string (date-time)	Filtra ventas cuyos recibos fueron actualizados hasta una fecha específica.
showReceivables	boolean	Flag para mostrar recibos y valores de venta sin considerar créditos. Default: `false`
take	int32	Total de registros a devolver (máx. 100, default: 25).
skip	int32	Total de registros a omitir antes de devolver resultados. Default: `0`
onlyMembership	boolean	Devuelve solo ventas asociadas a membresías. Default: `false`
atLeastMonthly	boolean	Elimina membresías con menos de 30 días. Default: `false`
flSwimming	boolean	Filtra membresías asociadas a la flag de natación. Default: `false`
showOnlyActiveMemberships	boolean	Devuelve solo membresías activas. Default: `false`
showAllowLocker	boolean	Indica si se deben mostrar ventas que permiten uso de casillero.
onlyTotalPass	boolean	Devuelve solo ventas asociadas a pases totales.
updateDate	string (date-time)	Filtra ventas con actualización a partir de esta fecha.

📤 Estructura de la Respuesta

La respuesta devuelve una lista de ventas con la siguiente estructura:

Campo	Tipo	Descripción
idSale	int32	Identificador único de la venta.
idMember	int32	ID del alumno vinculado a la venta.
idEmployee	int32	ID del empleado asociado.
idProspect	int32	ID del prospect vinculado (si aplica).
idEmployeeSale	int32	ID del empleado responsable de la venta.
saleDate	string (date-time)	Fecha en que se realizó la venta.
saleDateServer	string (date-time)	Fecha de registro de la venta en el servidor.
idPersonal	int32	ID del personal trainer vinculado a la venta (si aplica).
corporatePartnershipName	string	Nombre de la alianza corporativa asociada (si aplica).
coporatePartnershipId	int32	ID de la alianza corporativa.
removed	boolean	Indica si la venta fue eliminada/cancelada.
idEmployeeRemoval	int32	ID del empleado que realizó la eliminación (si aplica).
removalDate	string (date-time)	Fecha de eliminación de la venta (si aplica).
idBranch	int32	ID de la sucursal donde se registró la venta.
observations	string	Observaciones relacionadas a la venta.
idSaleRecurrency	int32	Identificador de recurrencia de la venta (si aplica).
saleSource	int32	Origen de la venta.
idSaleMigration	string	Código de referencia en caso de migración de ventas.
saleItens	array	Lista de ítems asociados a la venta (productos, servicios o membresías).
member	object	Alumno/miembro asociado a la venta. Ver detalle más abajo.
receivables	arrayobject	Lista de recibos asociados a la venta (cuotas, pagos, etc.). (Solo si `showReceivables = true`)
responsibles	arrayobject	Lista de responsables asociados a la venta.
registrationKind	string	Tipo de registro asociado a la venta (`renewal` para recurrencia o null para nueva venta).

🧩 Estructura del Objeto `saleItens`

Campo	Tipo	Descripción
idSaleItem	int32	ID del ítem de la venta.
idSale	int32	ID de la venta asociada.
description	string	Descripción del ítem.
item	string	Nombre del ítem vendido.
itemValue	number	Valor unitario del ítem.
saleValue	number	Valor total del ítem en la venta.
saleValueWithoutCreditValue	number	Valor total sin créditos aplicados.
quantity	int32	Cantidad del ítem vendido.
idMembership	int32	ID de la membresía (si aplica).
idMembershipRenewed	int32	ID de la membresía renovada (si aplica).
numMembers	int32	Número de alumnos vinculados al ítem.
idProduct	int32	ID del producto vendido (si aplica).
idService	int32	ID del servicio vendido (si aplica).
corporatePartnershipName	string	Nombre de la alianza corporativa asociada al ítem.
coporatePartnershipId	int32	ID de la alianza corporativa asociada al ítem.
membershipStartDate	date-time	Fecha de inicio de la membresía (si aplica).
discount	number	Valor del descuento aplicado.
corporateDiscount	number	Valor del descuento corporativo aplicado.
tax	number	Valor de impuestos.
voucher	string	Código de voucher aplicado.
accountingCode	string	Código contable del ítem.
municipalServiceCode	string	Código de servicio municipal.
flReceiptOnly	boolean	Indica si el ítem es solo de recibo.
idSaleItemMigration	string	Identificador del ítem en proceso de migración.
flSwimming	boolean	Indica si el ítem da acceso a la piscina.
flAllowLocker	boolean	Indica si el ítem permite uso de casillero.
idMemberMembership	int32	ID del vínculo de membresía del alumno.
valueNextMonth	number	Valor que se cobrará el próximo mes.

🧩 Estructura del Objeto `member`

Campo	Tipo	Descripción
`idMember`	int32	Identificador único del miembro.
`firstName`	string	Primer nombre del miembro.
`lastName`	string	Apellido del miembro.
`registerName`	string	Nombre registrado del miembro en el sistema.
`registerLastName`	string	Apellido registrado del miembro en el sistema.
`usePreferredName`	boolean	Indica si el sistema debe usar el nombre preferencial del miembro.
`document`	string	Documento de identificación del miembro.
`country`	string	País registrado del miembro.
`address`	string	Dirección del miembro.
`state`	string	Estado de la dirección.
`city`	string	Ciudad de la dirección.
`passport`	string	Número de pasaporte del miembro, si aplica.
`zipCode`	string	Código postal de la dirección.
`complement`	string	Complemento de la dirección.
`neighborhood`	string	Barrio de la dirección.
`number`	string	Número de la dirección.
`idMemberMigration`	string	Identificador del miembro en proceso de migración de base de datos.
`registrationKind`	string	Tipo de registro del miembro (`renewal` para recurrencia o null para nueva venta).
`idFirstMemberMembership`	int32	Identificador de la primera membresía del miembro.
`contacts`	array	Lista de contactos del miembro. Ver estructura de contactos.
`responsibles`	array	Lista de responsables vinculados al miembro. Ver estructura de responsables.
`diasRenovacao`	int32	Cantidad de días considerados para la renovación del contrato.

🧩 Estructura del Objeto `receivables`

Campo	Tipo	Descripción
idReceivable	int32	ID del título generado.
description	string	Descripción del recibo.
registrationDate	date-time	Fecha de registro del recibo.
dueDate	date-time	Fecha de vencimiento.
receivingDate	date-time	Fecha de cobro.
competenceDate	date-time	Fecha de competencia.
cancellationDate	date-time	Fecha de cancelación (si aplica).
ammount	number	Valor del recibo.
ammountPaid	number	Valor pagado.
responsibles	arrayobject	Responsables asociados al recibo.
status	object	Estado del recibo (`id` y `name`).
currentInstallment	int32	Número de la cuota actual.
totalInstallments	int32	Total de cuotas.
authorization	string	Código de autorización de la transacción.
payerName	string	Nombre del pagador.
idMemberPayer	int32	ID del alumno pagador.
idProspectPayer	int32	ID del prospect pagador.
idBranchMember	int32	ID de la sucursal del alumno.
idSale	int32	ID de la venta asociada.
bankAccount	object	Cuenta bancaria utilizada (`id`, `name`).
paymentType	object	Tipo de pago utilizado (`id`, `name`).
invoiceDetails	array	Lista de facturas asociadas.
fees	number	Valor de tasas aplicadas.
conciliated	boolean	Indica si el recibo fue conciliado.
logTef	object	Datos de TEF (transacciones electrónicas).
tid	string	Identificador de la transacción.
nsu	string	Número secuencial único.
updateDate	date-time	Fecha de la última actualización.
chargeDate	date-time	Fecha del cobro.
idReceivableFrom	int32	ID del recibo de origen.
transactionToken	string	Token de la transacción.
idRevenueCenter	int32	ID del centro de ingresos.
cardAcquirer	string	Nombre del adquirente de la tarjeta.
cardFlag	string	Marca de la tarjeta.
creditDetails	array	Detalles de créditos asociados.
cancellationDescription	string	Motivo de cancelación.
source	string	Origen del recibo.
saleDate	date-time	Fecha de la venta asociada al recibo.

🧩 Estructura del Objeto `receivables.responsibles`

Campo	Tipo	Descripción
idResponsible	int32	ID del responsable financiero.
idMember	int32	ID del miembro al cual el responsable está vinculado.
name	string	Nombre del responsable.
cpf	string	CPF del responsable.
email	string	Correo electrónico del responsable.
phone	string	Teléfono del responsable.
observation	string	Observaciones adicionales sobre el responsable.
idMemberResponsible	int32	ID del miembro que actúa como responsable.
acessFiti	boolean	Indica si el responsable tiene acceso al Fiti.
financialResponsible	boolean	Indica si es el responsable financiero.
personType	string	Tipo de persona del responsable (ej.: Física o Jurídica).
document	string	Documento del responsable (CPF o CNPJ, según el tipo de persona).

🧩 Estructura del Objeto `receivables.invoiceDetails`

Campo	Tipo	Descripción
invoiceNumber	string	Número de la factura.
issuedAmount	number	Valor emitido en la factura.
status	string	Estado de la factura.
sendDate	date-time	Fecha de envío de la factura.
canceledDate	date-time	Fecha de cancelación (si aplica).
urlPdf	string	Enlace al PDF de la factura.
idInvoiceType	int32	ID del tipo de factura.
invoiceType	string	Tipo de factura.

🧩 Estructura del Objeto `receivables.logTef`

Campo	Tipo	Descripción
authorization	string	Código de autorización TEF.
tefId	string	ID TEF.
merchantCheckoutGuid	string	GUID del checkout del comerciante.

🧩 Estructura del Objeto `receivables.creditDetails`

Campo	Tipo	Descripción
idCredit	int32	ID del crédito.
idCancelationCredit	int32	ID del crédito de cancelación.
idBranchOrigin	int32	ID de la sucursal de origen.
ammount	number	Valor del crédito.
branchDocument	string	Documento de la sucursal.
idSaleOrigin	int32	ID de la venta de origen.
idReceivableOrigin	int32	ID del título de origen.

🧩 Estructura del Objeto `responsibles`

Campo	Tipo	Descripción
idResponsible	int32	ID del responsable financiero.
idMember	int32	ID del miembro al cual el responsable está vinculado.
name	string	Nombre del responsable.
cpf	string	CPF del responsable.
email	string	Correo electrónico del responsable.
phone	string	Teléfono del responsable.
observation	string	Observaciones adicionales sobre el responsable.
idMemberResponsible	int32	ID del miembro que actúa como responsable.
acessFiti	boolean	Indica si el responsable tiene acceso al Fiti.
financialResponsible	boolean	Indica si es el responsable financiero.
personType	string	Tipo de persona del responsable (ej.: Física o Jurídica).
document	string	Documento del responsable (CPF o CNPJ, según el tipo de persona).

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

Obtener Lista de Ventas#

Descripción#

🔑 Parámetros de la Solicitud#

📤 Estructura de la Respuesta#

🧩 Estructura del Objeto saleItens#

🧩 Estructura del Objeto member#

🧩 Estructura del Objeto receivables#

🧩 Estructura del Objeto receivables.responsibles#

🧩 Estructura del Objeto receivables.invoiceDetails#

🧩 Estructura del Objeto receivables.logTef#

🧩 Estructura del Objeto receivables.creditDetails#

🧩 Estructura del Objeto responsibles#

Requisição