Skip to content
Factuplan Factuplan Documentación API para Desarrolladores | Factuplan

Categorías

Maneja todas las operaciones CRUD para las categorías en la API.

Endpoints

Section titled “Endpoints”

Obtener todas las categorías

Section titled “Obtener todas las categorías”

GET /categories

Parámetros de consulta:

  • query: Parámetros de filtrado y ordenamiento (opcional)
[
  {
    "id": "82a81d68-f786-46a8-8184-31efc5bee730",
    "deletedAt": null,
    "createdAt": "2025-06-03T03:11:19.350Z",
    "updatedAt": "2025-06-03T03:11:19.350Z",
    "name": "Nombre de la categoría",
    "description": "Descripción de la categoría"
  },
  {
    "id": "fe58bcfc-8be2-4ef0-9498-2df2adce551e",
    "deletedAt": null,
    "createdAt": "2025-06-03T03:19:40.775Z",
    "updatedAt": "2025-06-03T03:19:40.775Z",
    "name": "Otra categoría",
    "description": "Descripción de otra categoría"
  }
]

Filtros

Section titled “Filtros”
CampoOperadorEjemplo
namelikeGET /categories?query=filter.name__like=producto

Obtener una categoría por ID

Section titled “Obtener una categoría por ID”

GET /categories/{id}

Parámetros de URL:

  • id: ID de la categoría a buscar
{
  "id": "4c415301-2932-4614-8b57-e4df1deca600",
  "deletedAt": null,
  "createdAt": "2025-06-03T03:20:07.856Z",
  "updatedAt": "2025-06-03T03:20:07.856Z",
  "name": "Nombre de la categoría",
  "description": "Descripción de la categoría"
}

Crear una nueva categoría

Section titled “Crear una nueva categoría”

POST /categories

{
  "name": "Computadoras",
  "taxpayerId": "ef920607-a364-4ea0-b3ea-61617bda33c8"
}

Actualizar una categoría existente

Section titled “Actualizar una categoría existente”

PUT /categories/{id}

Parámetros de URL:

  • id: ID de la categoría a actualizar
{
  "name": "Equipos Informáticos",
  "taxpayerId": "ef920607-a364-4ea0-b3ea-61617bda33c8"
}

Eliminar una categoría

Section titled “Eliminar una categoría”

DELETE /categories/{id}

Parámetros de URL:

  • id: ID de la categoría a eliminar