Listar Contratos

Permite obtener una lista de elementos, donde cada elemento contiene la información de cada una de los contratos registradas en la inmobiliaria.

Endpoint: https://{{instancia}}.arrendasoft.co/service/v2/public/contracts/list

{{instancia}}: Hace referencia a la instancia de cada inmobiliaria.

Petición

Ejemplos de peticiones

https://{{instancia}}.arrendasoft.co/service/v2/public/contracts/list

https://{{instancia}}.arrendasoft.co/service/v2/public/contracts/list?page=1

https://{{instancia}}.arrendasoft.co/service/v2/public/contracts/list?page_size=100

https://{{instancia}}.arrendasoft.co/service/v2/public/contracts/list?page=1&page_size=100

Respuesta

Lista de elementos, donde cada elemento contiene la información de los datos obtenidos, estado, mensaje, listado de las facturas y paginación.

{
    "status": 200,
    "message": null,
    "body": [
        {
            "contrato_id": 1,
            "consecutivo": 1,
            "propiedad_id": 7774,
            "propiedad": "7774 -  CR 92 # 33 - 49",
            "estrato_propiedad": "Tres",
            "propietario": "[1] 20000001 - DENIS RUIZ",
            "propietarios_id": "94",
            "inquilino": "[1] 80011122233 - GOBERNACION DE ANTIOQUIA",
            "inquilinos_id": "92",
            "valor_canon_individual": "28000000",
            "canon_total": 28000000,
            "porcentaje_comision": "9.71 %",
            "periodicidad": "Mensual",
            "escenario": "Estatales",
            "estado": "Terminado",
            "estado_id": 2,
            "fecha_inicio": "2014-02-01",
            "fecha_fin": "2014-12-31",
            "fecha_terminacion": "2014-05-31",
            "observaciones": "NINGUNA",
            "uso": "Comercial",
            "fecha_creacion": "2014-04-14 09:41:54",
            "creado_por": "Administrador"
        },
        {
            "contrato_id": 2,
            "consecutivo": 2,
            "propiedad_id": 129,
            "propiedad": "129 - Cra 34 # 40 - 35",
            "estrato_propiedad": "Comercial",
            "propietario": "[1] 900000001 - INMOBILIARIA CONSULTORES INMOBILIARIOS S.A.S.",
            "propietarios_id": "100",
            "inquilino": "[1] 350000004 - MÓNICA CANO",
            "inquilinos_id": "8",
            "valor_canon_individual": "401594",
            "canon_total": 401594,
            "porcentaje_comision": "8.62 %",
            "periodicidad": "Mensual",
            "escenario": "(2) (F.I.) CANON DE ARRENDAMIENTO CON IVA 19 %, SIN RETEFUENTE, SIN RETEIVA, SIN RETEICA --- (F.P.) COMISIÓN CON IVA (19%), SIN RETEFUENTE  SIN RETEIVA, SIN RETEICA.",
            "estado": "Terminado",
            "estado_id": 2,
            "fecha_inicio": "2013-01-01",
            "fecha_fin": "2014-12-30",
            "fecha_terminacion": "2014-09-30",
            "observaciones": null,
            "uso": "Comercial",
            "fecha_creacion": "2014-04-15 12:12:52",
            "creado_por": "Administrativo"
        }
    ],
    "pagination": {
        "total_records": 1082,
        "total_pages": 541,
        "current_page": 1,
        "page_size": 2,
        "current_page_records": 2,
        "has_next_page": true,
        "has_previous_page": false
    }
}

Claves y Descripciones del JSON de Contratos

Esta tabla enumera las claves presentes en el JSON principal de la respuesta y proporciona una breve descripción de cada una, explicando su propósito y el tipo de información que contienen.

Cuerpo

Cada elemento dentro de la lista body, tiene las siguientes claves:

Paginación

Cada elemento dentro de la lista pagination tiene las siguientes claves:

Ejemplos

curl -X GET "https://{{instancia}}.arrendasoft.co/service/v2/public/contracts/list?page_size=100&page=3" -H "Content-Type: application/json" -H "Authorization: Bearer YOUR_AUTHENTICATION_TOKEN"

<?php

$instance = 'your_instance'; // Reemplace con su instancia actual
$token = 'YOUR_AUTHENTICATION_TOKEN'; // Reemplace con el token obtenido desde el servicio de login

// Parámetros de ejemplo para listar contratos
$page = 1;
page_size = 50;

$url = "https://{$instance}.arrendasoft.co/service/v2/public/contracts/list?";
$queryParams = [
    'page' => $page,
    'page_size' => $page_size
];
$url .= http_build_query($queryParams);

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
    'Authorization: Bearer ' . $token
]);

$response = curl_exec($ch);
$http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);

if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
} else {
    echo "HTTP Status Code: " . $http_code . "\n";
    echo "Response: " . $response . "\n";
    
    // Procesar la respuesta
    $info = json_decode($response, true);
    $body = $info['body'] ?? [];
    if ($http_code == 200 && !empty($body)) {
        echo "Se consultaron " . count($body) . " contratos.\n";
        
        // Ejemplo: Imprimir los números de los contratos
        foreach($body as $contract) {
          echo "Contrato número: " . $contract['consecutivo'] . "\n";
        }
    } else {
        echo "{$info['message']}.\n";
    }
}
curl_close($ch);

?>