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, solosó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, solosó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
statuserror EnteroBooleano Código del estado de la respuesta, 200false (falso) para exitoso, 500true (verdadero) para errorerror.
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 facturasla retornadasinformación contable retornada por la API.
paginationObjetoContiene toda la información de paginación y respuesta.
Cuerpo

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

Clave Tipo Descripción
factura_idcuenta EnteroTexto IdentificadorNúmero únicoo código de la facturacuenta PUC.
factura_numeronombre_cuenta EnteroTexto NúmeroNombre de la facturacuenta PUC.
resolucionsaldo_anterior TextoNumérico PrefijoValor ydel númerosaldo anterior de la resolucióncuenta contable.
fecha_facturadebitos TextoNumérico FechaValor de los débitos de la facturacuenta contable.
fecha_vencimientocreditos TextoNumérico FechaValor de vencimientolos créditos de la facturacuenta contable.
valor_totalsaldo_actualNuméricoValor del saldo actual de la cuenta contable.
base_retencion Numérico Valor de la facturabase de retención de la cuenta contable.
saldoterceros NuméricoObjeto Saldo pendienteListado de laterceros factura
documento_terceroTextoNúmero de documento del cliente
nombre_terceroTextoNombre completo del cliente
estadoTextoEstado de la factura
estado_dianTextoEstado de la factura en la DIAN cuando es una factura electrónica
estado_cliente_dianTextoEstado de la factura respecto al cliente en la DIAN cuando es una factura electrónica
notasNuméricoCantidad de notas débito o crédito que tiene la factura
creado_porTextoUsuario que creó la factura en el sistema
fecha_envio_dianTextoFecha de envío de la facturaVinculados a lalas DIANcuentas cuando es factura electrónica
fecha_creacionTextoFecha de creación de la facturacontables
PaginaciónTerceros

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

Clave Tipo Descripción
total_recordsdocumento_terceroTextoNúmero de documento de identidad del tercero.
nombre_terceroTextoNombre completo del tercero.
saldo_anterior Numérico TotalValor del saldo anterior de facturasla delcuenta sistemacontable.
total_pagesdebitos Numérico CantidadValor de páginas,los este corresponde al total de registros dividido por el tamañodébitos de la páginacuenta contable.
current_pagecreditos Numérico PáginaValor actualde los créditos de la cuenta contable.
page_sizesaldo_actual Numérico TamañoValor del saldo actual de la página,cuenta es decir, cantidad de registros por consultacontable.
current_page_recordsbase_retencion Numérico Cantidad de registrosValor de la páginabase actualde retención de la cuenta contable.
has_next_pagedetalles BooleanoObjeto VerdaderoListado side haydocumentos contables relacionados con la cuenta contable en el periodo.
Detalles

Cada elemento dentro de la lista detalles tiene las siguientes páginasclaves:

quesepuedenconsultar,falsoenotrocaso puedenconsultar,faltoenotro
Clave Tipo Descripción
fecha_documentoTextoFecha del documento contable.
has_previous_pageconsecutivo_documento BooleanoTexto VerdaderoConsecutivo sidel existendocumento páginascontable, previasincluyendo queel seprefijo.
detalle_documento Texto Descripción casou observaciones del documento contable.
debitosNuméricoValor de los débitos del documento contable.
creditosNuméricoValor de los créditos del documento contable.
base_retencionNuméricoValor de la base de retención del documento contable.

Ejemplos

Curl
curl -X GET "https://{{instancia}}.arrendasoft.co/service/v2/public/invoices/list?page_size=100accounting/general-ledger?fecha_ini=2024-01-01&page=3"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 facturasinformación del reporte contable auxiliar general
$pagefecha_ini = 1;'2024-01-01';
page_size$fecha_fin = 50;'2024-03-11';
$cuenta_ini = '1';
$cuenta_fin = '3';

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

?>