Recibos — Consultar

Frecuencia de actualización recomendada: 15 minutos

Con este endpoint se pueden obtener los recibos sin procesar (estado: 0) de forma paginada mediante el parámetro batchSize. Es posible filtrar por otros parámetros en simultáneo.

GET/v1/recibos

Parameters

Parámetro	Tipo	Descripción
fechaDesde	String	Filtro para obtener los recibos a partir de una fecha. Formato: "yyyy-MM-dd HH:mm:ss.fff".
fechaHasta	String	Filtro para obtener los recibos hasta una fecha. Mismo formato.
batchSize	Int	Cantidad de recibos a solicitar (máximo 5000).
idDesde	Int	Filtro para obtener los recibos con id igual o mayor al enviado.
vendedor	String	Filtro para obtener los recibos del vendedor enviado.
cliente	String	Filtro para obtener los recibos del cliente enviado.
estado	Int	Filtro para obtener los recibos con un estado específico. 0: Nuevo \| 1: Procesado.

Response body

Campo	Tipo	Descripción
id	LongRequired	Código identificador del ítem del recibo.
guid	String(64)Required	Código identificador único del recibo generado por Axum.
estado	String(1)Required	Estado en el que se encuentra el recibo. 0: Nuevo \| 1: Procesado.
codigoCliente	String(64)Required	Código del cliente asociado al recibo.
codigovendedor	String(20)Required	Código del vendedor asociado al recibo.
fecha	DatetimeRequired	Fecha en la que se realizó el recibo.
empresa	String(4)Required	Empresa que emitió el documento.
sucursal	String(4)Required	Sucursal de destino.
ACuenta	Decimal	Monto a favor del cliente luego de regularizar un pago.
comprobantes	ArrayRequired	Comprobantes que regulariza el recibo: facturaId (Long, Required) código identificador de la factura · comprobanteCodigo (String(64), Required) código asignado por el sistema de gestión · comprobanteNumero (String(64), Required) número según normativa de la AFIP · monto (Decimal, Required) monto de la factura a regularizar.
valores	ArrayRequired	Medios de pago utilizados: codigo (String(64), Required) código de medio de pago utilizado por el cliente · monto (Decimal, Required) monto a saldar con este medio de pago · observacion (String(64)) observación que puede cargar el vendedor antes de enviar la cobranza.
total	DecimalRequired	Monto total del recibo a imputar.

Respuestas

Código	Significado
200	Recibos pendientes (estado 0), paginados según batchSize.
403	La API key enviada en `X-API-KEY` no es válida.
404	Falta el header `X-API-KEY` o la URL es incorrecta.
429	Se superó el límite de 30 requests por minuto.
500	Error interno del servidor. Reintentar más tarde.

cURL

curl --location 'https://gateway.axum.com.ar/{tenant}/api/v1/recibos' \
  --header 'X-API-KEY: {tenant-apikey}'

RESPONSE · 200 OK

[
  {
    "id": 11231232,
    "guid": "20240614_164954#1d8ea826-86ca-498e-bfe5-5d43979ae4cb",
    "estado": "0",
    "codigoCliente": "1000",
    "codigovendedor": "02",
    "fecha": "2020-01-06 08:04:12",
    "fechaProcesado": null,
    "empresa": "0001",
    "sucursal": "0001",
    "ACuenta": 0.000,
    "comprobantes": [
      { "facturaId": "4425", "comprobanteCodigo": "FA5", "comprobanteNumero": "000000181", "monto": 4000.3301 }
    ],
    "valores": [
      { "codigo": "TRA", "monto": 3000.00, "observacion": null },
      { "codigo": "DEP", "monto": 1000.3301, "observacion": null }
    ],
    "total": 4000.3301
  }
]