Saldos y Movimientos
GET/balance/history/:clave/items/:items/page/:page
Este endpoint permite realizar una consulta de los registros de saldos y cobros asociados a las guías generadas en el sistema. A través de parámetros de consulta, se pueden especificar dos fechas: una fecha de inicio y una fecha de fin, lo que permite filtrar los resultados dentro de un rango temporal específico.
Al realizar la consulta, el endpoint retorna todos los registros que coinciden con los criterios especificados. Los registros incluyen información sobre las recargas de saldo y las guías generadas, proporcionando un panorama completo de las transacciones realizadas en el período seleccionado.
Este endpoint es fundamental para la auditoría y el análisis financiero, ya que proporciona una visión detallada de los movimientos relacionados con los saldos y guías en un intervalo de tiempo definido.
Request
Header Parameters
Token de acceso en formato Bearer. Ejemplo: Bearer "access_token".
Identificador único de la tienda.
Query Parameters
Fecha en que se creo el movimiento Date: yyyy-mm-dd.
Indica la fecha final de búsqueda Date: yyyy-mm-dd.
Indica el tipo de registros que serán filtrados, los valores aceptados son: s - saldos, g - guias.
Id de la forma de pago.
Responses
- 200
- 400
Respuesta de petición.
Response Headers
- application/json
- Schema
- Example (from schema)
- Estructura de Response
Schema
[
]
Indica si la petición fue exitosa o no.
Mensaje arrojado del resultado de la petición.
detail
object
Detalle de la respuesta.
Saldo que tiene actualmente el comercio.
data
array
Array con información requerida.
Identificador del movimiento(saldo/guia).
Fecha y hora en que en que se registro el movimiento en t1envios.
Tipo de movimiento (saldo/guia).
Sub total.
Precio total.
Id comercio interno.
Nombre forma de pago.
Indicador de la operación en texto: Ingreso / Egreso.
Solo fecha en que se registro el movimiento en t1envios.
Solo hora en que se registro el movimiento en t1envios.
Total de todos los registros.
Total de registros filtrados.
{
"success": boolean,
"message": "string",
"detail": {
"saldo_actual": "float",
"data": [
{
"folio": "string",
"fecha": "string",
"tipo": "string",
"subtotal": integer,
"total": integer,
"id_comercio": "string",
"tipo_pago": "string",
"tipo_operacion": "string",
"fecha_alta": "string",
"hora_alta": "string",
},
"total_registros": integer,
"total_filtrados": integer
]
}
}
{
"success": true,
"message": "Consulta realizada correctamente",
"detail": {
"saldo_actual": 1086.81999997,
"data": [
{
"folio": "4165600505",
"fecha": "2024-08-05 17:38:24",
"tipo": "Guía",
"subtotal": 2,
"total": 2,
"id_comercio": 4102,
"tipo_pago": "Credito T1Envios",
"tipo_operacion": "Egreso",
"fecha_alta": "2024-08-05",
"hora_alta": "17:38:24",
},
{
"folio": "4165600505",
"fecha": "2024-08-05 17:38:24",
"tipo": "Guía",
"subtotal": 2,
"total": 2,
"id_comercio": 4102,
"tipo_pago": "Credito T1Envios",
"tipo_operacion": "Egreso",
"fecha_alta": "2024-08-05",
"hora_alta": "17:38:24",
},
"total_registros": 2,
"total_filtrados": 2
]
}
}
Posibles errores por falta de algún campo requerido o validación.
Response Headers
- application/json
- Schema
- Example (from schema)
- Error
Schema
Indica si la petición fue exitosa o no.
Mensaje mostrado cuando se obtiene la respuesta de una petición.
Mensaje de error obtenido.
detail
object
Detalle de la respuesta de error obtenida.
{
"success": boolean,
"message": "string",
"error": "string",
"detail": {
"errorType": "string",
"errorMessage": "string",
"traceback": "string",
}
}
{
"success": false,
"message": "Error en la petición",
"error": "Valor no válido: El parámetro items debe ser un número entero mayor o igual a 1",
"detail": {
"errorType": "ValueError",
"errorMessage": "Valor no válido: El parámetro items debe ser un número entero mayor o igual a 1",
"traceback": "ValueError('El parámetro items debe ser un número entero mayor o igual a 1')",
}
}