Balances List
Listar Saldos
Obtiene listado de saldos del cliente 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:
|
Sí |
N/A |
Resource URL
- GET HOST/v1/customers/balances/?created_at_after=(date: created_at_after)&created_at_before=(date: created_at_before)&customer=(int: customer)
- 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).
customer – Identificador del cliente.
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:
id (int) – Identificador del documento factura.
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.
total (float) – Total de la factura.
balance (float) – Saldo de la factura.
Example request
GET /v1/customers/balances/?created_at_after=2025-08-01&created_at_before=2025-08-15 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": 4102,
"next": "https://api.next-cloud.mx/v1/customers/balances/?created_at_after=2025-08-01&created_at_before=2025-08-15&page=2&page_size=5",
"previous": null,
"results": [
{
"id": 9436602,
"document": "FACTC",
"folio": 3368053,
"serie": "E",
"created_at": "2025-08-01T07:51:08.323000Z",
"total": "1401.74",
"balance": "1001.74"
},
{
"id": 9436630,
"document": "FACTC",
"folio": 3368054,
"serie": "E",
"created_at": "2025-08-01T07:51:09.853000Z",
"total": "2430.49",
"balance": "2430.49"
},
{
"id": 9436643,
"document": "FACTC",
"folio": 3368055,
"serie": "E",
"created_at": "2025-08-01T07:51:10.630000Z",
"total": "700.87",
"balance": "600.87"
},
{
"id": 9436645,
"document": "FACTC",
"folio": 3368056,
"serie": "E",
"created_at": "2025-08-01T07:51:11.350000Z",
"total": "2430.49",
"balance": "2000.00"
},
{
"id": 9436689,
"document": "FACTC",
"folio": 3368057,
"serie": "E",
"created_at": "2025-08-01T07:51:11.997000Z",
"total": "653.95",
"balance": "653.95"
}
]
}