Siga a estrutura de pergunta recomendada pelo Dev Bot antes de enviar suas dúvidas de integração.
- Boas vindas 💜
- 📃 Guias
- Primeiros passos com a API
- Conhecendo a documentação
- Casos de uso
- FAQ
- Sugestões
- 🌐 API Reference
- AccessControl
- Activities
- Get activities
- Get activities schedule
- Get activities schedule details
- Enroll member in activity schedule
- Change status of a member in activity schedule
- 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
- Get activities enrollment by member or membership
- Create a new enrollment for a member
- Delete enrollment
- Get enrollment details 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
- 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)
- Get cost center
- Get receivables conciliation report
- Sales
- Service
- States
- Voucher
- Webhook
- Workout
- Get all default workouts
- Link workout for client
- Change data from a client's prescribed workout
- Get all client's or prospect's or employee's workouts by month, year or idProfessor
- 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
- Esquemas
- Schemas
- ActivityGroupApiViewModel
- ActivityAreaViewModel
- ActiveMembersReturnViewModel
- AtividadeAgendaApiViewModel
- ActivityEmployeesViewModel
- ActivityGroupViewModel
- AtividadeBasicoApiViewModel
- AtividadeAgendaApiCustomViewModel
- ActivityResourcesViewModel
- AtividadeListApiViewModel
- ActivityUnavailability
- AtividadeLugarReservaApiViewModel
- AreaBloqueioAgendaApiViewModel
- AddressFamily
- AtividadeLugarReservaViewModel
- AtividadeSessaoParticipanteApiViewModel
- AtividadeAgendaListApiViewModel
- AsnEncodedData
- BairroViewModel
- Assembly
- BandeirasBasicoViewModel
- AsymmetricAlgorithm
- BankAccountsViewModel
- BasicFreezeViewModel
- BasicMemberMembershipApiViewModel
- AtividadeSessaoAgendaViewModel
- BonusSessionViewModel
- BusinessHoursViewModel
- CardDataViewModel
- CardTranslationViewModel
- CartIdViewModel
- CartItemsViewModel
- CartViewModel
- CidadeViewModel
- BloqueioAgendaApiViewModel
- ClienteDetalhesBasicosApiViewModel
- ClienteEnotasRetorno
- BranchGatewayViewModel
- ClienteTransferenciaViewModel
- ClientesAtivosRetornoViewModel
- CofinsEnotasRetorno
- ConfiguracaoApiViewModel
- ByteReadOnlyMemory
- ContratoEntradasApiViewModel
- ByteReadOnlySpan
- ContratoFiliaisResumoApiViewModel
- CallingConventions
- CityViewModel
- CancellationToken
- ContratosCanceladosParcelasApiViewModel
- ContratosCanceladosResumoApiViewModel
- ContratosResumoApiViewModel
- ContratosResumoPaginaVendaViewModel
- ColaboradoresBloqueioAgendaApiViewModel
- ConveniosApiViewModel
- CostCenterApiViewModel
- ConjugadoItemRequestApiViewModel
- DadosContratoTrasnferenciaApiViewModel
- Claim
- DadosTrocaContratoApiViewModel
- ClaimsIdentity
- DebtorChargesViewModel
- ClaimsPrincipal
- DebtorsItensViewModel
- DefaultResponseViewModel
- DiferenciaisApiViewModel
- DifferentialsViewModel
- EFormaContato
- EFormaPagamentoTotem
- EOrigemAgendamento
- EStatusAtividade
- EStatusAtividadeSessao
- ConnectionInfo
- ETemperatura
- ConstructorInfo
- ETipoContrato
- ETipoDocumento
- ETipoGateway
- DropsetItemRequestApiViewModel
- EmployeeApiIntegracaoAtualizacaoViewModel
- EmployeeApiBranchPermissions
- EmployeeApiIntegracaoViewModel
- EmpresasConveniosApiViewModel
- ESubStatus
- EmpresasFiliaisGatewayViewModel
- EmpresasFiliaisOcupacaoViewModel
- ESubStatusApi
- EnderecoEnotasRetorno
- CustomAttributeData
- EnotasRetorno
- CustomAttributeNamedArgument
- EntradasResumoApiViewModel
- CustomAttributeTypedArgument
- EstadoViewModel
- ExperimentalClassResponseViewModel
- FitcoinsResponseViewModel
- FreezeViewModel
- FreteEnotasRetorno
- FuncionariosResumoApiViewModel
- HttpResponseError
- IcmsEnotasRetorno
- ImpostosEnotasRetorno
- InformacoesIndicadosViewModel
- InstallmentViewModel
- ItenEnotasRetorno
- LiberacaoCatracaManualViewModel
- LogTefApiViewModel
- MemberAuthenticateViewModel
- MemberBasicResponsibleViewModel
- MemberBlockUnblockViewModel
- MemberDataViewModel
- MemberMembershipApiViewModel
- MemberNewSaleViewModel
- MemberResponsibleViewModel
- IdMemberResponseViewModel
- MemberServiceViewModel
- MemberTransferViewModel
- ItensBloqueioAgendaApiViewModel
- MembersApiViewModel
- MembersBasicApiViewModel
- MetadadosEnotasRetorno
- MonthDiscountViewModel
- NewSaleViewModel
- NotificationApiViewModel
- MatricularApiViewModel
- NotificationProspectApiViewModel
- MatricularConfiguracaoApiViewModel
- EventAttributes
- NotificationResponseViewModel
- EventInfo
- NovoVoucherViewModel
- PagamentoEnotasRetorno
- FieldAttributes
- PayablesApiSubTypesViewModel
- FieldInfo
- PayablesApiViewModel
- PedidoEnotasRetorno
- PercentualAproximadoTributosEnotasRetorno
- PeriodizacaoApiViewModel
- PisEnotasRetorno
- GenericParameterAttributes
- PixPaymentDetailsViewModel
- HostString
- PrescricaoTreinoViewModel
- HttpContext
- ProblemDetails
- HttpRequest
- ProspectApiIntegracaoAtualizacaoViewModel
- HttpResponse
- ProspectApiIntegracaoViewModel
- ProspectIdViewModel
- ICustomAttributeProvider
- ProspectResponsavelFinanceiroViewmodel
- IIdentity
- ProspectTransferViewModel
- IPAddress
- NeighborhoodViewModel
- ProspectTransferenciaViewModel
- IResponseCookies
- ProspectsResumoApiViewModel
- IServiceProvider
- ProtocoloEnotasRetorno
- ISession
- PublicoAtividadeViewModel
- ReceivablesApiSubTypesViewModel
- ReceivablesApiViewModel
- ReceivablesApiViewModelListGridComQtdeViewModel
- ReceivablesCreditDetails
- ReceivablesInvoiceApiViewModel
- ProgressivoItemRequestApiViewModel
- IntPtr
- ReceivablesMaskReceivedViewModel
- RetornoCatracaViewModel
- RetornoEntradaManualViewModel
- KeySizes
- RevenueCenterApiViewModel
- LayoutKind
- SaleItensViewModel
- SalesItemViewModel
- SalesItemsViewModel
- MatriculaDetalhesApiViewModel
- SalesViewModel
- ProdutoResumoApiViewModel
- ServiceDiscountViewModel
- ServicoAdicionalApiViewModel
- ServicoAnualApiViewModel
- ServicoEnotasRetorno
- ServicosResumoApiViewModel
- RecursosBloqueioAgendaApiViewModel
- SimplificadoEnotasRetorno
- MemberInfo
- SpsProspectsServicosInteresses
- MemberLevelViewModel
- SumaryDebtorsViewModel
- TaxDataViewModel
- MemberParkingViewModel
- TelefoneApiViewModel
- TransferClientResponseViewModel
- TransporteEnotasRetorno
- UnavailableSpotsResponseViewModel
- MemberTypes
- VouchersResumoApiViewModel
- W12UtilsCategoryMembershipViewModel
- SerieItemRequestApiViewModel
- W12UtilsWebhookHeaderViewModel
- SeriePrescricaoRequestApiViewModel
- W12UtilsWebhookViewModel
- MethodAttributes
- W12UtilzWebHookFilterViewModel
- MethodBase
- YearDiscountViewModel
- TimeSpan
- MethodImplAttributes
- autorizaEntradaExternoViewModel
- MethodInfo
- retornoAutorizaEntradaExternoViewModel
- MobilePushMultiplaViewModel
- MobilePushViewModel
- Module
- ModuleHandle
- TreinoPrescricaoRequestApiViewModel
- Oid
- VoucherCriacaoViewModel
- StateViewModel
- VouchersCodigosViewModel
- ParameterAttributes
- VouchersCodigosViewModelListWithQuantityViewModel
- ParameterInfo
- PathString
- PipeReader
- VoucherAtributePublicViewModel
- PipeWriter
- VoucherItemApiViewModel
- PropertyAttributes
- PropertyInfo
- PublicKey
- QueryString
- RuntimeFieldHandle
- RuntimeMethodHandle
- RuntimeTypeHandle
- SafeWaitHandle
- SecurityRuleSet
- Stream
- StringStringKeyValuePair
- StringStringValuesKeyValuePair
- StructLayoutAttribute
- Type
- TypeAttributes
- TypeInfo
- TypeObjectKeyValuePair
- WaitHandle
- WebSocketManager
- X500DistinguishedName
- X509Certificate2
- X509Extension
Sales
Esse fluxo é fundamental para integrações de PDV, autoatendimento (totem) e e-commerce, garantindo o controle e rastreamento das transações.
Endpoints disponíveis#
| Método | Endpoint | Descrição |
|---|---|---|
GET | /api/v1/sales/{idSale} | Recupera os detalhes de uma venda pelo seu identificador. |
GET | /api/v2/sales | Lista todas as vendas realizadas. |
POST | /api/v2/sales | Cria uma nova venda. |
GET | /api/v1/sales/by-session-id | Retorna as vendas associadas a um sessionId. |
GET | /api/v1/sales/sales-items | Retorna os itens de uma venda (utilizado em site/totem). |
Modificado em 2026-01-31 05:15:32