Get Sales List

Description

This endpoint returns the sales registered in the system and allows filtering by member, dates, status, sale types, and other parameters.

The response can also include information about sale items (services, products, memberships) and receivables (installments, payments, collection status, etc.).

NOTE. Available for use with both Branch Access Keys and General Admin Access Keys.

🔑 Request Parameters

Parameter	Type	Description
`idBranch`	int32	Filters by the ID of a specific branch/location.
`idMember`	int32	Filters by the ID of a specific member.
`dateSaleStart`	string (date-time)	Filters by the start date of the sale registration in `yyyy-mm-dd` format.
`dateSaleEnd`	string (date-time)	Filters by the end date of the sale registration in `yyyy-mm-dd` format.
`removalDateStart`	string (date-time)	Filters by the start date of sale removal in `yyyy-mm-dd` format.
`removalDateEnd`	string (date-time)	Filters by the end date of sale removal in `yyyy-mm-dd` format.
`receivablesRegistrationDateStart`	string (date-time)	Filters sales with receivables registered from a specific date onward.
`receivablesRegistrationDateEnd`	string (date-time)	Filters sales with receivables registered up to a specific date.
`updatedReceivableStartDate`	string (date-time)	Filters sales whose receivables were updated from a specific date onward.
`updatedReceivableEndDate`	string (date-time)	Filters sales whose receivables were updated up to 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 skip before results are returned. Default: `0`.
`onlyMembership`	boolean	Returns only sales associated with memberships. Default: `false`.
`atLeastMonthly`	boolean	Removes memberships with fewer than 30 days (as in the previous `removeMonthly` parameter). 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 sales that allow locker usage should be displayed.
`onlyTotalPass`	boolean	Returns only sales associated with total passes.
`updateDate`	string (date-time)	Filters sales updated from a specific date onward.

📤 Response Structure

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

Field	Type	Description
`idSale`	int32	Unique sale identifier.
`idMember`	int32	ID of the member associated with the sale.
`idEmployee`	int32	ID of the associated employee.
`nameEmployee`	string	Name of the associated employee.
`idProspect`	int32	ID of the associated prospect, when applicable.
`idResponsible`	int32	ID of the associated responsible person, when applicable.
`idMemberResponsible`	int32	ID of the member's responsible person, when applicable.
`cpfResponsible`	string	CPF of the member's responsible person, when applicable.
`idEmployeeSale`	int32	ID of the employee responsible for the sale.
`updateDate`	string (date-time)	Date when the sale was updated, when applicable.
`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)	Sale date recorded by the server.
`timeZone`	string	Time zone.
`idPersonal`	int32	ID of the personal trainer associated with the sale, when applicable.
`removed`	boolean	Indicates whether the sale was removed/canceled.
`idEmployeeRemoval`	int32	ID of the employee who performed the removal, when applicable.
`removalDate`	string (date-time)	Date when the sale was removed, when applicable.
`idBranch`	int32	ID of the branch where the sale was registered.
`observations`	string	Sale-related observations.
`idSaleRecurrency`	int32	Sale recurrence identifier, when applicable.
`saleSource`	int32	Sale source.
`idSaleMigration`	string	Reference code in case of sale migration.
`idCartToken`	string	Identifier of the cart related to the sale, when applicable.
`saleItens`	array	List of items associated with the sale (products, services, or memberships).
`member`	object	Member associated with the sale. See below.
`receivables`	arrayobject	List of receivables associated with the sale (installments, payments, etc.). Returned only when `showReceivables = true`.
`registrationKind`	string	Type of record associated with the sale (`renewal` for recurring sales or `null` for a new sale).

🧩 `saleItens` Object Structure

Field	Type	Description
`idSaleItem`	int32	Sale item ID.
`idSale`	int32	ID of the associated sale.
`description`	string	Item description.
`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	Membership ID, when applicable.
`additionalType`	string	Add-on type. If `null`, it is not an add-on membership; if `Fixed`, it is a fixed add-on; and if `Optional`, it is an optional add-on.
`idMembershipRenewed`	int32	ID of the renewed membership, when applicable.
`numMembers`	int32	Number of members linked to the item.
`idProduct`	int32	ID of the sold product, when applicable.
`idService`	int32	ID of the sold service, when 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	Membership start date, when applicable.
`discount`	number	Applied discount amount.
`corporateDiscount`	number	Applied corporate discount amount.
`tax`	number	Tax amount.
`voucher`	string	Applied voucher code.
`accountingCode`	string	Accounting code of the item.
`municipalServiceCode`	string	Municipal service code.
`flReceiptOnly`	boolean	Indicates whether the item is receipt-only.
`idSaleItemMigration`	string	Item identifier in a migration process.
`flSwimming`	boolean	Indicates whether the item grants access to the pool.
`flAllowLocker`	boolean	Indicates whether the item grants locker access.
`idMemberMembership`	int32	ID of the member's membership relationship.
`valueNextMonth`	number	Amount that will be charged next month.

🧩 `member` Object Structure

Field	Type	Description
`idMember`	int32	Unique member identifier.
`firstName`	string	Member's first name.
`lastName`	string	Member's last name.
`registerName`	string	Member's registered first name in the system.
`registerLastName`	string	Member's registered last name in the system.
`usePreferredName`	boolean	Indicates whether the system should use the member's preferred name.
`document`	string	Member's identification document.
`country`	string	Country provided in the member's registration.
`address`	string	Member's address.
`state`	string	State of the member's address.
`city`	string	City of the member's address.
`passport`	string \| null	Member's passport number, 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	Member identifier in a database migration process.
`registrationKind`	string	Member registration type (e.g., `renewal` for recurring sales 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 persons linked to the member. See structure below.
`diasRenovacao`	int32	Number of days considered for renewal of the member's contract.

🧩 `member.responsibles` Object Structure

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

🧩 `receivables` Object Structure

Field	Type	Description
`idReceivable`	int32	Generated receivable ID.
`description`	string	Receivable description.
`registrationDate`	date-time	Receivable registration date.
`dueDate`	date-time	Due date.
`receivingDate`	date-time	Receiving date.
`competenceDate`	date-time	Competency date.
`cancellationDate`	date-time	Cancellation date, when applicable.
`ammount`	number	Receivable amount.
`ammountPaid`	number	Paid amount.
`responsibles`	arrayobject	Responsible persons associated with the receivable.
`status`	object	Receivable status (contains `id` and `name`).
`currentInstallment`	int32	Current installment number.
`totalInstallments`	int32	Total number of installments.
`authorization`	string	Transaction authorization code.
`payerName`	string	Payer's name.
`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	Amount of applied fees.
`conciliated`	boolean	Indicates whether the receivable was reconciled.
`logTef`	object	TEF data (electronic funds transactions).
`tid`	string	Transaction identifier.
`nsu`	string	Unique sequential number.
`updateDate`	date-time	Date of last update.
`chargeDate`	date-time	Charge date.
`idReceivableFrom`	int32	ID of the source receivable.
`transactionToken`	string	Transaction token.
`idRevenueCenter`	int32	Revenue center ID.
`cardAcquirer`	string	Name of the card acquirer.
`cardFlag`	string	Card brand.
`creditDetails`	array	Details of associated credits.
`cancellationDescription`	string	Cancellation reason.
`source`	string	Receivable source.
`saleDate`	date-time	Date of the sale associated with the receivable.

🧩 `receivables.responsibles` Object Structure

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

🧩 `receivables.invoiceDetails` Object Structure

Field	Type	Description
`invoiceNumber`	string	Invoice number.
`issuedAmount`	number	Amount issued on the invoice.
`status`	string	Invoice status.
`sendDate`	date-time	Invoice sending date.
`canceledDate`	date-time	Cancellation date, when applicable.
`urlPdf`	string	Link to the invoice PDF.
`idInvoiceType`	int32	Invoice type ID.
`invoiceType`	string	Invoice type.

🧩 `receivables.logTef` Object Structure

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

🧩 `receivables.creditDetails` Object Structure

Field	Type	Description
`idCredit`	int32	Credit ID.
`idCancelationCredit`	int32	Cancellation credit ID.
`idBranchOrigin`	int32	Origin branch ID.
`ammount`	number	Credit amount.
`branchDocument`	string	Branch document.
`idSaleOrigin`	int32	Origin sale ID.
`idReceivableOrigin`	int32	Origin receivable ID.

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

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

Get Sales List

Description

🔑 Request Parameters

📤 Response Structure

🧩 `saleItens` Object Structure

🧩 `member` Object Structure

🧩 `member.responsibles` Object Structure

🧩 `receivables` Object Structure

🧩 `receivables.responsibles` Object Structure

🧩 `receivables.invoiceDetails` Object Structure

🧩 `receivables.logTef` Object Structure

🧩 `receivables.creditDetails` Object Structure

Request

Request Code Samples

Responses

Get sales

Get Sales List#

Description#

🔑 Request Parameters#

📤 Response Structure#

🧩 saleItens Object Structure#

🧩 member Object Structure#

🧩 member.responsibles Object Structure#

🧩 receivables Object Structure#

🧩 receivables.responsibles Object Structure#

🧩 receivables.invoiceDetails Object Structure#

🧩 receivables.logTef Object Structure#

🧩 receivables.creditDetails Object Structure#

Request

Request Code Samples

Responses

Get Sales List

Description

🔑 Request Parameters

📤 Response Structure

🧩 `saleItens` Object Structure

🧩 `member` Object Structure

🧩 `member.responsibles` Object Structure

🧩 `receivables` Object Structure

🧩 `receivables.responsibles` Object Structure

🧩 `receivables.invoiceDetails` Object Structure

🧩 `receivables.logTef` Object Structure

🧩 `receivables.creditDetails` Object Structure