Obtener la lista de impuestos
Recupera la lista de impuestos disponibles en el sistema.
Endpoint
GET /api/taxes
Autenticación
Requiere un token de autenticación Bearer.
Encabezados
| Encabezado | Valor | Obligatorio | Descripción |
|---|---|---|---|
Authorization |
Bearer {token} |
Sí | Token de autenticación. |
Accept |
application/json |
No | Solicita la respuesta en formato JSON simplificado. Si se omite, la API devuelve el formato JSON-LD de Hydra. |
Ejemplo de respuesta JSON
Para obtener una respuesta simplificada, envía el encabezado Accept: application/json.
[
{
"id": 1,
"name": "IVA 10%",
"amount": "10.00"
},
{
"id": 2,
"name": "IVA 5%",
"amount": "5.00"
}
]
Ejemplo de respuesta JSON-LD
Si no envías el encabezado Accept: application/json, la API devuelve una colección en formato JSON-LD de Hydra.
{
"@context": "/api/contexts/Tax",
"@id": "/api/taxes",
"@type": "hydra:Collection",
"hydra:totalItems": 154,
"hydra:member": [
{
"@id": "/api/taxes/1",
"@type": "Tax",
"id": 1,
"name": "IVA 10%",
"amount": "10.00"
},
{
"@id": "/api/taxes/2",
"@type": "Tax",
"id": 2,
"name": "IVA 5%",
"amount": "5.00"
}
],
"hydra:view": {
"@id": "/api/taxes?page=1",
"@type": "hydra:PartialCollectionView",
"hydra:first": "/api/taxes?page=1",
"hydra:last": "/api/taxes?page=6",
"hydra:next": "/api/taxes?page=2"
}
}
Descripción de los campos
Campos de cada impuesto
| Campo | Tipo | Descripción |
|---|---|---|
id |
integer |
Identificador único del impuesto. |
name |
string |
Nombre del impuesto. Por ejemplo, IVA 10% o IVA 5%. |
amount |
string |
Porcentaje del impuesto, expresado como una cadena numérica. Por ejemplo, "10.00" representa el 10 %. |
Campos adicionales de la respuesta JSON-LD
| Campo | Descripción |
|---|---|
@context |
Define el contexto JSON-LD de la entidad Tax. |
@id |
Identificador de la colección o recurso en la API. |
@type |
Tipo de recurso o colección. |
hydra:totalItems |
Cantidad total de impuestos disponibles en la colección. |
hydra:member |
Lista de impuestos incluidos en la página actual. |
hydra:view |
Información de paginación de la colección. |
hydra:first |
Enlace a la primera página. |
hydra:last |
Enlace a la última página. |
hydra:next |
Enlace a la página siguiente, cuando existe. |
Paginación
La respuesta JSON-LD incluye información para navegar entre las páginas de resultados. En el ejemplo, la colección contiene 154 impuestos distribuidos en 6 páginas.
Puedes consultar una página específica mediante el parámetro page:
GET /api/taxes?page=2
Notas
- El endpoint requiere autenticación mediante token.
- Utiliza
Accept: application/jsonsi necesitas una lista simplificada de impuestos. - El campo
amountse devuelve como una cadena de texto, no como un número. - Los ejemplos muestran dos impuestos; la cantidad real de resultados depende de los datos disponibles y de la paginación.