Endpoint Familias
Lista de familias
Method: GET URI: /api/v1/familias
Este endpoint permite obtener un listado de familias según los parámetros de búsqueda y ordenación.
Request
- Headers
- Content-Type: application/json
- token: <string>
- secret:<string>
- Params
- sort_column: campo por el que ordenar. Podrá ser: id o nombre. Por defecto será id.
- sort_type: indica el si la ordenación es ascendente o descendente. Podrá ser: asc o desc. Por defecto será asc.
- paginate_by: número de registros a mostrar. El mínimo será 1 y el máximo 100. Por defecto serán 10.
- page: número de página a mostrar. Por defecto será 1.
- nombre: valor a buscar en el campo nombre. La búsqueda se hará con un contiene.
Response 1: 200: existen datos
{
"status": 200,
"page": 1,
"paginate_by": 10,
"records": 12,
"data": [
{
"id": 1,
"nombre": "Familia uno",
"padre": {}
},
{
"id": 2,
"nombre": "Familia dos",
"padre": {
"id": 1,
"nombre": "Familia uno"
}
},
...
]
}
Response 2: 200: no existen datos
{
"status": 200,
"page": 1,
"paginate_by": 10,
"records": 0,
"data": []
}
Response 3: 400: petición errónea
{
"status": 400,
"error": "Error en la Petición"
}
Response 4: 402: petición no autorizada
{
"status": 402,
"error": "No autorizado"
}
Prueba la API de tu instalación aquí
Detalle de familia
Method: GET URI: /api/v1/familias
Este endpoint permite obtener el detalle de la familia cuyo id coincide con el parámetro suministrado.
Request
- Headers
- Content-Type: application/json
- token: <string>
- secret:<string>
- Params
- id: identificador de la familia a mostrar.
Response 1: 200: existen datos
{
"status": 200,
"data": {
"id": 2,
"nombre": "Familia dos",
"padre": {
"id": 1,
"nombre": "Familia uno"
},
"cta_contable_ingresos": "700000001",
"cta_contable_gastos": "600000001",
"margenes": [
{
"id": 1,
"tipo": "P",
"cantidad": 20.00
},
{
"id": 2,
"tipo": "F",
"cantidad": 5.00
},
...
]
}
}
Response 2: 404: no existen datos
{
"status": 404,
"error": "Familia no existe"
}
Response 3: 400: petición errónea
{
"status": 400,
"error": "Error en la Petición"
}
Response 4: 402: petición no autorizada
{
"status": 402,
"error": "No autorizado"
}
Prueba la API de tu instalación aquí