ByDomuDevelopers
Criar chave

Detalle de contrato de arriendo

GEThttps://api.bydomu.com/v1/leases/{id}

Esta referência é gerada a partir do código da API, por isso as descrições estão em espanhol. Nomes, parâmetros e exemplos são iguais em qualquer idioma.

El contrato con su propiedad, arrendatario, responsable, pagos de canon y solicitudes de mantenimiento.

Permissão
leases:read
Chaves
Só secreta (de um servidor)

Cabeçalhos

X-API-Keystringobrigatório
Sua chave secreta.

Parâmetros de rota

idstringobrigatório
ID del contrato

Respostas

200El contrato
401UNAUTHORIZED · Clave faltante, inválida, desactivada o vencida.
403FORBIDDEN · La clave no puede usar esta operación: falta el scope, es una secreta en el navegador, el nivel de la cuenta no la permite, está suspendida o se alcanzó un tope del plan.
404NOT_FOUND · El recurso no existe en la organización.
429RATE_LIMITED · Límite de peticiones excedido: el de la clave (`RATE_LIMITED`), el de escrituras de la organización (`TENANT_RATE_LIMITED`) o bloqueo temporal de la IP por claves inválidas.
500INTERNAL_ERROR · Error interno del servidor.
cURL
curl "https://api.bydomu.com/v1/leases/clx1lea001" \
  -H "X-API-Key: $BYDOMU_API_KEY"
JavaScript
const res = await fetch("https://api.bydomu.com/v1/leases/clx1lea001", {
  headers: { "X-API-Key": process.env.BYDOMU_API_KEY },
});
const data = await res.json();
Python
import os, requests

r = requests.get(
    "https://api.bydomu.com/v1/leases/clx1lea001",
    headers={"X-API-Key": os.environ["BYDOMU_API_KEY"]}
)
data = r.json()
Resposta · 200 · exemplo
{
  "data": {
    "id": "clx1lea001",
    "startDate": "2026-01-01T00:00:00.000Z",
    "endDate": "2027-01-01T00:00:00.000Z",
    "monthlyRent": "2500000.00",
    "adminFee": "350000.00",
    "securityDeposit": "2500000.00",
    "status": "DRAFT",
    "paymentDayOfMonth": 5,
    "lateFeePercentage": "2.00",
    "createdAt": "2025-12-20T10:00:00.000Z",
    "property": {
      "id": "clx1prop002",
      "title": "Apto 301 Laureles",
      "address": "Cra 76 #35-18",
      "city": "Medellín",
      "type": "APARTMENT"
    },
    "tenant": {
      "id": "clx1con001",
      "firstName": "María",
      "lastName": "González",
      "phone": "+573009876543",
      "email": "[email protected]"
    },
    "manager": {
      "id": "clx1usr001",
      "firstName": "Carlos",
      "lastName": "Rodríguez"
    },
    "payments": [
      {
        "id": "clx1rpy001",
        "period": "2026-09",
        "amount": "2500000.00",
        "adminFee": "350000.00",
        "lateFee": "0.00",
        "totalAmount": "2850000.00",
        "status": "PENDING",
        "dueDate": "2026-09-05T00:00:00.000Z",
        "paidAt": "2026-09-04T15:20:00.000Z",
        "paymentMethod": "TRANSFERENCIA"
      }
  …

A chave vai na variável BYDOMU_API_KEY. Os dados do exemplo não são de nenhuma imobiliária.