Invoices List

Listar Facturas de servicios

Obtiene listado de las facturas de servicios en base a los parámetros enviados.

Nombre	Tipo y longitud o rango de dato	Descripción	Requerido	Default
HOST	URL	Se indicará de acuerdo el ambiente donde será consumido el servicio: Producción: https://api.next-cloud.mx Staging: https://api.axolote.next-cloud.mx	Sí	N/A

Resource URL

GET HOST/v1/providers/invoices/?created_at_after=(date: created_at_after)&created_at_before=(date: created_at_before)&provider=(int: provider)

Parámetros:

• created_at_after (date) – Fecha inicial del rango de creación (formato YYYY-MM-DD).

• created_at_before (date) – Fecha final del rango de creación (formato YYYY-MM-DD).

• provider – Identificador del proveedor.

• page (int) – (optional) Identificador de la pagina consultada.

• page_size (int) – (opcional) Total de resultados por pagina (por defecto son 100).

Encabezados de solicitud:

• Authorization – Token del usuario.

• Content-Type – Define el formato en el que se envian los datos por el body.

Objeto JSON de respuesta:

• count (int) – Total de resultados obtenidos por la consulta.

• next (string) – Página siguiente de resultados.

• previous (string) – Página anterior de resultados.

• result (obj) – Objeto con resultados de la consulta.

Códigos de Status:

• 200 OK – Ningún error.

• 400 Bad Request – Algún parámetro es incorrecto.

• 401 Unauthorized – Token no válido o no enviado.

• 404 Not Found – El recurso no existe.

result object:

Objeto JSON de respuesta:

• document (string) – Clave del documento factura.

• folio (int) – Folio de la factura.

• serie (string) – Serie de factura.

• created_at (date) – Fecha de creación del documento.

• currency (string) – Clave de la moneda.

• status (string) – Clave del estado.

• balance (float) – Saldo de la factura.

• total (float) – Total de la factura.

Example request

GET /v1/providers/invoices/?provider=1&created_at_after=2024-05-01&created_at_before=2024-05-28 HTTP/1.1
Host: api.next-cloud.mx
Accept: application/json
Content-Type: application/json
Authorization: Token ( token del usuario )

Example Response

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
Allow: GET

{
    "count": 2,
    "next": null,
    "previous": null,
    "results": [
        {
            "document": "FACPS",
            "folio": 882,
            "serie": "0",
            "created_at": "2024-05-28T12:46:43Z",
            "currency": "MN",
            "status": "CN",
            "balance": "0.00",
            "total": "348.00"
        },
        {
            "document": "FACPS",
            "folio": 881,
            "serie": "0",
            "created_at": "2024-05-28T12:46:42Z",
            "currency": "MN",
            "status": "CN",
            "balance": "0.00",
            "total": "23200.00"
        }
    ]
}