Financeiro › Contratos » Ocupantes

Pesquisar

get/financial/contracts/{contract_id}/occupants

Request

  • Base URL: https://api.apresenta.me
  • URL: https://api.apresenta.me/financial/contracts/{contract_id}/occupants
  • 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,name,type,principal
filter[name]string

Filtra por nome do Ocupante

Example:Jorge
filter[type]string

Filtra por tipo do Ocupante. Valores permitidos:

  • resident: Morador
  • tenant: Inquilino
  • guarantor: Fiador
  • witness: Testemunha
  • payer: Responsável pelo Pagamento
  • buyer: Comprador
  • procurator: Procurador
Example:resident
filter[principal]boolean

Filtra por ocupante principal

Example:true
filter[start_at]string

date Filtra por data de entrada

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

date Filtra por data de saída

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

Filtra por tipos de ocupante

include[person]string

Incluir dados da Pessoa

Example:id,name,tax_id
include[contract]string

Incluir dados do Contrato

Example:id,reference,type

Changes

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