Skip to content
Vinicius Peralta edited this page Mar 6, 2026 · 2 revisions
erDiagram
    direction LR
    Tag }o--|| Category : contained
    Tag {
        long id
        string name
        long categoryId
    }
    Category {
        long id
        string name
        string color
        string icon
        boolean active
        long userId
    }
Loading

Tag domain is used to represent the tags that can be associated with transactions.

Each tag belongs to a Category and has a name, it´s purpose is to provide a way to classify transactions in a more granular way than categories, allowing users to have more flexibility in how they organize their transactions, the tag domain provides services for managing tags.

For example, a "Food" category may contain tags such as "Restaurant", "Groceries", or "Delivery". This enables more detailed filtering, reporting, and analysis without increasing the number of primary categories.

Tags are optional and are designed to enhance flexibility while maintaining structural consistency across the system.

Services

Here we have detailed information about the services related to API-CoreData Tag domain such as request parameters needed, endpoint and a flowchart.

Update

To update a category existing tags, you need to provide the following list of objects:

[
  {
    "id": 1,
    "name": "Restaurant"
  },
  {
    "id": null,
    "name": "Groceries"
  }
]

Rules:

  • id: Optional, if provided, it must correspond to an existing tag within the category. If not provided, a new tag will be created.
  • name: Required, must be unique within the category, and should not exceed 20 characters.

The system will validate the information received to check if all data is valid and if the tag does not already exists within the category.

Endpoint

There is no endpoint for creating or updating tags, instead, tags are managed through the category update endpoint:

[PATCH] /api/core/category

Flowchart

flowchart
    A((START)) --> B
    B{Tag request is valid?} -- Yes --> C
    B -- No --> D[Return 400 - Bad Request]
    C[Remove tags not included in the request] --> E
    E[Update existing tags] --> F
    F[Create new tags] --> G[Return updated tags]
    
    style A stroke:#FF6D00
    style D stroke:#D50000
    style G stroke:#00C853
Loading

Clone this wiki locally