POST /plan (Plan)
create_planCreate a plan for contract registration by specifying name, payment options, product quotas, and discounts in the Conexa system.
Instructions
Criação de um plano, utilizado no cadastro de contrato, no sistema Conexa.
Campos do body:
companyId (integer) [obrigatório]: ID da unidade
name (string) [obrigatório]: Nome do plano ( deve ser único )
serviceCategoryId (integer) [obrigatório]: ID da categoria de serviço
costCenterId (integer) [obrigatório]: ID do centro custo
description (string): Descrição do plano
paymentPeriodicities (array of objects): Opções de periodicidade de pagamento
paymentPeriodicities[].periodicity (string) [obrigatório]: Periodicidade de pagamento, podendo ser: monthly , bimonthly , quarterly , semester ou yearly
paymentPeriodicities[].amount (decimal) [obrigatório]: Valor do plano em determinada periodicidade
membershipFee (decimal): Taxa de adesão
refundValue (decimal): Valor de deposito retornavel
fidelityMonths (integer): Meses de fidelidade
productQuotas (array of objects): Cotas de serviços/itens (produtos) que vão estar associadas ao plano
productQuotas[].productId (integer) [obrigatório]: ID do serviço/item
productQuotas[].quantity (integer) [obrigatório]: Quantidade de cotas
nfseDescription (string): Descrição da nota fiscal
descriptionReceipt (string): Descrição do recibo (depende de configuração)
discountOnRooms (decimal): Valor em percentual de desconto em salas
discountOnWorkstation (decimal): Valor em percentual de desconto em ambientes compartilhados
isSmsEnabled (boolean): Flag para verificar se envia SMS. Padrão: false
serviceCorrespondenceQuotas (object): Configura as cotas de atendimentos e correspondências (depende de configuração)
serviceCorrespondenceQuotas.limited (boolean): Define se a quantidade de atendimentos e correspondências é ou não limitada
serviceCorrespondenceQuotas.messagesLimit (integer) [obrigatório]: Define o limite de atendimentos e correspondências. Definir como 0 para não adicionar cotas ao contrato
serviceCorrespondenceQuotas.priceAdditionalMessage (decimal) [obrigatório]: Define o valor a ser pago caso o limite de atendimentos e correspondências seja ultrapassado
bookingModels (array of objects): Lista de Modelos de Reserva (Estações de Trabalho do Ambiente Compartilhado)
bookingModels[].id (integer) [obrigatório]: ID do Modelo de reserva
bookingModels[].stations (integer) [obrigatório]: Quantidade de estações
privateSpaceIds (array): IDs de espaços privativos que o plano contempla
hourQuotas (array of objects): Pacotes de horas
hourQuotas[].hours (integer) [obrigatório]: Quantidade de horas da cota
hourQuotas[].periodicity (string) [obrigatório]: Frequência de disponibilidade de cota, podendo ser: daily , weekly ou monthly
hourQuotas[].spaceId (integer) [obrigatório]: ID do espaço
hourQuotas[].groupId (integer) [obrigatório]: ID do grupo
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Corpo JSON da requisição (campos na descrição da tool) |