Financeiro › Contratos

Obter

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

Request

  • Base URL: https://api.apresenta.me
  • URL: https://api.apresenta.me/financial/contracts/{id}
  • 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
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[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.