Skip to main content
GET
/
invoices
curl https://api.onepay.la/v1/invoices?page=1&filter[status]=CREATED&sort=-created_at \
  -H "Authorization: Bearer sk_test_xxx"

{
  "data": [
    {
      "id": "2f2b1e5a-1a2b-4c33-8a18-5e9f3b9f4b1a",
      "name": "Internet plan - Octubre",
      "provider": "biller",
      "provider_id": "987654",
      "reference": "INV-12345678",
      "status": "CREATED",
      "remarks": null,
      "metadata": {
        "key": "value"
      }
    }
  ],
  "current_page": 1,
  "from": 1,
  "last_page": 2,
  "per_page": 20,
  "to": 20,
  "total": 21
}

​
Query params

​
page
number
Número de página. Por defecto 1.
​
filter[id]
string
Filtra por ID exacto de la factura.
​
filter[status]
string
Filtra por estado de la factura.
​
filter[reference]
string
Filtra por referencia exacta.
​
filter[provider_id]
string
Filtra por provider id.
​
sort
string
Ordena por fecha de creación. Valores permitidos: created_at o -created_at. Por defecto -created_at.
curl https://api.onepay.la/v1/invoices?page=1&filter[status]=CREATED&sort=-created_at \
  -H "Authorization: Bearer sk_test_xxx"

​
Response

{
  "data": [
    {
      "id": "2f2b1e5a-1a2b-4c33-8a18-5e9f3b9f4b1a",
      "name": "Internet plan - Octubre",
      "provider": "biller",
      "provider_id": "987654",
      "reference": "INV-12345678",
      "status": "CREATED",
      "remarks": null,
      "metadata": {
        "key": "value"
      }
    }
  ],
  "current_page": 1,
  "from": 1,
  "last_page": 2,
  "per_page": 20,
  "to": 20,
  "total": 21
}
Notas
  • La respuesta usa un formateador de colección personalizado que expone los datos de paginación en la raíz de la respuesta (current_page, from, last_page, per_page, to, total), además de la clave data.
  • El listado no incluye el objeto payment anidado por rendimiento; se expone en el detalle y en la creación.