Obtener venta por ID

Descripción

Este endpoint permite obtener la venta utilizando idSale.

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

🔑 Parámetros de consulta (Query Params)

Parámetro	Tipo	Obligatorio	Descripción
idSale	int32	Sí	ID de la venta.

📤 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 prospecto 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 registrada en el servidor.
idPersonal	int32	ID del personal trainer vinculado (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 removida/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 con la venta.
idSaleRecurrency	int32	ID 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.
idCartToken	string	Token único de identificación del carrito.
saleItens	array	Lista de ítems asociados a la venta (productos, servicios o membresías).
receivables	array	Lista de recibos asociados a la venta.
responsibles	array	Lista de responsables asociados a la 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 de ítems vendidos.
idMembership	int32	ID de la membresía (si aplica).
idMembershipRenewed	int32	ID de la membresía renovada (si aplica).
numMembers	int32	Cantidad 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.
coporatePartnershipId	int32	ID de la alianza corporativa asociada.
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 del impuesto.
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	ID del ítem en proceso de migración.
flSwimming	boolean	Indica si el ítem da acceso a la piscina.
flAllowLocker	boolean	Indica si el ítem da derecho a casillero.
idMemberMembership	int32	ID de la relación de membresía del alumno.
valueNextMonth	number	Valor que se cobrará el próximo mes.

🧩 Estructura del Objeto `receivables`

Campo	Tipo	Descripción
idReceivable	int32	ID del recibo 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	array	Responsables financieros.
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 prospecto 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 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 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.

🧩 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 (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 recibo de origen.

🧩 Estructura del Objeto `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).

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 *****************

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 sale by Id

Obtener venta por ID

Descripción

🔑 Parámetros de consulta (Query Params)

📤 Estructura de la Respuesta

🧩 Estructura del Objeto `saleItens`

🧩 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

Exemplos de Requisição

Respostas

Get sale by Id

Obtener venta por ID

Descripción

🔑 Parámetros de consulta (Query Params)

📤 Estructura de la Respuesta

🧩 Estructura del Objeto saleItens

🧩 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

Exemplos de Requisição

Respostas

🧩 Estructura del Objeto `saleItens`

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