Follow the question structure recommended by Dev Bot before submitting your integration questions.
- Welcome 💜
- 📃 Guides
- 🌐 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
- FitnessAssessment
- Get the branch's custom fitness-assessment protocols (RF-1).
- Get a protocol detail (field configuration) of any type (RF-2). The response shape is dynamic per type. Ids are not unique across types, so type selects the source.
- Management listing of fitness assessments by period/type/expiration (RF-3). General administration only.
- Get the member's answered fitness assessments (RF-4). Requires `idMember` (client-scoped source). When `idFitnessAssessment` is given, returns the full answer detail of that single assessment, with a dynamic shape per protocol type. Otherwise returns th
- Add a bioimpedance fitness assessment for the member (RF-5). Returns the created id.
- Edit a bioimpedance fitness assessment (RF-6): updates ALL bioimpedance data (measurements, basic data, photos) and the expiry date.
- Delete a bioimpedance fitness assessment. Soft delete: the record is kept and flagged as deleted, crediting the employee and the date of the exclusion — same behaviour as the EVO APP flow (`v1/avaliacao-fisica/ExcluirRespostaBioimpedancia`).
- 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
- Authenticate a member by encrypted id
- 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
- Add a responsible to a member
- Remove a responsible from a member
- Membership
- Notifications
- Parking
- Partnership
- Payables
- PaymentType
- 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
- Collects (registers) a payment for a sale
- List PJBank boletos (bank slips) for the authenticated branch.
- 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
- Get the latest workout of each active member of a branch (management view). Only workouts from the new workout version are considered - a member whose workouts all come from the legacy version is reported as having no workout (workoutStatus 0).
- Schemas
- Schemas
- ActiveMembersReturnViewModel
- ActivityAreaViewModel
- ActivityEmployeesViewModel
- ActivityGroupApiViewModel
- ActivityGroupViewModel
- ActivityResourcesViewModel
- ActivityUnavailability
- AreaBloqueioAgendaApiViewModel
- AdditionalMembershipApiViewModel
- AtividadeAgendaApiCustomViewModel
- ApiResultadoConfirmacaoViewModel
- AdditionalMembershipNewSaleViewModel
- AtividadeAgendaApiViewModel
- AddressLocationViewModel
- ApiResultadoPreAutorizacaoViewModel
- AtividadeAgendaListApiViewModel
- ApiProConsumoItemViewModel
- AtividadeBasicoApiViewModel
- ApiProConsumoPeriodoViewModel
- AddressFamily
- AtividadeEnrollScheduleApiV2ViewModel
- ApiProConsumoUsoViewModel
- AtividadeListApiViewModel
- ApiProConsumoViewModel
- AtividadeLugarReservaApiViewModel
- AtividadeLugarReservaViewModel
- AtividadeSessaoAgendaViewModel
- AsnEncodedData
- AtividadeSessaoParticipanteApiViewModel
- BandeirasBasicoViewModel
- BankAccountsViewModel
- BairroViewModel
- BasicFreezeViewModel
- BasicMemberMembershipApiViewModel
- AtualizarConfiguracoesEmpresaRequestViewModel
- Assembly
- BloqueioAgendaApiViewModel
- AtualizarConfiguracoesFinanceirasRequestViewModel
- BonusSessionViewModel
- AtualizarConfiguracoesVendaRequestViewModel
- AsymmetricAlgorithm
- BusinessHoursViewModel
- CancelReceivablesResponseViewModel
- CancelReceivablesViewModel
- CardDataViewModel
- BasicDataDto
- CardTranslationViewModel
- BranchGatewayViewModel
- BranchIdentificationViewModel
- BioimpedanceCreatedResponse
- CartViewModel
- BranchOperationViewModel
- BioimpedanceRequest
- ChargeReceivableRequestViewModel
- ChargeReceivableResponseViewModel
- CheckinResponseItemViewModel
- CityViewModel
- BioimpedanceUpdateRequest
- ClienteEnotasRetorno
- CardValidationCheckRequestViewModel
- CidadeViewModel
- ClienteTransferenciaViewModel
- CardValidationStartRequestViewModel
- CofinsEnotasRetorno
- ColaboradoresBloqueioAgendaApiViewModel
- ConfiguracaoApiViewModel
- ConjugadoItemRequestApiViewModel
- ContractCancellationViewModel
- CartIdViewModel
- ClientesAtivosRetornoViewModel
- ContractSuspensionViewModel
- CartItemsViewModel
- ContratoEntradasApiViewModel
- ContratoFiliaisResumoApiViewModel
- ByteReadOnlyMemory
- ContratosCanceladosParcelasApiViewModel
- ContratosCanceladosResumoApiViewModel
- ByteReadOnlySpan
- ContratosResumoPaginaVendaViewModel
- ClienteDetalhesBasicosApiViewModel
- ConveniosApiViewModel
- CostCenterApiViewModel
- CallingConventions
- DadosContratoTrasnferenciaApiViewModel
- ContactViewModel
- DadosTrocaContratoApiViewModel
- DebtorChargesViewModel
- DebtorsItensViewModel
- CollectReceivableRequestViewModel
- CancellationToken
- DefaultResponseViewModel
- DiferenciaisApiViewModel
- DifferentialsViewModel
- DropsetItemRequestApiViewModel
- EFormaContato
- EFormaPagamentoTotem
- EStatusAtividade
- CreateBankAccountRequestViewModel
- EStatusAtividadeSessao
- ContratosResumoApiViewModel
- ESubStatus
- ESubStatusApi
- DataPrivacyViewModel
- ETemperatura
- Claim
- ETipoContrato
- ETipoDocumento
- ClaimsIdentity
- EmployeeApiBranchPermissions
- EmployeeApiIntegracaoAtualizacaoViewModel
- EmployeeApiIntegracaoViewModel
- ClaimsPrincipal
- EmpresasConveniosApiViewModel
- EmpresasFiliaisOcupacaoViewModel
- EnderecoEnotasRetorno
- EFusoHorario
- EnotasRetorno
- EntradasResumoApiViewModel
- DigitalPresenceViewModel
- ExperimentalClassResponseViewModel
- FilialIntegracaoViewModel
- FitcoinsResponseViewModel
- FreezeViewModel
- EOrigemAgendamento
- FreteEnotasRetorno
- FuncionariosResumoApiViewModel
- ConnectionInfo
- ETipoGateway
- GrupoFiliaisIntegracaoViewModel
- HttpResponseError
- EStatusTreino
- IcmsEnotasRetorno
- ConstructorInfo
- IdMemberResponseViewModel
- ImpostosEnotasRetorno
- InformacoesIndicadosViewModel
- InstallmentViewModel
- IntegracaoBoletoConsultaViewModel
- ItenEnotasRetorno
- ItensBloqueioAgendaApiViewModel
- LiberacaoCatracaManualViewModel
- LogTefApiViewModel
- FinanceiroAutomaticSettlementViewModel
- MatriculaDetalhesApiV2ViewModel
- FinanceiroAvailableCeilingViewModel
- MatriculaDetalhesApiViewModel
- FinanceiroBankSlipExpiredViewModel
- MatricularApiViewModel
- FinanceiroBankSlipViewModel
- EmpresasFiliaisGatewayViewModel
- MatricularConfiguracaoApiViewModel
- FinanceiroCreditsDiscountsViewModel
- MemberAuthenticateViewModel
- FinanceiroDefaultAccountsViewModel
- MemberBasicResponsibleViewModel
- MemberBlockUnblockViewModel
- FinanceiroFinancialOperationViewModel
- CustomAttributeData
- FinanceiroGenerateForOutstandingBalanceViewModel
- MemberLevelViewModel
- FinanceiroInterestAndFinesViewModel
- CustomAttributeNamedArgument
- MemberMembershipApiViewModel
- FinanceiroOnlineSalesByBankSlipViewModel
- MemberNewSaleViewModel
- FinanceiroDefaultingViewModel
- FinanceiroPaymentMethodsViewModel
- MemberParkingViewModel
- CustomAttributeTypedArgument
- MemberScheduleApiV2ViewModel
- FinanceiroInstallmentRulesViewModel
- MemberServiceViewModel
- EstadoViewModel
- MemberTransferViewModel
- MembersApiResumidoVendaViewModel
- FinanceiroRecurringDebitCardViewModel
- MetadadosEnotasRetorno
- FitnessAssessmentManagementResponse
- MobilePushMultiplaViewModel
- FotoFacialIntegracaoViewModel
- MobilePushViewModel
- MonthDiscountViewModel
- NeighborhoodViewModel
- NotificationApiViewModel
- NotificationProspectApiViewModel
- NotificationResponseViewModel
- NovoVoucherViewModel
- PagamentoEnotasRetorno
- PayablesApiSubTypesViewModel
- PayablesApiViewModel
- PedidoEnotasRetorno
- PaymentDataViewModel
- PercentualAproximadoTributosEnotasRetorno
- IgnoredReceivableViewModel
- PeriodizacaoApiViewModel
- MemberCreditCardApiViewModel
- PisEnotasRetorno
- PixPaymentDetailsViewModel
- PrescricaoTreinoViewModel
- ManagementWorkoutResponseApiViewModel
- ProblemDetails
- ProdutoResumoApiViewModel
- ProgressivoItemRequestApiViewModel
- MemberResponsibleAddViewModel
- MemberResponsibleViewModel
- ProspectIdViewModel
- MarkReceivedResponseViewModel
- ProspectResponsavelFinanceiroViewmodel
- ProspectTransferViewModel
- MemberIdAuthViewModel
- ProspectTransferenciaViewModel
- MemberIdAuthenticatedViewModel
- ProtocoloEnotasRetorno
- EventAttributes
- PublicoAtividadeViewModel
- ReceivablesApiResumoVendaViewModel
- ReceivablesApiSubTypesViewModel
- MemberDataViewModel
- ReceivablesApiViewModel
- EventInfo
- ReceivablesApiViewModelListGridComQtdeViewModel
- ReceivablesCreditDetails
- ReceivablesInvoiceApiViewModel
- ReceivablesMaskReceivedViewModel
- MembersApiViewModel
- FieldAttributes
- ReconcileReceivablesResponseViewModel
- MembersBasicApiViewModel
- ReconcileReceivablesViewModel
- RecursosBloqueioAgendaApiViewModel
- FieldInfo
- RetornoAgregadoresCheckinMultiFiliaisViewModel
- RetornoCatracaViewModel
- RetornoEntradaManualViewModel
- RevenueCenterApiViewModel
- NewSaleViewModel
- SalesItemViewModel
- SalesItemsViewModel
- SalesViewModelV2
- SerieItemRequestApiViewModel
- PlatformSettingsViewModel
- GenericParameterAttributes
- SeriePrescricaoRequestApiViewModel
- ServiceDiscountViewModel
- ServicoAdicionalApiViewModel
- HostString
- ServicoAnualApiViewModel
- ServicoEnotasRetorno
- ServicosResumoApiViewModel
- HttpContext
- SimplificadoEnotasRetorno
- SpsProspectsServicosInteresses
- StateViewModel
- SumaryDebtorsViewModel
- TaxDataViewModel
- HttpRequest
- TelefoneApiViewModel
- TransferClientResponseViewModel
- TransporteEnotasRetorno
- HttpResponse
- ProspectApiIntegracaoAtualizacaoViewModel
- TreinoPrescricaoRequestApiViewModel
- ProspectApiIntegracaoViewModel
- UnavailableSpotsResponseViewModel
- VendasResumoApiViewModel
- VoucherAtributePublicViewModel
- ICustomAttributeProvider
- VoucherCriacaoViewModel
- VoucherItemApiViewModel
- ProspectsResumoApiViewModel
- VouchersCodigosViewModel
- IIdentity
- VouchersCodigosViewModelListWithQuantityViewModel
- ProtocolResponse
- VouchersResumoApiViewModel
- W12UtilsCategoryMembershipViewModel
- IPAddress
- W12UtilsWebhookHeaderViewModel
- W12UtilsWebhookViewModel
- W12UtilzWebHookFilterViewModel
- YearDiscountViewModel
- IResponseCookies
- autorizaEntradaExternoViewModel
- retornoAutorizaEntradaExternoViewModel
- IServiceProvider
- ISession
- RestricaoTreinoResumoApiViewModel
- SaleItensViewModel
- IntPtr
- VendaAuthorizedBranchesViewModel
- KeySizes
- VendaBranchIntegrationViewModel
- VendaClientRulesViewModel
- VendaCommercialRulesViewModel
- LayoutKind
- VendaCommissioningViewModel
- VendaCommunicationViewModel
- VendaContractSignatureViewModel
- VendaDocumentsViewModel
- VendaExpirationTimeViewModel
- TagTreinoResumoApiViewModel
- VendaFinancialPendingViewModel
- VendaOnlineContractsViewModel
- SalesViewModel
- VendaPromotionsViewModel
- VendaReceiptViewModel
- MemberInfo
- VendaSaleIntentLinkViewModel
- MemberTypes
- VendaSaleRestrictionsViewModel
- 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
AddressLocationViewModel
{
"zipCode": "string",
"stateShort": "string",
"stateId": 0,
"address": "string",
"number": "string",
"neighborhood": "string",
"city": "string",
"latitude": 0,
"longitude": 0
}