Reporte Auxiliar General [Beta]
Permite obtener una lista de elementos, donde cada elemento contiene la información de cada unacuenta decontable lasnecesaria facturasy registradassuficiente enpara laconstruir inmobiliaria.el informe contable Auxiliar General.
Endpoint: https://{{instancia}}.arrendasoft.co/service/v2/public/invoices/listaccounting/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 |
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 |
No | Especifica el |
Ejemplos de peticiones
https://{{instancia}}.arrendasoft.co/service/v2/public/invoices/listaccounting/general-ledger
https://{{instancia}}.arrendasoft.co/service/v2/public/invoices/list?page=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/invoices/list?page_size=100accounting/general-ledger?fecha_ini=2025-01-01&fecha_fin=2025-04-15&cuenta_ini=1&cuenta_fin=2
https://{{instancia}}.arrendasoft.co/service/v2/public/invoices/list?page=1&page_size=100
Respuesta
Lista de elementos, donde cada elemento contiene la información de los datos obtenidos, estado,error, mensaje, listado de las facturascuentas y paginación.detalles.
{
"status"error": 200,false,
"message": null,"",
"body": [
{
"factura_id": 366,
"factura_numero": 324,
"resolucion"cuenta": "0 - 120000042273"11050502",
"fecha_factura"nombre_cuenta": "2014-08-01"Caja generales MO",
"fecha_vencimiento"saldo_anterior": "2014-08-06",12118088.71,
"valor_total"debitos": "94992.00",5664964,
"saldo"creditos": 0,
"94992.00",saldo_actual": 17783052.71,
"base_retencion": 0,
"terceros": {
"89": {
"documento_tercero": "1111111"11223344",
"nombre_tercero": "TERCERO FACTURADO"COOPERATIVA",
"estado"saldo_anterior": "Facturada",-374086,
"estado_dian"debitos": null,5664964,
"estado_cliente_dian": null,
"notas"creditos": 0,
"creado_por"saldo_actual": 5290878,
"base_retencion": 0,
"detalles": [
{
"fecha_documento": "Administrador"2024-02-02",
"fecha_envio_dian": null,
"fecha_creacion"consecutivo_documento": "2014-08-08RC-20200",
10:50:52""detalle_documento": "Pago en Consignación",
"debitos": 2323912,
"creditos": 0,
"base_retencion": 0
},
{
"factura_id": 8,
"factura_numero": 7,
"resolucion"fecha_documento": "0 - 120000042273"2024-02-02",
"fecha_factura"consecutivo_documento": "2014-01-01"RC-20202",
"fecha_vencimiento"detalle_documento": "2014-01-06"Pago",
"valor_total"debitos": "1666850.00",3341052,
"saldo": "0.00",
"documento_tercero": "22222222",
"nombre_tercero": "COOPERATIVA MULTIACTIVA",
"estado": "Pagada",
"estado_dian": null,
"estado_cliente_dian": null,
"notas"creditos": 0,
"creado_por"base_retencion": "Contador",
"fecha_envio_dian": null,
"fecha_creacion": "2014-05-07 11:14:46"0
}
],
"pagination": {
"total_records": 41326,
"total_pages": 83,
"current_page": 83,
"page_size": 500,
"current_page_records": 326,
"has_next_page": false,
"has_previous_page": true
}
}
}
]
}
Claves y Descripciones del JSON de FacturaciónReporte 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 |
---|---|---|
status |
Entero | Código del estado de la respuesta, 200 para exitoso, 500 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 facturas retornadas por la API. |
pagination |
Objeto | Contiene 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_id |
Entero | Identificador único de la factura |
factura_numero |
Entero | Número de la factura |
resolucion |
Texto | Prefijo y número de la resolución |
fecha_factura |
Texto | Fecha de la factura |
fecha_vencimiento |
Texto | Fecha de vencimiento de la factura |
valor_total |
Numérico | Valor de la factura |
saldo |
Numérico | Saldo pendiente de la factura |
documento_tercero |
Texto | Número de documento del cliente |
nombre_tercero |
Texto | Nombre completo del cliente |
estado |
Texto | Estado de la factura |
estado_dian |
Texto | Estado de la factura en la DIAN cuando es una factura electrónica |
estado_cliente_dian |
Texto | Estado de la factura respecto al cliente en la DIAN cuando es una factura electrónica |
notas |
Numérico | Cantidad de notas débito o crédito que tiene la factura |
creado_por |
Texto | Usuario que creó la factura en el sistema |
fecha_envio_dian |
Texto | Fecha de envío de la factura a la DIAN cuando es factura electrónica |
fecha_creacion |
Texto | Fecha de creación de la factura |
Paginación
Cada elemento dentro de la lista pagination
tiene las siguientes claves:
Clave | Tipo | Descripción |
---|---|---|
total_records |
Numérico | Total de facturas del sistema |
total_pages |
Numérico | Cantidad de páginas, este corresponde al total de registros dividido por el tamaño de la página |
current_page |
Numérico | Página actual |
page_size |
Numérico | Tamaño de la página, es decir, cantidad de registros por consulta |
current_page_records |
Numérico | Cantidad de registros de la página actual |
has_next_page |
Booleano | Verdadero si hay siguientes páginas que se pueden consultar, falso en otro caso |
has_previous_page |
Booleano | Verdadero si existen páginas previas que se pueden consultar, falto en otro caso |
Ejemplos
Curl
curl -X GET "https://{{instancia}}.arrendasoft.co/service/v2/public/invoices/list?page_size=100&page=3" -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 facturas
$page = 1;
page_size = 50;
$url = "https://{$instance}.arrendasoft.co/service/v2/public/invoices/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) . " facturas.\n";
// Ejemplo: Imprimir los números de las facturas
foreach($body as $invoice) {
echo "Factura número: " . $invoice['factura_numero'] . "\n";
}
} else {
echo "{$info['message']}.\n";
}
}
curl_close($ch);
?>