Financeiro › Contratos » Ocupantes

Criar

post/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

Request body

typestring required

Tipo do ocupante. Valores permitidos:

  • resident: Morador
  • tenant: Inquilino
  • guarantor: Fiador
  • witness: Testemunha
  • payer: Responsável pelo Pagamento
  • buyer: Comprador
  • procurator: Procurador
namestring required

Nome do ocupante

person_idinteger

ID da pessoa

tax_idstring

CPF/CNPJ

principalboolean

Ocupante principal

percentagenumber

Porcentagem

start_atstring

Data de entrada

end_atstring

Data de saída

descriptionstring

Descrição

notesstring

Observações

Example request

{
  "type": "resident",
  "name": "Jorge",
  "person_id": 123456,
  "tax_id": "123.456.789-00",
  "percentage": 100,
  "start_at": "2024-01-01",
  "end_at": "2024-12-31",
  "description": "Morador principal",
  "notes": "Observações importantes"
}

Changes

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