Financeiro › Contratos

Criar

<aside>🔒 Para acessar essa rota é necessária a permissão de cadastro de Contratos</aside>
post/financial/contracts

Request

  • Base URL: https://api.apresenta.me
  • URL: https://api.apresenta.me/financial/contracts
  • Auth: HTTP bearer

Request body

typestring required

Tipo do contrato. Valores permitidos:

  • rent: Anual
  • season: Temporada
  • sale: Venda
  • subscription: Assinatura
building_idinteger required

ID do Imóvel

tenant_idinteger required

ID do Inquilino

billing_idinteger required

ID do método de pagamento

start_atstring required

Data de início

recurrencystring required

Recorrência. Valores permitidos:

  • daily: Diariamente
  • monthly: Mensalmente
amountnumber required

Valor do contrato

business_idinteger required

ID da empresa

account_idinteger required

ID da conta financeira

billing_methodstring required

Tipo de pagamento ao proprietário. Valores permitidos:

  • ticket: Boleto
  • cash: Dinheiro
  • deposit: Depósito
  • pix: PIX
  • ted: DOC/TED
  • credit: Cartão de Crédito
  • debit: Cartão de Débito
  • check: Cheque
  • debit_account: Débito em Conta
due_datestring

Data do vencimento

sale_typestring

Tipo de venda. Valores permitidos:

  • deed_registration: Escritura/Registro
  • financing: Financiamento
  • private_document: Documento Particular
  • assignment_of_rights: Cessão de direito
referencestring

Código de referência

activestring

Status de atividade. Valores permitidos:

  • active: Ativo
  • pre_reserved: Pré-Reservado
  • reserved: Reservado
  • suspended: Suspenso
  • canceled: Cancelado
  • finished: Concluído
active_datestring

Data de alteração da atividade

statusstring

Status do contrato. Valores permitidos:

  • progress: Em Andamento
  • closing: Encerrando
  • readjust: Aguardando Reajuste
  • renew: Aguardando Renovação
  • no_invoices: Contrato sem Faturas
  • suspended: Suspenso
  • pending: Pendente
  • finished: Finalizado
  • canceled: Cancelado
  • terminating: Aguardando Rescisão
  • on_notice: Em Aviso Prévio
  • terminated: Rescindido
status_datestring

Data de alteração do status

payment_statusstring

Status de pagamento. Valores permitidos:

  • due_5_days: Vence em 5 dias
  • due_10_days: Vence em 10 dias
  • nothing: Nada a pagar
  • ok: Pagamento em Dia
  • 5_days: Menos de 5 dias Vencido
  • 30_days: Menos de um mês Vencido
  • month: Mais de um mês Vencido
  • 3_months: Mais de três meses Vencido
payment_status_datestring

Data de alteração do status de pagamento

user_idinteger

ID do usuário responsável

agent_idinteger

ID do corretor

procurator_idinteger

ID do procurador

team_idinteger

ID da equipe

accessstring

Nível de acesso. Valores permitidos:

  • all: Todos os Usuários
  • responsible: Usuários Responsáveis
tagstring

Tags

guaranteed_transferboolean

Repasse garantido

guaranteed_transfer_monthsinteger

Meses garantidos no repasse

guaranteed_transfer_release_after_daysinteger

Dias para liberação do repasse

end_atstring

Data de término

booleanstring

indeterminado

signed_atstring

Data de assinatura

recurrency_amountinteger

Quantidade de recorrências

modalitystring

Modalidade. Valores permitidos:

  • start: Início do Contrato
  • due_date: Dia de Vencimento
  • monthly: Início do Mês
current_amountnumber

Valor atual do contrato

service_rate_amountnumber

Valor da taxa de serviço

totalnumber

Valor total

signal_amountnumber

Valor de sinal

refund_amountnumber

Valor de reembolso

fiscal_note_withholdingnumber

Retenção de nota fiscal

due_dayinteger

Dia do vencimento

billing_timingstring

Momento do faturamento

first_commissionnumber

Primeira comissão

first_commission_installmentinteger

Parcelas da primeira comissão

recurring_commissionnumber

Comissão recorrente

add_commission_on_firstboolean

Adicionar comissão na primeira parcela

proportionalboolean

Proporcional

unify_first_invoiceboolean

Unificar primeira fatura

readjust_activeboolean

Reajuste ativo

readjust_indicatorstring

Indicador de reajuste. Valores permitidos:

  • IGP-M: IGP-M
  • INCC-M: INCC-M
  • INPC: INPC
  • IVAR: IVAR
  • IPC-BR: IPC-BR
  • IPCA: IPCA
  • highest_index: Maior disponível
  • lowest_index: Menor disponível
  • IPC-FIPE: IPC-FIPE
readjust_withinteger

Período de reajuste

readjust_atstring

Data do reajuste

readjusted_atstring

Data do último reajuste

guaranteestring

Garantia

notesstring

Observações

clausesstring

Cláusulas

invoice_installmentinteger

Parcelas da fatura

witness_1integer

ID da primeira testemunha

witness_2integer

ID da segunda testemunha

guarantor_1integer

ID do primeiro fiador

guarantor_2integer

ID do segundo fiador

billing_autostring

Geração automática das faturas de locação: business, active ou inactive

ticket_late_feeboolean

Multa por atraso

ticket_late_fee_item_idinteger

ID do item de multa

ticket_late_fee_percentagenumber

Porcentagem da multa

ticket_late_fee_interestnumber

Juros da multa

ticket_discountboolean

Desconto

ticket_discount_actionstring

Ação do desconto. Valores permitidos:

  • percentage: Porcentagem
  • fixed: Fixo
ticket_discount_modestring

Modo do desconto. Valores permitidos:

  • fixed: Fixo
  • percentage: Percentual
ticket_discount_percentagenumber

Porcentagem do desconto

ticket_discount_fixednumber

Valor fixo do desconto

ticket_discount_daysinteger

Dias para desconto

termination_feenumber

Valor da multa de rescisão

termination_fee_monthsinteger

Meses de multa

termination_fee_exemptionboolean

Isenção de multa

termination_fee_amountnumber

Valor da multa

deal_idinteger

ID do negócio

documentablesstring[]

Lista de documentos na nova estrutura polimórfica

transfer_modestring

Modo de transferência. Valores permitidos:

  • manually: Manual
  • after_receive: Após Recebimento
  • fixed_day_or_next: Em dia Fixo ou Seguinte
  • fixed_day: Em dia Fixo
transfer_after_daysinteger

Dias para transferência

transfer_autoboolean

Transferência automática

fiscal_note_triggerstring

Modo de emissão da nota fiscal (NONE, BUSINESS, MANUAL, ON_PAYMENT_CONFIRMATION, ON_PAYMENT_NO_CONVERT)

dimobboolean

DIMOB

metadatastring

Metadados

Example request

{
  "type": "rent",
  "building_id": 123456,
  "tenant_id": 123456,
  "billing_id": 123456,
  "start_at": "2024-01-01",
  "recurrency": "monthly",
  "amount": 1500,
  "business_id": 123456,
  "account_id": 123456,
  "billing_method": "pix",
  "due_date": "2024-01-05",
  "sale_type": "deed_registration",
  "reference": "CONTR-001",
  "active": "active",
  "active_date": "2024-01-01",
  "status": "no_invoices",
  "status_date": "2024-01-01",
  "payment_status": "ok",
  "payment_status_date": "2024-01-01",
  "user_id": 123456,
  "agent_id": 123456,
  "procurator_id": 123456,
  "team_id": 123456,
  "access": "all",
  "tag": "importante",
  "guaranteed_transfer": true,
  "guaranteed_transfer_months": 12,
  "guaranteed_transfer_release_after_days": 30,
  "end_at": "2024-12-31",
  "boolean": "false",
  "signed_at": "2024-01-01",
  "recurrency_amount": 12,
  "modality": "start",
  "current_amount": 1500,
  "service_rate_amount": 150,
  "total": 1650,
  "signal_amount": 1500,
  "due_day": 5,
  "billing_timing": "pre",
  "first_commission_installment": 1,
  "readjust_active": true,
  "readjust_indicator": "IGP-M",
  "readjust_with": 12,
  "readjust_at": "2024-01-01",
  "readjusted_at": "2024-01-01",
  "guarantee": "caução",
  "notes": "Contrato de aluguel residencial",
  "clauses": "Cláusulas do contrato",
  "invoice_installment": 1,
  "witness_1": 123456,
  "witness_2": 123456,
  "guarantor_1": 123456,
  "guarantor_2": 123456,
  "billing_auto": "business",
  "ticket_late_fee": true,
  "ticket_late_fee_item_id": 123456,
  "ticket_late_fee_percentage": 2,
  "ticket_late_fee_interest": 1,
  "ticket_discount": true,
  "ticket_discount_action": "percentage",
  "ticket_discount_mode": "fixed",
  "ticket_discount_percentage": 5,
  "ticket_discount_fixed": 50,
  "ticket_discount_days": 5,
  "termination_fee": 1500,
  "termination_fee_months": 3,
  "termination_fee_amount": 1500,
  "deal_id": 123456,
  "documentables": [
    {
      "template_id": 1,
      "content": "<p>...</p>",
      "privacy": "private"
    }
  ],
  "transfer_mode": "manually",
  "transfer_after_days": 5,
  "fiscal_note_trigger": "BUSINESS",
  "metadata": "{\"key\": \"value\"}"
}

Changes

No recorded changes to this operation across all 1 revision of this API.