PATCH /plan/:id (Plan)
update_planUpdate a plan in the Conexa contract registration system. Modify plan fields like name, payment options, product quotas, and service correspondence limits.
Instructions
Atualiza um plano, utilizado no cadastro de contrato, no sistema Conexa.
Campos do body:
companyId (integer): ID da unidade
name (string): Nome do plano ( deve ser único )
serviceCategoryId (integer): ID da categoria de serviço
costCenterId (integer): 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 para a periodicidade
membershipFee (decimal): Taxa de adesão
refundValue (decimal): Valor de depósito retornável
fidelityMonths (integer): Quantidade de meses de fidelidade
productQuotas (array of objects): Lista de cotas de serviços/itens (produtos) vinculadas ao plano
productQuotas[].productId (integer) [obrigatório]: ID do serviço/item
productQuotas[].quantity (integer) [obrigatório]: Quantidade de cotas
dueDay (integer): Dia do vencimento do plano "Cliente Avulso"
nfseDescription (string): Descrição da nota fiscal
receiptDescription (string): Descrição do recibo (depende de configuração)
discountOnRooms (decimal): Valor em percentual de desconto para reserva em salas
discountOnWorkstation (decimal): Valor em percentual de desconto para reserva em ambientes compartilhados
isSmsEnabled (boolean): Flag de envio de SMS
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 adicional por atendimentos e correspondências, caso 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): Lista de IDs de espaços privativos associados ao plano
hourQuotas (array of objects): Lista de cotas de horas para uso de salas ou ambientes compartilhados
hourQuotas[].hours (integer) [obrigatório]: Quantidade de horas inclusas
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 |
|---|---|---|---|
| id | Yes | Valor de :id na rota /plan/:id | |
| body | Yes | Corpo JSON da requisição (campos na descrição da tool) |