Base URL https://api.afer.pro aferapp.com
Tesorería

Cobros del período

POST https://api.afer.pro/consultarCobros

El dinero cobrado entre dos fechas, con desglose por método de pago y comisiones de pasarela.

Mientras consultarVentas mide lo facturado, este endpoint mide lo que ha entrado en caja: los pagos registrados con fecha en el rango.

Incluye dos orígenes: cobros de facturas de venta y anticipos de cliente (cobros sin factura todavía, como los pedidos web pagados por adelantado). El desglose por método de pago muestra por dónde entra el dinero, y total_comisiones suma las comisiones de pasarela (Stripe, etc.).

Autenticación

Envía tus claves API en las cabeceras X-API-KEY y X-API-SECRET. La cuenta sobre la que se opera se resuelve automáticamente a partir de la clave. Cómo obtener tus claves →

Este endpoint requiere autenticación con API key: sin credenciales responde 401.

Parámetros del cuerpo

El cuerpo de la petición es un objeto JSON con Content-Type: application/json.

fecha_iniciodate
obligatorio
Inicio del período (YYYY-MM-DD), incluido.
fecha_findate
obligatorio
Fin del período (YYYY-MM-DD), incluido.

Ejemplo de petición

curl -X POST 'https://api.afer.pro/consultarCobros' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: afer_tk_TU_TOKEN' \
  -H 'X-API-SECRET: afer_sk_TU_SECRET' \
  -d '{
    "fecha_inicio": "2026-08-01",
    "fecha_fin": "2026-08-18"
}'
<?php

$data = [
  'fecha_inicio' => '2026-08-01',
  'fecha_fin' => '2026-08-18',
];

$ch = curl_init('https://api.afer.pro/consultarCobros');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
    'X-API-KEY: afer_tk_TU_TOKEN',
    'X-API-SECRET: afer_sk_TU_SECRET',
]);

$respuesta = json_decode(curl_exec($ch), true);
curl_close($ch);
const respuesta = await fetch('https://api.afer.pro/consultarCobros', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'X-API-KEY': 'afer_tk_TU_TOKEN',
    'X-API-SECRET': 'afer_sk_TU_SECRET'
  },
  body: JSON.stringify({
      "fecha_inicio": "2026-08-01",
      "fecha_fin": "2026-08-18"
  })
});

const resultado = await respuesta.json();

Respuesta

200 · application/json
{
    "errorCode": 200,
    "errorMsg": "",
    "data": {
        "fecha_inicio": "2026-08-01",
        "fecha_fin": "2026-08-18",
        "total_cobrado": 38900.15,
        "cobros_facturas": 36400.15,
        "cobros_anticipos": 2500,
        "total_comisiones": 84.3,
        "num_cobros": 64,
        "por_metodo": [
            {
                "metodo_pago_fk": 2,
                "metodo": "Transferencia",
                "importe": 22100,
                "num": 18
            },
            {
                "metodo_pago_fk": 8,
                "metodo": "Stripe",
                "importe": 9800.15,
                "num": 31
            }
        ]
    }
}

Errores

CasoResultado
Sin credenciales de API key errorCode 401.
Fechas ausentes o mal formadas errorCode 400 indicando el parámetro.
Notas
  • Los importes de cobro son los pagados por el cliente (con IVA incluido): no los compares directamente con las bases sin IVA de ventas.