Ir al contenido principal

Reporte Auxiliar General [Beta]

Permite obtener una lista de elementos, donde cada elemento contiene la información de cada cuenta contable necesaria y suficiente para construir el informe contable Auxiliar General.

Endpoint: https://{{instancia}}.arrendasoft.co/service/v2/public/accounting/general-ledger

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

Petición

Método GET
Content-Type application/json
Authorization Bearer token, Token obtenido al consumir el servicio Login
Parámetros
Parámetro Tipo Obligatorio

Valor por defecto

 Descripción
fecha_ini String No Primer día del año en curso Especifica la fecha inicial del rango que se desea consultar, el formato debe ser aaaa-mm-dd.
fecha_fin String No Último día del año en curso Especifica la fecha final del rango que se desea consultar, el formato debe ser aaaa-mm-dd.
cuenta_ini String No 1 Especifica el código inicial de cuenta PUC del rango que se desea consultar, debe ser solo el código de cuenta deseado, sólo permite números.
cuenta_fin String No 9 Especifica el código final de la cuenta PUC del rango que se desea consultar, debe ser solo el código de cuenta deseado, sólo permite números.

Ejemplos de peticiones

https://{{instancia}}.arrendasoft.co/service/v2/public/accounting/general-ledger
https://{{instancia}}.arrendasoft.co/service/v2/public/accounting/general-ledger?fecha_ini=2025-01-01
https://{{instancia}}.arrendasoft.co/service/v2/public/accounting/general-ledger?fecha_ini=2025-01-01&fecha_fin=2025-04-15
https://{{instancia}}.arrendasoft.co/service/v2/public/accounting/general-ledger?fecha_ini=2025-01-01&fecha_fin=2025-04-15&cuenta_ini=1
https://{{instancia}}.arrendasoft.co/service/v2/public/accounting/general-ledger?fecha_ini=2025-01-01&fecha_fin=2025-04-15&cuenta_ini=1&cuenta_fin=2

Respuesta

Lista de elementos, donde cada elemento contiene la información de los datos obtenidos, error, mensaje, listado de las cuentas y detalles.

{
    "error": false,
    "message": "",
    "body": [
        {
            "cuenta": "11050502",
            "nombre_cuenta": "Caja generales MO",
            "saldo_anterior": 12118088.71,
            "debitos": 5664964,
            "creditos": 0,
            "saldo_actual": 17783052.71,
            "base_retencion": 0,
            "terceros": {
                "89": {
                    "documento_tercero": "11223344",
                    "nombre_tercero": "COOPERATIVA",
                    "saldo_anterior": -374086,
                    "debitos": 5664964,
                    "creditos": 0,
                    "saldo_actual": 5290878,
                    "base_retencion": 0,
                    "detalles": [
                        {
                            "fecha_documento": "2024-02-02",
                            "consecutivo_documento": "RC-20200",
                            "detalle_documento": "Pago en Consignación",
                            "debitos": 2323912,
                            "creditos": 0,
                            "base_retencion": 0
                        },
                        {
                            "fecha_documento": "2024-02-02",
                            "consecutivo_documento": "RC-20202",
                            "detalle_documento": "Pago",
                            "debitos": 3341052,
                            "creditos": 0,
                            "base_retencion": 0
                        }
                    ]
                }
            }
        }
    ]
}
Claves y Descripciones del JSON de Reporte Auxiliar General

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.

Clave Tipo Descripción
error Booleano Código del estado de la respuesta, false (falso) para exitoso, true (verdadero) para error.
message Texto Cuando la respuesta es exitosa, es nulo o vacío, y cuando hay error, este contiene el mensaje que describe el error presentado.
body Objeto Contiene el listado de la información contable retornada por la API.
Cuerpo

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

Clave Tipo Descripción
cuenta Texto Número o código de la cuenta PUC.
nombre_cuenta Texto Nombre de la cuenta PUC.
saldo_anterior Numérico Valor del saldo anterior de la cuenta contable.
debitos Numérico Valor de los débitos de la cuenta contable.
creditos Numérico Valor de los créditos de la cuenta contable.
saldo_actual Numérico Valor del saldo actual de la cuenta contable.
base_retencion Numérico Valor de la base de retención de la cuenta contable.
terceros Objeto Listado de terceros Vinculados a las cuentas contables
Terceros

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

Clave Tipo Descripción
documento_tercero Texto Número de documento de identidad del tercero.
nombre_tercero Texto Nombre completo del tercero.
saldo_anterior Numérico Valor del saldo anterior de la cuenta contable.
debitos Numérico Valor de los débitos de la cuenta contable.
creditos Numérico Valor de los créditos de la cuenta contable.
saldo_actual Numérico Valor del saldo actual de la cuenta contable.
base_retencion Numérico Valor de la base de retención de la cuenta contable.
detalles Objeto Listado de documentos contables relacionados con la cuenta contable en el periodo.
Detalles

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

Clave Tipo Descripción
fecha_documento Texto Fecha del documento contable.
consecutivo_documento Texto Consecutivo del documento contable, incluyendo el prefijo.
detalle_documento Texto Descripción u observaciones del documento contable.
debitos Numérico Valor de los débitos del documento contable.
creditos Numérico Valor de los créditos del documento contable.
base_retencion Numérico Valor de la base de retención del documento contable.

Ejemplos

Curl 
curl -X GET "https://{{instancia}}.arrendasoft.co/service/v2/public/accounting/general-ledger?fecha_ini=2024-01-01&fecha_fin=2024-02-28&cuenta_ini=1&cuenta_fin=2" -H "Content-Type: application/json" -H "Authorization: Bearer YOUR_AUTHENTICATION_TOKEN"
PHP Curl 
<?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 información del reporte contable auxiliar general
$fecha_ini = '2024-01-01';
$fecha_fin = '2024-03-11';
$cuenta_ini = '1';
$cuenta_fin = '3';

$url = "https://{$instance}.arrendasoft.co/service/v2/public/accounting/general-ledger?";
$queryParams = [
    'fecha_ini' => $fecha_ini,
    'fecha_fin' => $fecha_fin,
    'cuenta_ini' => $cuenta_ini,
    'cuenta_fin' => $cuenta_fin
];
$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) . " cuentas.\n";
        
        // Ejemplo: Imprimir los números de las cuentas
        foreach($body as $invoice) {
          echo "Cuenta número: " . $invoice['cuenta'] . "\n";
        }
    } else {
        echo "{$info['message']}.\n";
    }
}
curl_close($ch);

?>

Volver arriba