Base URL https://api.afer.pro Referencia aferapp.com Reservar demo
Documentación

Referencia de la API

Todos los endpoints de https://api.afer.pro en una sola página: método, ruta y qué hace cada uno. Pincha en cualquiera para ver sus parámetros, sus ejemplos y su respuesta.

80 endpoints 90 rutas REST 16 áreas
Antes de empezar

Toda llamada va autenticada con tus claves en las cabeceras X-API-KEY y X-API-SECRET; la cuenta se resuelve sola a partir de la clave. Las rutas versionadas (/api/v1/…) son las recomendadas; los alias en castellano de la v0 siguen operativos y no se van a retirar.

El acceso a la API requiere plan Advanced o Premium con el extra de IA (Tier 1 o superior), y cada cuenta tiene su ritmo de peticiones por minuto y por día. Cómo obtener tus claves → · Límites de uso →

Facturas 5

Todo lo que se puede hacer con una factura de venta: emitirla, listarla, leerla y bajarse su PDF.

POST /api/v1/invoices Crear factura Crea una factura de venta con sus líneas, da de alta o actualiza el cliente de facturación y, opcionalmente, registra el cobro o sus vencimientos.
GET /api/v1/invoices Listar facturas Listado paginado de facturas de venta con filtros por fechas, cliente y estado de cobro.
GET /api/v1/invoices/{id} Obtener factura Devuelve un factura de venta concreto por su identificador, con su cabecera, su contraparte y todas sus líneas.
GET /api/v1/invoices/{id}/pdf PDF de una factura Genera el PDF de una factura con la plantilla de impresión de tu cuenta y lo devuelve en base64 (o como enlace).
GET /api/v1/invoices/{id}/attachments
GET /api/v1/delivery-notes/{id}/attachments GET /api/v1/orders/{id}/attachments GET /api/v1/recurring-invoices/{id}/attachments GET /api/v1/purchase-delivery-notes/{id}/attachments GET /api/v1/purchase-orders/{id}/attachments GET /api/v1/purchase-invoices/{id}/attachments GET /api/v1/estimates/{id}/attachments
Obtener adjuntos Los ficheros adjuntos de un documento de venta o de compra, con su URL de descarga.

Albaranes 3

Entregas que se facturan después: crear, listar y leer albaranes de venta.

POST /api/v1/delivery-notes Crear albarán Crea un albarán de venta con sus líneas y sus movimientos de inventario, sin emitir factura.
GET /api/v1/delivery-notes Listar albaranes Listado paginado de albaranes con filtros por fechas, cliente, facturable y origen recurrente.
GET /api/v1/delivery-notes/{id} Obtener albarán Devuelve un albarán concreto por su identificador, con su cabecera, su contraparte y todas sus líneas.

Pedidos 3

La venta comprometida que aún hay que preparar: crear, listar y leer pedidos.

POST /api/v1/orders Crear pedido Crea un pedido de venta con sus líneas. Si la operación ya está cobrada, el pago se registra como anticipo del cliente.
GET /api/v1/orders Listar pedidos Listado paginado de pedidos de venta con filtros por fechas y cliente.
GET /api/v1/orders/{id} Obtener pedido Devuelve un pedido de venta concreto por su identificador, con su cabecera, su contraparte y todas sus líneas.

Presupuestos 2

Lo ofertado y en qué estado está cada oferta.

GET /api/v1/estimates Listar presupuestos Los presupuestos emitidos, con su cliente, su estado del pipeline y su base imponible.
GET /api/v1/estimates/{id} Obtener presupuesto Un presupuesto por su identificador, con su cliente y todas sus líneas.

Facturas recurrentes 7

Cuotas y suscripciones: alta, catálogo vivo, MRR, altas, bajas y renovaciones.

POST /api/v1/recurring-invoices Crear recurrente Crea una plantilla de facturación recurrente anual para un cliente: una suscripción que Afer facturará automáticamente.
GET /api/v1/recurring-invoices Listar recurrentes El catálogo de servicios recurrentes con su periodicidad, vigencia, última facturación e importe por ciclo.
GET /api/v1/recurring-invoices/{id} Obtener recurrente Devuelve un servicio recurrente concreto por su identificador, con su cabecera, su contraparte y todas sus líneas.
GET /api/v1/recurring/mrr MRR y ARR vivos El negocio recurrente vivo en una fecha: MRR (no anuales), ARR (anuales) y contratos activos por periodicidad.
GET /api/v1/recurring/new Recurrentes creados Devuelve los servicios recurrentes dados de alta entre dos fechas, agrupados por periodicidad: semanales, mensuales, anuales…
GET /api/v1/recurring/renewals Renovaciones de recurrentes Calcula las renovaciones de los servicios recurrentes en un rango de fechas: cuántas veces renueva cada uno, en qué fechas y por qué importe.
GET /api/v1/recurring/churn Recurrentes dados de baja El churn del negocio recurrente: servicios con fecha de caducidad dentro del rango, agrupados por periodicidad.

Clientes 2

La cartera: datos fiscales, vías de contacto, consentimientos RGPD y portal.

GET /api/v1/customers Listar clientes Devuelve los clientes de facturación de tu cuenta, paginados y con identificadores cifrados, con buscador y filtro por fecha de alta.
GET /api/v1/customers/{id} Obtener cliente La ficha de un cliente por su identificador, con sus datos fiscales y su enlace al portal.

Compras y proveedores 9

El lado del gasto: proveedores, pedidos, albaranes y facturas de compra.

GET /api/v1/reports/purchases Compras del período Devuelve las compras entre dos fechas (facturas de compra), con serie mensual opcional.
GET /api/v1/suppliers Listar proveedores Devuelve los proveedores de tu cuenta, paginados y con identificadores cifrados, con buscador.
GET /api/v1/suppliers/{id} Obtener proveedor La ficha de un proveedor por su identificador, con sus datos fiscales y de contacto.
GET /api/v1/purchase-invoices Listar facturas de compra Listado paginado de facturas de compra con filtros por fechas, proveedor, estado de pago y tipo de gasto.
GET /api/v1/purchase-invoices/{id} Obtener factura de compra Una factura de compra por su identificador, con su proveedor y todas sus líneas.
GET /api/v1/purchase-delivery-notes Listar albaranes de compra Los albaranes recibidos de tus proveedores, con su base imponible.
GET /api/v1/purchase-delivery-notes/{id} Obtener albarán de compra Un albarán de compra por su identificador, con su proveedor y todas sus líneas.
GET /api/v1/purchase-orders Listar pedidos de compra Los pedidos cursados a tus proveedores, con su base imponible.
GET /api/v1/purchase-orders/{id} Obtener pedido de compra Un pedido de compra por su identificador, con su proveedor y todas sus líneas.

Informes 3

Los agregados que responden a "¿cómo va el negocio?".

GET /api/v1/reports/summary Resumen del panel Los KPIs del mes en una sola llamada: ventas, cobros, pendiente de cobro, MRR/ARR y pipeline del CRM.
GET /api/v1/reports/sales Ventas del período Devuelve las ventas entre dos fechas (albaranes + facturas directas), separando cuánto proviene de servicios recurrentes.
GET /api/v1/reports/profit-and-loss Resultado y margen Ventas menos compras del período: margen bruto en euros y en porcentaje, con serie mensual opcional.

Tesorería 7

El dinero que entra y sale: cobros, pagos, morosidad y previsión de caja.

GET /api/v1/treasury/collections Cobros del período El dinero cobrado entre dos fechas, con desglose por método de pago y comisiones de pasarela.
GET /api/v1/treasury/payments Pagos del período El dinero pagado entre dos fechas (gastos): pagos de facturas de compra y anticipos a proveedor, por método de pago.
GET /api/v1/treasury/receivables Pendiente de cobro Cuánto te deben: saldo pendiente con aging (antigüedad de la deuda) y el top de facturas con más importe pendiente.
GET /api/v1/treasury/payables Pendiente de pago Cuánto debes a proveedores: saldo pendiente de pago con aging y el top de facturas de compra pendientes.
GET /api/v1/treasury/collections/forecast Previsión de cobros El cash-flow previsto: vencimientos pendientes agrupados por mes o semana según su fecha de vencimiento.
GET /api/v1/treasury/payments/forecast Previsión de pagos Lo que tocará pagar y cuándo: vencimientos de compra pendientes agrupados por mes o semana.
GET /api/v1/treasury/transactions Transacciones de tesorería Todos los movimientos de caja del rango en un listado: entradas y salidas con método, contraparte y documento de origen.

CRM y marketing 8

Del lead a la venta: contactos, oportunidades, pipeline y métricas comerciales.

POST /api/v1/crm/contacts Crear contacto Da de alta un contacto en el CRM, o lo actualiza si ya existe uno con el mismo email o móvil.
POST /api/v1/crm/opportunities Crear oportunidad Crea una oportunidad en un funnel del CRM, resolviendo o creando el contacto asociado por email o móvil.
GET /api/v1/crm/funnels Listar funnels El catálogo del CRM: funnels con sus etapas, canales de captación, motivos de pérdida y tipos de acción.
GET /api/v1/crm/opportunities Pipeline del CRM Las oportunidades abiertas por funnel y etapa (número y valor) y, con un rango de fechas, las creadas, ganadas y perdidas con su win rate.
GET /api/v1/crm/dashboard Dashboard del CRM El dashboard comercial completo de un funnel: KPIs, rates de actividad, embudo por etapas, motivos de pérdida, puntos de dolor, playbooks, canales, comerciales y evolución.
GET /api/v1/crm/loss-reasons Listar motivos de pérdida Los motivos de pérdida de tu CRM y, opcionalmente, cuánto se usa cada uno en un funnel concreto.
PUT /api/v1/crm/opportunities/{id}/close Ganar o perder oportunidad Marca una oportunidad como ganada o perdida (con motivo y comentarios), o la reabre.
PUT /api/v1/crm/opportunities/{id}/stage Mover oportunidad de etapa Mueve una oportunidad a otra etapa del embudo — o a otro embudo distinto.

Productos e inventario 5

El catálogo: artículos, familias, precios por tarifa y stock.

GET /api/v1/products Listar productos El catálogo de artículos con referencia, familia, coste, precios por tarifa y stock.
GET /api/v1/products/{id} Obtener producto La ficha completa de un artículo, con sus precios por tarifa y, si es de alquiler, su tabla por días.
GET /api/v1/price-lists Tarifas de venta Qué tarifas de precio existen en tu cuenta, cuántos clientes usa cada una y el precio de un artículo en todas.
GET /api/v1/product-categories Familias de artículos Las categorías de producto de tu cuenta con el número de artículos de cada una.
GET /api/v1/products/stock Stock de artículos El stock de tus artículos, con el número de referencias bajo mínimo para la tarjeta de alertas del panel.

Proyectos y obras 4

El económico de cada obra: ventas, costes, margen y horas imputadas.

GET /api/v1/projects Proyectos y su económico Cada obra con sus ventas, sus costes, su resultado y su margen, con el mismo criterio que el panel interno.
GET /api/v1/projects/{id} Obtener proyecto La ficha de una obra: cabecera, económico agregado y resumen de tareas.
GET /api/v1/project-times Horas imputadas a proyectos Las horas fichadas contra proyectos entre dos fechas, agregadas por proyecto y por persona, con su coste.
GET /api/v1/tasks Tareas de proyecto Las tareas de obra con su proyecto, su estado, su responsable y su progreso.

Equipo y control horario 10

Plantilla, contratos, turnos, ausencias y fichajes. Solo lectura.

GET /api/v1/employees Listar empleados Las personas dadas de alta en tu cuenta con su departamento. Por defecto solo las activas.
GET /api/v1/employees/{id} Obtener empleado La ficha de una persona con su departamento y su contrato vigente.
GET /api/v1/employees/contracts
GET /api/v1/employees/{id}/contract
Contratos laborales Los contratos de la plantilla: tipo, fechas, período de prueba y jornada pactada.
GET /api/v1/departments Departamentos Los departamentos de tu cuenta con el número de empleados activos de cada uno.
GET /api/v1/shifts Turnos configurados El maestro de turnos: la plantilla horaria de semana completa que se aplica a la planificación.
GET /api/v1/schedules Planificación de turnos Qué turno tiene asignado cada persona cada día de un período, con sus tramos y sus horas previstas.
GET /api/v1/work-calendar
GET /api/v1/employees/{id}/work-calendar
Calendario laboral Los días no laborables de un período: los de la empresa y, si pides una persona, también los suyos.
GET /api/v1/time-off Ausencias y vacaciones Las ausencias que solapan un período, con su tipo, si están autorizadas y cuántos días caen dentro.
GET /api/v1/employees/times
GET /api/v1/employees/{id}/times
Fichajes del período Los registros de jornada entre dos fechas: entrada, salida y horas de cada apunte.
GET /api/v1/employees/times/summary Horas fichadas vs planificadas Por persona y período: horas fichadas, horas planificadas y su desviación.

Alquiler y disponibilidad 3

Consulta qué unidades quedan libres antes de vender un alquiler por fechas.

GET /api/v1/rentals/availability/summary Disponibilidad de un artículo Devuelve las unidades disponibles de un artículo de alquiler (o de una de sus variaciones), en un rango de fechas o en general.
GET /api/v1/rentals/availability Disponibilidad por variaciones Devuelve, para uno o varios artículos, la disponibilidad de cada variación en un rango de fechas: stock, unidades reservadas y unidades libres.
GET /api/v1/rentals/bookings Reservas por variaciones Devuelve las variaciones con stock de los artículos indicados y el detalle de cada reserva que ocupa el rango de fechas.

Charters 5

Publica tu flota, consulta disponibilidad por franjas y mide la ocupación.

GET /api/v1/charters Listar flota de charter Devuelve la flota de charter publicada de tu cuenta: barcos, franjas horarias, precios por mes y disponibilidad semanal.
GET /api/v1/charters/{id} Detalle de un barco Devuelve el detalle completo de una embarcación de la flota: datos comerciales, todas sus imágenes y sus franjas con precios.
GET /api/v1/charters/availability Disponibilidad de la flota El calendario de disponibilidad día a día de cada barco y cada franja horaria en un rango de fechas.
GET /api/v1/charters/bookings/lookup Localizar reserva de charter Localiza una reserva de charter por email, fecha y apellido del cliente, y devuelve el enlace a su detalle en la web de reservas.
GET /api/v1/charters/occupancy Ocupación de la flota La ocupación de cada embarcación en un rango de fechas: días con reserva y porcentaje sobre los días del período.

Configuración de la cuenta 4

Los catálogos que dan nombre a los identificadores del resto de respuestas.

GET /api/v1/payment-methods Métodos de pago Los métodos de pago disponibles en tu cuenta, para poner nombre a los que devuelve tesorería.
GET /api/v1/numbering-series Series de facturación Las series de numeración de factura de tu cuenta y qué significa cada una.
GET /api/v1/document-statuses Estados de documento Los estados del pipeline de documentos, con su color, para filtrar y para pintar.
GET /api/v1/health Estado del servicio Comprueba que la API responde y que tus credenciales son válidas.
Lo que la API no hace
  • No escribe fichajes. El registro de jornada es un libro legal y solo se alimenta desde la app y el circuito interno: el área de control horario es de consulta.
  • No borra documentos. No hay verbos DELETE: las anulaciones se hacen por rectificativa desde Afer, nunca borrando el original.
  • No expone datos de nómina. Los contratos se devuelven sin salario, pluses ni retenciones.