Follow the question structure recommended by Dev Bot before submitting your integration questions.
- Welcome 💜
- 📃 Guides
- Getting started with the API
- Understanding the documentation
- Use cases
- FAQ
- Suggestions
- 🌐 API Reference
- AccessControl
- Activities
- Get activities
- Get activities schedule
- Get activities schedule details
- Create a new experimental class and enroll the member on it
- List of spots that are already filled in the activity session
- Get activities schedule by idService or idMembership
- Book member in activity schedule
- Change status of a member in activity schedule
- Get activities schedule by enrollment
- Create a new enrollment for a member
- Delete enrollment
- Get enrollment details for a member
- Get activity sessions for a member
- Appointments
- BankAccounts
- Carts
- Configuration
- Employees
- Entries
- Invoices
- Management
- MemberMembership
- Members
- Get member profile
- Get members
- Retrieves active members from a specific branch or from all branches
- Get member services
- Get member credit cards
- Update a member card number
- Authenticate member
- Get link for reset password
- Update a member fitcoins
- Get member fitcoins
- Get basic member information.
- Get member's latest branch transfer
- Update basic member data
- Transfers a member from one branch to another
- Block/unblock member
- Send push notification to a specific member
- Send push notification to multiple members
- Membership
- Notifications
- Parking
- Partnership
- Payables
- Pix
- Product
- Prospects
- Receivables
- Gets a list of debts and current status (Similar to the Collections - Default report)
- Creates batch collection attempts for the member membership contracts.
- Gets the details of a specific charge batch.
- Get receivables
- Marks a list of receivables as received (paid)
- Cancels a list of receivables
- Reconciles a list of receivables with the transaction data informed
- Get cost center
- Get receivables conciliation report
- Charge a receivable using a member's credit card
- List PJBank boletos (bank slips) for the authenticated branch.
- Collects (registers) a payment for a sale
- Sales
- Service
- States
- Voucher
- Webhook
- Workout
- Change data from a client's prescribed workout
- Get all Exercises
- Get all default workouts of the new prescription
- Get all client's or prospect's or employee's workouts of the new prescription
- Get all client's or prospect's or employee's workouts of the new prescription by month, year or idProfessor
- Link workout of the new prescription for client
- Create a workout of the new prescription
- AccessControl
- Schemas
- Schemas
- ActiveMembersReturnViewModel
- ActivityAreaViewModel
- ActivityEmployeesViewModel
- ActivityGroupApiViewModel
- ActivityGroupViewModel
- ActivityResourcesViewModel
- ActivityUnavailability
- AreaBloqueioAgendaApiViewModel
- AtividadeAgendaApiCustomViewModel
- AtividadeAgendaApiViewModel
- AtividadeAgendaListApiViewModel
- AtividadeBasicoApiViewModel
- AddressFamily
- AtividadeEnrollScheduleApiV2ViewModel
- AtividadeListApiViewModel
- AtividadeLugarReservaApiViewModel
- AtividadeLugarReservaViewModel
- AtividadeSessaoAgendaViewModel
- AsnEncodedData
- AtividadeSessaoParticipanteApiViewModel
- BandeirasBasicoViewModel
- BankAccountsViewModel
- BairroViewModel
- BasicFreezeViewModel
- BasicMemberMembershipApiViewModel
- Assembly
- BloqueioAgendaApiViewModel
- BonusSessionViewModel
- AsymmetricAlgorithm
- BranchGatewayViewModel
- BusinessHoursViewModel
- CancelReceivablesResponseViewModel
- CancelReceivablesViewModel
- CardDataViewModel
- CardTranslationViewModel
- CartIdViewModel
- CartItemsViewModel
- CartViewModel
- ChargeReceivableRequestViewModel
- ChargeReceivableResponseViewModel
- CheckinResponseItemViewModel
- CityViewModel
- ClienteDetalhesBasicosApiViewModel
- ClienteEnotasRetorno
- CidadeViewModel
- ClienteTransferenciaViewModel
- CofinsEnotasRetorno
- ColaboradoresBloqueioAgendaApiViewModel
- CollectReceivableRequestViewModel
- ConfiguracaoApiViewModel
- ConjugadoItemRequestApiViewModel
- ContractCancellationViewModel
- ClientesAtivosRetornoViewModel
- ContractSuspensionViewModel
- ContratoEntradasApiViewModel
- ContratoFiliaisResumoApiViewModel
- ByteReadOnlyMemory
- ContratosCanceladosParcelasApiViewModel
- ContratosCanceladosResumoApiViewModel
- ContratosResumoApiViewModel
- ByteReadOnlySpan
- ContratosResumoPaginaVendaViewModel
- ConveniosApiViewModel
- CostCenterApiViewModel
- CallingConventions
- DadosContratoTrasnferenciaApiViewModel
- DadosTrocaContratoApiViewModel
- DebtorChargesViewModel
- DebtorsItensViewModel
- CancellationToken
- DefaultResponseViewModel
- DiferenciaisApiViewModel
- DifferentialsViewModel
- DropsetItemRequestApiViewModel
- EFormaContato
- EFormaPagamentoTotem
- EOrigemAgendamento
- EStatusAtividade
- EStatusAtividadeSessao
- ESubStatus
- ESubStatusApi
- ETemperatura
- Claim
- ETipoContrato
- ETipoDocumento
- ETipoGateway
- ClaimsIdentity
- EmployeeApiBranchPermissions
- EmployeeApiIntegracaoAtualizacaoViewModel
- EmployeeApiIntegracaoViewModel
- ClaimsPrincipal
- EmpresasConveniosApiViewModel
- EmpresasFiliaisOcupacaoViewModel
- EnderecoEnotasRetorno
- EnotasRetorno
- EntradasResumoApiViewModel
- ExperimentalClassResponseViewModel
- FilialIntegracaoViewModel
- FitcoinsResponseViewModel
- FreezeViewModel
- FreteEnotasRetorno
- FuncionariosResumoApiViewModel
- ConnectionInfo
- GrupoFiliaisIntegracaoViewModel
- HttpResponseError
- IcmsEnotasRetorno
- ConstructorInfo
- IdMemberResponseViewModel
- ImpostosEnotasRetorno
- InformacoesIndicadosViewModel
- InstallmentViewModel
- IntegracaoBoletoConsultaViewModel
- ItenEnotasRetorno
- ItensBloqueioAgendaApiViewModel
- LiberacaoCatracaManualViewModel
- LogTefApiViewModel
- MatriculaDetalhesApiV2ViewModel
- MatriculaDetalhesApiViewModel
- MatricularApiViewModel
- EmpresasFiliaisGatewayViewModel
- MatricularConfiguracaoApiViewModel
- MemberAuthenticateViewModel
- MemberBasicResponsibleViewModel
- MemberBlockUnblockViewModel
- CustomAttributeData
- MemberCreditCardApiViewModel
- MemberDataViewModel
- MemberLevelViewModel
- CustomAttributeNamedArgument
- MemberMembershipApiViewModel
- MemberNewSaleViewModel
- MemberParkingViewModel
- CustomAttributeTypedArgument
- MemberResponsibleViewModel
- MemberScheduleApiV2ViewModel
- MemberServiceViewModel
- EstadoViewModel
- MemberTransferViewModel
- MembersApiResumidoVendaViewModel
- MembersApiViewModel
- MembersBasicApiViewModel
- MetadadosEnotasRetorno
- MobilePushMultiplaViewModel
- MobilePushViewModel
- MonthDiscountViewModel
- NeighborhoodViewModel
- NewSaleViewModel
- NotificationApiViewModel
- NotificationProspectApiViewModel
- NotificationResponseViewModel
- NovoVoucherViewModel
- PagamentoEnotasRetorno
- PayablesApiSubTypesViewModel
- PayablesApiViewModel
- PedidoEnotasRetorno
- PercentualAproximadoTributosEnotasRetorno
- PeriodizacaoApiViewModel
- PisEnotasRetorno
- PixPaymentDetailsViewModel
- PrescricaoTreinoViewModel
- ProblemDetails
- ProdutoResumoApiViewModel
- ProgressivoItemRequestApiViewModel
- ProspectApiIntegracaoAtualizacaoViewModel
- ProspectApiIntegracaoViewModel
- ProspectIdViewModel
- ProspectResponsavelFinanceiroViewmodel
- ProspectTransferViewModel
- ProspectTransferenciaViewModel
- ProspectsResumoApiViewModel
- ProtocoloEnotasRetorno
- EventAttributes
- PublicoAtividadeViewModel
- ReceivablesApiResumoVendaViewModel
- ReceivablesApiSubTypesViewModel
- ReceivablesApiViewModel
- EventInfo
- ReceivablesApiViewModelListGridComQtdeViewModel
- ReceivablesCreditDetails
- ReceivablesInvoiceApiViewModel
- ReceivablesMaskReceivedViewModel
- FieldAttributes
- ReconcileReceivablesResponseViewModel
- ReconcileReceivablesViewModel
- RecursosBloqueioAgendaApiViewModel
- FieldInfo
- RetornoAgregadoresCheckinMultiFiliaisViewModel
- RetornoCatracaViewModel
- RetornoEntradaManualViewModel
- RevenueCenterApiViewModel
- SaleItensViewModel
- SalesItemViewModel
- SalesItemsViewModel
- SalesViewModelV2
- SerieItemRequestApiViewModel
- GenericParameterAttributes
- SeriePrescricaoRequestApiViewModel
- ServiceDiscountViewModel
- ServicoAdicionalApiViewModel
- HostString
- ServicoAnualApiViewModel
- ServicoEnotasRetorno
- ServicosResumoApiViewModel
- HttpContext
- SimplificadoEnotasRetorno
- SpsProspectsServicosInteresses
- StateViewModel
- SumaryDebtorsViewModel
- TaxDataViewModel
- HttpRequest
- TelefoneApiViewModel
- TransferClientResponseViewModel
- TransporteEnotasRetorno
- HttpResponse
- TreinoPrescricaoRequestApiViewModel
- UnavailableSpotsResponseViewModel
- VendasResumoApiViewModel
- VoucherAtributePublicViewModel
- ICustomAttributeProvider
- VoucherCriacaoViewModel
- VoucherItemApiViewModel
- VouchersCodigosViewModel
- IIdentity
- VouchersCodigosViewModelListWithQuantityViewModel
- VouchersResumoApiViewModel
- W12UtilsCategoryMembershipViewModel
- IPAddress
- W12UtilsWebhookHeaderViewModel
- W12UtilsWebhookViewModel
- W12UtilzWebHookFilterViewModel
- YearDiscountViewModel
- IResponseCookies
- autorizaEntradaExternoViewModel
- retornoAutorizaEntradaExternoViewModel
- IServiceProvider
- ISession
- IntPtr
- KeySizes
- LayoutKind
- SalesViewModel
- MemberInfo
- MemberTypes
- MethodAttributes
- MethodBase
- MethodImplAttributes
- TimeSpan
- MethodInfo
- ReverseReceivedResponseViewModel
- ReverseReceivedViewModel
- Module
- ModuleHandle
- Oid
- ParameterAttributes
- ParameterInfo
- PathString
- PipeReader
- PipeWriter
- PropertyAttributes
- PropertyInfo
- PublicKey
- QueryString
- RuntimeFieldHandle
- RuntimeMethodHandle
- RuntimeTypeHandle
- SafeWaitHandle
- SecurityRuleSet
- Stream
- StringStringKeyValuePair
- StringStringValuesKeyValuePair
- StructLayoutAttribute
- Type
- TypeAttributes
- TypeInfo
- TypeObjectKeyValuePair
- WaitHandle
- WebSocketManager
- X500DistinguishedName
- X509Certificate2
- X509Extension
Sales
This flow is essential for integrations with POS, self-service (kiosk), and e-commerce, ensuring control and tracking of transactions.
Available Endpoints#
| Method | Endpoint | Description |
|---|---|---|
GET | /api/v1/sales/{idSale} | Retrieves the details of a sale by its identifier. |
GET | /api/v2/sales | Lists all sales made. |
POST | /api/v2/sales | Creates a new sale. |
GET | /api/v1/sales/by-session-id | Returns the sales associated with a sessionId. |
GET | /api/v1/sales/sales-items | Returns the items of a sale (used in site/kiosk). |
Modified at 2026-05-27 22:32:15