Obtener Lista de Ventas

Descripción

Este endpoint devuelve las ventas registradas en el sistema y permite filtrarlas por miembro, fechas, estado, tipos de venta y otros parámetros.

La respuesta también puede incluir información sobre los elementos de la venta (servicios, productos, memberships) y cuentas por cobrar (cuotas, pagos, estado de cobro, etc.).

OBS. Disponible para su 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 el ID de una unidad/sucursal específica.
`idMember`	int32	Filtra por el ID de un miembro específico.
`dateSaleStart`	string (date-time)	Filtra por fecha de inicio del registro de la venta en el formato `yyyy-mm-dd`.
`dateSaleEnd`	string (date-time)	Filtra por fecha de finalización del registro de la venta en el formato `yyyy-mm-dd`.
`removalDateStart`	string (date-time)	Filtra por fecha de inicio de eliminación de la venta en el formato `yyyy-mm-dd`.
`removalDateEnd`	string (date-time)	Filtra por fecha de finalización de eliminación de la venta en el formato `yyyy-mm-dd`.
`receivablesRegistrationDateStart`	string (date-time)	Filtra ventas con cuentas por cobrar registradas a partir de una fecha específica.
`receivablesRegistrationDateEnd`	string (date-time)	Filtra ventas con cuentas por cobrar registradas hasta una fecha específica.
`updatedReceivableStartDate`	string (date-time)	Filtra ventas cuyas cuentas por cobrar fueron actualizadas a partir de una fecha específica.
`updatedReceivableEndDate`	string (date-time)	Filtra ventas cuyas cuentas por cobrar fueron actualizadas hasta una fecha específica.
`showReceivables`	boolean	Indicador para mostrar las cuentas por cobrar y los valores de la venta sin considerar créditos. Predeterminado: `false`.
`take`	int32	Número total de registros que se devolverán (máximo de 100, predeterminado de 25). Predeterminado: `25`.
`skip`	int32	Número total de registros que se omitirán antes de comenzar a devolver resultados. Predeterminado: `0`.
`onlyMembership`	boolean	Devuelve únicamente ventas asociadas a memberships (suscripciones). Predeterminado: `false`.
`atLeastMonthly`	boolean	Excluye memberships con menos de 30 días (como en el parámetro anterior `removeMonthly`). Predeterminado: `false`.
`flSwimming`	boolean	Filtra memberships asociadas a la configuración de natación. Predeterminado: `false`.
`showOnlyActiveMemberships`	boolean	Devuelve únicamente memberships activas. Predeterminado: `false`.
`showAllowLocker`	boolean	Indica si deben mostrarse las ventas que permiten el uso de lockers.
`onlyTotalPass`	boolean	Devuelve únicamente ventas asociadas a pases totales.
`updateDate`	string (date-time)	Filtra ventas actualizadas a partir de una fecha específica.

📤 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 miembro asociado a la venta.
`idEmployee`	int32	ID del empleado asociado.
`nameEmployee`	string	Nombre del empleado asociado.
`idProspect`	int32	ID del prospecto asociado, cuando corresponda.
`idResponsible`	int32	ID del responsable asociado, cuando corresponda.
`idMemberResponsible`	int32	ID del responsable del miembro asociado, cuando corresponda.
`cpfResponsible`	string	CPF del responsable del miembro asociado, cuando corresponda.
`idEmployeeSale`	int32	ID del empleado responsable de la venta.
`updateDate`	string (date-time)	Fecha de actualización de la venta, cuando exista.
`nameEmployeeSale`	string	Nombre del empleado responsable de la venta.
`idCommissionedEmployee`	int32	ID del empleado comisionado por la venta.
`nameCommissionedEmployee`	string	Nombre del empleado comisionado por la venta.
`saleDate`	string (date-time)	Fecha en que se realizó la venta.
`saleDateServer`	string (date-time)	Fecha de la venta registrada por el servidor.
`timeZone`	string	Zona horaria.
`idPersonal`	int32	ID del personal trainer asociado a la venta, cuando corresponda.
`removed`	boolean	Indica si la venta fue eliminada/cancelada.
`idEmployeeRemoval`	int32	ID del empleado que realizó la eliminación, cuando exista.
`removalDate`	string (date-time)	Fecha de eliminación de la venta, cuando exista.
`idBranch`	int32	ID de la sucursal donde se registró la venta.
`observations`	string	Observaciones relacionadas con la venta.
`idSaleRecurrency`	int32	Identificador de recurrencia de la venta, cuando corresponda.
`saleSource`	int32	Origen de la venta.
`idSaleMigration`	string	Código de referencia en caso de migración de ventas.
`idCartToken`	string	Identificador del carrito relacionado con la venta, cuando corresponda.
`saleItens`	array	Lista de elementos asociados a la venta (productos, servicios o memberships).
`member`	object	Miembro asociado a la venta. Ver más abajo.
`receivables`	arrayobject	Lista de cuentas por cobrar asociadas a la venta (cuotas, pagos, etc.). Se devuelve únicamente cuando `showReceivables = true`.
`registrationKind`	string	Tipo de registro asociado a la venta (`renewal` para recurrencia o `null` para una nueva venta).

🧩 Estructura del Objeto `saleItens`

Campo	Tipo	Descripción
`idSaleItem`	int32	ID del elemento de la venta.
`idSale`	int32	ID de la venta asociada.
`description`	string	Descripción del elemento.
`item`	string	Nombre del elemento vendido.
`itemValue`	number	Valor unitario del elemento.
`saleValue`	number	Valor total del elemento en la venta.
`saleValueWithoutCreditValue`	number	Valor total sin créditos aplicados.
`quantity`	int32	Cantidad del elemento vendido.
`idMembership`	int32	ID del membership, cuando corresponda.
`additionalType`	string	Tipo de adicional. Si es `null`, no es un contrato adicional; si es `Fixed`, es un adicional fijo; y si es `Optional`, es un adicional opcional.
`idMembershipRenewed`	int32	ID del membership renovado, cuando corresponda.
`numMembers`	int32	Cantidad de miembros vinculados al elemento.
`idProduct`	int32	ID del producto vendido, cuando corresponda.
`idService`	int32	ID del servicio vendido, cuando corresponda.
`corporatePartnershipName`	string	Nombre de la alianza corporativa asociada al elemento.
`coporatePartnershipId`	int32	ID de la alianza corporativa asociada al elemento.
`membershipStartDate`	date-time	Fecha de inicio del membership, cuando corresponda.
`discount`	number	Valor del descuento aplicado.
`corporateDiscount`	number	Valor del descuento corporativo aplicado.
`tax`	number	Valor del impuesto.
`voucher`	string	Código del voucher aplicado.
`accountingCode`	string	Código contable del elemento.
`municipalServiceCode`	string	Código de servicio municipal.
`flReceiptOnly`	boolean	Indica si el elemento es únicamente para recibo.
`idSaleItemMigration`	string	Identificador del elemento en un proceso de migración.
`flSwimming`	boolean	Indica si el elemento permite acceso a la piscina.
`flAllowLocker`	boolean	Indica si el elemento da derecho a locker.
`idMemberMembership`	int32	ID del vínculo de membership del miembro.
`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	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 utilizar el nombre preferido del miembro.
`document`	string	Documento de identificación del miembro.
`country`	string	País informado en el registro del miembro.
`address`	string	Dirección del miembro.
`state`	string	Estado de la dirección del miembro.
`city`	string	Ciudad de la dirección del miembro.
`passport`	string \| null	Número de pasaporte del miembro, cuando corresponda.
`zipCode`	string	Código postal de la dirección del miembro.
`complement`	string \| null	Complemento de la dirección.
`neighborhood`	string	Barrio del domicilio del miembro.
`number`	string	Número de la dirección.
`idMemberMigration`	string \| null	Identificador del miembro en un proceso de migración de base de datos.
`registrationKind`	string	Tipo de registro del miembro (ej.: `renewal` para recurrencia y `null` para una nueva venta).
`idFirstMemberMembership`	int32	Identificador del primer membership del miembro.
`contacts`	array	Lista de contactos registrados para el miembro. Ver estructura más abajo.
`responsibles`	array	Lista de responsables vinculados al miembro. Ver estructura más abajo.
`diasRenovacao`	int32	Cantidad de días considerados para la renovación del contrato del miembro.

🧩 Estructura del Objeto `member.responsibles`

Campo	Tipo	Descripción
`idResponsible`	int32	ID del responsable financiero.
`idMember`	int32	ID del miembro al que está vinculado el responsable.
`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 a 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`

Campo	Tipo	Descripción
`idReceivable`	int32	ID del título generado.
`description`	string	Descripción de la cuenta por cobrar.
`registrationDate`	date-time	Fecha de registro de la cuenta por cobrar.
`dueDate`	date-time	Fecha de vencimiento.
`receivingDate`	date-time	Fecha de recepción.
`competenceDate`	date-time	Fecha de competencia.
`cancellationDate`	date-time	Fecha de cancelación, cuando corresponda.
`ammount`	number	Valor del título.
`ammountPaid`	number	Valor pagado.
`responsibles`	arrayobject	Responsables asociados al recibo.
`status`	object	Estado de la cuenta por cobrar (contiene `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 miembro pagador.
`idProspectPayer`	int32	ID del prospecto pagador.
`idBranchMember`	int32	ID de la sucursal del miembro.
`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 las tasas aplicadas.
`conciliated`	boolean	Indica si la cuenta por cobrar fue conciliada.
`logTef`	object	Datos de TEF (transacciones electrónicas de fondos).
`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 título 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 los créditos asociados.
`cancellationDescription`	string	Motivo de la cancelación.
`source`	string	Origen de la cuenta por cobrar.
`saleDate`	date-time	Fecha de la venta asociada a la cuenta por cobrar.

🧩 Estructura del Objeto `receivables.responsibles`

Campo	Tipo	Descripción
`idResponsible`	int32	ID del responsable financiero.
`idMember`	int32	ID del miembro al que está vinculado el responsable.
`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 a 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, cuando corresponda.
`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 comercio.

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

Envía tus solicitudes HTTP con un encabezado

Authorization

que contenga la palabra Basic seguida de un espacio y una cadena codificada en base64 username:password

Ejemplo:

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

application/json

Success

Body

Ejemplo

{
    "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",
    "idCommissionedEmployee": 0,
    "nameCommissionedEmployee": "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,
            "additionalType": "string",
            "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",
                "idResponsibleCategory": 0,
                "responsibleCategoryName": "string",
                "responsibleValidated": true,
                "darwinBilling": true,
                "updateDate": "2019-08-24T14:15:22.123Z",
                "idEmployeeUpdate": 0
            }
        ],
        "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",
        "whatsappUsername": "string",
        "whatsappBsuid": "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",
                "idResponsibleCategory": 0,
                "responsibleCategoryName": "string",
                "responsibleValidated": true,
                "darwinBilling": true,
                "updateDate": "2019-08-24T14:15:22.123Z",
                "idEmployeeUpdate": 0
            }
        ]
    },
    "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"
}

Get sales

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 `member.responsibles`

🧩 Estructura del Objeto `receivables`

🧩 Estructura del Objeto `receivables.responsibles`

🧩 Estructura del Objeto `receivables.invoiceDetails`

🧩 Estructura del Objeto `receivables.logTef`

🧩 Estructura del Objeto `receivables.creditDetails`

Solicitud

Ejemplos de solicitud

Respuestas

Get sales

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 member.responsibles#

🧩 Estructura del Objeto receivables#

🧩 Estructura del Objeto receivables.responsibles#

🧩 Estructura del Objeto receivables.invoiceDetails#

🧩 Estructura del Objeto receivables.logTef#

🧩 Estructura del Objeto receivables.creditDetails#

Solicitud

Ejemplos de solicitud

Respuestas

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 `member.responsibles`

🧩 Estructura del Objeto `receivables`

🧩 Estructura del Objeto `receivables.responsibles`

🧩 Estructura del Objeto `receivables.invoiceDetails`

🧩 Estructura del Objeto `receivables.logTef`

🧩 Estructura del Objeto `receivables.creditDetails`