Categorías

Las categorías clasifican movimientos, partidas y filas de la agenda. Hay un catálogo común y puedes crear las tuyas.

El objeto categoría

Campos

idstring: En el catálogo, un código estable como expense-groceries. En las tuyas, un UUID. Es lo que se manda como categoryId.
namestring: Nombre visible.
typestring: ADD (ingreso) o CUT (gasto). Debe coincidir con el del movimiento.
iconstring: Nombre del ícono.
colorstring: Color en hexadecimal, como #EA580C.
keywordsstring[]: Palabras que ayudan a la clasificación automática.
isCustomboolean: true si es tuya.

Listar categorías

GEThttps://api.tuplatica.app/api/platica/categories

Plan: Gratis (tus categorías propias solo con Pro)Permiso de la key: Solo lectura o superior

Devuelve primero el catálogo y luego tus categorías propias.

curl "https://api.tuplatica.app/api/platica/categories" \
  -H "Authorization: Bearer $PLATICA_API_KEY"

Respuesta 200

[
  {
    "id": "expense-groceries",
    "name": "Mercado y alimentos",
    "type": "CUT",
    "icon": "shopping_cart",
    "color": "#EA580C",
    "keywords": [
      "mercado",
      "supermercado"
    ],
    "isCustom": false
  },
  {
    "id": "7d9f1b3d-5f7a-4b9d-8f1b-3d5f7a9b1d3f",
    "name": "Gastos del edificio",
    "type": "CUT",
    "icon": "apartment",
    "color": "#7C3AED",
    "keywords": [
      "cuota edificio",
      "fondo de reserva"
    ],
    "isCustom": true
  }
]

Códigos del catálogo base: ingresos income-salary, income-freelance, income-sales, income-remittance, income-other…; gastos expense-groceries, expense-transport, expense-housing, expense-services, expense-health, expense-other… La lista viva es la que devuelve esta ruta.

Sugerir una categoría

POSThttps://api.tuplatica.app/api/platica/categories/suggest

Plan: ProPermiso de la key: Solo lectura o superior

Recibe una descripción y devuelve la categoría que Platica elegiría, aprendiendo de tus elecciones anteriores. No guarda nada, pero usa POST, así que necesita una key de lectura y escritura.

Cuerpo

typestringobligatorio: ADD o CUT.
descriptionstringobligatorio: Hasta 500 caracteres.

curl -X POST "https://api.tuplatica.app/api/platica/categories/suggest" \
  -H "Authorization: Bearer $PLATICA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "CUT",
    "description": "Pago de internet CANTV"
  }'

Crear una categoría propia

POSThttps://api.tuplatica.app/api/platica/categories/custom

Plan: ProPermiso de la key: Lectura y escritura

Cuerpo

namestringobligatorio: Hasta 80 caracteres. Único por tipo.
typestringobligatorio: ADD o CUT.
iconstringobligatorio: Nombre del ícono, hasta 80 caracteres.
colorstringobligatorio: Hexadecimal, como #7C3AED.
keywordsstring[]: Hasta 30 palabras de hasta 60 caracteres.

curl -X POST "https://api.tuplatica.app/api/platica/categories/custom" \
  -H "Authorization: Bearer $PLATICA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Gastos del edificio",
    "type": "CUT",
    "icon": "apartment",
    "color": "#7C3AED",
    "keywords": [
      "cuota edificio",
      "fondo de reserva"
    ]
  }'

Respuesta 201

{
  "id": "7d9f1b3d-5f7a-4b9d-8f1b-3d5f7a9b1d3f",
  "name": "Gastos del edificio",
  "type": "CUT",
  "icon": "apartment",
  "color": "#7C3AED",
  "keywords": [
    "cuota edificio",
    "fondo de reserva"
  ],
  "isCustom": true
}

Si ya tienes una categoría con ese nombre y tipo, responde 409.

Editar o eliminar

PATCHhttps://api.tuplatica.app/api/platica/categories/custom/:id

Plan: ProPermiso de la key: Lectura y escritura

Mismos campos que al crear, todos opcionales.

curl -X PATCH "https://api.tuplatica.app/api/platica/categories/custom/7d9f1b3d-5f7a-4b9d-8f1b-3d5f7a9b1d3f" \
  -H "Authorization: Bearer $PLATICA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "color": "#2563EB"
  }'

DELETEhttps://api.tuplatica.app/api/platica/categories/custom/:id

Elimina tu categoría. Responde 204 sin cuerpo.

Las categorías del catálogo no se editan

Solo puedes crear, editar y borrar las tuyas. Las del catálogo son comunes a todos los usuarios.