Financeiro › Contratos

Pesquisar

<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Contrato</aside>
get/financial/contracts

Request

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

Query parameters

sortstring

Campo para ordenar os registros

Example:id
fieldsstring

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:id,reference,deal_id
filter[id]integer

ID do contrato

Example:123123
filter[id2]integer

ID do contrato

Example:123123
filter[building_id]integer

ID do Imóvel

Example:123456
filter[tenant_id]integer

ID do Inquilino

Example:123456
filter[billing_id]integer

ID do método de pagamento

Example:123456
filter[reference]string

Código de referência

Example:CONTR-001
filter[type]string

Tipo do contrato. Valores permitidos:

  • rent: Anual
  • season: Temporada
  • sale: Venda
  • subscription: Assinatura
Example:rent
filter[sale_type]string

Tipo de venda. Valores permitidos:

  • deed_registration: Escritura/Registro
  • financing: Financiamento
  • private_document: Documento Particular
  • assignment_of_rights: Cessão de direito
Example:deed_registration
filter[active]string

Status de atividade. Valores permitidos:

  • active: Ativo
  • pre_reserved: Pré-Reservado
  • reserved: Reservado
  • suspended: Suspenso
  • canceled: Cancelado
  • finished: Concluído
Example:active
filter[active_date]string

Data de alteração da atividade

Example:2024-01-01
filter[status]string

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
Example:no_invoices
filter[status_date]string

Data de alteração do status

Example:2024-01-01
filter[payment_status]string

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
Example:ok
filter[payment_status_date]string

Data de alteração do status de pagamento

Example:2024-01-01
filter[user_id]integer

ID do usuário responsável

Example:123456
filter[agent_id]integer

ID do corretor

Example:123456
filter[procurator_id]integer

ID do procurador

Example:123456
filter[team_id]integer

ID da equipe

Example:123456
filter[access]string

Nível de acesso. Valores permitidos:

  • all: Todos os Usuários
  • responsible: Usuários Responsáveis
Example:all
filter[tag]string

Tags

Example:importante
filter[guaranteed_transfer]boolean

Repasse garantido

Example:true
filter[guaranteed_transfer_months]integer

Meses garantidos no repasse

Example:12
filter[guaranteed_transfer_release_after_days]integer

Dias para liberação do repasse

Example:30
filter[start_at]string

Data de início

Example:2024-01-01
filter[end_at]string

Data de término

Example:2024-12-31
filter[signed_at]string

Data de assinatura

Example:2024-01-01
filter[recurrency]string

Recorrência. Valores permitidos:

  • daily: Diariamente
  • monthly: Mensalmente
Example:monthly
filter[recurrency_amount]integer

Quantidade de recorrências

Example:12
filter[modality]string

Modalidade. Valores permitidos:

  • start: Início do Contrato
  • due_date: Dia de Vencimento
  • monthly: Início do Mês
Example:start
filter[amount]number

Valor do contrato

Example:1500
filter[current_amount]number

Valor atual do contrato

Example:1500
filter[service_rate_amount]number

Valor da taxa de serviço

Example:150
filter[total]number

Valor total

Example:1650
filter[signal_amount]number

Valor de sinal

Example:1500
filter[refund_amount]number

Valor de reembolso

filter[fiscal_note_withholding]number

Retenção de nota fiscal

filter[due_day]integer

Dia do vencimento

Example:5
filter[due_date]string

Data do vencimento

Example:2024-01-05
filter[billing_timing]string

Momento do faturamento

Example:pre
filter[first_commission]number

Primeira comissão

filter[first_commission_installment]integer

Parcelas da primeira comissão

Example:1
filter[recurring_commission]number

Comissão recorrente

filter[add_commission_on_first]boolean

Adicionar comissão na primeira parcela

filter[proportional]boolean

Proporcional

filter[unify_first_invoice]boolean

Unificar primeira fatura

filter[readjust_active]boolean

Reajuste ativo

Example:true
filter[readjust_indicator]string

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
Example:IGP-M
filter[readjust_with]integer

Período de reajuste

Example:12
filter[readjust_at]string

Data do reajuste

Example:2024-01-01
filter[readjusted_at]string

Data do último reajuste

Example:2024-01-01
filter[guarantee]string

Garantia

Example:caução
filter[notes]string

Observações

Example:Contrato de aluguel residencial
filter[clauses]string

Cláusulas

Example:Cláusulas do contrato
filter[invoice_installment]integer

Parcelas da fatura

Example:1
filter[witness_1]integer

ID da primeira testemunha

Example:123456
filter[witness_2]integer

ID da segunda testemunha

Example:123456
filter[guarantor_1]integer

ID do primeiro fiador

Example:123456
filter[guarantor_2]integer

ID do segundo fiador

Example:123456
filter[ticket_late_fee]boolean

Multa por atraso

Example:true
filter[ticket_late_fee_item_id]integer

ID do item de multa

Example:123456
filter[ticket_late_fee_percentage]number

Porcentagem da multa

Example:2
filter[ticket_late_fee_interest]number

Juros da multa

Example:1
filter[ticket_discount]boolean

Desconto

Example:true
filter[ticket_discount_action]string

Ação do desconto. Valores permitidos:

  • percentage: Porcentagem
  • fixed: Fixo
Example:percentage
filter[ticket_discount_mode]string

Modo do desconto. Valores permitidos:

  • fixed: Fixo
  • percentage: Percentual
Example:fixed
filter[ticket_discount_percentage]number

Porcentagem do desconto

Example:5
filter[ticket_discount_fixed]number

Valor fixo do desconto

Example:50
filter[ticket_discount_days]integer

Dias para desconto

Example:5
filter[termination_fee]number

Valor da multa de rescisão

Example:1500
filter[termination_fee_months]integer

Meses de multa

Example:3
filter[termination_fee_exemption]boolean

Isenção de multa

filter[termination_fee_amount]number

Valor da multa

Example:1500
filter[termination_fee_comission]number

Valor da multa

Example:1500
filter[termination_fee_requester]number

Valor da multa

Example:1500
filter[termination_fee_motive]number

Valor da multa

Example:1500
filter[termination_fee_calculate_mode]number

Valor da multa

Example:1500
filter[termination_at]string

Data de Rescisão

Example:1500.00
filter[deal_id]integer

ID do negócio

Example:123456
filter[business_id]integer

ID da empresa

Example:123456
filter[account_id]integer

ID da conta financeira

Example:123456
filter[billing_method]string

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
Example:pix
filter[metadata]string

json Metadados

Example:{"key": "value"}
filter[documentables.template_id]integer

Filtra contratos por template de documento (nova estrutura documentables)

Example:123456
filter[documentables.privacy]string

Filtra contratos por privacidade do documentable

Example:private
filter[receipt_document_id]integer

Modelo de documento do recibo

Example:123123
filter[transfer_mode]string

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
Example:manually
filter[transfer_auto]boolean

Transferência automática

filter[transfer_after_days]integer

Dias para transferência

Example:5
filter[renewed_id]integer

Código do ID do contrato que foi renovado

Example:987987
filter[fiscal_note_trigger]string

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

Example:BUSINESS
filter[statusIn][]string[]

Filtra contratos por status

filter[statusNotIn][]string[]

Filtra contratos excluindo status

filter[paymentStatusIn][]string[]

Filtra contratos por status de pagamento

filter[activeIn][]string[]

Filtra contratos por status de atividade

filter[typeIn][]string[]

Filtra contratos por tipo

filter[accountIn][]integer[]

Filtra contratos por conta financeira

filter[businessIn][]integer[]

Filtra contratos por empresa

filter[tenantIn][]integer[]

Filtra contratos por inquilino

filter[buildingIn][]integer[]

Filtra contratos por imóvel

filter[buildingId2In][]integer[]

Filtra contratos por código do imóvel

filter[condominiumIn][]integer[]

Filtra contratos por condomínio

filter[dealIn][]integer[]

Filtra contratos por negócio

filter[ownerIn][]integer[]

Filtra contratos por proprietário

filter[ownerAllIn][]integer[]

Filtra contratos por todos os proprietários

filter[ownerOrTenantIn][]integer[]

Filtra contratos por proprietário ou inquilino

filter[ownerOrTenantOrBuyerIn][]integer[]

Filtra contratos por proprietário, inquilino ou comprador

filter[billingIn][]integer[]

Filtra contratos por método de pagamento

filter[ownerNotIn][]integer[]

Filtra contratos excluindo proprietários

filter[occupantIn][]integer[]

Filtra contratos por ocupante

filter[buyerIn][]integer[]

Filtra contratos por comprador

filter[renewedFrom][]integer[]

Filtra contratos renovados a partir de

filter[atMonth]integer

Filtra contratos por mês de atividade

Example:1
filter[atYear]integer

Filtra contratos por ano de atividade

Example:2024
filter[soldMonth]integer

Filtra contratos por mês de venda

Example:1
filter[soldYear]integer

Filtra contratos por ano de venda

Example:2024
filter[readjustMonth]string

Filtra contratos por mês/ano de reajuste

Example:2024-01
filter[endMonth]string

Filtra contratos por mês/ano de término

Example:2024-01
filter[renewedBetween][]string[]

Filtra contratos renovados entre datas

filter[responsibleIn][]integer[]

Filtra contratos por responsáveis

filter[team]integer

Filtra contratos por equipe

Example:1
filter[extended]boolean

Filtra contratos prorrogados

Example:true
filter[contractItems][]integer[]

Filtra contratos por itens

filter[guaranteeTypeIn][]string[]

Filtra contratos pela modalidade da garantia locatícia; use "undefined" para os que ainda não têm garantia informada

filter[hasGuarantor]boolean

Filtra contratos com fiador

Example:true
filter[hasFireInsurance]boolean

Filtra contratos com seguro de incêndio

Example:true
filter[overduePaymentDays]integer

Filtra contratos com pagamentos atrasados em dias

Example:30
filter[dueDateInvoices]string

Filtra contratos com faturas vencidas em data

Example:2024-01-01
filter[paidPeriod][]string[]

Filtra contratos com pagamentos entre datas

filter[cityIn][]integer[]

Filtra contratos por cidade

filter[stateIn][]integer[]

Filtra contratos por estado

filter[districtIn][]integer[]

Filtra contratos por bairro

include[occupants]string

Incluir dados dos Ocupantes

Example:id,name,type
include[buyers]string

Incluir dados dos Compradores

Example:id,name,type
include[vehicles]string

Incluir dados dos Veículos

Example:id,brand,model
include[tickets]string

Incluir dados dos Atendimentos

Example:id,title
include[inspects]string

Incluir dados dos Atendimentos

Example:id,type,status
include[events]string

Incluir dados dos Eventos

Example:id,title,address
include[business]string

Incluir dados da Empresa

Example:id,name
include[building]string

Incluir dados do Imóvel

Example:id,title
include[billing]string

Incluir dados da Empresa de Cobrança

Example:id,name
include[account]string

Incluir dados da Conta Financeira

Example:id,name
include[user]string

Incluir dados do Responsável pelo Contrato

Example:id,name
include[renewed]string

Incluir dados do Contrato Pai que gerou este

Example:id,deal_id
include[renewedTo]string

Incluir dados do Contrato Filho que este gerou

Example:id,deal_id
include[team]string

Incluir dados da Equipe de Venda/Locação

Example:id,name
include[tenant]string

Incluir dados do Inquilino

Example:id,name
include[owners]string

Incluir dados dos Proprietários

Example:id,name
include[invoices]string

Incluir dados das Faturas

Example:id,amount
include[items]string

Incluir dados dos Itens

Example:id,description,amount
include[commissions]string

Incluir dados das Comissões

Example:id,description,amount
include[insurances]string

Incluir dados dos Seguros

Example:id,type,amount
include[files]string

Incluir dados dos Arquivos

Example:id,name,url
include[documentables]string

Incluir dados dos Documentos (estrutura documentables)

Example:id,template_id,privacy
include[deal]string

Incluir dados do Negócio

Example:id,title

Changes

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