POST /contract (Contract)

Cadastro de um contrato para um Cliente no sistema Conexa.

Campos do body:

• planId (integer) [obrigatório]: ID do plano

• customerId (integer) [obrigatório]: ID do cliente

• paymentFrequency (integer) [obrigatório]: Periodicidade do pagamendo do contrato conforme o plano, podendo ser: monthly , bimonthly , quarterly , semester e yearly

• startDate (string) [obrigatório]: Data de início. Formato: yyyy-MM-dd

• endDate (string): Data de encerramento. Formato: yyyy-MM-dd

• firstDueDate (string) [obrigatório]: Determina a data de vencimento da primeira parcela. Formato yyyy-mm-dd

• dueDay (integer) [obrigatório]: Dia de vencimento do contrato

• fidelityDate (string): Data de fidelidade. Formato: yyyy-MM-dd

• amount (decimal): Valor do contrato¹

• discountValue (decimal): Valor do desconto aplicado ao valor do contrato (em reais)

• sellerId (integer): ID do vendedor (usuário)

• contractSummary (string): Descrição resumida do contrato

• notes (string): Observações

• membershipFee (decimal): Taxa de adesão do contrato

• generateSales (string): Define a partir de quando deve gerar as vendas, podendo ser: firstOccurrence , currentOccurrence, nextOccurrence ou firstOccurrenceSettleRetroactive

• expenseSettlement (object): Configura informações necessárias para quitar as cobranças retroativas, caso generateSales for firstOccurrenceSettleRetroactive .

• expenseSettlement.receivingMethodId (integer): ID do meio de recebimento a ser utilizado para quitar as vendas retroativas

• expenseSettlement.accountId (integer): ID da conta bancária a ser utilizada para quitar as vendas retroativas

• prorataType (string): Define a forma como a prorata dese ser cálculada. Podendo ser: startOfMonth , notCalculate ou perDueDate (está última depende da configuração do sistema)

• nfseDescription (string): Descrição utilizada na NFSe

• refund (object / null): Configura os dados do depósito retornável. Informe null para não gerar, mesmo que esteja configurado no plano

• refund.amount (decimal): Valor do depósito retornável

• refund.dateLimit (string) [obrigatório]: Data de vencimento do depósito retornável

• refund.isToGenerateRefundBillet (boolean) [obrigatório]: Define se deve ser gerado um boleto do depósito retornável

• complementaryServices (array of objects): Define os serviços complementares que serão adicionados ao contrato

• complementaryServices[].productOrServiceId (integer) [obrigatório]: Id do produto ou serviço

• complementaryServices[].quantity (integer) [obrigatório]: Quantidade do produto ou serviço

• complementaryServices[].amount (decimal): Valor final do serviço

• complementaryServices[].notes (string): Observações

• extraFields (array of objects / null): Lista de campos extras do contrato. Enviar null ou omitir para não alterar. Os campos extras devem ser do tipo contract

• extraFields[].id (integer) [obrigatório]: ID do campo extra

• extraFields[].value (string) [obrigatório]: Valor do campo extra

• discountOnRooms (decimal): Desconto (%) aplicado às reservas de salas realizadas pelo contratante

• discountOnWorkstation (decimal): Desconto (%) aplicado às reservas de ambientes compartilhados realizadas pelo contratante

• privateSpaceId (integer): ID do Escritório Privativo vinculado ao Contrato

• isSmsEnabled (boolean): Indica se o envio de recados via SMS está habilitado no contrato

• calculateProrataHourPackage (boolean): Define se deve ser realizado o cálculo do prorata nos pacotes de horas

• serviceCorrespondeceQuotas (object): Configura as cotas de Atendimento e Correpondência

• serviceCorrespondeceQuotas.limited (boolean): Define se a quantidade de atendimentos ou correspondências é ou não limitada

• serviceCorrespondeceQuotas.messagesLimit (integer) [obrigatório]: Define o limite de atendimentos ou correspondências. Definir como 0 para não adicionar cotas ao contrato

• serviceCorrespondeceQuotas.priceAdditionalMessage (decimal) [obrigatório]: Define o valor a ser pago por atendimentos ou correspondências caso o limite seja ultrapassado