Get a report of generated invoices. Supports pagination and optional filters by year/month.
Endpoint: GET /invoices
Authorization:
| Nombre | Tipo | Descripción |
|---|---|---|
| Authorization | Basic | Se utiliza la auth que maneja OXXO pay. |
Parameters:
| Nombre | Obligatorio | Tipo | Descripción | Ejemplo |
|---|---|---|---|---|
| next_page_url | No | string | Pagination cursor returned by the previous response. | 1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 |
| size | No | int | Number of records per page | Por defecto es 100. Mínimo 1 Máximo 1000 |
| from | No | number (ms) | Initial timestamp (UTC ms) Date until which to search. | 1661220000000 Por defecto se toman los últimos 31 días. |
| to | No | number (ms) | Final timestamp (UTC ms) Date until which to search. | 1661220000000 Por defecto se toman los últimos 31 días. |
| year | No | int | Year to query. Can be combined with month. | 2024 |
| month | No | int | Month to query (MM). Requires year. | 06 |
| field | No | string | Fields to filter (comma-separated) | date,amount |
Example request:
curl -X GET "https://services.digitalfemsa.io/reports/v1/invoices?year=2024&month=06&size=2&next_page_url=eyJzZWFyY2hfYWZ0ZXIiOlsxNzEwOTU5ODg3MTEyXX0%3D" \
-H "Authorization: Bearer <your_api_key>"Expected response:
{
"has_more": false,
"total": 3,
"object": "list",
"data": [
{
"amount": 0,
"commission": -6.33,
"commission_amount": -7.34,
"commission_tax": -1.01,
"company_id": "5f90a9802238c00001123bcd",
"date": "2024-01",
"id": "12345678ccccccc",
"net": 7.34,
"status": "error"
},
{
"amount": 0,
"commission": 1.8,
"commission_amount": 2.09,
"commission_tax": 0.29,
"company_id": "5f90a9802238c123456789abcdc",
"date": "2024-03",
"id": "12345678bbbbbbbb",
"net": -2.09,
"status": "paid"
},
{
"amount": 25,
"commission": 0.98,
"commission_amount": 1.14,
"commission_tax": 0.16,
"company_id": "5f90a9802238123456789lkjhg",
"date": "2024-06",
"id": "1234567890aaaaaa",
"net": 23.86,
"status": "error"
}
]
}