Get Sales List

Description

This endpoint returns the sales recorded in the system, which can be filtered by member, dates, status, types of sale, among other parameters. The response may also include information about sale items (services, products, memberships) and receivables (installments, payments, charge status, etc.).

NOTE. Available for use with branch access key and also with General ADM access key.

🔑 Request Parameters

Parameter	Type	Description
idBranch	int32	Filters by the ID of a specific branch.
idMember	int32	Filters by the ID of a specific member.
dateSaleStart	string (date-time)	Filters by the start date of the sale record in the format `yyyy-mm-dd`.
dateSaleEnd	string (date-time)	Filters by the end date of the sale record in the format `yyyy-mm-dd`.
removalDateStart	string (date-time)	Filters by the start date of sale removal in the format `yyyy-mm-dd`.
removalDateEnd	string (date-time)	Filters by the end date of sale removal in the format `yyyy-mm-dd`.
receivablesRegistrationDateStart	string (date-time)	Filters sales with receivables registered from a specific date.
receivablesRegistrationDateEnd	string (date-time)	Filters sales with receivables registered until a specific date.
updatedReceivableStartDate	string (date-time)	Filters sales whose receivables were updated from a specific date.
updatedReceivableEndDate	string (date-time)	Filters sales whose receivables were updated until a specific date.
showReceivables	boolean	Flag to display receivables and sale values without considering credits. default: `false`
take	int32	Total number of records to be returned (maximum of 100, default of 25). default: `25`
skip	int32	Total number of records to be skipped before starting to return results. default: `0`
onlyMembership	boolean	Returns only sales associated with memberships (subscriptions). default: `false`
atLeastMonthly	boolean	Removes memberships with less than 30 days (as in the old parameter `removeMonthly`). default: `false`
flSwimming	boolean	Filters memberships associated with the swimming flag. default: `false`
showOnlyActiveMemberships	boolean	Returns only active memberships. default: `false`
showAllowLocker	boolean	Indicates whether to display sales that allow locker use.
onlyTotalPass	boolean	Returns only sales associated with total passes.
updateDate	string (date-time)	Filters sales with updates from this date.

📤 Response Structure

The response returns a list of sales with the following structure:

Field	Type	Description
idSale	int32	Unique identifier of the sale.
idMember	int32	ID of the member linked to the sale.
idEmployee	int32	ID of the associated employee.
nameEmployee	string	Name of the associated employee.
idProspect	int32	ID of the linked prospect (if applicable).
idResponsible	int32	ID of the linked responsible party (if applicable).
idMemberResponsible	int32	ID of the member's linked responsible party (if applicable).
cpfResponsible	string	CPF of the member's linked responsible party (if applicable).
idEmployeeSale	int32	ID of the employee responsible for the sale.
updateDate	string (date-time)	Date when the sale was updated (if any).
nameEmployeeSale	string	Name of the employee responsible for the sale.
idCommissionedEmployee	int32	ID of the employee commissioned for the sale.
nameCommissionedEmployee	string	Name of the employee commissioned for the sale.
saleDate	string (date-time)	Date when the sale was made.
saleDateServer	string (date-time)	Date of the sale recorded by the server.
timeZone	string	Time zone.
idPersonal	int32	ID of the personal trainer linked to the sale (if applicable).
removed	boolean	Indicates whether the sale was removed/canceled.
idEmployeeRemoval	int32	ID of the employee who performed the removal (if any).
removalDate	string (date-time)	Date when the sale was removed (if any).
idBranch	int32	ID of the branch where the sale was recorded.
observations	string	Observations related to the sale.
idSaleRecurrency	int32	Identifier of the sale recurrence (if applicable).
saleSource	int32	Source of the sale.
idSaleMigration	string	Reference code in case of sale migration.
idCartToken	string	Identifier of the cart related to the sale (if applicable).
saleItens	array	List of items associated with the sale (products, services, or memberships).
member	object	Member/student associated with the sale. See more below.
receivables	arrayobject	List of receivables associated with the sale (installments, payments, etc.). (Returned only if `showReceivables = true`)
registrationKind	string	Type of registration associated with the sale (`renewal` for recurrence or null for a new sale).

🧩 Structure of the `saleItens` Object

Field	Type	Description
idSaleItem	int32	ID of the sale item.
idSale	int32	ID of the associated sale.
description	string	Description of the item.
item	string	Name of the sold item.
itemValue	number	Unit value of the item.
saleValue	number	Total value of the item in the sale.
saleValueWithoutCreditValue	number	Total value without applied credits.
quantity	int32	Quantity of the sold item.
idMembership	int32	ID of the membership (if applicable).
idMembershipRenewed	int32	ID of the renewed membership (if applicable).
numMembers	int32	Number of members linked to the item.
idProduct	int32	ID of the sold product (if applicable).
idService	int32	ID of the sold service (if applicable).
corporatePartnershipName	string	Name of the corporate partnership associated with the item.
coporatePartnershipId	int32	ID of the corporate partnership associated with the item.
membershipStartDate	date-time	Start date of the membership (when applicable).
discount	number	Value of the applied discount.
corporateDiscount	number	Value of the applied corporate discount.
tax	number	Tax amount.
voucher	string	Code of the applied voucher.
accountingCode	string	Accounting code of the item.
municipalServiceCode	string	Municipal service code.
flReceiptOnly	boolean	Indicates whether the item is receipt-only.
idSaleItemMigration	string	Identifier of the item in the migration process.
flSwimming	boolean	Indicates whether the item grants access to the swimming pool.
flAllowLocker	boolean	Indicates whether the item grants locker rights.
idMemberMembership	int32	ID of the member's membership link.
valueNextMonth	number	Amount that will be charged next month.

🧩 Structure of the `member` Object

Field	Type	Description
`idMember`	int32	Unique identifier of the member.
`firstName`	string	First name of the member.
`lastName`	string	Last name of the member.
`registerName`	string	Registered name of the member in the registration record.
`registerLastName`	string	Registered last name of the member in the registration record.
`usePreferredName`	boolean	Indicates whether the system should use the member's preferred name.
`document`	string	Identification document of the member.
`country`	string	Country provided in the member's registration.
`address`	string	Address of the member.
`state`	string	State of the member's address.
`city`	string	City of the member's address.
`passport`	string \| null	Passport number of the member, when applicable.
`zipCode`	string	Postal code of the member's address.
`complement`	string \| null	Address complement.
`neighborhood`	string	Neighborhood of the member's address.
`number`	string	Address number.
`idMemberMigration`	string \| null	Identifier of the member in a database migration process.
`registrationKind`	string	Type of registration of the member (e.g., `renewal` for recurrence and null for a new sale).
`idFirstMemberMembership`	int32	Identifier of the member's first membership.
`contacts`	array	List of contacts registered for the member. See structure below.
`responsibles`	array	List of responsible parties linked to the member. See structure below.
`diasRenovacao`	int32	Number of days considered for the member's contract renewal.

🧩 Structure of the `member.responsibles` Object

Field	Type	Description
idResponsible	int32	ID of the financial responsible party.
idMember	int32	ID of the member to whom the responsible party is linked.
name	string	Name of the responsible party.
cpf	string	CPF of the responsible party.
email	string	Email of the responsible party.
phone	string	Phone number of the responsible party.
observation	string	Additional observations about the responsible party.
idMemberResponsible	int32	ID of the member acting as the responsible party.
acessFiti	boolean	Indicates whether the responsible party has access to Fiti.
financialResponsible	boolean	Indicates whether this person is the financial responsible party.
personType	string	Type of person of the responsible party (e.g., Individual or Legal Entity).
document	string	Document of the responsible party (CPF or CNPJ, according to the person type).

🧩 Structure of the `receivables` Object

Field	Type	Description
idReceivable	int32	ID of the generated receivable.
description	string	Description of the receivable.
registrationDate	date-time	Registration date of the receivable.
dueDate	date-time	Due date.
receivingDate	date-time	Payment receipt date.
competenceDate	date-time	Competence date.
cancellationDate	date-time	Cancellation date (if applicable).
ammount	number	Value of the receivable.
ammountPaid	number	Amount paid.
responsibles	arrayobject	Responsible parties associated with the payment receipt.
status	object	Status of the receivable (contains `id` and `name`).
currentInstallment	int32	Number of the current installment.
totalInstallments	int32	Total number of installments.
authorization	string	Authorization code of the transaction.
payerName	string	Name of the payer.
idMemberPayer	int32	ID of the paying member.
idProspectPayer	int32	ID of the paying prospect.
idBranchMember	int32	ID of the member's branch.
idSale	int32	ID of the associated sale.
bankAccount	object	Bank account used (`id`, `name`).
paymentType	object	Payment type used (`id`, `name`).
invoiceDetails	array	List of associated invoices.
fees	number	Value of applied fees.
conciliated	boolean	Indicates whether the receivable has been reconciled.
logTef	object	TEF data (electronic funds transactions).
tid	string	Transaction identifier.
nsu	string	Unique sequential number.
updateDate	date-time	Date of the last update.
chargeDate	date-time	Charge date.
idReceivableFrom	int32	ID of the originating receivable.
transactionToken	string	Transaction token.
idRevenueCenter	int32	ID of the revenue center.
cardAcquirer	string	Name of the card acquirer.
cardFlag	string	Card brand.
creditDetails	array	Details of associated credits.
cancellationDescription	string	Reason for cancellation.
source	string	Source of the receivable.
saleDate	date-time	Date of the sale associated with the receivable.

🧩 Structure of the `receivables.responsibles` Object

Field	Type	Description
idResponsible	int32	ID of the financial responsible party.
idMember	int32	ID of the member to whom the responsible party is linked.
name	string	Name of the responsible party.
cpf	string	CPF of the responsible party.
email	string	Email of the responsible party.
phone	string	Phone number of the responsible party.
observation	string	Additional observations about the responsible party.
idMemberResponsible	int32	ID of the member acting as the responsible party.
acessFiti	boolean	Indicates whether the responsible party has access to Fiti.
financialResponsible	boolean	Indicates whether this person is the financial responsible party.
personType	string	Type of person of the responsible party (e.g., Individual or Legal Entity).
document	string	Document of the responsible party (CPF or CNPJ, according to the person type).

🧩 Structure of the `receivables.invoiceDetails` Object

Field	Type	Description
invoiceNumber	string	Invoice number.
issuedAmount	number	Amount issued on the invoice.
status	string	Invoice status.
sendDate	date-time	Date when the invoice was sent.
canceledDate	date-time	Cancellation date (if applicable).
urlPdf	string	Link to the invoice PDF.
idInvoiceType	int32	ID of the invoice type.
invoiceType	string	Invoice type.

🧩 Structure of the `receivables.logTef` Object

Field	Type	Description
authorization	string	TEF authorization code.
tefId	string	TEF ID.
merchantCheckoutGuid	string	Merchant checkout GUID.

🧩 Structure of the `receivables.creditDetails` Object

Field	Type	Description
idCredit	int32	ID of the credit.
idCancelationCredit	int32	ID of the cancellation credit.
idBranchOrigin	int32	ID of the branch of origin.
ammount	number	Amount of the credit.
branchDocument	string	Branch document.
idSaleOrigin	int32	ID of the originating sale.
idReceivableOrigin	int32	ID of the originating receivable.

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

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

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

Example

{
    "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,
            "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"
}

🟠400Bad Request

Get sales

Get Sales List#

Description#

🔑 Request Parameters#

📤 Response Structure#

🧩 Structure of the saleItens Object#

🧩 Structure of the member Object#

🧩 Structure of the member.responsibles Object#

🧩 Structure of the receivables Object#

🧩 Structure of the receivables.responsibles Object#

🧩 Structure of the receivables.invoiceDetails Object#

🧩 Structure of the receivables.logTef Object#

🧩 Structure of the receivables.creditDetails Object#

Request