Listar Facturas [Beta]

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

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

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

Petición

Nota: Para los parámetros de tipo fecha que se compongan de un rango, como listing_start_date y listing_end_date, se debe tener en cuenta que si se envía solo el start_date, se retornarán registros donde la condición es “>= (mayor o igual)”. Si solo se envía el end_date, se retornarán registros donde la condición es “<= (menos o igual)”, y si se envían ambas, entonces se retornarán registros dentro de ese rango de fechas.

Ejemplos de peticiones

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

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

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

https://{{instancia}}.arrendasoft.co/service/v2/public/properties?invoices/list?page=1&limit=10&listing_start_date=2024-03-26

https://{{instancia}}.arrendasoft.co/service/v2/public/properties?page=1&limit=10&listing_start_date=2024-03-26&listing_end_date=2024-03-26page_size=100

Respuesta

Lista de elementos, donde cada elemento contiene la información de cada una de las propiedades.facturas.

{
    "status": 200,
    "message": null,
    "body": [
        {
            "codigo"factura_id": 366,
            "factura_numero": 324,
            "resolucion": "137"0 - 120000042273",
            "titulo"fecha_factura": "Apartamento cerca del estadio y la cuarta brigada"2014-08-01",
            "clase_id"fecha_vencimiento": "1247"2014-08-06",
            "clase_inmueble"valor_total": "Apartamento"94992.00",
            "tipo_servicio_id"saldo": "arriendo"94992.00",
            "tipo_servicio"documento_tercero": "Arriendo"1111111",
            "estrato"nombre_tercero": "1258"TERCERO FACTURADO",
            "estrato_texto"estado": "Cuatro"Facturada",
            "fecha_consignacion"estado_dian": null,
            "estado_cliente_dian": null,
            "notas": 0,
            "creado_por": "2024-04-26"Administrador",
            "asesor_id"fecha_envio_dian": null,
            "fecha_creacion": "5"2014-08-08 10:50:52"
        },
        {
            "factura_id": 8,
            "factura_numero": 7,
            "resolucion": "0 - 120000042273",
            "asesor"fecha_factura": "InterServicios"2014-01-01",
            "pais_id"fecha_vencimiento": "1"2014-01-06",
            "pais"valor_total": "COLOMBIA"1666850.00",
            "departamento_id": "5",
        "departamento": "Antioquia",
        "municipio_id": "1",
        "municipio": "Medellin",
        "barrio_id": "3",
        "barrio": "Estadio",
        "direccion": "CALLE 50 # 74 - 12",
        "coordenadas": "6.21505012838972:-75.57529436962885",
        "valor_arriendo1": "1600000",
        "valor_arriendo2": "0",
        "valor_venta1": "0",
        "valor_venta2": "0",
        "valor_administracion": "0",
        "avaluo_catastral": "0",
        "impuesto_predial"saldo": "0.00",
            "area"documento_tercero": "75.00"22222222",
            "observaciones": null,
        "propiedad_destacada"nombre_tercero": "No",COOPERATIVA "llaves_en": "oficina",
        "llaves_otro": null,
        "paga_cuota_sost": "propietario",
        "folio_matricula": null,
        "referencia_catastral": null,
        "edificio_unidad": "urbanizacion"MULTIACTIVA",
            "estado": "1"Pagada",
            "estado_texto"estado_dian": null,
            "estado_cliente_dian": null,
            "notas": 0,
            "creado_por": "Activa"Contador",
            "cantidad_images"fecha_envio_dian": null,
            "fecha_creacion": "3",2014-05-07 "cantidad_videos": "1",
        "caracteristicas": [
            {
                "id": "1",
                "descripcion": "Nº De Habitaciones",
                "tipo_campo": "numeric",
                "orden": "1",
                "grupo": "Características del inmueble",
                "valor": "4"
            },
            {
                "id": "2",
                "descripcion": "Nº De Baños",
                "tipo_campo": "numeric",
                "orden": "2",
                "grupo": "Características del inmueble",
                "valor": "3"
            },
            {
                "id": "5",
                "descripcion": "Nº De Piso",
                "tipo_campo": "numeric",
                "orden": "3",
                "grupo": "Características del inmueble",
                "valor": "1"
            },
            {
                "id": "4",
                "descripcion": " Antigüedad del Inmueble",
                "tipo_campo": "numeric",
                "orden": "5",
                "grupo": "Características del Inmueble",
                "valor": "3"
            },
            {
                "id": "14",
                "descripcion": "Cocina Integral",
                "tipo_campo": "checkbox",
                "orden": "5",
                "grupo": "Características Internas",
                "valor": "1"
            },
            {
                "id": "34",
                "descripcion": "Sala",
                "tipo_campo": "checkbox",
                "orden": "6",
                "grupo": "Características del Inmueble",
                "valor": "1"
            },
            {
                "id": "31",
                "descripcion": "Red de gas",
                "tipo_campo": "select",
                "orden": "5",
                "grupo": "Características del Inmueble",
                "valor": "si",
                "valor_texto": "Si"
            },
            {
                "id": "63",
                "descripcion": "Garaje",
                "tipo_campo": "checkbox",
                "orden": "10",
                "grupo": "Características Internas",
                "valor": "1"11:14:46"
        }
    ],
    "propietarios"pagination": [ {
        "id"total_records": "272",41326,
        "documento"total_pages": "4207050496",83,
        "nombres"current_page": "CRISTINA GUERRERO",83,
        "apellidos"page_size": 500,
        "current_page_records": 326,
        "has_next_page": false,
        "has_previous_page": true
    }
],
        "imagenes": [
            {
                "posicion": "1",
                "size": "19201080",
                "imagen": "https://qa.arrendasoft.co/img/fotos/1920x1080_66ae4cfba9aa891473fe8f78a0c7e6f6.jpeg"
            },
            {
                "posicion": "2",
                "size": "19201080",
                "imagen": "https://qa.arrendasoft.co/img/fotos/1920x1080_660ae9fb29a0ff3c0e47cf13cde4740e.jpeg"
            },
            {
                "posicion": "3",
                "size": "19201080",
                "imagen": "https://qa.arrendasoft.co/img/fotos/1920x1080_83883a0f75ddae325f41eafce4066631.jpeg"
            }
        ],
        "videos": [
            {
                "url": "608AV8w6gL0",
                "tipo": "youtube",
                "descripcion": null,
                "posicion": "1"
            }
        ]
    },
    {
        "codigo": "136",
        "titulo": "FINCA",
        "clase_id": "1254",
        "clase_inmueble": "Finca",
        "tipo_servicio_id": "venta y arriendo",
        "tipo_servicio": "Venta y Arriendo",
        "estrato": "1258",
        "estrato_texto": "Cuatro",
        "fecha_consignacion": "2021-04-16",
        "asesor_id": "6",
        "asesor": "KAREN CANO",
        "pais_id": "1",
        "pais": "COLOMBIA",
        "departamento_id": "11",
        "departamento": "Bogota D.c.",
        "municipio_id": "150",
        "municipio": "Bogota",
        "barrio_id": "838",
        "barrio": "Bosa",
        "direccion": "CR 145 # 85 - 9",
        "coordenadas": "4.875468815048683:-73.62556445019526",
        "valor_arriendo1": "6050000",
        "valor_arriendo2": "0",
        "valor_venta1": "500000000",
        "valor_venta2": "0",
        "valor_administracion": "0",
        "avaluo_catastral": "0",
        "impuesto_predial": "0.00",
        "area": "1200.00",
        "observaciones": "Esta finca ofrece una experiencia rural única con comodidades modernas. La espaciosa casa principal cuenta con encantadoras habitaciones, cuenta con una reluciente piscina y áreas verdes bien cuidadas.",
        "propiedad_destacada": "No",
        "llaves_en": "oficina",
        "llaves_otro": null,
        "paga_cuota_sost": null,
        "folio_matricula": "0",
        "referencia_catastral": "0",
        "edificio_unidad": "urbanizacion",
        "estado": "1",
        "estado_texto": "Activa",
        "cantidad_images": "2",
        "cantidad_videos": "0",
        "caracteristicas": [
            {
                "id": "1",
                "descripcion": "Nº De Habitaciones",
                "tipo_campo": "numeric",
                "orden": "1",
                "grupo": "Características del inmueble",
                "valor": "9"
            },
            {
                "id": "2",
                "descripcion": "Nº De Baños",
                "tipo_campo": "numeric",
                "orden": "2",
                "grupo": "Características del inmueble",
                "valor": "4"
            },
            {
                "id": "11",
                "descripcion": "Zona de lavandería",
                "tipo_campo": "checkbox",
                "orden": "14",
                "grupo": "Características del inmueble",
                "valor": "1"
            },
            {
                "id": "9",
                "descripcion": "Cuarto de servicio",
                "tipo_campo": "checkbox",
                "orden": "5",
                "grupo": "Características del Inmueble",
                "valor": "1"
            },
            {
                "id": "26",
                "descripcion": "Sauna / Turco / Jacuzzi",
                "tipo_campo": "checkbox",
                "orden": "6",
                "grupo": "Características del Inmueble",
                "valor": "1"
            }
        ],
        "propietarios": [
            {
                "id": "83",
                "documento": "2830863285",
                "nombres": "LILIA MARLEN",
                "apellidos": "LOPEZ CASTELLANOS"
            }
        ],
        "imagenes": [
            {
                "posicion": "1",
                "size": "19201080",
                "imagen": "https://qa.arrendasoft.co/img/fotos/1920x1080_431b70772304a609c280036305f66ac4.jpeg"
            },
            {
                "posicion": "2",
                "size": "19201080",
                "imagen": "https://qa.arrendasoft.co/img/fotos/1920x1080_209e299b845c8bdf9479f5fb055461fe.jpeg"
            }
        ],
        "videos": []
    }
]

Claves y Descripciones del JSON de PropiedadesFacturación

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

CaracterísticasCuerpo

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

Paginación

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

Propietarios

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

Imágenes

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

Videos

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

Ejemplos

curl -X GET "https://{{instancia}}.arrendasoft.co/service/v2/public/properties?invoices/list?page_size=100&page=1&limit=10&listing_start_date=2024-03-01&listing_end_date=2024-03-31"3" -H "Content-Type: application/json" -H "Authorization: Bearer YOUR_AUTHENTICATION_TOKEN"

<?php

$instance = 'your_instance'; // ReplaceReemplace withcon yoursu instancia actual instance
$token = 'YOUR_AUTHENTICATION_TOKEN'; // ReplaceReemplace withcon theel token obtainedobtenido fromdesde theel servicio de login service

// ExampleParámetros parametersde forejemplo listingpara propertieslistar facturas
$page = 1;
$limitpage_size = 10;
$listingStartDate = '2024-03-01';
$listingEndDate = '2024-03-31';50;

$url = "https://{$instance}.arrendasoft.co/service/v2/public/properties?invoices/list?";
$queryParams = [
    'page' => $page,
    'limit'page_size' => $limit,
    'listing_start_date' => $listingStartDate,
    'listing_end_date' => $listingEndDatepage_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";
    
    // YouProcesar canla further process the JSON response hererespuesta
    $propertiesinfo = json_decode($response, true);
    $body = $info['body'] ?? [];
    if ($http_code == 200 && !empty($properties)body)) {
        echo "SuccessfullySe retrievedconsultaron " . count($properties)body) . " properties.facturas.\n";
        
        // Example:Ejemplo: printImprimir thelos titlenúmeros ofde thelas firstfacturas
        propertyforeach($body ifas (isset($properties[0]['titulo']))invoice) {
          echo "FirstFactura property title:número: " . $properties[0][invoice['titulo'factura_numero'] . "\n";
        }
    } else {
        echo "Failed to retrieve properties or no properties found.{$info['message']}.\n";
    }
}
curl_close($ch);

?>