Add Single Rule Project
\nThis endpoint allows users to create a new single rule project under their saving service. The request is made to the specified user's endpoint and requires a JSON payload that defines the parameters of the rule project.
\nRequest Parameters
\nThe request body must contain the following parameters:
\n- \n
rule_type (string): The unique identifier for the type of rule being created.
\n \nfrom_account (string): The identifier for the account from which the funds will be drawn.
\n \nto_account (string): The identifier for the account to which the funds will be allocated.
\n \nproject_name (string): A descriptive name for the saving project.
\n \ntotal (string): The total amount of money targeted for the saving project.
\n \ngoal_date (string): The date by which the saving goal should be achieved, formatted as YYYY-MM-DD.
\n \namount (string): The amount of money to be saved in each execution cycle.
\n \nexecution_frequency (string): The frequency with which the saving rule will be executed (e.g., daily, weekly, monthly).
\n \nrule_execution_days (array of integers): An array specifying the days of the week on which the rule should be executed (0 for Sunday, 1 for Monday, etc.).
\n \ntransaction_category (string): The unique identifier for the category of transactions associated with the rule.
\n \nsoccer_team (string): A unique identifier related to a specific soccer team, if applicable.
\n \nsoccer_condition (string): A condition related to the soccer team, if applicable.
\n \nsalary_percentage (integer): The percentage of the salary to be allocated to the saving project.
\n \nsalary_execution_day (integer): The specific day of the month on which the salary allocation will occur.
\n \n
Response
\nUpon successful creation of the single rule project, the API will respond with a confirmation of the project details, including the unique identifier for the newly created project and any other relevant information.
\nEnsure that all required fields are provided in the request body to avoid errors during the project creation process.
\n","urlObject":{"path":["api-saving","v1","saving-service","users","{{user_id}}","single-rule-project",""],"host":["{{host_app}}"],"query":[],"variable":[]}},"response":[{"id":"bf4189b8-d1ad-4bc7-8ebc-83c32a6ff7e1","name":"Crear proyecto y regla","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n // ── OBLIGATORIOS (siempre requeridos) \n \"rule_type\": \"7c8fbf63-545a-4f60-8c87-14f1f1d52f8c\", // REQUERIDO — UUID del tipo de regla \n \"from_account\": \"FROM_001\", // REQUERIDO — cuenta origen \n \"to_account\": \"TO_001\", // REQUERIDO — cuenta destino \n // ── OPCIONALES generales \n \"project_name\": \"Mi ahorro\", // OPCIONAL — si se omite, se usa la descripción del tipo de regla\n \"total\": \"600000.00\", // OPCIONAL — meta de monto total del proyecto \n \"goal_date\": \"2027-01-01\", // OPCIONAL — fecha futura de meta \n // ── OPCIONALES según tipo de regla \n \"amount\": \"50000.00\", // OPCIONAL* fixed_amount | guilty_pleasure | soccer_passion \n \"execution_frequency\": \"M\", // OPCIONAL* fixed_amount — D=diaria | S=semanal | Q=quincena M= \n \"rule_execution_days\": [\n 5\n ], // OPCIONAL fixed_amount S = [1 a 7] Q = [1-14, 15-31] M [1 A 31] \n \"transaction_category\": \"22118f55-e6a9-46b0-ae8f-a063dda396e0\", // OPCIONAL* guilty_pleasure — \n \"soccer_team\": \"PATCH /api-saving/v1/saving-service/users/{user_id}/single-rule-project/{project_id}/
\nThis endpoint allows you to update the details of a specific rule project associated with a user. The request modifies various attributes of the rule project identified by the user_id and project_id.
Request Body Parameters
\n- \n
rule_status (string): The status of the rule, represented by a unique identifier.
\n \nrule_type (string): The type of the rule, represented by a unique identifier.
\n \namount (string): The monetary amount associated with the rule.
\n \nexecution_frequency (string): The frequency at which the rule is executed (e.g., daily, weekly).
\n \nrule_execution_days (array of integers): An array indicating the days on which the rule is executed.
\n \ntransaction_category (string): The category of transactions related to the rule, represented by a unique identifier.
\n \nsoccer_team (string): A unique identifier for the soccer team associated with the rule.
\n \nsoccer_condition (string): The condition related to the soccer rule.
\n \nsalary_percentage (integer): The percentage of salary allocated to the rule.
\n \nsalary_execution_day (integer): The specific day of the month when the salary execution occurs.
\n \n
Response Structure
\nThe response will return the updated rule project details, including:
\n- \n
id (string): The unique identifier of the rule project.
\n \nuser_id (string): The identifier of the user associated with the rule project.
\n \namount (number): The updated monetary amount.
\n \nsalary_percentage (number): The updated salary percentage.
\n \nexecution_frequency (string): The frequency of execution.
\n \nrule_execution_days (object): An object containing the days on which the rule is executed.
\n \nsoccer_condition (string or null): The condition related to the soccer rule.
\n \nsoccer_team (string or null): The identifier for the soccer team.
\n \nweather_city (string or null): The city related to weather conditions.
\n \ntemperature (number): The temperature associated with the rule.
\n \ncreated_at (string): The timestamp when the rule was created.
\n \nrule_type (object): An object containing details about the rule type, including its metadata.
\n \nrule_status (object): An object containing details about the rule status, including its metadata.
\n \ntransaction_category (object): An object containing details about the transaction category, including its metadata.
\n \nspend_less_limit_amount (number): The limit amount for spending less.
\n \nspend_less_category_id (string or null): The category ID for spending less.
\n \ndeleted_at (string or null): The timestamp when the rule was deleted, if applicable.
\n \n
This endpoint is essential for maintaining and updating user-specific rule projects within the saving service.
\n","urlObject":{"path":["api-saving","v1","saving-service","users","{{user_id}}","single-rule-project","{{project_id}}",""],"host":["{{host_app}}"],"query":[],"variable":[]}},"response":[{"id":"806fd846-b854-4e0f-a2fb-aa5e15a74b48","name":"New Request","originalRequest":{"method":"GET","header":[]},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": \"5257fb70-b5c8-4835-aeae-d67ce775911f\",\n \"user_id\": \"0c79f672-e604-4fa4-86f8-389f5d669113\",\n \"amount\": 1500,\n \"salary_percentage\": 0,\n \"execution_frequency\": \"M\",\n \"rule_execution_days\": {\n \"days\": []\n },\n \"soccer_condition\": null,\n \"soccer_team\": null,\n \"weather_city\": null,\n \"temperature\": 0,\n \"created_at\": \"2026-03-26T17:11:15.369908-03:00\",\n \"rule_type\": {\n \"id\": \"229011e5-fb7a-447c-bada-bb48010175ce\",\n \"catalog\": \"47bd8165-2b84-4bc9-91d0-6126beee2b40\",\n \"item_name\": \"rule_type_guilty_pleasure\",\n \"description\": \"Regla placer culpable\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/rules/placer_culpable.svg\",\n \"name\": \"Placer culpable\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"icon_pause\": \"/assets/xerpa/global/img/rules/placer_culpable_pausa.svg\",\n \"short_name\": \"RULE_TYPE_GUILTY_PLEASURE\",\n \"description\": \"Ahorra cuando te das un gustito en tus comercios favoritos.\",\n \"icon_primary\": \"/assets/xerpa/global/img/rules/placer_culpable_circle.svg\",\n \"frequency_description\": \"Ahorra {amount} en {description}\"\n }\n },\n \"rule_status\": {\n \"id\": \"65729137-0844-4b28-85b5-2e81b73a948a\",\n \"catalog\": \"2cc53df2-5a17-4205-8622-d68d90b75311\",\n \"item_name\": \"rule_status_active\",\n \"description\": \"Regla activa\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/rules/active.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"RULE_STATUS_ACTIVE\"\n }\n },\n \"transaction_category\": {\n \"id\": \"22118f55-e6a9-46b0-ae8f-a063dda396e0\",\n \"catalog\": \"0fc441ec-a52f-4d5d-a36d-c07181c4f65f\",\n \"item_name\": \"Shopping\",\n \"description\": \"Deportes\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/shopping.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"SHOPPING\"\n }\n },\n \"spend_less_limit_amount\": 0,\n \"spend_less_category_id\": null,\n \"deleted_at\": null\n}"}],"_postman_id":"0befc97b-bd75-47a5-8400-b50e53daac82"}],"id":"bec05947-7328-4f1d-aaee-be29caa6d0e3","_postman_id":"bec05947-7328-4f1d-aaee-be29caa6d0e3","description":""}],"id":"97e1b9c3-3ed7-4d2c-b7dd-1195cb73af0e","description":"API Savings
\nPermite gestionar las metas y reglas de ahorro creadas por los usuarios dentro de la plataforma de Xerpa. Está diseñada para integrarse fácilmente en aplicaciones bancarias o financieras, habilitando experiencias personalizadas de ahorro automático.
\nEste conjunto de endpoints permite a las aplicaciones externas:
\n- \n
Realizar operaciones con las metas de ahorro.
\n \nGestiuonar las reglas automáticas de ahorro a cada meta.
\n \nConsultar el estado, el progreso y el historial de movimientos y actividades relacionados con los objetivos del usuario.
\n \n
📌 Casos de uso comunes
\n- \n
Mostrar al usuario un resumen de sus metas activas y progreso acumulado.
\n \nPermitirle crear una nueva meta con condiciones personalizadas.
\n \nRealizar abonos manuales a una meta de ahorro.
\n \nRetirar dinero desde una meta de ahorro.
\n \nImplementar agregar, editar, pausar o elimnar reglas de ahorro como monto fijo, redondeo, placer culpable, etc.
\n \nVer el historial de todos los movimientos de dinero de la meta.
\n \n
\n
🔐 Autenticación requerida
\nTodos los endpoints requieren un User Token válido, ya que cada solicitud se vincula a un usuario específico.
\n\n\nEl token debe enviarse como:
\nAuthorization: Bearer {{user_token}}
\n
🎯 Consideraciones
\n- \n
Cada meta de ahorro pertenece a un usuario específico.
\n \nEs posible tener múltiples metas activas al mismo tiempo.
\n \nLas reglas de ahorro pueden ser editadas o eliminadas por el usuario en cualquier momento.
\n \nSolo se puede obtener el detalle de la información de metas activas.
\n \n
\n
\n
Flujo de Ahorros
\nLos ahorros son los registros que se generan en el módulo de Ahorro Automático por medio de las reglas que el usuario configura y que monitorean eventos de su día a día.
\nEl Ahorro Automático se ejecuta mediante el intercambio de información a nivel de backend entre Xerpa y el banco. Esta información se comparte con el banco a través de un filesystem de xerpa al cual tiene acceso al banco con sus respectivas credenciales.
\nEtapa 0: Cálculo de ahorros
\nPrevio al inicio de cada proceso de ahorro en batch, en xerpa se ejecutan las reglas y se calculan los ahorros pendientes de cada usuario.
Xerpa deposita dos archivos en el filesystem para comenzar el proceso:
- \n
YYYYMMDD_payments.TXT: documento con los ahorros para que el banco ejecute.
\n \nYYYYMMDD_payments.DATA: documento que funciona como bandera para indicar que el archivo de ahorros fue depositado exitosamente.
\n \n
Etapa 1: Ejecución de ahorros
\nEl banco de acuerdo a su horario de ejecución de tareas batch lee el archivo con la información de los ahorros pendientes e inicia el proceso de cargo y abono en las cuentas de los usuarios.
Dentro del archivo y en cada registro se indica la información para cada cargo y abono: usuario, origen, destino y monto.
Estas operaciones son ejecutadas por el banco para luego compartirle a xerpa los resultados de cada una de ellas.
Etapa 2: Respuesta de Ahorros
\nUna vez finalizado el proceso de cargo y abono, se genera un archivo con los resultados de las operaciones y se deposita en el filesystem xerpa.
\nJunto al archivo de resultados, se debe adjuntar un archivo que se utiliza como bandera con el mismo nombre y extensión .data para indicar al filewatcher que el archivo original fue subido exitosamente.
\nEjemplo:
\n- \n
20220501_payments_response.TXT -> Archivo con los resultados de ahorros.
\n \n20220501_payments_response.DATA -> Archivo bandera con contenido vacío.
\n \n
Por parte de xerpa se valida el archivo y si existen errores se retorna un archivo de control con el código de error identificado.
\nSi es válido el archivo se inicia su procesamiento y se deposita un archivo de control indicando los registros recibidos y procesados.
\n\n
Definición de archivos
\nArchivo ahorros pendientes
\nLa primera fila del archivo son las cabeceras de cada columna.
\nLos registros del archivo se consideran desde la fila 2 en adelante.
\nTodos los campos son separados por un pipe \"|\".
\nNombre del archivo de ahorros
\n\n\nEl nombre del archivo incluye la fecha de creación con el formato
\n
YYYY-MM-DD_payments.TXT
- YYYY: Año
- MM: Mes. Si es de 1 a 9 anteponer un 0.
- DD: Día del mes. Si es de 1 a 9 anteponer un 0.
Ejemplo:
2022-05-01_payments.TXT
Ejemplo de archivo de ahorros pendientes
\n2022_05_01_payments.TXT
\npayment_id|user_id|date|from_account_id|to_account_id|amount\n6A6CE368-BD07-C607-8632-382514B325B2|12DF4015-78DA-B7EB-4350-A8160717CC7C|2022-05-01|881586C0-06A4-2403-FF79-BA509A18EB62|31A692C8-353B-ADAA-9540-964266949A94|220,1\n61A41265-5369-3052-BB4F-A870B82070E6|AFEA8C8C-984A-6A1A-3FCF-B43CED325B71|2022-05-02|9416CE14-1E4F-AF4D-7FF5-8048FCE1CD8B|ECA07989-8386-F21E-8592-B4A0E92AD69C|197,76\n4938CBE3-CD95-7069-06C9-754DBD7E69C5|1E49CE42-240D-2BE2-D2D2-E0D4BB374F5D|2022-05-03|038E7C58-D5EB-FE70-400D-05796E58AC97|53F59F1D-62A4-4797-A0C2-4BEBCA668BBB|56,8\n6775C1C4-425B-08CB-B074-68BD249A1271|372A3B0A-8096-5608-DCE1-AA3B7F0CB813|2022-05-04|3407E5CF-E109-4BAB-D666-213E33599C65|3C6CDFCE-05C1-8EF2-D5FD-77566F572788|22,42\n\nArchivo de respuesta de ahorros
\nLa primera fila del archivo son las cabeceras de cada columna.
\nLos registros del archivo se consideran desde la fila 2 en adelante.
\nEjemplo de archivo de respuesta de ahorros
\n2022-05-01_payments_response.TXT
\npayment_id|user_id|date|from_account_id|to_account_id|amount\n6A6CE368-BD07-C607-8632-382514B325B2|12DF4015-78DA-B7EB-4350-A8160717CC7C|2022-05-01|881586C0-06A4-2403-FF79-BA509A18EB62|31A692C8-353B-ADAA-9540-964266949A94|220,1|44682|881586C0-06A4-2403-FF79-BA509A18EB62|200|AHORRO EXITOSO\n61A41265-5369-3052-BB4F-A870B82070E6|AFEA8C8C-984A-6A1A-3FCF-B43CED325B71|2022-05-02|9416CE14-1E4F-AF4D-7FF5-8048FCE1CD8B|ECA07989-8386-F21E-8592-B4A0E92AD69C|197,76|44683|9416CE14-1E4F-AF4D-7FF5-8048FCE1CD8B|100|SIN FONDOS\n4938CBE3-CD95-7069-06C9-754DBD7E69C5|1E49CE42-240D-2BE2-D2D2-E0D4BB374F5D|2022-05-03|038E7C58-D5EB-FE70-400D-05796E58AC97|53F59F1D-62A4-4797-A0C2-4BEBCA668BBB|56,8|44684|038E7C58-D5EB-FE70-400D-05796E58AC97|500|ERROR\n6775C1C4-425B-08CB-B074-68BD249A1271|372A3B0A-8096-5608-DCE1-AA3B7F0CB813|2022-05-04|3407E5CF-E109-4BAB-D666-2\n\nCatálogo de códigos de respuesta
\n- \n
- Saldo de seguridad: En algunas implementaciones se busca que siempre quede en la cuenta de origen del usuario un monto mínimo después de aplicado el ahorro. \n
Ejemplos
\n- \n
Ahorro exitoso:
\n- \n
Saldo cuenta de origen: $15
\n \nMonto a ahorrar: $10
\n \nResultado: ahorro realizado
\n \nCódigo de respuesta: 200
\n \n
\nSaldo insuficiente:
\n- \n
Saldo cuenta de origen: $15
\n \nMonto a ahorrar: $18
\n \nResultado: no se puede realizar el ahorro
\n \nCódigo de respuesta: 100
\n \n
\nError en el proceso:
\n- \n
Si ocurre un error relacionado con el proceso, el usuario, la cuenta de origen o la cuenta de destino
\n \nCódigo de respuesta: 500
\n \n
\nSaldo de seguridad insuficiente:
\n- \n
Saldo de seguridad configurado: $5
\n \nSaldo cuenta de origen: $15
\n \nMonto a ahorrar: $11
\n \nSaldo resultante: $4 (no cumple el mínimo requerido)
\n \nCódigo de respuesta: 300
\n \n
\n
Este endpoint permite obtener las métricas de ingresos y egresos del mes actual y de los últimos cinco meses atras de un usuario en un periodo determinado.
\nWidgets
\n- \n
- Resumen mensual \n
\n
Request
\n- \n
Método**:**
\nGET\nEndpoint**:**{{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/metrics/balance/
\n \nParámetros de ruta:
\n- \n
user_id(string, requerido): ID del usuario. \n
\nParámetros de query:
\n- \n
category(string): ID de la categoria. \n
\n
Request Body
\nEste request de tipo GET no requiere cuerpo.
El cuerpo de la solicitud debe enviarse vacío.
Response
\nLa respuesta será un objeto JSON con las métricas consolidadas del balance financiero del usuario para el periodo consultado. Este entrega una lista de objetos, donde cada objeto representa un año en especifico, incluyendo:
\n- \n
\nyear(number): Año de los ingresos. \n
\nmonths(array of objects): Lista de objetosmonthdonde se incluye el detalle del balance de cada mes:- \n
\nyear(number): Año del balance \n
\nmonth(string): Mes del balance \n
\ndisabled(bool): Indica si esta activado o desactivado el balance \n
\nincomes(number): Total de ingresos \n
\nexpenses(number): Total de gastos \n
\nbalance(number): Balance final del mes \n
\n
Response Format
\n{\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"year\": { \"type\": \"integer\" },\n \"months\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"year\": { \"type\": \"integer\" },\n \"month\": { \"type\": \"string\" },\n \"disabled\": { \"type\": \"boolean\" },\n \"incomes\": { \"type\": \"number\" },\n \"expenses\": { \"type\": \"number\" },\n \"balance\": { \"type\": \"number\" }\n }\n }\n }\n }\n }\n}\n\nEste endpoint permite obtener las métricas agregadas de balance financiero de un usuario en un periodo determinado.
\nWidgets
\n\n\n
Request
\n- \n
Método**:**
\nGET\nEndpoint**:**{{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/metrics/balance/
\n \nParámetros de ruta:
\n- \n
user_id(string, requerido): ID del usuario. \n
\nParámetros de query:
\n- \n
category(string): ID de la categoria. \n
\n
Request Body
\nEste request de tipo GET no requiere cuerpo.
El cuerpo de la solicitud debe enviarse vacío.
Response
\nLa respuesta será un objeto JSON con las métricas consolidadas del balance financiero del usuario para el periodo consultado. Este entrega una lista de objetos, donde cada objeto representa un año en especifico, incluyendo:
\n- \n
\nyear(number): Año de los ingresos. \n
\nmonths(array of objects): Lista de objetosmonthdonde se incluye el detalle del balance de cada mes:- \n
\nyear(number): Año del balance \n
\nmonth(string): Mes del balance \n
\ndisabled(bool): Indica si esta activado o desactivado el balance \n
\nincomes(number): Total de ingresos \n
\nexpenses(number): Total de gastos \n
\nbalance(number): Balance final del mes \n
\n
Response Format
\n{\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"year\": { \"type\": \"integer\" },\n \"months\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"year\": { \"type\": \"integer\" },\n \"month\": { \"type\": \"string\" },\n \"disabled\": { \"type\": \"boolean\" },\n \"incomes\": { \"type\": \"number\" },\n \"expenses\": { \"type\": \"number\" },\n \"balance\": { \"type\": \"number\" }\n }\n }\n }\n }\n }\n}\n\nEste endpoint permite consultar las métricas detalladas de gastos de un usuario en un periodo determinado. Se utiliza para analizar el comportamiento financiero y consumo por categorías.
\nEste endpoint es útil para obtener una visión general de los gastos del usuario y su distribución por categorías, lo que permite un análisis más profundo de sus hábitos de consumo.
\nWidgets
\n\n\n
Request
\n- \n
Método**:**
\nGET\nEndpoint**:** {{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/metrics/expenses/
\n \nParámetros de ruta
\n- \n
user_id(string, requerido): ID del usuario. \n
\nPárametros de query:
\n- \n
date_month(string, opcional): Fecha de consulta. \n
\n
Request Body
\nEste request de tipo GET no requiere cuerpo.
El cuerpo de la solicitud debe enviarse vacío.
Response
\nLa respuesta será un objeto JSON con el resumen de gastos totales y su distribución por categoría.
\n- \n
\nglobal_expenses(number): Total de gastos globales del usuario. \n
\ncategories(array): Lista de objetos que representan las categorías de gasto. Cada objeto de categoría incluye:- \n
\ncategory(object): Detalles de la categoría, que incluye:- \n
\nid(string): Identificador único de la categoría. \n
\ncatalog(string): Catálogo asociado a la categoría. \n
\nitem_name(string): Nombre del ítem en la categoría. \n
\ndescription(string): Descripción de la categoría. \n
\nmetadata(object): Información adicional sobre la categoría, que incluye:- \n
\nicon(string): Icono representativo de la categoría. \n
\nname(string): Nombre de la categoría. \n
\ncolor(string): Color asociado a la categoría. \n
\nactive(boolean): Estado de activación de la categoría. \n
\nshort_name(string): Nombre corto de la categoría. \n
\ncolor_class(string): Clase de color para la categoría. \n
\ndescription(string): Descripción adicional de la categoría. \n
\nicon_ignore(string): Indicador para ignorar el icono. \n
\nicon_primary(string): Icono primario de la categoría. \n
\n
\n
\nbudget(object): Información sobre el presupuesto de la categoría, que incluye:- \n
\nid(string|null): Identificador del presupuesto. \n
\namount(number): Monto del presupuesto. \n
\nbudget_date(string or null): Fecha del presupuesto. \n
\ncategory(string or null): Categoría asociada al presupuesto. \n
\nhas_budget(boolean): Indica si hay un presupuesto asignado. \n
\nbudget_spent(number): Monto gastado del presupuesto. \n
\n
\nexpenses(object): Detalles de los gastos en la categoría, que incluye:- \n
\namount(number): Monto total de gastos en la categoría. \n
\ncount(number): Número de transacciones en la categoría. \n
\n
\npercentage(number): Proporción de gastos de la categoría en relación al total de gastos. \n
\ndisabled(boolean): Indica si la categoría está desactivada. \n
\namount(number): Monto total de gastos en la categoría. \n
\n
Response Format
\n{\n \"type\": \"object\",\n \"properties\": {\n \"global_expenses\": { \"type\": \"number\" },\n \"categories\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"category\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"catalog\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"item_name\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"icon\": { \"type\": \"string\" },\n \"name\": { \"type\": \"string\" },\n \"color\": { \"type\": \"string\" },\n \"active\": { \"type\": \"boolean\" },\n \"short_name\": { \"type\": \"string\" },\n \"color_class\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"icon_ignore\": { \"type\": \"string\" },\n \"icon_primary\": { \"type\": \"string\" }\n }\n }\n }\n },\n \"budget\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": [\"string\", \"null\"], \"format\": \"uuid\" },\n \"amount\": { \"type\": \"number\" },\n \"budget_date\": { \"type\": [\"string\", \"null\"], \"format\": \"date\" },\n \"category\": { \"type\": [\"string\", \"null\"], \"format\": \"uuid\" },\n \"has_budget\": { \"type\": \"boolean\" },\n \"budget_spent\": { \"type\": \"number\" }\n }\n },\n \"expenses\": {\n \"type\": \"object\",\n \"properties\": {\n \"amount\": { \"type\": \"number\" },\n \"count\": { \"type\": \"integer\" }\n }\n },\n \"percentage\": { \"type\": \"number\" },\n \"disabled\": { \"type\": \"boolean\" },\n \"amount\": { \"type\": \"number\" }\n }\n }\n }\n }\n}\n\nDescripción del Endpoint
\nEste endpoint permite consultar un resumen general del comportamiento financiero del usuario durante un periodo. Proporciona métricas clave como ingresos, egresos, balance y actividad, lo que permite a los usuarios obtener una visión clara de su situación financiera.
\n\n
Request
\n- \n
Método:
\nGET\nEndpoint: {{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/metrics/general/
\n \nParámetros de ruta:
\n- \n
user_id(string, requerido): ID del usuario \n
\nParámetros de query: Se agregan al final de la ruta, sirven principalmente para manejar la paginación de la petición. Ejm:
\n/projects/?page=1&page_size=10- \n
\npaginate(boolean, opcional): Indica si se debe paginar la respuesta. Por defecto, se establece entrue. \n
\npage(integer, opcional): Número de la página que se desea recuperar en la respuesta paginada. El valor por defecto es1. \n
\npage_size(integer, opcional): Número de elementos por página en la respuesta paginada. El valor por defecto es1. \n
\n
Request Body
\nEste request de tipo GET no requiere cuerpo.
El cuerpo de la solicitud debe enviarse vacío.
Response
\nLa respuesta será un objeto JSON que contiene un conjunto amplio de métricas financieras agregadas.
\n- \n
\ntotal_spend(number): Total de gastos realizados por el usuario. \n
\namount_count(number): Número total de transacciones registradas. \n
\ncategory(object): Información sobre la categoría de gasto, que incluye:- \n
\nid(string): Identificador único de la categoría. \n
\ncatalog(string): Catálogo de la categoría. \n
\nitem_name(string): Nombre del ítem dentro de la categoría. \n
\ndescription(string): Descripción de la categoría. \n
\nmetadata(object): Metadatos adicionales sobre la categoría, que incluye:- \n
\nbg(string): Color de fondo asociado. \n
\nicon(string): Icono representativo de la categoría. \n
\nname(string): Nombre de la categoría. \n
\ncolor(string): Color representativo de la categoría. \n
\nactive(boolean): Estado de actividad de la categoría. \n
\nshort_name(string): Nombre corto de la categoría. \n
\ncolor_class(string): Clase de color para estilos. \n
\ndescription(string): Descripción adicional. \n
\nicon_ignore(string): Indicador para ignorar el icono. \n
\nicon_primary(string): Icono principal de la categoría. \n
\n
\n
La respuesta también incluye información de paginación, como:
\n- \n
\nnext(string or null): URL de la siguiente página \n
\nprevious(string or null): URL de la página anterior \n
\ntotal_pages(number): Total de páginas disponibles \n
\ncurrent_page(number): Página actual \n
\noffset(number): Índice de desplazamiento \n
\ncount(number): Total de elementos \n
Response Format
\n{\n \"type\": \"object\",\n \"properties\": {\n \"next\": { \"type\": [\"string\", \"null\"] },\n \"previous\": { \"type\": [\"string\", \"null\"] },\n \"total_pages\": { \"type\": \"integer\" },\n \"current_page\": { \"type\": \"integer\" },\n \"offset\": { \"type\": \"integer\" },\n \"count\": { \"type\": \"integer\" },\n \"results\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"total_spend\": { \"type\": \"number\" },\n \"amount_count\": { \"type\": \"number\" },\n \"category\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"catalog\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"item_name\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"bg\": { \"type\": \"string\" },\n \"icon\": { \"type\": \"string\" },\n \"name\": { \"type\": \"string\" },\n \"color\": { \"type\": \"string\" },\n \"active\": { \"type\": \"boolean\" },\n \"short_name\": { \"type\": \"string\" },\n \"color_class\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"icon_ignore\": { \"type\": \"string\" },\n \"icon_primary\": { \"type\": \"string\" }\n }\n }\n }\n }\n }\n }\n }\n }\n}\n\nEste endpoint permite consultar las métricas de ingresos registrados por un usuario en un periodo determinado. Es útil para visualizar patrones de entrada de dinero y realizar comparativas.
\nWidgets
\n\n\n
Request
\n- \n
Método:
\nGET\nEndpoint:
\n{{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/metrics/incomes/\nParámetros de ruta:
\n- \n
user_id(string, requerido): ID del usuario. \n
\nParámetros de query:
\n- \n
date_month(string, requerido): Mes y año para el cual se consultan los ingresos en formatoYYYY-MM. \n
\n
Request Body
\nEste request de tipo GET no requiere cuerpo.
El cuerpo de la solicitud debe enviarse vacío.
Response
\nLa respuesta será un objeto JSON con los datos de ingresos para el usuario.
\nCampos comunes:
\n- \n
\nglobal_incomes(number): Total de ingresos globales del usuario en el mes especificado. \n
\ncategories(array): Lista de categorías de ingresos, donde cada categoría incluye:- \n
\ncategory(object): Detalles de la categoría, que incluye:- \n
\nid(string): Identificador de la categoría. \n
\ncatalog(string): Catálogo al que pertenece la categoría. \n
\nitem_name(string): Nombre del ítem. \n
\ndescription(string): Descripción de la categoría. \n
\nmetadata(object): Metadatos relacionados con la categoría, que incluyen:- \n
\nbg(string): Color de fondo. \n
\nicon(string): Icono asociado. \n
\nname(string): Nombre de la categoría. \n
\ncolor(string): Color de la categoría. \n
\nactive(boolean): Estado de la categoría. \n
\nshort_name(string): Nombre corto de la categoría. \n
\ncolor_class(string): Clase de color. \n
\ndescription(string): Descripción adicional. \n
\nicon_ignore(string): Indicador para ignorar el icono. \n
\nicon_primary(string): Icono principal. \n
\n
\n
\nincomes(object): Detalles de los ingresos en la categoría, que incluyen:- \n
\namount(number): Monto total de ingresos en la categoría. \n
\ncount(number): Número de ingresos registrados en la categoría. \n
\n
\npercentage(number): Porcentaje que representa la categoría sobre el total de ingresos. \n
\ndisabled(boolean): Estado que indica si la categoría está desactivada. \n
\namount(number): Monto total de ingresos en la categoría. \n
\n
Response Format
\n{\n \"type\": \"object\",\n \"properties\": {\n \"global_incomes\": { \"type\": \"number\" },\n \"categories\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"category\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"catalog\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"item_name\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"bg\": { \"type\": \"string\" },\n \"icon\": { \"type\": \"string\" },\n \"name\": { \"type\": \"string\" },\n \"color\": { \"type\": \"string\" },\n \"active\": { \"type\": \"boolean\" },\n \"short_name\": { \"type\": \"string\" },\n \"color_class\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"icon_ignore\": { \"type\": \"string\" },\n \"icon_primary\": { \"type\": \"string\" }\n }\n }\n }\n },\n \"incomes\": {\n \"type\": \"object\",\n \"properties\": {\n \"amount\": { \"type\": \"number\" },\n \"count\": { \"type\": \"integer\" }\n },\n \"required\": [\"amount\", \"count\"]\n },\n \"percentage\": { \"type\": \"number\" },\n \"disabled\": { \"type\": \"boolean\" },\n \"amount\": { \"type\": \"number\" }\n }\n }\n }\n }\n}\n\nEste endpoint permite obtener los datos necesarios para graficar la evolución de gastos fijos y variables de un usuario. Es útil para generar visualizaciones comparativas mensuales o por periodos personalizados.
\nWidgets
\n\n\n
Request
\n- \n
Método:
\nGET\nEndpoint:
\n{{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/metrics/fixed_expenses/\nParámetros de ruta
\n- \n
user_id(string, requerido): ID del usuario para el cual se desean obtener los datos de gastos. \n
\nParámetros de query
\n- \n
date_month(string, requerido): Fecha en formatoYYYY-MMpara la cual se solicitan los datos de gastos fijos y variables. \n
\n
Request Body
\nEste request de tipo GET no requiere cuerpo.
El cuerpo de la solicitud debe enviarse vacío.
Response
\nLa respuesta será un objeto JSON que contiene datos agregados sobre los gastos fijos y variables del usuario.
\n- \n
\nglobal_expenses(number): Total de gastos globales. \n
\nfixed_expenses(object): Detalles sobre los gastos fijos.- \n
\nexpenses(object): Información sobre los gastos fijos.- \n
\namount(number): Monto total de gastos fijos. \n
\ncount(number): Cantidad de gastos fijos registrados. \n
\n
\namount(number): Monto total de gastos fijos. \n
\npercentage(number): Porcentaje de gastos fijos en relación a los gastos totales. \n
\n
\nvariable_expenses(object): Detalles sobre los gastos variables.- \n
\nexpenses(object): Información sobre los gastos variables.- \n
\namount(number): Monto total de gastos variables. \n
\ncount(number): Cantidad de gastos variables registrados. \n
\n
\namount(number): Monto total de gastos variables. \n
\npercentage(number): Porcentaje de gastos variables en relación a los gastos totales. \n
\n
Response Format
\n{\n \"type\": \"object\",\n \"properties\": {\n \"global_expenses\": { \"type\": \"number\" },\n \"fixed_expenses\": {\n \"type\": \"object\",\n \"properties\": {\n \"expenses\": {\n \"type\": \"object\",\n \"properties\": {\n \"amount\": { \"type\": \"number\" },\n \"count\": { \"type\": \"integer\" }\n }\n },\n \"amount\": { \"type\": \"number\" },\n \"percentage\": { \"type\": \"number\" }\n }\n },\n \"variable_expenses\": {\n \"type\": \"object\",\n \"properties\": {\n \"expenses\": {\n \"type\": \"object\",\n \"properties\": {\n \"amount\": { \"type\": \"number\" },\n \"count\": { \"type\": \"integer\" }\n }\n },\n \"amount\": { \"type\": \"number\" },\n \"percentage\": { \"type\": \"number\" }\n }\n }\n }\n}\n\nEste endpoint permite obtener los datos necesarios para graficar la evolución de gastos fijos y variables de un usuario. Es útil para generar visualizaciones comparativas mensuales o por periodos personalizados.
\nWidgets
\n\n\n
Request
\n- \n
Método:
\nGET\nEndpoint:
\n{{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/metrics/fixed_expenses/\nParámetros de ruta
\n- \n
user_id(string, requerido): ID del usuario para el cual se desean obtener los datos de gastos. \n
\nParámetros de query
\n- \n
date_month(string, requerido): Fecha en formatoYYYY-MMpara la cual se solicitan los datos de gastos fijos y variables. \n
\n
Request Body
\nEste request de tipo GET no requiere cuerpo.
El cuerpo de la solicitud debe enviarse vacío.
Response
\nLa respuesta será un objeto JSON que contiene datos agregados sobre los gastos fijos y variables del usuario.
\n- \n
\nglobal_expenses(number): Total de gastos globales. \n
\nfixed_expenses(object): Detalles sobre los gastos fijos.- \n
\nexpenses(object): Información sobre los gastos fijos.- \n
\namount(number): Monto total de gastos fijos. \n
\ncount(number): Cantidad de gastos fijos registrados. \n
\n
\namount(number): Monto total de gastos fijos. \n
\npercentage(number): Porcentaje de gastos fijos en relación a los gastos totales. \n
\n
\nvariable_expenses(object): Detalles sobre los gastos variables.- \n
\nexpenses(object): Información sobre los gastos variables.- \n
\namount(number): Monto total de gastos variables. \n
\ncount(number): Cantidad de gastos variables registrados. \n
\n
\namount(number): Monto total de gastos variables. \n
\npercentage(number): Porcentaje de gastos variables en relación a los gastos totales. \n
\n
Response Format
\n{\n \"type\": \"object\",\n \"properties\": {\n \"global_expenses\": { \"type\": \"number\" },\n \"fixed_expenses\": {\n \"type\": \"object\",\n \"properties\": {\n \"expenses\": {\n \"type\": \"object\",\n \"properties\": {\n \"amount\": { \"type\": \"number\" },\n \"count\": { \"type\": \"integer\" }\n }\n },\n \"amount\": { \"type\": \"number\" },\n \"percentage\": { \"type\": \"number\" }\n }\n },\n \"variable_expenses\": {\n \"type\": \"object\",\n \"properties\": {\n \"expenses\": {\n \"type\": \"object\",\n \"properties\": {\n \"amount\": { \"type\": \"number\" },\n \"count\": { \"type\": \"integer\" }\n }\n },\n \"amount\": { \"type\": \"number\" },\n \"percentage\": { \"type\": \"number\" }\n }\n }\n }\n}\n\n📊 Métricas financieras del usuario
\nLa subcarpeta Metrics dentro de Transactions contiene los endpoints diseñados para obtener indicadores clave del comportamiento financiero del usuario, calculados a partir de sus transacciones registradas. Estas métricas permiten representar de forma agregada la actividad de gasto, ingreso, balance y hábitos financieros, con el objetivo de facilitar análisis, visualizaciones y toma de decisiones.
\nEste módulo funciona como capa analítica del sistema, y está preparado para alimentar dashboards, reportes, alertas inteligentes o recomendaciones personalizadas.
\n\n
📌 Funcionalidades incluidas
\nLos endpoints permiten consultar métricas como:
\n- \n
Balance general: ingresos, egresos y balance neto.
\n \nGasto total y por categoría: distribución, porcentajes y montos.
\n \nIngresos: totales y segmentación por fuente.
\n \nResumen general: actividad, días activos, transacciones.
\n \nComparación fija vs. variable: evolución de tipos de gasto por periodo.
\n \n
\n
📅 Periodos de análisis
\nLa mayoría de los endpoints permiten definir un rango de fechas (start_date, end_date), con lo que es posible construir visualizaciones por semana, mes, trimestre o periodo personalizado.
\n
🧠 Casos de uso
\n- \n
Gráficas de pastel y barras para dashboards.
\n \nSeguimiento de progreso frente a presupuestos.
\n \nAlertas ante cambios inusuales de comportamiento.
\n \nRecomendaciones contextuales basadas en tendencias de gasto o ingreso.
\n \n
\n
🔐 Seguridad
\n- \n
Todos los endpoints requieren autenticación.
\n \nEl
\nuser_iddebe ser validado contra el token autenticado. \n
Este endpoint permite consultar la lista de presupuestos (budgets) creados por un usuario. Se puede usar para visualizar, filtrar y gestionar los presupuestos activos o pasados asociados a sus cuentas.
\n- \n
Este endpoint devuelve todos los presupuestos creados por el usuario autenticado o filtrado.
\n \nEs ideal para construir listados, dashboards financieros o visualizaciones en tiempo real.
\n \nSe puede combinar con los endpoints de detalle y edición para ofrecer una experiencia completa de gestión de presupuestos personales.
\n \n
Widgets
\n\n\n
Request
\n- \n
Endpoint**:** {{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/budgets/
\n \nParámetros de ruta:
\n- \n
user_id(string): ID del usuario asociado al proyecto. \n
\nParámetros de query: Se agregan al final de la ruta, sirven principalmente para manejar la paginación de la petición. Ejm:
\n/projects/?page=1&page_size=10- \n
\npage(number): Número de página para la paginación de resultados. \n
\npage_size(number): Cantidad de resultados que se incluirán por página. \n
\npaginate(bool): Indica si se desea que la respuesta sea paginada o no. \n
\ndate_month(string) (requerido): Indica la fecha de consulta. \n
\n
Request Body
\nEste request de tipo GET no requiere cuerpo.
El cuerpo de la solicitud debe enviarse vacío.
Response
\nLa respuesta será un objeto JSON que incluye un arreglo de presupuestos, con la siguiente estructura:
\n- \n
\nid(string): Identificador único del presupuesto. \n
\nuser_id(string): ID del usuario propietario. \n
\ncategory(string): ID de la categoría asociada. \n
\nstatus(string): ID del estado del presupuesto \n
\namount(number): Monto definido para el presupuesto. \n
\nbugget_date(string): Fecha del presupuesto. \n
La respuesta también incluye información de paginación, como:
\n- \n
\nnext(string or null): URL de la siguiente página \n
\nprevious(string or null): URL de la página anterior \n
\ntotal_pages(number): Total de páginas disponibles \n
\ncurrent_page(number): Página actual \n
\noffset(number): Índice de desplazamiento \n
\ncount(number): Total de elementos \n
\n
Response Format
\n{\n \"type\": \"object\",\n \"properties\": {\n \"next\": {\n \"anyOf\": [\n { \"type\": \"string\", \"format\": \"uri\" },\n { \"type\": \"null\" }\n ]\n },\n \"previous\": {\n \"anyOf\": [\n { \"type\": \"string\", \"format\": \"uri\" },\n { \"type\": \"null\" }\n ]\n },\n \"total_pages\": { \"type\": \"integer\" },\n \"current_page\": { \"type\": \"integer\" },\n \"offset\": { \"type\": \"integer\" },\n \"results\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"user_id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"category\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"status\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"amount\": { \"type\": \"string\" },\n \"budget_date\": { \"type\": \"string\", \"format\": \"date\" }\n }\n }\n },\n \"count\": { \"type\": \"integer\" }\n }\n}\n\nEste endpoint permite registrar un nuevo presupuesto (budget) para un usuario dentro del sistema de finanzas personales (PFM). El presupuesto se asocia a una cuenta, una categoría de gasto, un monto y un rango de fechas.
\n- \n
El presupuesto se puede crear solo para el mes actual, pero no se deben solapar fechas para la misma categoría y cuenta.
\n \nNo se pueden crear presupuestos para meses pasados.
\n \nLos montos deben expresarse en la moneda estándar del sistema (por ejemplo, pesos o centavos, según la configuración).
\n \nEste endpoint se usa comúnmente como parte del onboarding o configuraciones mensuales del usuario.
\n \nExiste un proceso autimático que persiste los presupuestos de un mes al siguiente.
\n \n
Widget
\n\n\n
Request
\n- \n
Método:
\nPOST\nEndpoint: {{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/budgets/
\n \nParámetros de ruta:
\n- \n
user_id(string): ID del usuario asociado al proyecto. \n
\n
Request Body
\n- \n
\ncategory(string): ID de la categoria asociada. \n
\nstatus(string): ID del estado del presupuesto. \n
\namount(number): Monto total asignado al presupuesto. \n
\nbudget_date(string): Fecha del presupuesto. Esta tiene que coincidir con el año y mes de la fecha de consulta. \n
Request Body Example
\n{\n \"category\": \"category_id\",\n \"status\": \"status_id\",\n \"amount\": \"500\",\n \"budget_date\": \"2030-10-12\"\n}\n\n\n
Response
\nLa respuesta será un objeto JSON con los datos del presupuesto recién creado:
\n- \n
\nid(string): Identificador único del presupuesto. \n
\nuser_id(string): ID del usuario propietario. \n
\ncategory(string): ID de la categoría asociada. \n
\nstatus(string): ID del estado del presupuesto \n
\namount(number): Monto definido para el presupuesto. \n
\nbugget_date(string): Fecha del presupuesto. \n
\n
Response Format
\n{\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"user_id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"category\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"status\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"amount\": { \"type\": \"string\" },\n \"budget_date\": { \"type\": \"string\", \"format\": \"date\" }\n }\n}\n\nEste endpoint permite consultar el detalle de un presupuesto específico utilizando su identificador único (budget_id).
Widget
\n\n\n
Request
\n- \n
Método:
\nGET\nEndpoint: {{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/budgets/{{budget_id}}/
\n \nParámetro de ruta:
\n- \n
\nuser_id(string): ID del usuario \n
\nbudget_id(string): ID del presupuesto a consultar. \n
\n
Request Body
\nEste request de tipo GET no requiere cuerpo.
El cuerpo de la solicitud debe enviarse vacío.
Response
\nLa respuesta será un objeto JSON con los datos completos del presupuesto.
\n- \n
\nid(string): Identificador único del presupuesto. \n
\nuser_id(string): ID del usuario propietario. \n
\ncategory(string): ID de la categoría asociada. \n
\nstatus(string): ID del estado del presupuesto \n
\namount(number): Monto definido para el presupuesto. \n
\nbugget_date(string): Fecha del presupuesto. \n
Response Format
\n{\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"user_id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"category\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"status\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"amount\": { \"type\": \"string\" },\n \"budget_date\": { \"type\": \"string\", \"format\": \"date\" }\n }\n}\n\nEste endpoint permite editar por completo un presupuesto existente, sobrescribiendo todos sus valores.
\nWidgets
\n\n\n
Request
\n- \n
Método:
\nPUT\nEndpoint:
\n{{host_app}}/api-pfm/v1/pfm-service/budgets/{{budget_id}}/\nParámetro de ruta:
\n- \n
budget_id(string): ID del presupuesto que se desea modificar. \n
\nCuerpo de la solicitud: Requiere un objeto JSON con todos los campos obligatorios del presupuesto.
\n \n
Campos requeridos:
\n- \n
\nuser_id(string): ID del usuario. \n
\naccount_id(string): ID de la cuenta asociada. \n
\namount(number): Nuevo monto asignado al presupuesto. \n
\nstart_date(string): Nueva fecha de inicio (YYYY-MM-DD). \n
\nend_date(string): Nueva fecha de fin (YYYY-MM-DD). \n
\nspending_category_id(string): ID de la categoría de gasto. \n
Ejemplo:
\n{\n \"user_id\": \"71a44b8d-c82e-4c33-870f-fc82b31f6705\",\n \"account_id\": \"b22283a1-093f-4cb1-b4e4-bbce6d97a0ee\",\n \"amount\": 250000,\n \"start_date\": \"2024-02-01\",\n \"end_date\": \"2024-02-29\",\n \"spending_category_id\": \"fc0fa15f-d84d-4dd9-84a6-c610aabf0165\"\n}\n\n\n
Response
\nLa respuesta será un objeto JSON con los datos actualizados del presupuesto.
\nCampos incluidos:
\n- \n
\nid,user_id,account_id,spending_category_id: Identificadores del presupuesto y sus entidades relacionadas. \n
\namount: Nuevo monto actualizado. \n
\nstart_date,end_date: Nuevas fechas del periodo presupuestal. \n
\nstatus: Estado del presupuesto. \n
\ncreated_at,updated_at: Timestamps de creación y última modificación. \n
\n
Consideraciones
\n- \n
Solo se pueden editar presupuestos del mes en curso o futuros.
\n \nNo se permite editar presupuestos de meses pasados.
\n \n
Este endpoint permite modificar parcialmente un presupuesto existente, actualizando únicamente los campos incluidos en la solicitud.
\n\n
Request
\n- \n
Método:
\nPATCH\nEndpoint: {{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/budgets/{{budget_id}}/
\n \nParámetros de ruta:
\n- \n
\nuser_id(string): ID del usuario. \n
\nbudget_id(string): ID del presupuesto a actualizar. \n
\n
Request Body
\n- \n
\ncategory(string) (opcional): ID de la categoría asociada. \n
\nstatus(string) (opcional): ID del estado del presupuesto \n
\namount(number) (opcional): Monto definido para el presupuesto. \n
\nbugget_date(string) (opcional): Fecha del presupuesto. Tiene que ser en el formato AAAA-MM-DD \n
Request Body Example
\n{\n \"category\":\"category_id\",\n \"status\":\"status_id\",\n \"amount\": 10,\n \"budget_date\":\"2025-06-04\"\n}\n\n\n
Response
\nLa respuesta será un objeto JSON con el presupuesto actualizado, incluyendo todos sus campos, aunque solo se haya modificado uno o varios.
\n- \n
\nid(string): Identificador único del presupuesto. \n
\nuser_id(string): ID del usuario propietario. \n
\ncategory(string): ID de la categoría asociada. \n
\nstatus(string): ID del estado del presupuesto \n
\namount(number): Monto definido para el presupuesto. \n
\nbugget_date(string): Fecha del presupuesto. \n
\n
Response Format
\n{\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"user_id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"category\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"status\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"amount\": { \"type\": \"string\" },\n \"budget_date\": { \"type\": \"string\", \"format\": \"date\" }\n }\n}\n\nEste endpoint permite eliminar un presupuesto específico del sistema utilizando su identificador único. Solo es posible eliminar un presupuesto del mes actual.
\nWidget
\n\n\n
Request
\n- \n
Método:
\nDELETE\nEndpoint: {{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/budgets/{{delete_budget_id}}/
\n \nParámetro de ruta:
\n- \n
\nuser_id(string): ID del usuario \n
\nbudget_id(string): ID del presupuesto que se desea eliminar. \n
\n
Request Body
\nEste request de tipo POST no requiere cuerpo.
El cuerpo de la solicitud debe enviarse vacío.
Response
\nLa respuesta será un objeto JSON vacio, confirmando la correcta eliminacion del presupuesto.
\n","urlObject":{"path":["api-pfm","v1","pfm-service","users","{{user_id}}","budgets","{{budget_id}}",""],"host":["{{host_app}}"],"query":[],"variable":[]}},"response":[{"id":"9c0944e8-ac97-48b7-8d40-e82d3bf58f1e","name":"Successful Response","originalRequest":{"method":"DELETE","header":[],"url":"{{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/budgets/{{budget_id}}/"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 04 Jun 2025 15:52:02 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"f4ca03e5-084a-4e78-a459-e17765f833ed"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LpXBfGdOIAMEuPQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-68406ba2-65f1e2917a1531295678869a;Parent=0880ee30da4bcfab;Sampled=0;Lineage=1:e7de7122:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":null},{"id":"1fa7658e-92f7-4daf-bc29-91179775d845","name":"Bad Request - Already deleted","originalRequest":{"method":"DELETE","header":[],"url":"{{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/budgets/{{budget_id}}/"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 04 Jun 2025 15:54:07 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ab89196d-cb09-4315-936f-2bfa858e5cd0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LpXU6E9aoAMETaw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-68406c1f-301632131f1d2bf4455a7537;Parent=0e372748f10bd7e2;Sampled=0;Lineage=1:e7de7122:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"df4f2554-1a54-4e17-b734-2db0d7426373"}],"id":"6a4b1546-19fe-4462-a1c6-d75137a46e49","description":"💸Gestión de presupuestos personales
\nLa carpeta Budgets contiene todos los endpoints necesarios para la creación, consulta, edición y eliminación de presupuestos definidos por el usuario. Estos presupuestos permiten establecer límites de gasto por categoría, cuenta y periodo, ayudando al usuario a tener mayor control sobre sus finanzas personales.
\nEl módulo de presupuestos es una pieza clave dentro del sistema PFM, ya que complementa la visualización de hábitos financieros con acciones concretas de planificación y control.
\n\n
📌 Funcionalidades incluidas
\nLos endpoints disponibles permiten:
\n- \n
Crear nuevos presupuestos personalizados.
\n \nConsultar el detalle o listado de presupuestos existentes.
\n \nEditar presupuestos de forma total (
\nPUT) o parcial (PATCH). \nEliminar presupuestos que ya no están en uso.
\n \n
Cada presupuesto puede estar asociado a:
\n- \n
Un usuario (
\nuser_id). \nUna cuenta bancaria (
\naccount_id). \nUna categoría de gasto (
\nspending_category_id). \nUn periodo de tiempo (
\nstart_date,end_date). \nUn monto objetivo (
\namount). \n
\n
🧠 Consideraciones
\n- \n
Los presupuestos pueden superponerse en fechas solo si pertenecen a diferentes categorías.
\n \nEl sistema permite realizar seguimiento del cumplimiento de cada presupuesto mediante otros endpoints de métricas.
\n \nEs posible utilizar estos endpoints como parte del flujo de onboarding o de recordatorios inteligentes para establecer límites de gasto.
\n \nLos campos
\nstatusyupdated_atpermiten saber si un presupuesto está activo y cuándo fue modificado por última vez. \n
\n
🔐 Seguridad
\n- \n
Todos los endpoints requieren autenticación vía token.
\n \nLas acciones de edición o eliminación pueden estar restringidas a usuarios propietarios o administradores del sistema.
\n \n
Este endpoint permite crear una nueva nota asociada a una transacción específica.
\nWidgets
\n- \n
- Crear nota \n
\n
Request
\n- \n
Método**:**
\nPOST\nEndpoint**:**
\n{{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/transactions/{{transaccion_id}}/transaction-note/\nParámetros de ruta:
\n- \n
user_id(string): ID del usuario asociado al proyecto. \n
\n
Request Body
\n- \n
- transaction_note (string): La nota que se desea asociar a la transacción. \n
Request Body Example
\n{\n \"transaction_note\": \"Nota_eos-eum-voluptas\"\n}\n\nResponse
\nLa respuesta incluye un JSON que contiene los siguientes campos:
\n- \n
\nid(string): Identificador único de la nota creada. \n
\nuser_id(string): Identificador del usuario asociado a la nota. \n
\nupdated_at(string): Marca de tiempo de la última actualización de la nota. \n
\ntransaction(string):: Identificador de la transacción a la que se asocia la nota. \n
\ntransaction_date(string):: Fecha de la transacción. \n
\ntransaction_note(string): Contenido de la nota creada. \n
Response Format
\n{\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"user_id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"updated_at\": { \"type\": \"string\", \"format\": \"date-time\" },\n \"transaction\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"transaction_date\": { \"type\": \"string\", \"format\": \"date\" },\n \"transaction_note\": { \"type\": \"string\" }\n }\n}\n\nEste endpoint permite obtener información sobre las notas de transacciones asociadas a un usuario específico.
\nWidgets
\n\n\n
Request
\n- \n
Método**:**
\nGET\nEndpoint**:**
\n{{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/transactions/{{transaccion_id}}/transaction-note/\nParámetros de ruta:
\n- \n
\nuser_id(string): ID del usuario asociado a la transacción. \n
\ntransaccion_id(string): ID de la transacción para la cual se desea obtener la nota. \n
\n
Request Body
\nEste request de tipo GET no requiere cuerpo. El cuerpo de la solicitud debe enviarse vacío.
Response
\nLa respuesta incluye un JSON que contiene los siguientes campos:
\n- \n
\nid(string): Identificador único de la nota creada. \n
\nuser_id(string): Identificador del usuario asociado a la nota. \n
\nupdated_at(string): Marca de tiempo de la última actualización de la nota. \n
\ntransaction(string): Identificador de la transacción a la que se asocia la nota. \n
\ntransaction_date(string): Fecha de la transacción. \n
\ntransaction_note(string): Contenido de la nota creada. \n
Response Format
\n{\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"user_id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"updated_at\": { \"type\": \"string\", \"format\": \"date-time\" },\n \"transaction\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"transaction_date\": { \"type\": \"string\", \"format\": \"date\" },\n \"transaction_note\": { \"type\": \"string\" }\n }\n}\n\nEste endpoint permite editar completamente la nota de una transacción existente mediante una solicitud HTTP PUT. A continuación se detallan los parámetros y el formato esperado de la respuesta.
\nWidgets
\n\n\n
Request
\n- \n
Método**:**
\nPUT\nEndpoint**:** {{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/transactions/{{transaccion_id}}/transaction-note/{{transaction_note_id}}/
\n \nParámetros de ruta:
\n- \n
\nuser_id(string): ID del usuario asociado. \n
\ntransaction_id(string): ID de la transacción. \n
\n
Request Body
\n- \n
transaction_note(string): Nota de la transacción que se desea actualizar. \n
Request Body Example
\n{\n \"transaction_note\": \"Nota_corrupti-doloribus-doloribus\"\n}\n\nResponse
\nLa respuesta de una solicitud exitosa devolverá un objeto JSON que contiene la información de la transacción actualizada, incluyendo:
\n- \n
\nid(string): Identificador único de la nota creada. \n
\nuser_id(string): Identificador del usuario asociado a la nota. \n
\nupdated_at(string): Marca de tiempo de la última actualización de la nota. \n
\ntransaction(string):: Identificador de la transacción a la que se asocia la nota. \n
\ntransaction_date(string):: Fecha de la transacción. \n
\ntransaction_note(string): Contenido de la nota creada. \n
Response Format
\n{\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"user_id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"updated_at\": { \"type\": \"string\", \"format\": \"date-time\" },\n \"transaction\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"transaction_date\": { \"type\": \"string\", \"format\": \"date\" },\n \"transaction_note\": { \"type\": \"string\" }\n }\n}\n\nPermite editar parcialmente la nota de una transacción, útil si solo deseas modificar un campo sin sobrescribir otros.
\nWidgets
\n- \n
- Editar nota \n
\n
Request
\n- \n
Método:
\nPATCH\nEndpoint: {{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/transactions/{{transaccion_id}}/transaction-note/{{transaction_note_id}}
\n \nParámetros de ruta:
\n- \n
\nuser_id(string): ID del usuario asociado. \n
\ntransaction_id(string): ID de la transacción. \n
\n
Request Body
\n- \n
- transaction_note (string): La nueva nota de la transacción que deseas establecer. Este campo es obligatorio. \n
Request Body Example
\n{\n \"transaction_note\": \"Nota_ipsum-placeat-ex\"\n}\n\nResponse
\nLa respuesta de una solicitud exitosa devolverá un objeto JSON que contiene la información de la transacción actualizada, incluyendo:
\n- \n
\nid(string): Identificador único de la nota creada. \n
\nuser_id(string): Identificador del usuario asociado a la nota. \n
\nupdated_at(string): Marca de tiempo de la última actualización de la nota. \n
\ntransaction(string):: Identificador de la transacción a la que se asocia la nota. \n
\ntransaction_date(string):: Fecha de la transacción. \n
\ntransaction_note(string): Contenido de la nota creada. \n
Response Format
\n{\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"user_id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"updated_at\": { \"type\": \"string\", \"format\": \"date-time\" },\n \"transaction\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"transaction_date\": { \"type\": \"string\", \"format\": \"date\" },\n \"transaction_note\": { \"type\": \"string\" }\n }\n}\n\n📝 Notas personalizadas en transacciones
\nLa subcarpeta Transacción Nota contiene los endpoints que permiten a los usuarios agregar, editar o consultar notas personalizadas asociadas a sus transacciones. Estas notas permiten capturar contexto adicional, intenciones del gasto, recordatorios personales o justificaciones que no se reflejan directamente en la descripción original de la transacción.
\nEste módulo mejora la experiencia del usuario al ofrecer una capa de personalización y seguimiento cualitativo sobre sus movimientos financieros.
\n\n
📌 Funcionalidades incluidas
\nLos endpoints permiten:
\n- \n
Crear una nueva nota asociada a una transacción existente.
\n \nEditar completamente una nota registrada (
\nPUT). \nRealizar ediciones parciales de la nota (
\nPATCH). \nConsultar la nota actual de una transacción determinada.
\n \n
\n
🧠 Casos de uso
\n- \n
Registrar el motivo detrás de un gasto puntual.
\n \nDocumentar gastos compartidos, reembolsables o de negocio.
\n \nUsar notas como etiquetas personales o comentarios libres.
\n \nAyudar al usuario a recordar gastos atípicos o no recurrentes.
\n \n
\n
🧩 Consideraciones técnicas
\n- \n
Las notas son almacenadas como texto libre.
\n \nEstán asociadas directamente a un
\ntransaction_id. \nSe pueden sobrescribir o editar parcialmente sin afectar el resto de la transacción.
\n \nEl historial de cambios de notas no se conserva (último estado).
\n \n
\n
🔐 Seguridad
\n- \n
Solo el usuario propietario de la transacción puede agregar o modificar notas.
\n \nTodos los endpoints requieren autenticación válida mediante token.
\n \n
Este endpoint permite consultar el detalle de una transacción específica registrada por un usuario, utilizando su identificador único.
\nWidget
\n\n\n
Request
\n- \n
Método:
\nGET\nEndpoint:
\n{{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/transactions/{{transaccion_id}}/\nParámetros de ruta:
\n- \n
\nuser_id(string): ID del usuario propietario de la transacción. \n
\ntransaccion_id(string): ID de la transacción que se desea consultar. \n
\n
Request Body
\nEste request de tipo GET no requiere cuerpo.
El cuerpo de la solicitud debe enviarse vacío.
Response
\nLa respuesta será un objeto JSON que contiene todos los detalles de la transacción.
\n- \n
\nid(string): ID único de la transacción. \n
\nignore_pfm(boolean): Indica si la transacción debe ser ignorada por el PFM. \n
\nexternal_id(string): ID externo asociado a la transacción. \n
\nuser_id(string): ID del usuario propietario. \n
\ntransaction_date(string): Fecha de ocurrencia de la transacción. \n
\ntransaction_datetime(string): Fecha y hora de la transacción. \n
\namount(number): Monto de la transacción. \n
\ndescription(string): Descripción o concepto registrado. \n
\ncategory(string): Categoría asignada a la transacción. \n
\nuser_note(string|null): Nota del usuario sobre la transacción. \n
\nproduct_type(object): Detalles del tipo de producto, incluyendo:- \n
\nid(string): ID del tipo de producto. \n
\ncatalog(string): Catálogo del producto. \n
\nitem_name(string): Nombre del artículo. \n
\ndescription(string): Descripción del producto. \n
\nmetadata(object): Información adicional del producto, incluyendo:- \n
\nicon(string): Icono del producto. \n
\ncolor(string): Color del producto. \n
\nactive(boolean): Estado de actividad del producto. \n
\nshort_name(string): Nombre corto del producto. \n
\n
\n
\nexchange_rate(number|null): Tasa de cambio aplicable. \n
\nmerchant(object|null): Información del comerciante asociado. \n
\naccount_id(string): ID de la cuenta asociada a la transacción. \n
\ntransaction_note(object|null): Nota de la transacción, que incluye:- \n
\nid(string): ID de la nota. \n
\nuser_id(string): ID del usuario que creó la nota. \n
\nupdated_at(string): Timestamp de la última actualización. \n
\ntransaction(string): ID de la transacción relacionada. \n
\ntransaction_date(string): Fecha de la transacción relacionada. \n
\ntransaction_note(string): Contenido de la nota de la transacción. \n
\n
\nclassified(boolean): Indica si la transacción ha sido clasificada. \n
\nattributes(object): Atributos adicionales de la transacción. \n
\ntags(array): Lista de etiquetas asociadas a la transacción. \n
Response Format
\n{\n \"type\": \"object\",\n \"properties\": {\n \"next\": { \"type\": [\"string\", \"null\"], \"format\": \"uri\" },\n \"previous\": { \"type\": [\"string\", \"null\"], \"format\": \"uri\" },\n \"total_pages\": { \"type\": \"integer\", \"minimum\": 1 },\n \"current_page\": { \"type\": \"integer\", \"minimum\": 1 },\n \"offset\": { \"type\": \"integer\", \"minimum\": 0 },\n \"results\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"ignore_pfm\": { \"type\": \"boolean\" },\n \"external_id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"user_id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"transaction_date\": { \"type\": \"string\", \"format\": \"date\" },\n \"transaction_datetime\": { \"type\": \"string\", \"format\": \"date-time\" },\n \"amount\": {\"type\": \"string\",},\n \"description\": { \"type\": \"string\" },\n \"category\": {\n \"type\": [\"string\", \"object\"]\n },\n \"user_note\": { \"type\": [\"string\", \"null\"] },\n \"product_type\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"catalog\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"item_name\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"icon\": { \"type\": \"string\", \"format\": \"uri\" },\n \"color\": {\"type\": \"string\",},\n \"active\": { \"type\": \"boolean\" },\n \"short_name\": { \"type\": \"string\" }\n }\n }\n }\n \"exchange_rate\": { \"type\": [\"object\", \"null\"] },\n \"merchant\": { \"type\": [\"object\", \"null\"] },\n \"account_id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"transaction_note\": {\n \"type\": [\"object\", \"null\"],\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"user_id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"updated_at\": { \"type\": \"string\", \"format\": \"date-time\" },\n \"transaction\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"transaction_date\": { \"type\": \"string\", \"format\": \"date\" },\n \"transaction_note\": { \"type\": \"string\" }\n }\n },\n \"classified\": { \"type\": \"boolean\" },\n \"attributes\": { \"type\": \"object\" },\n \"tags\": {\n \"type\": \"array\",\n \"items\": {}\n }\n }\n }\n }\n }\n}\n\nEste endpoint permite cambiar el estado de ignorar de la transacción para que sea o no considerada dentro de las métricas y análisis del PFM.
\nUna transacción ignorada no será considerada para:
\n- \n
Cálculo de métricas generales
\n \nCálculo de métricas por categoría
\n \nPresupuestos
\n \n
Si se presentan en los listados de movimientos.
\nWidget
\n\n\n
Request
\n- \n
Método:
\nPATCH\nEndpoint:
\n{{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/transactions/{{transaccion_id}}/\nParámetro de ruta:
\n- \n
\nuser_id(string): ID del usuario que posee la transacción. \n
\ntransaccion_id(string): ID de la transacción que se desea modificar. \n
\n
Request Body
\n- \n
ignore_pfm(boolean): Indica si se debe ignorar el PFM, \n
{\n \"ignore_pfm\": false\n}\n\n\n
Response
\nLa respuesta será un objeto JSON que contiene los detalles actualizados de la transacción, reflejando el cambio en su categoría.
\n- \n
\nid(string): ID de la transacción. \n
\nignore_pfm(boolean): Estado actualizado de la opción de ignorar PFM. \n
\nexternal_id(string): ID externo de la transacción. \n
\nuser_id(string): ID del usuario asociado a la transacción. \n
\ntransaction_date(string): Fecha de la transacción. \n
\ntransaction_datetime(string): Fecha y hora de la transacción. \n
\namount(string): Monto de la transacción. \n
\ndescription(string): Descripción de la transacción. \n
\ncategory(string): ID de la nueva categoría asignada. \n
\nuser_note(string|null): Nota del usuario, si existe. \n
\nproduct_type(object): Detalles del tipo de producto asociado a la transacción. \n
\nexchange_rate(string|null): Tasa de cambio, si aplica. \n
\nmerchant(string|null): Información del comerciante, si aplica. \n
\naccount_id(string): ID de la cuenta asociada. \n
\ntransaction_note(object|null): Nota de la transacción, si existe. \n
\nclassified(boolean): Indica si la transacción ha sido clasificada. \n
\nattributes(object): Atributos adicionales, si existen. \n
\ntags(array): Etiquetas asociadas a la transacción. \n
Response Format
\n{\n \"id\": \"49178c5c-0d30-4dae-acd0-a6dce37fc8e4\",\n \"ignore_pfm\": true,\n \"external_id\": \"5dd0400f-2e0b-4e0c-abbb-9517811d3fb4\",\n \"user_id\": \"7a1cb76c-9af3-4557-bc6c-f56f9ee8ef8e\",\n \"transaction_date\": \"2024-09-20\",\n \"transaction_datetime\": \"2024-09-20T00:00:00+0000\",\n \"amount\": \"545000.00\",\n \"description\": \"PAGO AGUINALDO 2024\",\n \"category\": \"22118f55-e6a9-46b0-ae8f-a063dda396e0\",\n \"user_note\": null,\n \"product_type\": {\n \"id\": \"e480d1b0-cb8e-448c-9864-ed7ae4ce20b3\",\n \"catalog\": \"f1895069-e723-4cc8-9331-d1cb4110ab7a\",\n \"item_name\": \"cuenta_vista\",\n \"description\": \"Cuenta Vista\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/cuenta_vista.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"CUENTAVISTA\"\n }\n },\n \"exchange_rate\": null,\n \"merchant\": null,\n \"account_id\": \"5c7ddeb7-bb96-4ada-9745-3b97407634a1\",\n \"transaction_note\": {\n \"id\": \"6ecbfe95-96bd-4941-9220-1be8dcf50994\",\n \"user_id\": \"61a85f1f-98aa-4dcd-837d-84cf54bb532a\",\n \"updated_at\": \"2025-06-04T19:55:01+0000\",\n \"transaction\": \"49178c5c-0d30-4dae-acd0-a6dce37fc8e4\",\n \"transaction_date\": \"2024-08-05\",\n \"transaction_note\": \"Nota_iusto-eaque-repellat\"\n },\n \"classified\": true,\n \"attributes\": {},\n \"tags\": []\n}\n\nEste endpoint permite actualizar parcialmente la categoría de una transacción específica, sin modificar otros atributos.
\nWidget
\n\n\n
Request
\n- \n
Método:
\nPATCH\nEndpoint:
\n{{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/transactions/{{transaccion_id}}/\nParámetro de ruta:
\n- \n
\nuser_id(string): ID del usuario que posee la transacción. \n
\ntransaccion_id(string): ID de la transacción que se desea modificar. \n
\n
Request Body
\n- \n
\n\ncategory(string): ID de la nueva categoría a asignar a la transacción. Se debe validar si la transacción es de ingreso o de egreso para enviar uncategory_idde acuerdo al catálogo correspondiente. \n
{\n \"category\": \"category_id\"\n}\n\n\n
Response
\nLa respuesta será un objeto JSON que contiene los detalles actualizados de la transacción, reflejando el cambio en su categoría.
\n- \n
\nid(string): ID de la transacción. \n
\nignore_pfm(boolean): Estado actualizado de la opción de ignorar PFM. \n
\nexternal_id(string): ID externo de la transacción. \n
\nuser_id(string): ID del usuario asociado a la transacción. \n
\ntransaction_date(string): Fecha de la transacción. \n
\ntransaction_datetime(string): Fecha y hora de la transacción. \n
\namount(string): Monto de la transacción. \n
\ndescription(string): Descripción de la transacción. \n
\ncategory(string): ID de la nueva categoría asignada. \n
\nuser_note(string|null): Nota del usuario, si existe. \n
\nproduct_type(object): Detalles del tipo de producto asociado a la transacción. \n
\nexchange_rate(string|null): Tasa de cambio, si aplica. \n
\nmerchant(string|null): Información del comerciante, si aplica. \n
\naccount_id(string): ID de la cuenta asociada. \n
\ntransaction_note(object|null): Nota de la transacción, si existe. \n
\nclassified(boolean): Indica si la transacción ha sido clasificada. \n
\nattributes(object): Atributos adicionales, si existen. \n
\ntags(array): Etiquetas asociadas a la transacción. \n
Response Format
\n{\n \"id\": \"49178c5c-0d30-4dae-acd0-a6dce37fc8e4\",\n \"ignore_pfm\": true,\n \"external_id\": \"5dd0400f-2e0b-4e0c-abbb-9517811d3fb4\",\n \"user_id\": \"7a1cb76c-9af3-4557-bc6c-f56f9ee8ef8e\",\n \"transaction_date\": \"2024-09-20\",\n \"transaction_datetime\": \"2024-09-20T00:00:00+0000\",\n \"amount\": \"545000.00\",\n \"description\": \"PAGO AGUINALDO 2024\",\n \"category\": \"22118f55-e6a9-46b0-ae8f-a063dda396e0\",\n \"user_note\": null,\n \"product_type\": {\n \"id\": \"e480d1b0-cb8e-448c-9864-ed7ae4ce20b3\",\n \"catalog\": \"f1895069-e723-4cc8-9331-d1cb4110ab7a\",\n \"item_name\": \"cuenta_vista\",\n \"description\": \"Cuenta Vista\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/cuenta_vista.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"CUENTAVISTA\"\n }\n },\n \"exchange_rate\": null,\n \"merchant\": null,\n \"account_id\": \"5c7ddeb7-bb96-4ada-9745-3b97407634a1\",\n \"transaction_note\": {\n \"id\": \"6ecbfe95-96bd-4941-9220-1be8dcf50994\",\n \"user_id\": \"61a85f1f-98aa-4dcd-837d-84cf54bb532a\",\n \"updated_at\": \"2025-06-04T19:55:01+0000\",\n \"transaction\": \"49178c5c-0d30-4dae-acd0-a6dce37fc8e4\",\n \"transaction_date\": \"2024-08-05\",\n \"transaction_note\": \"Nota_iusto-eaque-repellat\"\n },\n \"classified\": true,\n \"attributes\": {},\n \"tags\": []\n}\n\nEste endpoint permite editar una transacción para asignarle la categoría \"ignorar\", de modo que quede fuera de los cálculos financieros y reportes del sistema.
\nRequest
\n- \n
Método:
\nPUT\nEndpoint:
\n{{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/transactions/{{transaccion_id}}/\nParámetros de ruta:
\n- \n
\nuser_id(string): ID del usuario al que pertenece la transacción. \n
\ntransaccion_id(string): ID de la transacción que se desea actualizar. \n
\n
Request Body
\nSe requiere un cuerpo en formato JSON con los siguientes parámetros:
\n- \n
\nignore_pfm(boolean): Indica si la transacción debe ser ignorada en los cálculos financieros. \n
\ncategory(string): ID de la categoría que se desea asignar a la transacción. \n
Request Body Example
\n{\n \"ignore_pfm\": true,\n \"category\": \"category_id\"\n}\n\nResponse
\nLa respuesta será un objeto JSON que representa la transacción actualizada, con la categoría modificada a “ignorada”.
\n- \n
\nid(string): ID de la transacción. \n
\nignore_pfm(boolean): Indica si la transacción está marcada para ser ignorada. \n
\nexternal_id(string): ID externo asociado a la transacción. \n
\nuser_id(string): ID del usuario que realizó la transacción. \n
\ntransaction_date(string): Fecha de la transacción. \n
\ntransaction_datetime(string): Fecha y hora de la transacción. \n
\namount(string): Monto de la transacción. \n
\ndescription(string): Descripción de la transacción. \n
\ncategory(string): Nueva categoría asignada (correspondiente a \"ignorar\"). \n
\nuser_note(null): Nota del usuario, si aplica. \n
\nproduct_type(object): Detalles del tipo de producto asociado a la transacción. \n
\nexchange_rate(null): Tasa de cambio, si aplica. \n
\nmerchant(null): Información del comerciante, si aplica. \n
\naccount_id(string): ID de la cuenta asociada a la transacción. \n
\ntransaction_note(object): Nota de la transacción, si aplica. \n
\nclassified(boolean): Indica si la transacción ha sido clasificada. \n
\nattributes(object): Atributos adicionales, si aplica. \n
\ntags(array): Etiquetas asociadas a la transacción. \n
Response Format
\n{\n \"id\": \"49178c5c-0d30-4dae-acd0-a6dce37fc8e4\",\n \"ignore_pfm\": true,\n \"external_id\": \"5dd0400f-2e0b-4e0c-abbb-9517811d3fb4\",\n \"user_id\": \"7a1cb76c-9af3-4557-bc6c-f56f9ee8ef8e\",\n \"transaction_date\": \"2024-09-20\",\n \"transaction_datetime\": \"2024-09-20T00:00:00+0000\",\n \"amount\": \"545000.00\",\n \"description\": \"PAGO AGUINALDO 2024\",\n \"category\": \"22118f55-e6a9-46b0-ae8f-a063dda396e0\",\n \"user_note\": null,\n \"product_type\": {\n \"id\": \"e480d1b0-cb8e-448c-9864-ed7ae4ce20b3\",\n \"catalog\": \"f1895069-e723-4cc8-9331-d1cb4110ab7a\",\n \"item_name\": \"cuenta_vista\",\n \"description\": \"Cuenta Vista\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/cuenta_vista.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"CUENTAVISTA\"\n }\n },\n \"exchange_rate\": null,\n \"merchant\": null,\n \"account_id\": \"5c7ddeb7-bb96-4ada-9745-3b97407634a1\",\n \"transaction_note\": {\n \"id\": \"6ecbfe95-96bd-4941-9220-1be8dcf50994\",\n \"user_id\": \"61a85f1f-98aa-4dcd-837d-84cf54bb532a\",\n \"updated_at\": \"2025-06-04T19:55:01+0000\",\n \"transaction\": \"49178c5c-0d30-4dae-acd0-a6dce37fc8e4\",\n \"transaction_date\": \"2024-08-05\",\n \"transaction_note\": \"Nota_iusto-eaque-repellat\"\n },\n \"classified\": true,\n \"attributes\": {},\n \"tags\": []\n}\n\nXerpa ofrece funcionalidades para presentar y personalizar el comportamiento y visualización de las transacciones de ingresos y gastos para un mejor entendimiento del usuario de sus finanzas personales.
\nCada transacción representa un registro de sus productos financieros: cuentas, tarjetas de débito, tarjetas de crédito, tarjetas de prepago o cualquier otro movimiento que impacte en el saldo del producto.
\nLas transacciones siempre están asociadas a un producto financiero a través del product_id y a la vez a un usuario a través del user_id .
Las transacciones presentadas son las registradas en las bases de datos Xerpa a través de los procesos de ingesta de transacciones disponibles en la API Middleware Xerpa. Cada transacción al ser recibida se enriquece y agregan propiedades a través del proceso de Enriquecimiento de Transacciones, logrando asociarles una categogía, comercio, logo y otros datos de estar disponibles.
Este endpoint permite obtener la lista de transacciones registradas por un usuario en un mes específico según el parámetro date_month, incluyendo información detallada como monto, categoría, fecha, cuenta de origen y metadatos asociados.
Widgets
\n\n\n
Request
\n- \n
Método:
\nGET\nEndpoint:
\n{{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/transactions/\nParámetros de ruta:
\n- \n
user_id(string, requerido): ID del usuario para el cual se desean obtener las transacciones. \n
\nParámetros query
\n- \n
date_month(string): Mes y año para filtrar las transacciones (formato: YYYY-MM). \n
\n
Request Body
\nEste request de tipo GET no requiere cuerpo.
El cuerpo de la solicitud debe enviarse vacío.
Response
\nLa respuesta será un objeto JSON que contiene una lista paginada de transacciones del usuario.
\n- \n
\nid(string): ID único de la transacción. \n
\nuser_id(string): ID del usuario. \n
\naccount_id(string): Cuenta asociada a la transacción. \n
\namount(number): Monto de la transacción. \n
\ntransaction_date(string): Fecha en que ocurrió la transacción. \n
\ndescription(string): Glosa o concepto de la transacción. \n
\ncategory(object): Detalles de la categoría asignada a la transacción, incluyendo:- \n
\nid(string): ID de la categoría. \n
\ncatalog(string): Catálogo de la categoría. \n
\nitem_name(string): Nombre del ítem de la categoría. \n
\ndescription(string): Descripción de la categoría. \n
\n
\nproduct_type(object): Detalles del tipo de producto asociado a la transacción, incluyendo:- \n
\nid(string): ID del tipo de producto. \n
\ncatalog(string): Catálogo del tipo de producto. \n
\nitem_name(string): Nombre del ítem del tipo de producto. \n
\n
\nexchange_rate(number|null): Tasa de cambio aplicada a la transacción (si aplica). \n
\nmerchant(string|null): Información sobre el comerciante (si aplica). \n
\ntransaction_note(string|null): Nota adicional sobre la transacción (si aplica). \n
\nclassified(boolean): Indica si la transacción ha sido clasificada. \n
\nattributes(object): Atributos adicionales de la transacción. \n
\ntags(array): Lista de etiquetas asociadas a la transacción. \n
La respuesta también incluye información de paginación, como:
\n- \n
\nnext(string or null): URL de la siguiente página \n
\nprevious(string or null): URL de la página anterior \n
\ntotal_pages(number): Total de páginas disponibles \n
\ncurrent_page(number): Página actual \n
\noffset(number): Índice de desplazamiento \n
\ncount(number): Total de elementos \n
Response Format
\n{\n \"type\": \"object\",\n \"properties\": {\n \"next\": {\n \"type\": [\"string\", \"null\"],\n \"format\": \"uri\"\n },\n \"previous\": {\n \"type\": [\"string\", \"null\"],\n \"format\": \"uri\"\n },\n \"total_pages\": {\n \"type\": \"integer\",\n \"minimum\": 1\n },\n \"current_page\": {\n \"type\": \"integer\",\n \"minimum\": 1\n },\n \"offset\": {\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"results\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"ignore_pfm\": { \"type\": \"boolean\" },\n \"external_id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"user_id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"transaction_date\": { \"type\": \"string\", \"format\": \"date\" },\n \"transaction_datetime\": { \"type\": \"string\", \"format\": \"date-time\" },\n \"amount\": {\"type\": \"string\"},\n \"description\": { \"type\": \"string\" },\n \"category\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"catalog\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"item_name\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"bg\": { \"type\": \"string\", \"format\": \"uri\" },\n \"icon\": { \"type\": \"string\", \"format\": \"uri\" },\n \"name\": { \"type\": \"string\" },\n \"color\": {\n \"type\": \"string\"\n },\n \"active\": { \"type\": \"boolean\" },\n \"short_name\": { \"type\": \"string\" },\n \"color_class\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"icon_ignore\": { \"type\": \"string\", \"format\": \"uri\" },\n \"icon_primary\": { \"type\": \"string\", \"format\": \"uri\" }\n }\n }\n }\n }\n }\n }\n }\n }\n}\n\nexpenses, incomes
\n","type":"text/plain"},"key":"movement_type","value":"incomes"},{"disabled":true,"key":"date_month","value":"2025-05"},{"key":"date_month","value":"2025-09"},{"key":"expand","value":"category"}],"variable":[]}},"response":[{"id":"9d11aa14-f23f-4dab-ad36-8443bd92f168","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/transactions/?date_month=2025-05","host":["{{host_app}}"],"path":["api-pfm","v1","pfm-service","users","{{user_id}}","transactions",""],"query":[{"key":"category","value":"uncategorized","disabled":true},{"key":"category","value":"3954361d-ddf5-46dc-a8f8-af98ee9811da","disabled":true},{"key":"paginate","value":"true","disabled":true},{"key":"page","value":"1","type":"text","disabled":true},{"key":"page_size","value":"1","type":"text","disabled":true},{"key":"expand","value":"category,exchange_rate","type":"text","disabled":true},{"key":"movement_type","value":"incomes","description":"expenses, incomes","type":"text","disabled":true},{"key":"date_month","value":"2025-05"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"next\": null,\n \"previous\": null,\n \"total_pages\": 1,\n \"current_page\": 1,\n \"offset\": 0,\n \"results\": [\n {\n \"id\": \"2556a72e-f1bf-4fd8-8c42-04d2ce115c02\",\n \"ignore_pfm\": false,\n \"external_id\": \"abc-1\",\n \"user_id\": \"9790de51-6732-4a07-b934-c58ab73f7bb5\",\n \"transaction_date\": \"2025-05-08\",\n \"transaction_datetime\": \"2025-05-08T00:00:00+0000\",\n \"amount\": \"-55.00\",\n \"description\": \"NETFLIX\",\n \"category\": \"f37b6770-7fc5-43e0-a837-50926e1ee459\",\n \"user_note\": null,\n \"product_type\": {\n \"id\": \"e480d1b0-cb8e-448c-9864-ed7ae4ce20b3\",\n \"catalog\": \"f1895069-e723-4cc8-9331-d1cb4110ab7a\",\n \"item_name\": \"cuenta_vista\",\n \"description\": \"Cuenta Vista\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/cuenta_vista.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"CUENTAVISTA\"\n }\n },\n \"exchange_rate\": null,\n \"merchant\": null,\n \"account_id\": \"31adddf5-1d3a-4af8-a218-db5f8f6f2f41\",\n \"transaction_note\": null,\n \"classified\": false\n },\n {\n \"id\": \"27520c0f-7bc5-4f0e-a029-9dee1b27bb17\",\n \"ignore_pfm\": false,\n \"external_id\": \"abc-2\",\n \"user_id\": \"9790de51-6732-4a07-b934-c58ab73f7bb5\",\n \"transaction_date\": \"2025-05-08\",\n \"transaction_datetime\": \"2025-05-08T00:00:00+0000\",\n \"amount\": \"-333.00\",\n \"description\": \"GOOGLE *Play Pass\",\n \"category\": \"f37b6770-7fc5-43e0-a837-50926e1ee459\",\n \"user_note\": null,\n \"product_type\": {\n \"id\": \"e480d1b0-cb8e-448c-9864-ed7ae4ce20b3\",\n \"catalog\": \"f1895069-e723-4cc8-9331-d1cb4110ab7a\",\n \"item_name\": \"cuenta_vista\",\n \"description\": \"Cuenta Vista\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/cuenta_vista.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"CUENTAVISTA\"\n }\n },\n \"exchange_rate\": null,\n \"merchant\": null,\n \"account_id\": \"31adddf5-1d3a-4af8-a218-db5f8f6f2f41\",\n \"transaction_note\": null,\n \"classified\": false\n },\n {\n \"id\": \"62b006cd-17a3-49eb-a0c3-7d511727fef6\",\n \"ignore_pfm\": false,\n \"external_id\": \"abc-3\",\n \"user_id\": \"9790de51-6732-4a07-b934-c58ab73f7bb5\",\n \"transaction_date\": \"2025-05-08\",\n \"transaction_datetime\": \"2025-05-08T00:00:00+0000\",\n \"amount\": \"-4500.00\",\n \"description\": \"PAPA JOHNS CCOLORA\",\n \"category\": \"f37b6770-7fc5-43e0-a837-50926e1ee459\",\n \"user_note\": null,\n \"product_type\": {\n \"id\": \"e480d1b0-cb8e-448c-9864-ed7ae4ce20b3\",\n \"catalog\": \"f1895069-e723-4cc8-9331-d1cb4110ab7a\",\n \"item_name\": \"cuenta_vista\",\n \"description\": \"Cuenta Vista\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/cuenta_vista.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"CUENTAVISTA\"\n }\n },\n \"exchange_rate\": null,\n \"merchant\": null,\n \"account_id\": \"31adddf5-1d3a-4af8-a218-db5f8f6f2f41\",\n \"transaction_note\": null,\n \"classified\": false\n }\n ],\n \"count\": 3\n}"},{"id":"c9625f53-5c52-46e8-bbdc-f5d4652ccd06","name":"Bad Request - Invalid date","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/transactions/?date_month=2024-09-invalid","host":["{{host_app}}"],"path":["api-pfm","v1","pfm-service","users","{{user_id}}","transactions",""],"query":[{"key":"date_month","value":"2024-09-invalid"},{"key":"category","value":"uncategorized","type":"text","disabled":true},{"key":"category","value":"3954361d-ddf5-46dc-a8f8-af98ee9811da","type":"text","disabled":true},{"key":"paginate","value":"true","disabled":true},{"key":"page","value":"1","type":"text","disabled":true},{"key":"page_size","value":"1","type":"text","disabled":true},{"key":"expand","value":"category,exchange_rate","type":"text","disabled":true},{"key":"movement_type","value":"incomes","description":"expenses, incomes","type":"text","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 04 Jun 2025 21:10:37 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"24"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a892f80d-b9f7-45b6-8ba4-27090e43fe93"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LqFsEFIvIAMEg0Q="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6840b64c-03d5bb5e0fcdcb9a6e91498a;Parent=5bec2b58393c807c;Sampled=0;Lineage=1:e7de7122:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"[\n \"Invalid date format.\"\n]"}],"_postman_id":"eb101666-77b6-4340-8b19-d960ee4f0330"},{"name":"Listado de transacciones por producto","event":[{"listen":"test","script":{"id":"14d24ee4-5d5e-44a5-aabe-4acff47b9d41","exec":["const xerpaTestApi = pm.require('@getxerpa/xerpa_test_api');\r","\r","xerpaTestApi.testResponseTime();\r","xerpaTestApi.testSuccessfulGet();\r","\r","// Parse the response JSON\r","const responseJson = pm.response.json();\r","\r","// Define the expected property types\r","const topLevelProperties = {\r"," next: { type: 'string', optional: true },\r"," previous: { type: 'string', optional: true },\r"," total_pages: 'number',\r"," current_page: 'number',\r"," offset: 'number',\r"," count: 'number',\r"," results: 'array'\r","};\r","\r","const resultProperties = {\r"," id: 'string',\r"," ignore_pfm: 'boolean',\r"," external_id: 'string',\r"," user_id: 'string',\r"," transaction_date: 'string',\r"," transaction_datetime: 'string',\r"," amount: 'string',\r"," description: 'string',\r"," category: 'string',\r"," user_note: { type: 'string', optional: true },\r"," product_type: 'object',\r"," exchange_rate: { type: 'string', optional: true },\r"," merchant: { type: 'object', optional: true },\r"," account_id: 'string',\r"," transaction_note: { type: 'string', optional: true },\r"," classified: 'boolean'\r","};\r","\r","const productTypeProperties = {\r"," id: 'string',\r"," catalog: 'string',\r"," item_name: 'string',\r"," description: 'string',\r"," metadata: 'object'\r","};\r","\r","const metadataProperties = {\r"," icon: 'string',\r"," color: 'string',\r"," active: 'boolean',\r"," short_name: 'string'\r","};\r","\r","const merchantProperties = {\r"," id: 'string',\r"," name: 'string',\r"," logo_url: 'string'\r","};\r","\r","// Check top-level properties\r","pm.test(\"Response has expected top-level properties with correct types\", () => {\r"," xerpaTestApi.checkObjectProperties(responseJson, topLevelProperties);\r","});\r","\r","// Check properties within the results array\r","pm.test(\"Results have expected properties with correct types\", () => {\r"," if (responseJson.results && responseJson.results.length > 0) {\r"," xerpaTestApi.checkObjectProperties(responseJson.results[0], resultProperties);\r"," \r"," // Check properties of the product_type object in the first result\r"," xerpaTestApi.checkObjectProperties(responseJson.results[0].product_type, productTypeProperties);\r"," \r"," // Check metadata properties of the product_type object in the first result\r"," xerpaTestApi.checkObjectProperties(responseJson.results[0].product_type.metadata, metadataProperties);\r"," \r"," // Check properties of the merchant object in the first result, if it exists\r"," if (responseJson.results[0].merchant) {\r"," xerpaTestApi.checkObjectProperties(responseJson.results[0].merchant, merchantProperties);\r"," }\r"," }\r","});"],"type":"text/javascript","packages":{"@getxerpa/xerpa_test_api":{"id":"01929aee-a3be-7f8c-91f1-e7a772cc76dc"}},"requests":{}}}],"id":"7d06aca2-b32b-4d1a-bd8e-63f6c83857b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token_user}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/transactions/?date_month=2024-09&account_id=5c7ddeb7-bb96-4ada-9745-3b97407634a2","description":"Este endpoint permite obtener la lista de transacciones registradas por un usuario en un producto y mes específico a través del parámetro account_id y date_month respectivamente, incluyendo información detallada como monto, categoría, fecha, cuenta de origen y metadatos asociados.
Widgets
\n\n\n
Request
\n- \n
Método:
\nGET\nEndpoint:
\n{{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/transactions/\nParámetros de ruta:
\n- \n
user_id(string, requerido): ID del usuario para el cual se desean obtener las transacciones. \n
\nParámetros query:
\n- \n
\ndate_month(string): Mes y año para filtrar las transacciones (formato: YYYY-MM). \naccount_id (string, opcional): ID de la cuenta para filtrar las transacciones.
\n \n
\n
Request Body
\nEste request de tipo GET no requiere cuerpo.
El cuerpo de la solicitud debe enviarse vacío.
Response
\nLa respuesta será un objeto JSON que contiene una lista paginada de transacciones del usuario.
\n- \n
\nid(string): ID único de la transacción. \n
\nuser_id(string): ID del usuario. \n
\naccount_id(string): Cuenta asociada a la transacción. \n
\namount(number): Monto de la transacción. \n
\ntransaction_date(string): Fecha en que ocurrió la transacción. \n
\ndescription(string): Glosa o concepto de la transacción. \n
\ncategory(object): Detalles de la categoría asignada a la transacción, incluyendo:- \n
\nid(string): ID de la categoría. \n
\ncatalog(string): Catálogo de la categoría. \n
\nitem_name(string): Nombre del ítem de la categoría. \n
\ndescription(string): Descripción de la categoría. \n
\n
\nproduct_type(object): Detalles del tipo de producto asociado a la transacción, incluyendo:- \n
\nid(string): ID del tipo de producto. \n
\ncatalog(string): Catálogo del tipo de producto. \n
\nitem_name(string): Nombre del ítem del tipo de producto. \n
\n
\nexchange_rate(number|null): Tasa de cambio aplicada a la transacción (si aplica). \n
\nmerchant(string|null): Información sobre el comerciante (si aplica). \n
\ntransaction_note(string|null): Nota adicional sobre la transacción (si aplica). \n
\nclassified(boolean): Indica si la transacción ha sido clasificada. \n
\nattributes(object): Atributos adicionales de la transacción. \n
\ntags(array): Lista de etiquetas asociadas a la transacción. \n
La respuesta también incluye información de paginación, como:
\n- \n
\nnext(string or null): URL de la siguiente página \n
\nprevious(string or null): URL de la página anterior \n
\ntotal_pages(number): Total de páginas disponibles \n
\ncurrent_page(number): Página actual \n
\noffset(number): Índice de desplazamiento \n
\ncount(number): Total de elementos \n
Response Format
\n{\n \"type\": \"object\",\n \"properties\": {\n \"next\": {\n \"type\": [\"string\", \"null\"],\n \"format\": \"uri\"\n },\n \"previous\": {\n \"type\": [\"string\", \"null\"],\n \"format\": \"uri\"\n },\n \"total_pages\": {\n \"type\": \"integer\",\n \"minimum\": 1\n },\n \"current_page\": {\n \"type\": \"integer\",\n \"minimum\": 1\n },\n \"offset\": {\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"results\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"ignore_pfm\": { \"type\": \"boolean\" },\n \"external_id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"user_id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"transaction_date\": { \"type\": \"string\", \"format\": \"date\" },\n \"transaction_datetime\": { \"type\": \"string\", \"format\": \"date-time\" },\n \"amount\": {\"type\": \"string\"},\n \"description\": { \"type\": \"string\" },\n \"category\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"catalog\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"item_name\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"bg\": { \"type\": \"string\", \"format\": \"uri\" },\n \"icon\": { \"type\": \"string\", \"format\": \"uri\" },\n \"name\": { \"type\": \"string\" },\n \"color\": {\n \"type\": \"string\"\n },\n \"active\": { \"type\": \"boolean\" },\n \"short_name\": { \"type\": \"string\" },\n \"color_class\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"icon_ignore\": { \"type\": \"string\", \"format\": \"uri\" },\n \"icon_primary\": { \"type\": \"string\", \"format\": \"uri\" }\n }\n }\n }\n }\n }\n }\n }\n }\n}\n\nexpenses, incomes
\n","type":"text/plain"},"key":"movement_type","value":"incomes"},{"key":"date_month","value":"2024-09"},{"key":"account_id","value":"5c7ddeb7-bb96-4ada-9745-3b97407634a2"},{"disabled":true,"key":"external_account_id","value":null}],"variable":[]}},"response":[{"id":"1b6ecabc-46b9-4527-838f-5eef2d2eb366","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/transactions/?date_month=2025-05&account_id=31adddf5-1d3a-4af8-a218-db5f8f6f2f41","host":["{{host_app}}"],"path":["api-pfm","v1","pfm-service","users","{{user_id}}","transactions",""],"query":[{"key":"category","value":"uncategorized","disabled":true},{"key":"category","value":"3954361d-ddf5-46dc-a8f8-af98ee9811da","disabled":true},{"key":"paginate","value":"true","disabled":true},{"key":"page","value":"1","type":"text","disabled":true},{"key":"page_size","value":"1","type":"text","disabled":true},{"key":"expand","value":"category,exchange_rate","type":"text","disabled":true},{"key":"movement_type","value":"incomes","description":"expenses, incomes","type":"text","disabled":true},{"key":"date_month","value":"2025-05"},{"key":"account_id","value":"31adddf5-1d3a-4af8-a218-db5f8f6f2f41"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"next\": null,\n \"previous\": null,\n \"total_pages\": 1,\n \"current_page\": 1,\n \"offset\": 0,\n \"results\": [\n {\n \"id\": \"2556a72e-f1bf-4fd8-8c42-04d2ce115c02\",\n \"ignore_pfm\": false,\n \"external_id\": \"abc-1\",\n \"user_id\": \"9790de51-6732-4a07-b934-c58ab73f7bb5\",\n \"transaction_date\": \"2025-05-08\",\n \"transaction_datetime\": \"2025-05-08T00:00:00+0000\",\n \"amount\": \"-55.00\",\n \"description\": \"NETFLIX\",\n \"category\": \"f37b6770-7fc5-43e0-a837-50926e1ee459\",\n \"user_note\": null,\n \"product_type\": {\n \"id\": \"e480d1b0-cb8e-448c-9864-ed7ae4ce20b3\",\n \"catalog\": \"f1895069-e723-4cc8-9331-d1cb4110ab7a\",\n \"item_name\": \"cuenta_vista\",\n \"description\": \"Cuenta Vista\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/cuenta_vista.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"CUENTAVISTA\"\n }\n },\n \"exchange_rate\": null,\n \"merchant\": null,\n \"account_id\": \"31adddf5-1d3a-4af8-a218-db5f8f6f2f41\",\n \"transaction_note\": null,\n \"classified\": false\n },\n {\n \"id\": \"27520c0f-7bc5-4f0e-a029-9dee1b27bb17\",\n \"ignore_pfm\": false,\n \"external_id\": \"abc-2\",\n \"user_id\": \"9790de51-6732-4a07-b934-c58ab73f7bb5\",\n \"transaction_date\": \"2025-05-08\",\n \"transaction_datetime\": \"2025-05-08T00:00:00+0000\",\n \"amount\": \"-333.00\",\n \"description\": \"GOOGLE *Play Pass\",\n \"category\": \"f37b6770-7fc5-43e0-a837-50926e1ee459\",\n \"user_note\": null,\n \"product_type\": {\n \"id\": \"e480d1b0-cb8e-448c-9864-ed7ae4ce20b3\",\n \"catalog\": \"f1895069-e723-4cc8-9331-d1cb4110ab7a\",\n \"item_name\": \"cuenta_vista\",\n \"description\": \"Cuenta Vista\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/cuenta_vista.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"CUENTAVISTA\"\n }\n },\n \"exchange_rate\": null,\n \"merchant\": null,\n \"account_id\": \"31adddf5-1d3a-4af8-a218-db5f8f6f2f41\",\n \"transaction_note\": null,\n \"classified\": false\n },\n {\n \"id\": \"62b006cd-17a3-49eb-a0c3-7d511727fef6\",\n \"ignore_pfm\": false,\n \"external_id\": \"abc-3\",\n \"user_id\": \"9790de51-6732-4a07-b934-c58ab73f7bb5\",\n \"transaction_date\": \"2025-05-08\",\n \"transaction_datetime\": \"2025-05-08T00:00:00+0000\",\n \"amount\": \"-4500.00\",\n \"description\": \"PAPA JOHNS CCOLORA\",\n \"category\": \"f37b6770-7fc5-43e0-a837-50926e1ee459\",\n \"user_note\": null,\n \"product_type\": {\n \"id\": \"e480d1b0-cb8e-448c-9864-ed7ae4ce20b3\",\n \"catalog\": \"f1895069-e723-4cc8-9331-d1cb4110ab7a\",\n \"item_name\": \"cuenta_vista\",\n \"description\": \"Cuenta Vista\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/cuenta_vista.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"CUENTAVISTA\"\n }\n },\n \"exchange_rate\": null,\n \"merchant\": null,\n \"account_id\": \"31adddf5-1d3a-4af8-a218-db5f8f6f2f41\",\n \"transaction_note\": null,\n \"classified\": false\n }\n ],\n \"count\": 3\n}"},{"id":"a6b16f29-5f83-4358-87d0-be6255e49f9f","name":"Bad Request - Invalid date","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/transactions/?date_month=2024-09-invalid","host":["{{host_app}}"],"path":["api-pfm","v1","pfm-service","users","{{user_id}}","transactions",""],"query":[{"key":"date_month","value":"2024-09-invalid"},{"key":"category","value":"uncategorized","type":"text","disabled":true},{"key":"category","value":"3954361d-ddf5-46dc-a8f8-af98ee9811da","type":"text","disabled":true},{"key":"paginate","value":"true","disabled":true},{"key":"page","value":"1","type":"text","disabled":true},{"key":"page_size","value":"1","type":"text","disabled":true},{"key":"expand","value":"category,exchange_rate","type":"text","disabled":true},{"key":"movement_type","value":"incomes","description":"expenses, incomes","type":"text","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 04 Jun 2025 21:10:37 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"24"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a892f80d-b9f7-45b6-8ba4-27090e43fe93"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LqFsEFIvIAMEg0Q="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6840b64c-03d5bb5e0fcdcb9a6e91498a;Parent=5bec2b58393c807c;Sampled=0;Lineage=1:e7de7122:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"[\n \"Invalid date format.\"\n]"}],"_postman_id":"7d06aca2-b32b-4d1a-bd8e-63f6c83857b0"},{"name":"Listado de transacciones por categoría","event":[{"listen":"test","script":{"id":"14d24ee4-5d5e-44a5-aabe-4acff47b9d41","exec":["const xerpaTestApi = pm.require('@getxerpa/xerpa_test_api');\r","\r","xerpaTestApi.testResponseTime();\r","xerpaTestApi.testSuccessfulGet();\r","\r","// Parse the response JSON\r","const responseJson = pm.response.json();\r","\r","// Define the expected property types\r","const topLevelProperties = {\r"," next: { type: 'string', optional: true },\r"," previous: { type: 'string', optional: true },\r"," total_pages: 'number',\r"," current_page: 'number',\r"," offset: 'number',\r"," count: 'number',\r"," results: 'array'\r","};\r","\r","const resultProperties = {\r"," id: 'string',\r"," ignore_pfm: 'boolean',\r"," external_id: 'string',\r"," user_id: 'string',\r"," transaction_date: 'string',\r"," transaction_datetime: 'string',\r"," amount: 'string',\r"," description: 'string',\r"," category: 'string',\r"," user_note: { type: 'string', optional: true },\r"," product_type: 'object',\r"," exchange_rate: { type: 'string', optional: true },\r"," merchant: { type: 'object', optional: true },\r"," account_id: 'string',\r"," transaction_note: { type: 'string', optional: true },\r"," classified: 'boolean'\r","};\r","\r","const productTypeProperties = {\r"," id: 'string',\r"," catalog: 'string',\r"," item_name: 'string',\r"," description: 'string',\r"," metadata: 'object'\r","};\r","\r","const metadataProperties = {\r"," icon: 'string',\r"," color: 'string',\r"," active: 'boolean',\r"," short_name: 'string'\r","};\r","\r","const merchantProperties = {\r"," id: 'string',\r"," name: 'string',\r"," logo_url: 'string'\r","};\r","\r","// Check top-level properties\r","pm.test(\"Response has expected top-level properties with correct types\", () => {\r"," xerpaTestApi.checkObjectProperties(responseJson, topLevelProperties);\r","});\r","\r","// Check properties within the results array\r","pm.test(\"Results have expected properties with correct types\", () => {\r"," if (responseJson.results && responseJson.results.length > 0) {\r"," xerpaTestApi.checkObjectProperties(responseJson.results[0], resultProperties);\r"," \r"," // Check properties of the product_type object in the first result\r"," xerpaTestApi.checkObjectProperties(responseJson.results[0].product_type, productTypeProperties);\r"," \r"," // Check metadata properties of the product_type object in the first result\r"," xerpaTestApi.checkObjectProperties(responseJson.results[0].product_type.metadata, metadataProperties);\r"," \r"," // Check properties of the merchant object in the first result, if it exists\r"," if (responseJson.results[0].merchant) {\r"," xerpaTestApi.checkObjectProperties(responseJson.results[0].merchant, merchantProperties);\r"," }\r"," }\r","});"],"type":"text/javascript","packages":{"@getxerpa/xerpa_test_api":{"id":"01929aee-a3be-7f8c-91f1-e7a772cc76dc"}}}}],"id":"af2f59af-c443-4e81-9187-314cf0881d7f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token_user}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/transactions/?category_id=f37b6770-7fc5-43e0-a837-50926e1ee459&date_month=2025-05","description":"Este endpoint permite obtener la lista de transacciones registradas por un usuario en un mes y categoría específico, incluyendo información detallada como monto, categoría, fecha, cuenta de origen y metadatos asociados.
\nLa categoría puede ser de ingresos o gastos
\nWidgets
\n\n\n
Request
\n- \n
Método:
\nGET\nEndpoint:
\n{{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/transactions/\nParámetros de ruta:
\n- \n
user_id(string, requerido): ID del usuario para el cual se desean obtener las transacciones. \n
\nParámetros query
\n- \n
\ndate_month(string): Mes y año para filtrar las transacciones (formato: YYYY-MM). \n
\ncategory(string, opcional): ID de la categoría para filtrar las transacciones. Tambien puede tomar el valor \"uncategorized\" para obtener las transacciones sin categoria asignada. \n
\npaginate(boolean, opcional): Indica si se debe aplicar paginación a los resultados (valor por defecto: true). \n
\npage(integer, opcional): Número de la página de resultados a retornar (valor por defecto: 1). \n
\npage_size(integer, opcional): Número máximo de transacciones a retornar por página (valor por defecto: 10). \n
\nexpand(string, opcional): Campos adicionales a incluir en la respuesta, separados por comas (ej.category,exchange_rate). \n
\nmovement_type(string, opcional): Tipo de movimiento a filtrar (incomes,expenses). \n
\n
Request Body
\nEste request de tipo GET no requiere cuerpo.
El cuerpo de la solicitud debe enviarse vacío.
Response
\nLa respuesta será un objeto JSON que contiene una lista paginada de transacciones del usuario.
\n- \n
\nid(string): ID único de la transacción. \n
\nuser_id(string): ID del usuario. \n
\naccount_id(string): Cuenta asociada a la transacción. \n
\namount(number): Monto de la transacción. \n
\ntransaction_date(string): Fecha en que ocurrió la transacción. \n
\ndescription(string): Glosa o concepto de la transacción. \n
\ncategory(object): Detalles de la categoría asignada a la transacción, incluyendo:- \n
\nid(string): ID de la categoría. \n
\ncatalog(string): Catálogo de la categoría. \n
\nitem_name(string): Nombre del ítem de la categoría. \n
\ndescription(string): Descripción de la categoría. \n
\n
\nproduct_type(object): Detalles del tipo de producto asociado a la transacción, incluyendo:- \n
\nid(string): ID del tipo de producto. \n
\ncatalog(string): Catálogo del tipo de producto. \n
\nitem_name(string): Nombre del ítem del tipo de producto. \n
\n
\nexchange_rate(number|null): Tasa de cambio aplicada a la transacción (si aplica). \n
\nmerchant(string|null): Información sobre el comerciante (si aplica). \n
\ntransaction_note(string|null): Nota adicional sobre la transacción (si aplica). \n
\nclassified(boolean): Indica si la transacción ha sido clasificada. \n
\nattributes(object): Atributos adicionales de la transacción. \n
\ntags(array): Lista de etiquetas asociadas a la transacción. \n
La respuesta también incluye información de paginación, como:
\n- \n
\nnext(string or null): URL de la siguiente página \n
\nprevious(string or null): URL de la página anterior \n
\ntotal_pages(number): Total de páginas disponibles \n
\ncurrent_page(number): Página actual \n
\noffset(number): Índice de desplazamiento \n
\ncount(number): Total de elementos \n
Response Format
\n{\n \"type\": \"object\",\n \"properties\": {\n \"next\": {\n \"type\": [\"string\", \"null\"],\n \"format\": \"uri\"\n },\n \"previous\": {\n \"type\": [\"string\", \"null\"],\n \"format\": \"uri\"\n },\n \"total_pages\": {\n \"type\": \"integer\",\n \"minimum\": 1\n },\n \"current_page\": {\n \"type\": \"integer\",\n \"minimum\": 1\n },\n \"offset\": {\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"results\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"ignore_pfm\": { \"type\": \"boolean\" },\n \"external_id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"user_id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"transaction_date\": { \"type\": \"string\", \"format\": \"date\" },\n \"transaction_datetime\": { \"type\": \"string\", \"format\": \"date-time\" },\n \"amount\": {\"type\": \"string\"},\n \"description\": { \"type\": \"string\" },\n \"category\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"catalog\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"item_name\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"bg\": { \"type\": \"string\", \"format\": \"uri\" },\n \"icon\": { \"type\": \"string\", \"format\": \"uri\" },\n \"name\": { \"type\": \"string\" },\n \"color\": {\n \"type\": \"string\"\n },\n \"active\": { \"type\": \"boolean\" },\n \"short_name\": { \"type\": \"string\" },\n \"color_class\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"icon_ignore\": { \"type\": \"string\", \"format\": \"uri\" },\n \"icon_primary\": { \"type\": \"string\", \"format\": \"uri\" }\n }\n }\n }\n }\n }\n }\n }\n }\n}\n\nexpenses, incomes
\n","type":"text/plain"},"key":"movement_type","value":"incomes"},{"disabled":true,"key":"expand","value":"category"},{"key":"category_id","value":"f37b6770-7fc5-43e0-a837-50926e1ee459"},{"key":"date_month","value":"2025-05"}],"variable":[]}},"response":[{"id":"2f089b1a-c4b1-4354-b20b-a23fdb036a5d","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/transactions/?category_id=f37b6770-7fc5-43e0-a837-50926e1ee459&date_month=2025-05","host":["{{host_app}}"],"path":["api-pfm","v1","pfm-service","users","{{user_id}}","transactions",""],"query":[{"key":"category","value":"uncategorized","disabled":true},{"key":"paginate","value":"true","disabled":true},{"key":"page","value":"1","type":"text","disabled":true},{"key":"page_size","value":"1","type":"text","disabled":true},{"key":"movement_type","value":"incomes","description":"expenses, incomes","type":"text","disabled":true},{"key":"expand","value":"category","disabled":true},{"key":"category_id","value":"f37b6770-7fc5-43e0-a837-50926e1ee459"},{"key":"date_month","value":"2025-05"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"next\": null,\n \"previous\": null,\n \"total_pages\": 1,\n \"current_page\": 1,\n \"offset\": 0,\n \"results\": [\n {\n \"id\": \"2556a72e-f1bf-4fd8-8c42-04d2ce115c02\",\n \"ignore_pfm\": false,\n \"external_id\": \"abc-1\",\n \"user_id\": \"9790de51-6732-4a07-b934-c58ab73f7bb5\",\n \"transaction_date\": \"2025-05-08\",\n \"transaction_datetime\": \"2025-05-08T00:00:00+0000\",\n \"amount\": \"-55.00\",\n \"description\": \"NETFLIX\",\n \"category\": \"f37b6770-7fc5-43e0-a837-50926e1ee459\",\n \"user_note\": null,\n \"product_type\": {\n \"id\": \"e480d1b0-cb8e-448c-9864-ed7ae4ce20b3\",\n \"catalog\": \"f1895069-e723-4cc8-9331-d1cb4110ab7a\",\n \"item_name\": \"cuenta_vista\",\n \"description\": \"Cuenta Vista\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/cuenta_vista.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"CUENTAVISTA\"\n }\n },\n \"exchange_rate\": null,\n \"merchant\": null,\n \"account_id\": \"31adddf5-1d3a-4af8-a218-db5f8f6f2f41\",\n \"transaction_note\": null,\n \"classified\": false\n },\n {\n \"id\": \"27520c0f-7bc5-4f0e-a029-9dee1b27bb17\",\n \"ignore_pfm\": false,\n \"external_id\": \"abc-2\",\n \"user_id\": \"9790de51-6732-4a07-b934-c58ab73f7bb5\",\n \"transaction_date\": \"2025-05-08\",\n \"transaction_datetime\": \"2025-05-08T00:00:00+0000\",\n \"amount\": \"-333.00\",\n \"description\": \"GOOGLE *Play Pass\",\n \"category\": \"f37b6770-7fc5-43e0-a837-50926e1ee459\",\n \"user_note\": null,\n \"product_type\": {\n \"id\": \"e480d1b0-cb8e-448c-9864-ed7ae4ce20b3\",\n \"catalog\": \"f1895069-e723-4cc8-9331-d1cb4110ab7a\",\n \"item_name\": \"cuenta_vista\",\n \"description\": \"Cuenta Vista\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/cuenta_vista.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"CUENTAVISTA\"\n }\n },\n \"exchange_rate\": null,\n \"merchant\": null,\n \"account_id\": \"31adddf5-1d3a-4af8-a218-db5f8f6f2f41\",\n \"transaction_note\": null,\n \"classified\": false\n },\n {\n \"id\": \"62b006cd-17a3-49eb-a0c3-7d511727fef6\",\n \"ignore_pfm\": false,\n \"external_id\": \"abc-3\",\n \"user_id\": \"9790de51-6732-4a07-b934-c58ab73f7bb5\",\n \"transaction_date\": \"2025-05-08\",\n \"transaction_datetime\": \"2025-05-08T00:00:00+0000\",\n \"amount\": \"-4500.00\",\n \"description\": \"PAPA JOHNS CCOLORA\",\n \"category\": \"f37b6770-7fc5-43e0-a837-50926e1ee459\",\n \"user_note\": null,\n \"product_type\": {\n \"id\": \"e480d1b0-cb8e-448c-9864-ed7ae4ce20b3\",\n \"catalog\": \"f1895069-e723-4cc8-9331-d1cb4110ab7a\",\n \"item_name\": \"cuenta_vista\",\n \"description\": \"Cuenta Vista\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/cuenta_vista.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"CUENTAVISTA\"\n }\n },\n \"exchange_rate\": null,\n \"merchant\": null,\n \"account_id\": \"31adddf5-1d3a-4af8-a218-db5f8f6f2f41\",\n \"transaction_note\": null,\n \"classified\": false\n }\n ],\n \"count\": 3\n}"},{"id":"acbf865c-b679-4ed5-8801-9d9bf4bc2803","name":"Bad Request - Invalid date","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/transactions/?date_month=2024-09-invalid","host":["{{host_app}}"],"path":["api-pfm","v1","pfm-service","users","{{user_id}}","transactions",""],"query":[{"key":"date_month","value":"2024-09-invalid"},{"key":"category","value":"uncategorized","type":"text","disabled":true},{"key":"category","value":"3954361d-ddf5-46dc-a8f8-af98ee9811da","type":"text","disabled":true},{"key":"paginate","value":"true","disabled":true},{"key":"page","value":"1","type":"text","disabled":true},{"key":"page_size","value":"1","type":"text","disabled":true},{"key":"expand","value":"category,exchange_rate","type":"text","disabled":true},{"key":"movement_type","value":"incomes","description":"expenses, incomes","type":"text","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 04 Jun 2025 21:10:37 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"24"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a892f80d-b9f7-45b6-8ba4-27090e43fe93"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LqFsEFIvIAMEg0Q="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6840b64c-03d5bb5e0fcdcb9a6e91498a;Parent=5bec2b58393c807c;Sampled=0;Lineage=1:e7de7122:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"[\n \"Invalid date format.\"\n]"}],"_postman_id":"af2f59af-c443-4e81-9187-314cf0881d7f"},{"name":"Listado de transacciones sin categoría","event":[{"listen":"test","script":{"id":"14d24ee4-5d5e-44a5-aabe-4acff47b9d41","exec":["const xerpaTestApi = pm.require('@getxerpa/xerpa_test_api');\r","\r","xerpaTestApi.testResponseTime();\r","xerpaTestApi.testSuccessfulGet();\r","\r","// Parse the response JSON\r","const responseJson = pm.response.json();\r","\r","// Define the expected property types\r","const topLevelProperties = {\r"," next: { type: 'string', optional: true },\r"," previous: { type: 'string', optional: true },\r"," total_pages: 'number',\r"," current_page: 'number',\r"," offset: 'number',\r"," count: 'number',\r"," results: 'array'\r","};\r","\r","const resultProperties = {\r"," id: 'string',\r"," ignore_pfm: 'boolean',\r"," external_id: 'string',\r"," user_id: 'string',\r"," transaction_date: 'string',\r"," transaction_datetime: 'string',\r"," amount: 'string',\r"," description: 'string',\r"," category: 'string',\r"," user_note: { type: 'string', optional: true },\r"," product_type: 'object',\r"," exchange_rate: { type: 'string', optional: true },\r"," merchant: { type: 'object', optional: true },\r"," account_id: 'string',\r"," transaction_note: { type: 'string', optional: true },\r"," classified: 'boolean'\r","};\r","\r","const productTypeProperties = {\r"," id: 'string',\r"," catalog: 'string',\r"," item_name: 'string',\r"," description: 'string',\r"," metadata: 'object'\r","};\r","\r","const metadataProperties = {\r"," icon: 'string',\r"," color: 'string',\r"," active: 'boolean',\r"," short_name: 'string'\r","};\r","\r","const merchantProperties = {\r"," id: 'string',\r"," name: 'string',\r"," logo_url: 'string'\r","};\r","\r","// Check top-level properties\r","pm.test(\"Response has expected top-level properties with correct types\", () => {\r"," xerpaTestApi.checkObjectProperties(responseJson, topLevelProperties);\r","});\r","\r","// Check properties within the results array\r","pm.test(\"Results have expected properties with correct types\", () => {\r"," if (responseJson.results && responseJson.results.length > 0) {\r"," xerpaTestApi.checkObjectProperties(responseJson.results[0], resultProperties);\r"," \r"," // Check properties of the product_type object in the first result\r"," xerpaTestApi.checkObjectProperties(responseJson.results[0].product_type, productTypeProperties);\r"," \r"," // Check metadata properties of the product_type object in the first result\r"," xerpaTestApi.checkObjectProperties(responseJson.results[0].product_type.metadata, metadataProperties);\r"," \r"," // Check properties of the merchant object in the first result, if it exists\r"," if (responseJson.results[0].merchant) {\r"," xerpaTestApi.checkObjectProperties(responseJson.results[0].merchant, merchantProperties);\r"," }\r"," }\r","});"],"type":"text/javascript","packages":{"@getxerpa/xerpa_test_api":{"id":"01929aee-a3be-7f8c-91f1-e7a772cc76dc"}}}}],"id":"3b1e4830-4249-4640-b8a1-de17910424d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token_user}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/transactions/?category=uncategorized&date_month=2025-05","description":"Este endpoint permite obtener la lista de transacciones registradas por un usuario, incluyendo información detallada como monto, categoría, fecha, cuenta de origen y metadatos asociados.
\nWidgets
\n- \n
- Transacciones sin categoría \n
\n
Request
\n- \n
Método:
\nGET\nEndpoint:
\n{{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/transactions/\nParámetros de ruta:
\n- \n
user_id(string, requerido): ID del usuario para el cual se desean obtener las transacciones. \n
\nParámetros query
\n- \n
\ndate_month(string): Mes y año para filtrar las transacciones (formato: YYYY-MM). \n
\ncategory(string, opcional): ID de la categoría para filtrar las transacciones. Tambien puede tomar el valor \"uncategorized\" para obtener las transacciones sin categoria asignada. \n
\npaginate(boolean, opcional): Indica si se debe aplicar paginación a los resultados (valor por defecto: true). \n
\npage(integer, opcional): Número de la página de resultados a retornar (valor por defecto: 1). \n
\npage_size(integer, opcional): Número máximo de transacciones a retornar por página (valor por defecto: 10). \n
\nexpand(string, opcional): Campos adicionales a incluir en la respuesta, separados por comas (ej.category,exchange_rate). \n
\nmovement_type(string, opcional): Tipo de movimiento a filtrar (incomes,expenses). \n
\n
Request Body
\nEste request de tipo GET no requiere cuerpo.
El cuerpo de la solicitud debe enviarse vacío.
Response
\nLa respuesta será un objeto JSON que contiene una lista paginada de transacciones del usuario.
\n- \n
\nid(string): ID único de la transacción. \n
\nuser_id(string): ID del usuario. \n
\naccount_id(string): Cuenta asociada a la transacción. \n
\namount(number): Monto de la transacción. \n
\ntransaction_date(string): Fecha en que ocurrió la transacción. \n
\ndescription(string): Glosa o concepto de la transacción. \n
\ncategory(object): Detalles de la categoría asignada a la transacción, incluyendo:- \n
\nid(string): ID de la categoría. \n
\ncatalog(string): Catálogo de la categoría. \n
\nitem_name(string): Nombre del ítem de la categoría. \n
\ndescription(string): Descripción de la categoría. \n
\n
\nproduct_type(object): Detalles del tipo de producto asociado a la transacción, incluyendo:- \n
\nid(string): ID del tipo de producto. \n
\ncatalog(string): Catálogo del tipo de producto. \n
\nitem_name(string): Nombre del ítem del tipo de producto. \n
\n
\nexchange_rate(number|null): Tasa de cambio aplicada a la transacción (si aplica). \n
\nmerchant(string|null): Información sobre el comerciante (si aplica). \n
\ntransaction_note(string|null): Nota adicional sobre la transacción (si aplica). \n
\nclassified(boolean): Indica si la transacción ha sido clasificada. \n
\nattributes(object): Atributos adicionales de la transacción. \n
\ntags(array): Lista de etiquetas asociadas a la transacción. \n
La respuesta también incluye información de paginación, como:
\n- \n
\nnext(string or null): URL de la siguiente página \n
\nprevious(string or null): URL de la página anterior \n
\ntotal_pages(number): Total de páginas disponibles \n
\ncurrent_page(number): Página actual \n
\noffset(number): Índice de desplazamiento \n
\ncount(number): Total de elementos \n
Response Format
\n{\n \"type\": \"object\",\n \"properties\": {\n \"next\": {\n \"type\": [\"string\", \"null\"],\n \"format\": \"uri\"\n },\n \"previous\": {\n \"type\": [\"string\", \"null\"],\n \"format\": \"uri\"\n },\n \"total_pages\": {\n \"type\": \"integer\",\n \"minimum\": 1\n },\n \"current_page\": {\n \"type\": \"integer\",\n \"minimum\": 1\n },\n \"offset\": {\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"results\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"ignore_pfm\": { \"type\": \"boolean\" },\n \"external_id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"user_id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"transaction_date\": { \"type\": \"string\", \"format\": \"date\" },\n \"transaction_datetime\": { \"type\": \"string\", \"format\": \"date-time\" },\n \"amount\": {\"type\": \"string\"},\n \"description\": { \"type\": \"string\" },\n \"category\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"catalog\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"item_name\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"bg\": { \"type\": \"string\", \"format\": \"uri\" },\n \"icon\": { \"type\": \"string\", \"format\": \"uri\" },\n \"name\": { \"type\": \"string\" },\n \"color\": {\n \"type\": \"string\"\n },\n \"active\": { \"type\": \"boolean\" },\n \"short_name\": { \"type\": \"string\" },\n \"color_class\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"icon_ignore\": { \"type\": \"string\", \"format\": \"uri\" },\n \"icon_primary\": { \"type\": \"string\", \"format\": \"uri\" }\n }\n }\n }\n }\n }\n }\n }\n }\n}\n\nexpenses, incomes
\n","type":"text/plain"},"key":"movement_type","value":"incomes"},{"key":"date_month","value":"2025-05"}],"variable":[]}},"response":[{"id":"1684f9a0-e652-4eb1-84f7-0a0a151f0af5","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/transactions/?category=uncategorized&date_month=2025-05","host":["{{host_app}}"],"path":["api-pfm","v1","pfm-service","users","{{user_id}}","transactions",""],"query":[{"key":"category","value":"uncategorized"},{"key":"category","value":"3954361d-ddf5-46dc-a8f8-af98ee9811da","disabled":true},{"key":"paginate","value":"true","disabled":true},{"key":"page","value":"1","type":"text","disabled":true},{"key":"page_size","value":"1","type":"text","disabled":true},{"key":"expand","value":"category,exchange_rate","type":"text","disabled":true},{"key":"movement_type","value":"incomes","description":"expenses, incomes","type":"text","disabled":true},{"key":"date_month","value":"2025-05"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"next\": null,\n \"previous\": null,\n \"total_pages\": 1,\n \"current_page\": 1,\n \"offset\": 0,\n \"results\": [\n {\n \"id\": \"2556a72e-f1bf-4fd8-8c42-04d2ce115c02\",\n \"ignore_pfm\": false,\n \"external_id\": \"abc-1\",\n \"user_id\": \"9790de51-6732-4a07-b934-c58ab73f7bb5\",\n \"transaction_date\": \"2025-05-08\",\n \"transaction_datetime\": \"2025-05-08T00:00:00+0000\",\n \"amount\": \"-55.00\",\n \"description\": \"NETFLIX\",\n \"category\": \"f37b6770-7fc5-43e0-a837-50926e1ee459\",\n \"user_note\": null,\n \"product_type\": {\n \"id\": \"e480d1b0-cb8e-448c-9864-ed7ae4ce20b3\",\n \"catalog\": \"f1895069-e723-4cc8-9331-d1cb4110ab7a\",\n \"item_name\": \"cuenta_vista\",\n \"description\": \"Cuenta Vista\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/cuenta_vista.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"CUENTAVISTA\"\n }\n },\n \"exchange_rate\": null,\n \"merchant\": null,\n \"account_id\": \"31adddf5-1d3a-4af8-a218-db5f8f6f2f41\",\n \"transaction_note\": null,\n \"classified\": false\n },\n {\n \"id\": \"27520c0f-7bc5-4f0e-a029-9dee1b27bb17\",\n \"ignore_pfm\": false,\n \"external_id\": \"abc-2\",\n \"user_id\": \"9790de51-6732-4a07-b934-c58ab73f7bb5\",\n \"transaction_date\": \"2025-05-08\",\n \"transaction_datetime\": \"2025-05-08T00:00:00+0000\",\n \"amount\": \"-333.00\",\n \"description\": \"GOOGLE *Play Pass\",\n \"category\": \"f37b6770-7fc5-43e0-a837-50926e1ee459\",\n \"user_note\": null,\n \"product_type\": {\n \"id\": \"e480d1b0-cb8e-448c-9864-ed7ae4ce20b3\",\n \"catalog\": \"f1895069-e723-4cc8-9331-d1cb4110ab7a\",\n \"item_name\": \"cuenta_vista\",\n \"description\": \"Cuenta Vista\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/cuenta_vista.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"CUENTAVISTA\"\n }\n },\n \"exchange_rate\": null,\n \"merchant\": null,\n \"account_id\": \"31adddf5-1d3a-4af8-a218-db5f8f6f2f41\",\n \"transaction_note\": null,\n \"classified\": false\n },\n {\n \"id\": \"62b006cd-17a3-49eb-a0c3-7d511727fef6\",\n \"ignore_pfm\": false,\n \"external_id\": \"abc-3\",\n \"user_id\": \"9790de51-6732-4a07-b934-c58ab73f7bb5\",\n \"transaction_date\": \"2025-05-08\",\n \"transaction_datetime\": \"2025-05-08T00:00:00+0000\",\n \"amount\": \"-4500.00\",\n \"description\": \"PAPA JOHNS CCOLORA\",\n \"category\": \"f37b6770-7fc5-43e0-a837-50926e1ee459\",\n \"user_note\": null,\n \"product_type\": {\n \"id\": \"e480d1b0-cb8e-448c-9864-ed7ae4ce20b3\",\n \"catalog\": \"f1895069-e723-4cc8-9331-d1cb4110ab7a\",\n \"item_name\": \"cuenta_vista\",\n \"description\": \"Cuenta Vista\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/cuenta_vista.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"CUENTAVISTA\"\n }\n },\n \"exchange_rate\": null,\n \"merchant\": null,\n \"account_id\": \"31adddf5-1d3a-4af8-a218-db5f8f6f2f41\",\n \"transaction_note\": null,\n \"classified\": false\n }\n ],\n \"count\": 3\n}"},{"id":"532ffb43-02b8-48f9-850a-3c6c31490cfc","name":"Bad Request - Invalid date","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/transactions/?date_month=2024-09-invalid","host":["{{host_app}}"],"path":["api-pfm","v1","pfm-service","users","{{user_id}}","transactions",""],"query":[{"key":"date_month","value":"2024-09-invalid"},{"key":"category","value":"uncategorized","type":"text","disabled":true},{"key":"category","value":"3954361d-ddf5-46dc-a8f8-af98ee9811da","type":"text","disabled":true},{"key":"paginate","value":"true","disabled":true},{"key":"page","value":"1","type":"text","disabled":true},{"key":"page_size","value":"1","type":"text","disabled":true},{"key":"expand","value":"category,exchange_rate","type":"text","disabled":true},{"key":"movement_type","value":"incomes","description":"expenses, incomes","type":"text","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 04 Jun 2025 21:10:37 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"24"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a892f80d-b9f7-45b6-8ba4-27090e43fe93"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LqFsEFIvIAMEg0Q="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6840b64c-03d5bb5e0fcdcb9a6e91498a;Parent=5bec2b58393c807c;Sampled=0;Lineage=1:e7de7122:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"[\n \"Invalid date format.\"\n]"}],"_postman_id":"3b1e4830-4249-4640-b8a1-de17910424d0"},{"name":"Listado de transacciones creadas ultimas horas","event":[{"listen":"test","script":{"id":"a2d12afc-4122-452c-b994-7601116ab0a1","exec":["const xerpaTestApi = pm.require('@getxerpa/xerpa_test_api');\r","\r","xerpaTestApi.testResponseTime();\r","xerpaTestApi.testSuccessfulGet();\r","\r","// Parse the response JSON\r","const responseJson = pm.response.json();\r","\r","// Define the expected property types\r","const topLevelProperties = {\r"," id: 'string',\r"," ignore_pfm: 'boolean',\r"," external_id: 'string',\r"," user_id: 'string',\r"," transaction_date: 'string',\r"," transaction_datetime: 'string',\r"," description: 'string',\r"," amount: 'string',\r"," transaction_category: 'object',\r"," created_at: 'string'\r","};\r","\r","const transactionCategoryProperties = {\r"," id: 'string',\r"," catalog: 'string',\r"," item_name: 'string',\r"," description: 'string',\r"," metadata: 'object'\r","};\r","\r","const metadataProperties = {\r"," icon: 'string',\r"," name: 'string',\r"," color: 'string',\r"," active: 'boolean',\r"," short_name: 'string',\r"," color_class: 'string',\r"," description: 'string',\r"," icon_ignore: 'string',\r"," icon_primary: 'string'\r","};\r","\r","// Check top-level properties\r","pm.test(\"Response has expected top-level properties with correct types\", () => {\r"," if (responseJson && responseJson.length > 0) {\r"," xerpaTestApi.checkObjectProperties(responseJson[0], topLevelProperties);\r"," }\r","});\r","\r","// Check properties of the transaction_category object\r","pm.test(\"Transaction category object has expected properties with correct types\", () => {\r"," if (responseJson && responseJson.length > 0) {\r"," xerpaTestApi.checkObjectProperties(responseJson[0].transaction_category, transactionCategoryProperties);\r"," }\r","});\r","\r","// Check properties of the metadata object within the transaction_category\r","pm.test(\"Metadata object has expected properties with correct types\", () => {\r"," if (responseJson && responseJson.length > 0) {\r"," xerpaTestApi.checkObjectProperties(responseJson[0].transaction_category.metadata, metadataProperties);\r"," }\r","});"],"type":"text/javascript","packages":{"@getxerpa/xerpa_test_api":{"id":"01929aee-a3be-7f8c-91f1-e7a772cc76dc"}}}}],"id":"05fda524-61b5-4fd4-ba9c-cd365df477e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token_user}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/transactions/created-at-last-hours/24/","description":"Este endpoint permite obtener las transacciones creadas en las últimas 24 horas por un usuario específico, ordenadas cronológicamente (de más reciente a más antigua). Es útil para mostrar un resumen actualizado en dashboards o actividades recientes, permitiendo a los usuarios revisar sus transacciones recientes de manera eficiente.
\nWidgets
\n- \n
- Home integrado, últimos movimientos. \n
\n
Request
\n- \n
Método:
\nGET\nEndpoint:
\n{{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/transactions/created-at-last-hours/24/\nParámetros de ruta:
\n- \n
user_id(string, requerido): ID del usuario cuyas transacciones se desean consultar. \n
\n
Request Body
\nEste request de tipo GET no requiere cuerpo.
El cuerpo de la solicitud debe enviarse vacío.
Response
\nLa respuesta será un objeto JSON que contiene un arreglo de transacciones ordenadas por fecha de creación (created_at), de la más nueva a la más antigua. Cada transacción incluirá los siguientes campos:
- \n
\nid(string): ID único de la transacción. \n
\nignore_pfm(boolean): Indica si la transacción debe ser ignorada por el PFM. \n
\nexternal_id(string): ID externo asociado a la transacción. \n
\nuser_id(string): ID del usuario propietario. \n
\ntransaction_date(string): Fecha de ocurrencia de la transacción. \n
\ntransaction_datetime(string): Fecha y hora de la transacción. \n
\namount(number): Monto de la transacción. \n
\ndescription(string): Descripción o concepto registrado. \n
\ncategory(string): Categoría asignada a la transacción. \n
\nuser_note(string|null): Nota del usuario sobre la transacción. \n
\nproduct_type(object): Detalles del tipo de producto, incluyendo:- \n
\nid(string): ID del tipo de producto. \n
\ncatalog(string): Catálogo del producto. \n
\nitem_name(string): Nombre del artículo. \n
\ndescription(string): Descripción del producto. \n
\nmetadata(object): Información adicional del producto, incluyendo:- \n
\nicon(string): Icono del producto. \n
\ncolor(string): Color del producto. \n
\nactive(boolean): Estado de actividad del producto. \n
\nshort_name(string): Nombre corto del producto. \n
\n
\n
\nexchange_rate(number|null): Tasa de cambio aplicable. \n
\nmerchant(object|null): Información del comerciante asociado. \n
\naccount_id(string): ID de la cuenta asociada a la transacción. \n
\ntransaction_note(object|null): Nota de la transacción, que incluye:- \n
\nid(string): ID de la nota. \n
\nuser_id(string): ID del usuario que creó la nota. \n
\nupdated_at(string): Timestamp de la última actualización. \n
\ntransaction(string): ID de la transacción relacionada. \n
\ntransaction_date(string): Fecha de la transacción relacionada. \n
\ntransaction_note(string): Contenido de la nota de la transacción. \n
\n
\nclassified(boolean): Indica si la transacción ha sido clasificada. \n
\nattributes(object): Atributos adicionales de la transacción. \n
\ntags(array): Lista de etiquetas asociadas a la transacción. \n
Response Format
\n{\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"ignore_pfm\": { \"type\": \"boolean\" },\n \"external_id\": { \"type\": \"string\" },\n \"user_id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"transaction_date\": { \"type\": \"string\", \"format\": \"date\" },\n \"transaction_datetime\": { \"type\": \"string\", \"format\": \"date-time\" },\n \"amount\": { \"type\": \"string\", \"pattern\": \"^\\d+(\\.\\d{2})?$\" },\n \"description\": { \"type\": \"string\" },\n \"category\": {\n \"oneOf\": [\n { \"type\": \"string\", \"format\": \"uuid\" },\n {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"catalog\": { \"type\": \"string\" },\n \"item_name\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"bg\": { \"type\": \"string\" },\n \"icon\": { \"type\": \"string\" },\n \"name\": { \"type\": \"string\" },\n \"color\": { \"type\": \"string\" },\n \"active\": { \"type\": \"boolean\" },\n \"short_name\": { \"type\": \"string\" },\n \"color_class\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"icon_ignore\": { \"type\": \"string\" },\n \"icon_primary\": { \"type\": \"string\" }\n }\n }\n }\n }\n ]\n },\n \"user_note\": { \"type\": [\"string\", \"null\"] },\n \"product_type\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"catalog\": { \"type\": \"string\" },\n \"item_name\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"icon\": { \"type\": \"string\" },\n \"color\": { \"type\": \"string\" },\n \"active\": { \"type\": \"boolean\" },\n \"short_name\": { \"type\": \"string\" }\n }\n }\n }\n },\n \"exchange_rate\": {\n \"oneOf\": [\n { \"type\": \"null\" },\n {\n \"type\": \"object\",\n \"properties\": {\n \"from\": { \"type\": \"string\" },\n \"to\": { \"type\": \"string\" },\n \"rate\": { \"type\": \"number\" }\n }\n }\n ]\n },\n \"merchant\": {\n \"oneOf\": [\n { \"type\": \"null\" },\n {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\" },\n \"name\": { \"type\": \"string\" },\n \"category\": { \"type\": \"string\" }\n }\n }\n ]\n },\n \"account_id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"transaction_note\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"user_id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"updated_at\": { \"type\": \"string\", \"format\": \"date-time\" },\n \"transaction\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"transaction_date\": { \"type\": \"string\", \"format\": \"date\" },\n \"transaction_note\": { \"type\": \"string\" }\n }\n },\n \"classified\": { \"type\": \"boolean\" },\n \"attributes\": { \"type\": \"object\" },\n \"tags\": { \"type\": \"array\", \"items\": { \"type\": \"string\" } }\n }\n}\n\nEste endpoint permite obtener todas las transacciones clasificadas como gastos fijos de un usuario específico en un mes determinado. Es útil para análisis de recurrencia, control de suscripciones y presupuestos predecibles.
\nWidgets
\n- \n
- Gastos fijos \n
\n
Request
\n- \n
Método:
\nGET\nEndpoint:
\n{{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/views/fixed_expenses/\nParámetros de ruta:
\n- \n
user_id(string, requerido): ID del usuario para el cual se desean obtener los gastos fijos. \n
\nParámetros de query:
\n- \n
date_month(string, requerido): Mes y año en formatoYYYY-MMpara filtrar las transacciones. \n
\n
Request Body
\nEste request de tipo GET no requiere cuerpo.
El cuerpo de la solicitud debe enviarse vacío.
Response
\nLa respuesta será un objeto JSON que contiene información sobre los gastos fijos del usuario, incluyendo el total de gastos y la cantidad de transacciones.
\n- \n
\nmonth_date(string): Fecha del mes consultado. \n
\nuser_id(string): ID del usuario asociado. \n
\ntotal_amount(number): Monto total de los gastos fijos para el mes. \n
\ntransaction_quantity(integer): Cantidad total de transacciones clasificadas como gastos fijos. \n
\ntransactions(object): Objeto que contiene la paginación y los detalles de las transacciones.- \n
\nnext(string|null): URL para la siguiente página de resultados. \n
\nprevious(string|null): URL para la página anterior de resultados. \n
\ntotal_pages(integer): Total de páginas disponibles. \n
\ncurrent_page(integer): Página actual de los resultados. \n
\noffset(integer): Desplazamiento de los resultados. \n
\nresults(array): Arreglo que contiene los detalles de cada transacción.- \n
\nid(string): Identificador único de la transacción. \n
\nignore_pfm(boolean): Indica si la transacción debe ser ignorada por el PFM. \n
\nexternal_id(string): ID externo asociado a la transacción. \n
\ntransaction_date(string): Fecha de la transacción. \n
\namount(string): Monto de la transacción. \n
\ndescription(string): Descripción de la transacción. \n
\ncategory(string): Categoría a la que pertenece la transacción. \n
\nuser_note(string|null): Nota del usuario sobre la transacción. \n
\nproduct_type(object): Detalles del tipo de producto asociado. \n
\naccount_id(string): ID de la cuenta asociada a la transacción. \n
\nclassified(boolean): Indica si la transacción ha sido clasificada correctamente. \n
\n
\n
Response Format
\n{\n \"type\": \"object\",\n \"properties\": {\n \"month_date\": {\"type\": \"string\"},\n \"user_id\": {\"type\": \"string\"},\n \"total_amount\": {\"type\": \"number\"},\n \"transaction_quantity\": {\"type\": \"integer\"},\n \"transactions\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\"type\": \"string\"},\n \"ignore_pfm\": {\"type\": \"boolean\"},\n \"external_id\": {\"type\": \"string\"},\n \"user_id\": {\"type\": \"string\"},\n \"transaction_date\": {\"type\": \"string\"},\n \"amount\": {\"type\": \"string\"},\n \"description\": {\"type\": \"string\"},\n \"category\": {\"type\": \"string\"},\n \"user_note\": {\"type\": [\"string\", \"null\"]},\n \"product_type\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\"type\": \"string\"},\n \"catalog\": {\"type\": \"string\"},\n \"item_name\": {\"type\": \"string\"},\n \"description\": {\"type\": \"string\"},\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"icon\": {\"type\": \"string\"},\n \"color\": {\"type\": \"string\"},\n \"active\": {\"type\": \"boolean\"},\n \"short_name\": {\"type\": \"string\"}\n }\n }\n }\n },\n \"account_id\": {\"type\": \"string\"},\n \"classified\": {\"type\": \"boolean\"}\n }\n }\n },\n \"next\": {\"type\": [\"string\", \"null\"]},\n \"previous\": {\"type\": [\"string\", \"null\"]},\n \"total_pages\": {\"type\": \"integer\"},\n \"current_page\": {\"type\": \"integer\"},\n \"offset\": {\"type\": \"integer\"},\n \"results\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\"type\": \"string\"},\n \"ignore_pfm\": {\"type\": \"boolean\"},\n \"external_id\": {\"type\": \"string\"},\n \"user_id\": {\"type\": \"string\"},\n \"transaction_date\": {\"type\": \"string\"},\n \"amount\": {\"type\": \"string\"},\n \"description\": {\"type\": \"string\"},\n \"category\": {\"type\": \"string\"},\n \"user_note\": {\"type\": [\"string\", \"null\"]},\n \"product_type\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\"type\": \"string\"},\n \"catalog\": {\"type\": \"string\"},\n \"item_name\": {\"type\": \"string\"},\n \"description\": {\"type\": \"string\"},\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"icon\": {\"type\": \"string\"},\n \"color\": {\"type\": \"string\"},\n \"active\": {\"type\": \"boolean\"},\n \"short_name\": {\"type\": \"string\"}\n }\n }\n }\n },\n \"account_id\": {\"type\": \"string\"},\n \"classified\": {\"type\": \"boolean\"}\n }\n }\n }\n }\n}\n\nEste endpoint permite obtener todas las transacciones clasificadas como gastos variables de un usuario determinado. Es útil para monitorear patrones de gasto no recurrentes o fluctuantes.
\nWidgets
\n- \n
- Gasto variable \n
\n
Request
\n- \n
Método:
\nGET\nEndpoint:
\n{{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/views/variable_expenses/\nParámetros de ruta:
\n- \n
user_id(string): ID del usuario. \n
\nParámetros de query:
\n- \n
\ncategory(string, requerido): Categoría de gasto. Puedes especificar múltiples categorías separadas por comas. \n
\npage(integer, opcional): Número de página para paginación. \n
\npage_size(integer, opcional): Número de transacciones por página. \n
\nexpand(string, opcional): Campos adicionales a incluir en la respuesta (ej.category,exchange_rate). \n
\nmovement_type(string, opcional): Tipo de movimiento, comoincomes. \n
\ndate_month(string, opcional): Mes y año de las transacciones en formatoYYYY-MM. \n
\n
Request Body
\nEste request de tipo GET no requiere cuerpo.
El cuerpo de la solicitud debe enviarse vacío.
Response
\nLa respuesta será un objeto JSON que incluye información sobre los gastos variables del usuario especificado.
\nCampos de respuesta:
\n- \n
\nmonth_date(string): Fecha del mes correspondiente a los gastos. \n
\nuser_id(string): ID del usuario. \n
\ntotal_amount(number): Monto total de los gastos variables. \n
\ntransaction_quantity(number): Cantidad total de transacciones. \n
\ntransactions(object): Objeto que contiene información paginada sobre las transacciones.- \n
\nnext(string|null): URL para la siguiente página de resultados. \n
\nprevious(string|null): URL para la página anterior de resultados. \n
\ntotal_pages(integer): Número total de páginas disponibles. \n
\ncurrent_page(integer): Página actual de los resultados. \n
\noffset(integer): Desplazamiento de los resultados. \n
\nresults(array): Lista de transacciones categorizadas como gasto variable.- \n
\nid(string): ID único de la transacción. \n
\nignore_pfm(boolean): Indica si la transacción debe ser ignorada en el análisis de PFM. \n
\nexternal_id(string): ID externo asociado a la transacción. \n
\ntransaction_date(string): Fecha de la transacción. \n
\ntransaction_datetime(string): Fecha y hora de la transacción. \n
\namount(string): Monto de la transacción. \n
\ndescription(string): Descripción de la transacción. \n
\ncategory(string): Categoría de la transacción. \n
\nuser_note(string|null): Nota del usuario sobre la transacción. \n
\nproduct_type(object): Información sobre el tipo de producto.- \n
\nid(string): ID del producto. \n
\ncatalog(string): Catálogo del producto. \n
\nitem_name(string): Nombre del ítem. \n
\ndescription(string): Descripción del producto. \n
\nmetadata(object): Información adicional del producto.- \n
\nicon(string): Icono del producto. \n
\ncolor(string): Color asociado al producto. \n
\nactive(boolean): Indica si el producto está activo. \n
\nshort_name(string): Nombre corto del producto. \n
\n
\n
\nexchange_rate(number|null): Tasa de cambio asociada a la transacción. \n
\nmerchant(string|null): Comerciante asociado a la transacción. \n
\naccount_id(string): ID de la cuenta utilizada para la transacción. \n
\ntransaction_note(string|null): Nota específica de la transacción. \n
\nclassified(boolean): Indica si la transacción ha sido clasificada correctamente. \n
\n
\n
Response Format
\n{\n \"type\": \"object\",\n \"properties\": {\n \"month_date\": {\"type\": \"string\"},\n \"user_id\": {\"type\": \"string\"},\n \"total_amount\": {\"type\": \"number\"},\n \"transaction_quantity\": {\"type\": \"integer\"},\n \"transactions\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\"type\": \"string\"},\n \"ignore_pfm\": {\"type\": \"boolean\"},\n \"external_id\": {\"type\": \"string\"},\n \"user_id\": {\"type\": \"string\"},\n \"transaction_date\": {\"type\": \"string\"},\n \"amount\": {\"type\": \"string\"},\n \"description\": {\"type\": \"string\"},\n \"category\": {\"type\": \"string\"},\n \"user_note\": {\"type\": [\"string\", \"null\"]},\n \"product_type\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\"type\": \"string\"},\n \"catalog\": {\"type\": \"string\"},\n \"item_name\": {\"type\": \"string\"},\n \"description\": {\"type\": \"string\"},\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"icon\": {\"type\": \"string\"},\n \"color\": {\"type\": \"string\"},\n \"active\": {\"type\": \"boolean\"},\n \"short_name\": {\"type\": \"string\"}\n }\n }\n }\n },\n \"account_id\": {\"type\": \"string\"},\n \"classified\": {\"type\": \"boolean\"}\n }\n }\n },\n \"next\": {\"type\": [\"string\", \"null\"]},\n \"previous\": {\"type\": [\"string\", \"null\"]},\n \"total_pages\": {\"type\": \"integer\"},\n \"current_page\": {\"type\": \"integer\"},\n \"offset\": {\"type\": \"integer\"},\n \"results\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\"type\": \"string\"},\n \"ignore_pfm\": {\"type\": \"boolean\"},\n \"external_id\": {\"type\": \"string\"},\n \"user_id\": {\"type\": \"string\"},\n \"transaction_date\": {\"type\": \"string\"},\n \"amount\": {\"type\": \"string\"},\n \"description\": {\"type\": \"string\"},\n \"category\": {\"type\": \"string\"},\n \"user_note\": {\"type\": [\"string\", \"null\"]},\n \"product_type\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\"type\": \"string\"},\n \"catalog\": {\"type\": \"string\"},\n \"item_name\": {\"type\": \"string\"},\n \"description\": {\"type\": \"string\"},\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"icon\": {\"type\": \"string\"},\n \"color\": {\"type\": \"string\"},\n \"active\": {\"type\": \"boolean\"},\n \"short_name\": {\"type\": \"string\"}\n }\n }\n }\n },\n \"account_id\": {\"type\": \"string\"},\n \"classified\": {\"type\": \"boolean\"}\n }\n }\n }\n }\n}\n\nexpenses, incomes
\n","type":"text/plain"},"key":"movement_type","value":"incomes"},{"key":"date_month","value":"2024-12"}],"variable":[]}},"response":[{"id":"8d8f02b3-0490-47bc-ad4a-68d6e84da993","name":"Sucessful Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/views/variable_expenses/?category=uncategorized&category=3954361d-ddf5-46dc-a8f8-af98ee9811da&page=1&page_size=1&expand=category,exchange_rate&movement_type=incomes&date_month=2024-12","host":["{{host_app}}"],"path":["api-pfm","v1","pfm-service","users","{{user_id}}","views","variable_expenses",""],"query":[{"key":"category","value":"uncategorized"},{"key":"category","value":"3954361d-ddf5-46dc-a8f8-af98ee9811da"},{"key":"page","value":"1"},{"key":"page_size","value":"1"},{"key":"expand","value":"category,exchange_rate"},{"key":"movement_type","value":"incomes","description":"expenses, incomes"},{"key":"date_month","value":"2024-12"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 04 Jun 2025 21:25:19 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"229"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"5538429e-5a42-45b7-9c5c-3dcf12b5c1be"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LqH2BF3BIAMEJmg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6840b9bf-1ec56d114de69b1d108f3809;Parent=4eb258368181a95f;Sampled=0;Lineage=1:e7de7122:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"month_date\": \"2024-12\",\n \"user_id\": \"7a1cb76c-9af3-4557-bc6c-f56f9ee8ef8e\",\n \"total_amount\": 0,\n \"transaction_quantity\": 0,\n \"transactions\": {\n \"next\": null,\n \"previous\": null,\n \"total_pages\": 1,\n \"current_page\": 1,\n \"offset\": 0,\n \"results\": [],\n \"count\": 0\n }\n}"}],"_postman_id":"6120323e-a331-4a9f-b86f-0eb8d00998d7"}],"id":"cecd5e0e-9061-436a-a766-c9fe910e8417","_postman_id":"cecd5e0e-9061-436a-a766-c9fe910e8417","description":""}],"id":"04fa0ba1-9fa2-406b-aa83-b6772bc8b599","description":"💳 Gestión de transacciones financieras
\nLa carpeta Transactions agrupa los endpoints que permiten consultar, clasificar, modificar y analizar las transacciones financieras asociadas a las cuentas del usuario. Es uno de los núcleos funcionales del sistema de finanzas personales (PFM), ya que a partir de estas transacciones se generan métricas, presupuestos, reglas y reportes.
\nEstas transacciones pueden provenir de integraciones bancarias o ser ingresadas manualmente, y son enriquecidas mediante procesos de categorización automática, reglas personalizadas y actividad del usuario.
\n\n
📌 Funcionalidades incluidas
\nLos endpoints disponibles permiten:
\n- \n
Consultar transacciones generales, fijas, variables o recientes.
\n \nObtener el detalle completo de una transacción individual.
\n \nCambiar su categoría de forma manual o marcarla como \"ignorada\".
\n \nAgregar o editar notas asociadas a una transacción.
\n \nRegistrar reclasificaciones y consultarlas posteriormente.
\n \nAcceder a métricas agregadas como balance, ingresos, gastos, y comparativas fijas vs. variables.
\n \n
\n
🧠 Casos de uso
\n- \n
Visualizar las transacciones en dashboards o historiales personales.
\n \nAnalizar el comportamiento de gasto por categoría o periodo.
\n \nAplicar reglas de reclasificación para corregir errores o preferencias personales.
\n \nEtiquetar transacciones con notas y trazabilidad de cambios.
\n \nGenerar reportes de actividad financiera personalizados.
\n \n
\n
🧩 Características destacadas
\n- \n
Las transacciones pueden clasificarse automáticamente mediante motores de Machine Learning, pero permiten intervención del usuario.
\n \nSe admite categorización manual (
\nPATCH,PUT) y reversión de clasificaciones (reclassify). \nEl atributo
\nfixed_expenseindica si una transacción es recurrente. \nMuchas operaciones pueden realizarse de forma parcial sin modificar el resto de los campos.
\n \n
\n
🔐 Seguridad
\n- \n
Todos los endpoints requieren autenticación.
\n \nLas modificaciones a transacciones pueden estar restringidas a usuarios propietarios.
\n \nAlgunas operaciones, como las reclasificaciones automáticas, requieren privilegios backend o administrativos.
\n \n
Este endpoint permite obtener el listado completo de reglas de clasificación definidas por el usuario.
\nWidgets
\n\n\n
Request
\n- \n
Método:
\nGET\nEndpoint:
\n{{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/user-rules-classification/\nParámetros de ruta:
\n- \n
user_id(string, requerido): ID del usuario que desea consultar sus reglas. \n
\nParámetros de query:
\n- \n
\npage(integer, opcional): Número de página para paginación de resultados. \n
\npage_size(integer, opcional): Cantidad de resultados por página. \n
\n
Request Body
\nEste request de tipo GET no requiere cuerpo.
El cuerpo de la solicitud debe enviarse vacío.
Response
\nDevuelve un objeto JSON que contiene información sobre las reglas de clasificación del usuario, con la siguiente estructura:
\nresults (array): Arreglo de objetos que representan las reglas de clasificación, cada uno con los siguientes campos:
- \n
\nid(string): Identificador de la regla. \n
\ncreated_at(string): Fecha de creación de la regla. \n
\nupdated_at(string): Fecha de la última actualización de la regla. \n
\nuser_id(string): ID del usuario al que pertenece la regla. \n
\ndeleted_at(string|null): Fecha de eliminación de la regla, si aplica. \n
\nrule_config(object): Configuración de la regla que incluye:- \n
\nfield(string): Campo evaluado (por ejemplo,description,amount). \n
\nvalue(string|number): Valor a comparar. \n
\noperator(string): Operador de comparación. \n
\ntarget_category(string): ID de la categoría objetivo. \n
\n
\nmetadata(object|null): Metadatos adicionales sobre la regla, si aplica. \n
\nuser_pfm_actions_type(string): Tipo de acción del usuario en relación a la regla. \n
\nuser_rules_classification_status(string): Estado de clasificación de la regla. \n
La respuesta también incluye información de paginación, como:
\n- \n
\nnext(string or null): URL de la siguiente página \n
\nprevious(string or null): URL de la página anterior \n
\ntotal_pages(number): Total de páginas disponibles \n
\ncurrent_page(number): Página actual \n
\noffset(number): Índice de desplazamiento \n
\ncount(number): Total de elementos \n
Response Format
\n{\n \"type\": \"object\",\n \"properties\": {\n \"next\": { \"type\": [\"string\", \"null\"], \"format\": \"uri\" },\n \"previous\": { \"type\": [\"string\", \"null\"], \"format\": \"uri\" },\n \"total_pages\": { \"type\": \"integer\", \"minimum\": 1 },\n \"current_page\": { \"type\": \"integer\", \"minimum\": 1 },\n \"offset\": { \"type\": \"integer\", \"minimum\": 0 },\n \"count\": { \"type\": \"integer\", \"minimum\": 0 },\n \"results\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"created_at\": { \"type\": \"string\", \"format\": \"date-time\" },\n \"updated_at\": { \"type\": \"string\", \"format\": \"date-time\" },\n \"user_id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"deleted_at\": { \"type\": [\"string\", \"null\"], \"format\": \"date-time\" },\n \"rule_config\": {\n \"type\": \"object\",\n \"properties\": {\n \"field\": { \"type\": \"string\" },\n \"value\": { \"type\": \"string\" },\n \"operator\": { \"type\": \"string\" },\n \"target_category\": { \"type\": \"string\" }\n }\n },\n \"metadata\": { \"type\": [\"object\", \"null\"] },\n \"user_pfm_actions_type\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"user_rules_classification_status\": { \"type\": \"string\", \"format\": \"uuid\" }\n }\n }\n }\n }\n}\n\nEste endpoint recupera las reglas de clasificación asociadas a un usuario específico dentro del servicio de Gestión de Finanzas Personales (PFM). Proporciona información sobre cómo se categorizan y clasifican las transacciones del usuario con base en reglas predefinidas.
\nWidgets
\n\n\n
Request
\n- \n
- Método:
GET
URL:{{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/user-rules-classification\n
Parámetros de Ruta:
\n- \n
user_id(string): El identificador único del usuario cuyas reglas de clasificación se desean consultar. \n
Response
\nLa respuesta será un objeto JSON que contiene los siguientes campos:
\n- \n
\nid(string): Identificador único de la regla de clasificación. \n
\nignore_pfm(boolean): Indica si el servicio PFM debe ignorar esta regla. \n
\nexternal_id(string): Identificador externo asociado a la regla. \n
\nuser_id(string): ID del usuario relacionado con la clasificación. \n
\ntransaction_date(string): Fecha de la transacción. \n
\ntransaction_datetime(string): Fecha y hora de la transacción. \n
\namount(string): Monto de la transacción. \n
\ndescription(string): Descripción de la transacción. \n
\ncategory(string): Categoría asignada a la transacción. \n
\nuser_note(string o null): Nota agregada por el usuario sobre la transacción. \n
product_type (object): Objeto que contiene los detalles del tipo de producto, incluyendo:
\n- \n
\nid(string): Identificador único del tipo de producto. \n
\ncatalog(string): Catálogo al que pertenece el producto. \n
\nitem_name(string): Nombre del ítem. \n
\ndescription(string): Descripción del tipo de producto. \n
\nmetadata(object): Metadatos adicionales del tipo de producto, incluyendo:- \n
\nicon(string): Ícono asociado al tipo de producto. \n
\ncolor(string): Representación de color del producto. \n
\nactive(boolean): Indica si el producto está activo. \n
\nshort_name(string): Nombre corto del tipo de producto. \n
\n
\nexchange_rate(string o null): Tipo de cambio aplicable a la transacción, si existe. \n
\nmerchant(string o null): Comerciante asociado a la transacción, si aplica. \n
\naccount_id(string): ID de la cuenta relacionada con la transacción. \n
\ntransaction_note(string o null): Nota relacionada con la transacción. \n
\nclassified(boolean): Indica si la transacción ha sido clasificada de acuerdo con las reglas. \n
\n
Este endpoint es esencial para comprender cómo se clasifican las transacciones de los usuarios, lo que permite una mejor gestión financiera y generación de reportes.
\n","urlObject":{"path":["api-pfm","v1","pfm-service","users","{{user_id}}","user-rules-classification"],"host":["{{host_app}}"],"query":[],"variable":[]}},"response":[{"id":"e41f7697-b993-45d2-afe7-47f9f8961d5a","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":"{{host_app}}/api-pfm/v1/pfm-service/users/61a85f1f-98aa-4dcd-837d-84cf54bb532a/transactions/14956a01-f5ee-4ea3-be40-9f2fd33a84c6/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 08 Aug 2024 15:05:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"771"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"3e4cbbd3-4cf7-44c0-98bb-2356dd423b7b"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"cMe56EhgoAMEL_w="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66b4dea5-2564bf58163d359467be85c2;Parent=3276b9e97db3029c;Sampled=0;lineage=e7de7122:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"14956a01-f5ee-4ea3-be40-9f2fd33a84c6\",\n \"ignore_pfm\": false,\n \"external_id\": \"TRX_971\",\n \"user_id\": \"61a85f1f-98aa-4dcd-837d-84cf54bb532a\",\n \"transaction_date\": \"2024-08-05\",\n \"transaction_datetime\": \"2024-08-05T00:00:00+0000\",\n \"amount\": \"-950.51\",\n \"description\": \"PAYU*PYU*UBER\",\n \"category\": \"f37b6770-7fc5-43e0-a837-50926e1ee459\",\n \"user_note\": null,\n \"product_type\": {\n \"id\": \"93909b64-0e8c-4494-bec5-c84906430182\",\n \"catalog\": \"f1895069-e723-4cc8-9331-d1cb4110ab7a\",\n \"item_name\": \"cuenta_ahorro\",\n \"description\": \"Cuenta Ahorro\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/cuenta_ahorro.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"CUENTAAHORRO\"\n }\n },\n \"exchange_rate\": null,\n \"merchant\": null,\n \"account_id\": \"12bf0ea1-da88-445c-9c17-29edbd18510d\",\n \"transaction_note\": null,\n \"classified\": false\n}"},{"id":"e0e39816-71ec-4302-ac62-1373c215f23e","name":"Not Found","originalRequest":{"method":"GET","header":[],"url":"{{host_app}}/api-pfm/v1/pfm-service/users/61a85f1f-98aa-4dcd-837d-84cf54bb532a/transactions/14956a01-f5ee-4ea3-be40-9f2fd33a84c7/"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 08 Aug 2024 15:06:37 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"23"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"6f359098-1d85-40b4-82d8-e18d4bb06e70"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"cMfHlEVYIAMEi0Q="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66b4defd-7c085e9c76226ec9456419d2;Parent=1ba76fb239a01581;Sampled=0;lineage=e7de7122:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"Not found.\"\n}"}],"_postman_id":"ff7202e8-f366-41ac-b441-995eb4d9bb52"},{"name":"Crear Regla clasificación","event":[{"listen":"test","script":{"id":"ec6a0890-a38d-41af-a167-8685a317b03f","exec":["const xerpaTestApi = pm.require('@getxerpa/xerpa_test_api');\r","\r","xerpaTestApi.testResponseTime();\r","xerpaTestApi.testSuccessfulGet();\r","\r","// Parse the response JSON\r","const responseJson = pm.response.json();\r","\r","// Define the expected property types\r","const topLevelProperties = {\r"," id: 'string',\r"," ignore_pfm: 'boolean',\r"," external_id: 'string',\r"," user_id: 'string',\r"," transaction_date: 'string',\r"," transaction_datetime: 'string',\r"," amount: 'string',\r"," description: 'string',\r"," category: 'string',\r"," user_note: { type: 'string', optional: true },\r"," product_type: 'object',\r"," exchange_rate: { type: 'string', optional: true },\r"," merchant: 'object',\r"," account_id: 'string',\r"," transaction_note: 'object',\r"," classified: 'boolean'\r","};\r","\r","const productTypeProperties = {\r"," id: 'string',\r"," catalog: 'string',\r"," item_name: 'string',\r"," description: 'string',\r"," metadata: 'object'\r","};\r","\r","const metadataProperties = {\r"," icon: 'string',\r"," color: 'string',\r"," active: 'boolean',\r"," short_name: 'string'\r","};\r","\r","const merchantProperties = {\r"," id: 'string',\r"," name: 'string',\r"," logo_url: 'string'\r","};\r","\r","const transactionNoteProperties = {\r"," id: 'string',\r"," user_id: 'string',\r"," updated_at: 'string',\r"," transaction: 'string',\r"," transaction_date: 'string',\r"," transaction_note: 'string'\r","};\r","\r","// Check top-level properties\r","pm.test(\"Response has expected top-level properties with correct types\", () => {\r"," xerpaTestApi.checkObjectProperties(responseJson, topLevelProperties);\r","});\r","\r","// Check properties of the product_type object\r","pm.test(\"Product type has expected properties with correct types\", () => {\r"," xerpaTestApi.checkObjectProperties(responseJson.product_type, productTypeProperties);\r"," \r"," // Check metadata properties of the product_type object\r"," xerpaTestApi.checkObjectProperties(responseJson.product_type.metadata, metadataProperties);\r","});\r","\r","// Check properties of the merchant object\r","pm.test(\"Merchant has expected properties with correct types\", () => {\r"," xerpaTestApi.checkObjectProperties(responseJson.merchant, merchantProperties);\r","});\r","\r","// Check properties of the transaction_note object\r","pm.test(\"Transaction note has expected properties with correct types\", () => {\r"," xerpaTestApi.checkObjectProperties(responseJson.transaction_note, transactionNoteProperties);\r","});"],"type":"text/javascript","packages":{"@getxerpa/xerpa_test_api":{"id":"01929aee-a3be-7f8c-91f1-e7a772cc76dc"}}}}],"id":"cec5aba5-75d8-4a4d-822b-783af1d9284c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token_user}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"rule_config\": {\r\n \"field\": \"description\",\r\n \"operator\": \"contains\",\r\n \"value\": \"NETFLIX\",\r\n \"target_category\": \"entertainment\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/user-rules-classification","description":"Este endpoint permite crear una nueva regla de clasificación personalizada para un usuario específico en el sistema de gestión de finanzas personales (PFM). La regla se basa en un campo específico y un valor que se desea clasificar en una categoría determinada.
\nWidgets
\n\n\n
Request
\n- \n
Método:
\nPOST\nEndpoint: {{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/user-rules-classification
\n \nParámetros de ruta:
\n- \n
user_id(string, requerido): ID del usuario que desea consultar sus reglas. \n
\n
Request Body
\nEl cuerpo de la solicitud debe contener los siguientes parámetros en formato JSON:
\n- \n
rule_config (objeto): Configuración de la regla de clasificación.
\n- \n
field (string): El campo sobre el cual se aplica la regla (ej. \"description\").
\n \noperator (string): El operador que se utiliza para la comparación (ej. \"contains\").
\n \nvalue (string): El valor que se busca en el campo especificado (ej. \"NETFLIX\").
\n \ntarget_category (string): La categoría a la que se asignará el valor si la regla se cumple (ej. \"entertainment\").
\n \n
\n
Request Body Example
\n{\n \"rule_config\": {\n \"field\": \"description\",\n \"operator\": \"contains\",\n \"value\": \"NETFLIX\",\n \"target_category\": \"entertainment\"\n }\n}\n\nResponse
\nAl realizar la solicitud, se espera una respuesta en formato JSON con la siguiente estructura:
\n- \n
id (string): Identificador único de la regla creada.
\n \ncreated_at (string): Fecha y hora en que se creó la regla.
\n \nupdated_at (string): Fecha y hora de la última actualización de la regla.
\n \nuser_id (string): Identificador del usuario al que pertenece la regla.
\n \ndeleted_at (null o string): Fecha y hora en que se eliminó la regla, si aplica.
\n \nrule_config (objeto): Configuración de la regla creada.
\n- \n
field (string): Campo utilizado en la regla.
\n \noperator (string): Operador utilizado en la regla.
\n \nvalue (string): Valor utilizado en la regla.
\n \ntarget_category (string): Categoría asignada a la regla.
\n \n
\nmetadata (object or null): Información adicional (si aplica).
\n \nuser_pfm_actions_type (string): Tipo de acción del usuario en el PFM.
\n \nuser_rules_classification_status (string): Estado de la clasificación de la regla del usuario.
\n \n
Response Format
\n{\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"created_at\": { \"type\": \"string\", \"format\": \"date-time\" },\n \"updated_at\": { \"type\": \"string\", \"format\": \"date-time\" },\n \"user_id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"deleted_at\": { \"type\": [\"string\", \"null\"], \"format\": \"date-time\" },\n \"rule_config\": {\n \"type\": \"object\",\n \"properties\": {\n \"field\": { \"type\": \"string\", \"enum\": [\"description\", \"amount\", \"merchant\"] },\n \"operator\": { \"type\": \"string\", \"enum\": [\"contains\", \"equals\", \"starts_with\", \"ends_with\"] },\n \"value\": { \"type\": \"string\" },\n \"target_category\": { \"type\": \"string\" }\n },\n \"required\": [\"field\", \"operator\", \"value\", \"target_category\"]\n },\n \"metadata\": { \"type\": [\"object\", \"null\"] },\n \"user_pfm_actions_type\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"user_rules_classification_status\": { \"type\": \"string\", \"format\": \"uuid\" }\n }\n}\n\nEsta solicitud permite crear una nueva clasificación de reglas para un usuario en el sistema. Se utiliza para definir cómo se deben clasificar las transacciones del usuario basándose en ciertas reglas configuradas.
\nWidgets
\n\n\n
Request
\n- \n
Método:
\nPOST\nEndpoint: {{host_app}}/api-pfm/v1/pfm-service/users/{{user_id}}/user-rules-
\n \nParámetros de ruta:
\n- \n
user_id(string, requerido): ID del usuario que desea consultar sus reglas. \n
\n
Request Body
\nEl cuerpo de la solicitud debe contener los siguientes parámetros en formato JSON:
\n- \n
rule_config (objeto): Configuración de la regla de clasificación.
\n- \n
field (string): El campo sobre el cual se aplica la regla (ej. \"description\").
\n \noperator (string): El operador que se utiliza para la comparación (ej. \"contains\").
\n \nvalue (string): El valor que se busca en el campo especificado (ej. \"NETFLIX\").
\n \ntarget_category (string): La categoría a la que se asignará el valor si la regla se cumple (ej. \"entertainment\").
\n \n
\n
Request Body Example
\n{\n \"rule_config\": {\n \"field\": \"description\",\n \"operator\": \"contains\",\n \"value\": \"NETFLIX\",\n \"target_category\": \"entertainment\"\n }\n}\n\nResponse
\nAl realizar la solicitud, se espera una respuesta en formato JSON con la siguiente estructura:
\n- \n
id (string): Identificador único de la regla creada.
\n \ncreated_at (string): Fecha y hora en que se creó la regla.
\n \nupdated_at (string): Fecha y hora de la última actualización de la regla.
\n \nuser_id (string): Identificador del usuario al que pertenece la regla.
\n \ndeleted_at (null o string): Fecha y hora en que se eliminó la regla, si aplica.
\n \nrule_config (objeto): Configuración de la regla creada.
\n- \n
field (string): Campo utilizado en la regla.
\n \noperator (string): Operador utilizado en la regla.
\n \nvalue (string): Valor utilizado en la regla.
\n \ntarget_category (string): Categoría asignada a la regla.
\n \n
\nmetadata (object or null): Información adicional (si aplica).
\n \nuser_pfm_actions_type (string): Tipo de acción del usuario en el PFM.
\n \nuser_rules_classification_status (string): Estado de la clasificación de la regla del usuario.
\n \n
Response Format
\n{\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"created_at\": { \"type\": \"string\", \"format\": \"date-time\" },\n \"updated_at\": { \"type\": \"string\", \"format\": \"date-time\" },\n \"user_id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"deleted_at\": { \"type\": [\"string\", \"null\"], \"format\": \"date-time\" },\n \"rule_config\": {\n \"type\": \"object\",\n \"properties\": {\n \"field\": { \"type\": \"string\", \"enum\": [\"description\", \"amount\", \"merchant\"] },\n \"operator\": { \"type\": \"string\", \"enum\": [\"contains\", \"equals\", \"starts_with\", \"ends_with\"] },\n \"value\": { \"type\": \"string\" },\n \"target_category\": { \"type\": \"string\" }\n },\n \"required\": [\"field\", \"operator\", \"value\", \"target_category\"]\n },\n \"metadata\": { \"type\": [\"object\", \"null\"] },\n \"user_pfm_actions_type\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"user_rules_classification_status\": { \"type\": \"string\", \"format\": \"uuid\" }\n }\n}\n\n🧠 Reglas personalizadas de clasificación
\nLa carpeta UserRulesClassification contiene los endpoints necesarios para que los usuarios puedan crear, consultar, editar o eliminar reglas personalizadas de clasificación de transacciones. Estas reglas permiten que el usuario influya directamente en la lógica de categorización del sistema, sobreescribiendo o complementando los resultados del motor de Machine Learning.
\nEste sistema de reglas es ejecutado como una segunda capa de decisión y permite una experiencia más precisa, adaptable y alineada a las preferencias personales o contables del usuario.
\n\n
📌 Funcionalidades incluidas
\nLos endpoints de esta carpeta permiten:
\n- \n
Listar todas las reglas activas de un usuario.
\n \nConsultar el detalle de una regla específica.
\n \nCrear nuevas reglas con condiciones definidas (por descripción, monto, etc.).
\n \nEditar reglas existentes.
\n \nEliminar reglas de forma lógica (soft delete).
\n \n
\n
⚙️ Cómo funciona una regla
\nUna regla está compuesta por:
\n- \n
\nfield: Campo sobre el cual se aplica la condición (ej.description). \n
\nvalue: Valor a evaluar (ej.\"Spotify\"). \n
\naction: Acción a realizar si se cumple la condición (ej.set_category). \n
\ncategory_id: Categoría a asignar si aplica. \n
\nactive: Estado de la regla. \n
Las reglas pueden aplicar a transacciones nuevas o recategorizadas manualmente, según la lógica de implementación.
\n\n
🧠 Casos de uso comunes
\n- \n
Clasificar automáticamente suscripciones específicas (ej.
\n\"Netflix\"→Entretenimiento). \nAsignar categorías específicas a cargos frecuentes de montos conocidos.
\n \nCorregir errores comunes del clasificador automático con intervención del usuario.
\n \nAplicar lógica contable personal o corporativa.
\n \n
\n
🔐 Seguridad
\n- \n
Todas las operaciones requieren autenticación.
\n \nLas reglas solo pueden ser gestionadas por el usuario al que pertenecen.
\n \nLa validación del campo, tipo de acción y valores es realizada por el backend.
\n \n
El endpoint entrega una lista de categorías de ingresos del catálogo. Permite a obtener información detallada sobre cada categoría, incluyendo los items asociados y sus metadatos.
\nEste catálogo no permite agregar o quitar items, solo se puede modificar su metadata.
\n\n
Request
\n- \n
Método:
\nGET\nURL: {{host_app}}/api-pfm/v1/pfm-service/catalogs-items/
\n \nParámetros de query:
\n- \n
\ncatalog(string): Id del catalogo que se desea consultar. Este puede tomar los valores:- \n
\"incomes_categories\": Categorias de ingresos.
\n \n\"expenses_categories\": Categorias de gastos
\n \n\"accounts_types\": Tipo de categoria
\n \n
\n
\n
Request Body
\n- \n
- Este request de tipo
GETno requiere cuerpo. El cuerpo de la solicitud debe enviarse vacío. \n
Response
\nLa respuesta es un arreglo de categorias que se presentan como un objeto con sus respectivas propiedades
\n- \n
\nid(string): ID del catalogo. \n
\ncatalog_name(string): Nombre del catalogo. \n
\ndescription(string): Descripcion del catalogo. \n
\nitems(array of objects): Lista de ítems pertenecientes al catálogo consultado, donde cada uno incluye:- \n
\nid(string): Identificador único del ítem. \n
\ncatalog(string): Nombre del catálogo al que pertenece. \n
\nitem_name(string): Clave técnica o interna del ítem. \n
\ndescription(string): Descripción legible del ítem. \n
\nmetadata(object): Metadatos adicionales, como:- \n
\nicon(string): Ícono asociado. \n
\ntitle(string): Título para interfaces gráficas. \n
\nmessage(object): Mensajes contextualizados por canal o lenguaje (A,E,G, etc.). \nOtros campos personalizados según el catálogo.
\n \n
\n
\n
Response Format
\nPara la informacion de cada categoria se mantiene el siguiente formato:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"catalog\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"item_name\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"bg\": { \"type\": \"string\" },\n \"icon\": { \"type\": \"string\" },\n \"name\": { \"type\": \"string\" },\n \"color\": { \"type\": \"string\" },\n \"active\": { \"type\": \"boolean\" },\n \"short_name\": { \"type\": \"string\" },\n \"color_class\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"icon_ignore\": { \"type\": \"string\" },\n \"icon_primary\": { \"type\": \"string\" }\n }\n }\n }\n}\n\nincomes_categories, expenses_categories, accounts_types
\n","type":"text/plain"},"key":"catalog","value":"incomes_categories"}],"variable":[]}},"response":[{"id":"06979dd7-d5e4-4134-990a-e5727ffedc38","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host_app}}/api-pfm/v1/pfm-service/catalogs-items/?catalog=incomes_categories","host":["{{host_app}}"],"path":["api-pfm","v1","pfm-service","catalogs-items",""],"query":[{"key":"paginate","value":"true","disabled":true},{"key":"page","value":"1","type":"text","disabled":true},{"key":"page_size","value":"1","type":"text","disabled":true},{"key":"catalog","value":"incomes_categories"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 07 Aug 2024 18:52:41 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"17897"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"8b0036fc-d038-4a78-a6e6-07901e67429b"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"cJtS9HflIAMELrA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66b3c279-1e14b50207b555c73a555e33;Parent=7e9f95efc2eaeb5e;Sampled=0;lineage=e7de7122:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"incomes_categories\": [\n {\n \"id\": \"e131ca4e-28d2-48fc-ab73-ea92e48b084f\",\n \"catalog\": \"c2a07389-da13-4420-9060-c6bef2d6bd03\",\n \"item_name\": \"Rendimientos\",\n \"description\": \"Pago de dividendos e intereses ganados\",\n \"metadata\": {\n \"bg\": \"#E5F0E0\",\n \"icon\": \"/assets/xerpa/global/img/categories/inc_rendimientos.svg\",\n \"name\": \"Rendimientos\",\n \"color\": \"#4D9932\",\n \"active\": true,\n \"short_name\": \"INCRENDIMIENTOS\",\n \"color_class\": \"cat-inc-rendimientos\",\n \"description\": \"Intereses y pago de dividendos\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/inc_rendimientos_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/inc_rendimientos_primary.svg\"\n }\n },\n {\n \"id\": \"3954361d-ddf5-46dc-a8f8-af98ee9811da\",\n \"catalog\": \"c2a07389-da13-4420-9060-c6bef2d6bd03\",\n \"item_name\": \"Sueldo\",\n \"description\": \"Sueldos, salarios, honorarios e ingresos por trabajo\",\n \"metadata\": {\n \"bg\": \"#E6F9F5\",\n \"icon\": \"/assets/xerpa/global/img/categories/inc_sueldo.svg\",\n \"name\": \"Ingresos\",\n \"color\": \"#01C38E\",\n \"active\": true,\n \"short_name\": \"INCSUELDO\",\n \"color_class\": \"cat-inc-sueldo\",\n \"description\": \"Salarios, honorarios y por contrato\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/inc_sueldo_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/inc_sueldo_primary.svg\"\n }\n },\n {\n \"id\": \"8ebba319-0042-41ff-bdbb-ba05cd824d52\",\n \"catalog\": \"c2a07389-da13-4420-9060-c6bef2d6bd03\",\n \"item_name\": \"Transferencias\",\n \"description\": \"Transferencias, depósitos y reembolsos recibidos\",\n \"metadata\": {\n \"bg\": \"#E3EFE9\",\n \"icon\": \"/assets/xerpa/global/img/categories/inc_transferencias.svg\",\n \"name\": \"Depósitos y Transferencias\",\n \"color\": \"#40916C\",\n \"active\": true,\n \"short_name\": \"INCTRANSFERENCIAS\",\n \"color_class\": \"cat-inc-trasferencias\",\n \"description\": \"Transferencias, depósitos y reembolsos\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/inc_transferencias_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/inc_transferencias_primary.svg\"\n }\n },\n {\n \"id\": \"593cea05-8f4d-4b40-ad1b-d73e43c8d53d\",\n \"catalog\": \"c2a07389-da13-4420-9060-c6bef2d6bd03\",\n \"item_name\": \"Devolución de impuestos\",\n \"description\": \"Devoluciones del Servicio de Impuestos Internos\",\n \"metadata\": {\n \"bg\": \"#DFF1E3\",\n \"icon\": \"/assets/xerpa/global/img/categories/inc_devolucion.svg\",\n \"name\": \"Devolución de impuestos\",\n \"color\": \"#25A244\",\n \"active\": true,\n \"short_name\": \"INCDEVOLUCION\",\n \"color_class\": \"cat-inc-devolucion\",\n \"description\": \"Reembolso o reducción de impuestos\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/inc_devolucion_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/inc_devolucion_primary.svg\"\n }\n },\n {\n \"id\": \"5f342655-bf27-4523-aa32-40d7cb48ae38\",\n \"catalog\": \"c2a07389-da13-4420-9060-c6bef2d6bd03\",\n \"item_name\": \"Subvención\",\n \"description\": \"Pensión, becas, subvención y ayudas familiares\",\n \"metadata\": {\n \"bg\": \"#E4EBE2\",\n \"icon\": \"/assets/xerpa/global/img/categories/inc_subvencion.svg\",\n \"name\": \"Subvención y Pensión\",\n \"color\": \"#47783F\",\n \"active\": true,\n \"short_name\": \"INCSUBVENCION\",\n \"color_class\": \"cat-inc-subvencion\",\n \"description\": \"Pensión y ayuda económica\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/inc_subvencion_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/inc_subvencion_primary.svg\"\n }\n },\n {\n \"id\": \"9abd4759-ab14-4e09-adc2-9c5dea1041b2\",\n \"catalog\": \"c2a07389-da13-4420-9060-c6bef2d6bd03\",\n \"item_name\": \"Rentas y arriendos\",\n \"description\": \"Ingresos por arriendos de muebles e inmuebles\",\n \"metadata\": {\n \"bg\": \"#D9EFE9\",\n \"icon\": \"/assets/xerpa/global/img/categories/inc_rentas.svg\",\n \"name\": \"Rentas y Arriendos\",\n \"color\": \"#01936C\",\n \"active\": true,\n \"short_name\": \"INCRENTAS\",\n \"color_class\": \"cat-inc-rentas\",\n \"description\": \"Arriendo de muebles e inmuebles\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/inc_rentas_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/inc_rentas_primary.svg\"\n }\n },\n {\n \"id\": \"763d39ca-45e8-4171-8a97-29ba9a37665c\",\n \"catalog\": \"c2a07389-da13-4420-9060-c6bef2d6bd03\",\n \"item_name\": \"Regalos y otros ingresos\",\n \"description\": \"Regalos hechos por transferencias y otros ingresos\",\n \"metadata\": {\n \"bg\": \"#E7F0E8\",\n \"icon\": \"/assets/xerpa/global/img/categories/inc_regalos.svg\",\n \"name\": \"Regalos y otros ingresos\",\n \"color\": \"#5C9961\",\n \"active\": true,\n \"short_name\": \"INCREGALOS\",\n \"color_class\": \"cat-inc-regalos\",\n \"description\": \"Otros tipos de ingresos\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/inc_regalos_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/inc_regalos_primary.svg\"\n }\n }\n ]\n}"}],"_postman_id":"84071bf8-ff92-43a3-9d97-28c36ad2b048"},{"name":"Categorías de egreso","event":[{"listen":"test","script":{"id":"299ec8c8-53e5-49b7-8cf4-2bc26bdc70e2","exec":[" const xerpaTestApi = pm.require('@getxerpa/xerpa_test_api');\r","\r","xerpaTestApi.testResponseTime();\r","xerpaTestApi.testSuccessfulGet();\r","\r","// Parse the response JSON\r","const responseJson = pm.response.json();\r","\r","// Define the expected property types\r","const topLevelProperties = {\r"," id: 'string',\r"," catalog_name: 'string',\r"," description: 'string',\r"," items: 'array'\r","};\r","\r","const itemProperties = {\r"," id: 'string',\r"," catalog: 'string',\r"," item_name: 'string',\r"," description: 'string',\r"," metadata: 'object'\r","};\r","\r","const metadataProperties = {\r"," icon: 'string',\r"," color: 'string',\r"," active: 'boolean',\r"," short_name: 'string'\r","};\r","\r","// Check top-level properties\r","pm.test(\"Response has expected top-level properties with correct types\", () => {\r"," if (responseJson && responseJson.length > 0) {\r"," xerpaTestApi.checkObjectProperties(responseJson[0], topLevelProperties);\r"," }\r","});\r","\r","// Check properties within the items array of the first catalog\r","pm.test(\"Items have expected properties with correct types\", () => {\r"," if (responseJson[0].items && responseJson[0].items.length > 0) {\r"," xerpaTestApi.checkObjectProperties(responseJson[0].items[0], itemProperties);\r"," \r"," // Check metadata properties of the first item\r"," xerpaTestApi.checkObjectProperties(responseJson[0].items[0].metadata, metadataProperties);\r"," }\r","});"],"type":"text/javascript","packages":{"@getxerpa/xerpa_test_api":{"id":"01929aee-a3be-7f8c-91f1-e7a772cc76dc"}}}}],"id":"d57176a9-486c-4074-99e9-74f816955a4c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token_user}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{host_app}}/api-pfm/v1/pfm-service/catalogs-items/?catalog=expenses_categories","description":"El endpoint entrega una lista de categorías de gastos del catálogo. Permite a obtener información detallada sobre cada categoría, incluyendo los items asociados y sus metadatos.
\nEste catálogo no permite agregar o quitar items, sólo se pueden modficar la información de su metadata.
\nWidgets
\n\n\n
Request
\n- \n
Método:
\nGET\nURL: {{host_app}}/api-pfm/v1/pfm-service/catalogs-items/
\n \nParámetros de query:
\n- \n
\ncatalog(string): Id del catalogo que se desea consultar. Este puede tomar los valores:- \n
\"incomes_categories\": Categorias de ingresos.
\n \n\"expenses_categories\": Categorias de gastos
\n \n\"accounts_types\": Tipo de categoria
\n \n
\n
\n
Request Body
\n- \n
- Este request de tipo
GETno requiere cuerpo. El cuerpo de la solicitud debe enviarse vacío. \n
Response
\nLa respuesta es un arreglo de categorias de diccionarios, en donde cada categoria contiene otro arreglo que agrupa los catalogos, los cuales contien:
\n- \n
\nid(string): ID del catalogo. \n
\ncatalog_name(string): Nombre del catalogo. \n
\ndescription(string): Descripcion del catalogo. \n
\nitems(array of objects): Lista de ítems pertenecientes al catálogo consultado, donde cada uno incluye:- \n
\nid(string): Identificador único del ítem. \n
\ncatalog(string): Nombre del catálogo al que pertenece. \n
\nitem_name(string): Clave técnica o interna del ítem. \n
\ndescription(string): Descripción legible del ítem. \n
\nmetadata(object): Metadatos adicionales, como:- \n
\nicon(string): Ícono asociado. \n
\ntitle(string): Título para interfaces gráficas. \n
\nmessage(object): Mensajes contextualizados por canal o lenguaje (A,E,G, etc.). \nOtros campos personalizados según el catálogo.
\n \n
\n
\n
Response Format
\nPara la informacion de cada categoria se mantiene el siguiente formato:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"catalog\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"item_name\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"bg\": { \"type\": \"string\" },\n \"icon\": { \"type\": \"string\" },\n \"name\": { \"type\": \"string\" },\n \"color\": { \"type\": \"string\" },\n \"active\": { \"type\": \"boolean\" },\n \"short_name\": { \"type\": \"string\" },\n \"color_class\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"icon_ignore\": { \"type\": \"string\" },\n \"icon_primary\": { \"type\": \"string\" }\n }\n }\n }\n}\n\nincomes_categories, expenses_categories, accounts_types
\n","type":"text/plain"},"key":"catalog","value":"expenses_categories"}],"variable":[]}},"response":[{"id":"b04a740c-b6d2-49f4-b184-f3a0d2af47a9","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host_app}}/api-pfm/v1/pfm-service/catalogs/","host":["{{host_app}}"],"path":["api-pfm","v1","pfm-service","catalogs",""],"query":[{"key":"paginate","value":"true","disabled":true},{"key":"page","value":"1","type":"text","disabled":true},{"key":"page_size","value":"1","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 07 Aug 2024 18:52:41 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"17897"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"8b0036fc-d038-4a78-a6e6-07901e67429b"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"cJtS9HflIAMELrA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66b3c279-1e14b50207b555c73a555e33;Parent=7e9f95efc2eaeb5e;Sampled=0;lineage=e7de7122:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"c2a07389-da13-4420-9060-c6bef2d6bd03\",\n \"catalog_name\": \"incomes_categories\",\n \"description\": \"Categorías de ingresos\",\n \"items\": [\n {\n \"id\": \"e131ca4e-28d2-48fc-ab73-ea92e48b084f\",\n \"catalog\": \"c2a07389-da13-4420-9060-c6bef2d6bd03\",\n \"item_name\": \"Rendimientos\",\n \"description\": \"Pago de dividendos e intereses ganados\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/inc_rendimientos.svg\",\n \"name\": \"Rendimientos\",\n \"color\": \"#4D9932\",\n \"active\": true,\n \"short_name\": \"INCRENDIMIENTOS\",\n \"color_class\": \"cat-inc-rendimientos\",\n \"description\": \"Intereses y pago de dividendos\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/inc_rendimientos_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/inc_rendimientos_primary.svg\"\n }\n },\n {\n \"id\": \"3954361d-ddf5-46dc-a8f8-af98ee9811da\",\n \"catalog\": \"c2a07389-da13-4420-9060-c6bef2d6bd03\",\n \"item_name\": \"Sueldo\",\n \"description\": \"Sueldos, salarios, honorarios e ingresos por trabajo\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/inc_sueldo.svg\",\n \"name\": \"Ingresos\",\n \"color\": \"#01C38E\",\n \"active\": true,\n \"short_name\": \"INCSUELDO\",\n \"color_class\": \"cat-inc-sueldo\",\n \"description\": \"Salarios, honorarios y por contrato\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/inc_sueldo_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/inc_sueldo_primary.svg\"\n }\n },\n {\n \"id\": \"763d39ca-45e8-4171-8a97-29ba9a37665c\",\n \"catalog\": \"c2a07389-da13-4420-9060-c6bef2d6bd03\",\n \"item_name\": \"Regalos y otros ingresos\",\n \"description\": \"Regalos hechos por transferencias y otros ingresos\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/inc_regalos.svg\",\n \"name\": \"Regalos y otros ingresos\",\n \"color\": \"#5C9961\",\n \"active\": true,\n \"short_name\": \"INCREGALOS\",\n \"color_class\": \"cat-inc-regalos\",\n \"description\": \"Otros tipos de ingresos\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/inc_regalos_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/inc_regalos_primary.svg\"\n }\n },\n {\n \"id\": \"8ebba319-0042-41ff-bdbb-ba05cd824d52\",\n \"catalog\": \"c2a07389-da13-4420-9060-c6bef2d6bd03\",\n \"item_name\": \"Transferencias\",\n \"description\": \"Transferencias, depósitos y reembolsos recibidos\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/inc_transferencias.svg\",\n \"name\": \"Depósitos y Transferencias\",\n \"color\": \"#40916C\",\n \"active\": true,\n \"short_name\": \"INCTRANSFERENCIAS\",\n \"color_class\": \"cat-inc-trasferencias\",\n \"description\": \"Transferencias, depósitos y reembolsos\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/inc_transferencias_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/inc_transferencias_primary.svg\"\n }\n },\n {\n \"id\": \"593cea05-8f4d-4b40-ad1b-d73e43c8d53d\",\n \"catalog\": \"c2a07389-da13-4420-9060-c6bef2d6bd03\",\n \"item_name\": \"Devolución de impuestos\",\n \"description\": \"Devoluciones del Servicio de Impuestos Internos\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/inc_devolucion.svg\",\n \"name\": \"Devolución de impuestos\",\n \"color\": \"#25A244\",\n \"active\": true,\n \"short_name\": \"INCDEVOLUCION\",\n \"color_class\": \"cat-inc-devolucion\",\n \"description\": \"Reembolso o reducción de impuestos\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/inc_devolucion_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/inc_devolucion_primary.svg\"\n }\n },\n {\n \"id\": \"5f342655-bf27-4523-aa32-40d7cb48ae38\",\n \"catalog\": \"c2a07389-da13-4420-9060-c6bef2d6bd03\",\n \"item_name\": \"Subvención\",\n \"description\": \"Pensión, becas, subvención y ayudas familiares\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/inc_subvencion.svg\",\n \"name\": \"Subvención y Pensión\",\n \"color\": \"#47783F\",\n \"active\": true,\n \"short_name\": \"INCSUBVENCION\",\n \"color_class\": \"cat-inc-subvencion\",\n \"description\": \"Pensión y ayuda económica\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/inc_subvencion_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/inc_subvencion_primary.svg\"\n }\n },\n {\n \"id\": \"9abd4759-ab14-4e09-adc2-9c5dea1041b2\",\n \"catalog\": \"c2a07389-da13-4420-9060-c6bef2d6bd03\",\n \"item_name\": \"Rentas y arriendos\",\n \"description\": \"Ingresos por arriendos de muebles e inmuebles\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/inc_rentas.svg\",\n \"name\": \"Rentas y Arriendos\",\n \"color\": \"#01936C\",\n \"active\": true,\n \"short_name\": \"INCRENTAS\",\n \"color_class\": \"cat-inc-rentas\",\n \"description\": \"Arriendo de muebles e inmuebles\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/inc_rentas_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/inc_rentas_primary.svg\"\n }\n }\n ]\n },\n {\n \"id\": \"1ec6a6b5-65d5-4a8c-85d0-4364c141aefd\",\n \"catalog_name\": \"expenses_categories\",\n \"description\": \"Categorías de egresos\",\n \"items\": [\n {\n \"id\": \"bf50dc35-43d0-4f60-9860-770b8afc96f4\",\n \"catalog\": \"1ec6a6b5-65d5-4a8c-85d0-4364c141aefd\",\n \"item_name\": \"Ignorar\",\n \"description\": \"Transacciones que no quieres que se agreguen a una categoría\",\n \"metadata\": {\n \"icon\": \"/assets/img/category/ignore.svg\",\n \"color\": \"#CFA7DC\",\n \"active\": true,\n \"short_name\": \"IGNORE\"\n }\n },\n {\n \"id\": \"38e570af-1241-426c-afa5-f874b1c49128\",\n \"catalog\": \"1ec6a6b5-65d5-4a8c-85d0-4364c141aefd\",\n \"item_name\": \"Otros\",\n \"description\": \"Otros\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/ahorro.svg\",\n \"color\": \"#9C9A9F\",\n \"active\": true,\n \"short_name\": \"OTROS\"\n }\n },\n {\n \"id\": \"4419f198-e4d5-4352-aba6-c6f173b748b2\",\n \"catalog\": \"1ec6a6b5-65d5-4a8c-85d0-4364c141aefd\",\n \"item_name\": \"Pago Tarjeta de Crédito\",\n \"description\": \"Compra de divisas, pago tarjeta de crédito\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/credit_card.svg\",\n \"name\": \"Pago Créditos\",\n \"color\": \"#E57465\",\n \"active\": true,\n \"short_name\": \"CREDITCARD\",\n \"color_class\": \"cat-credit-card\",\n \"description\": \"Tarjeta, créditos de consumo\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/credit_card_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/credit_card_primary.svg\"\n }\n },\n {\n \"id\": \"4cdad960-1ec7-4a9b-aae8-71eeb6ba2ad7\",\n \"catalog\": \"1ec6a6b5-65d5-4a8c-85d0-4364c141aefd\",\n \"item_name\": \"Transferencias entre Cuentas Propias\",\n \"description\": \"Transferencias entre mis cuentas personales\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/trans_cuentas.svg\",\n \"name\": \"Transf. entre mis Cuentas\",\n \"color\": \"#E07591\",\n \"active\": true,\n \"short_name\": \"TRANSCUENTAS\",\n \"color_class\": \"cat-trans-cuentas\",\n \"description\": \"Transf. entre cuentas propias\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/trans_cuentas_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/trans_cuentas_primary.svg\"\n }\n },\n {\n \"id\": \"f7f2f8aa-2297-41a2-9fcf-d65aa9cfb180\",\n \"catalog\": \"1ec6a6b5-65d5-4a8c-85d0-4364c141aefd\",\n \"item_name\": \"Donaciones & Regalos\",\n \"description\": \"Donaciones, regalos a terceros\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/donaciones.svg\",\n \"name\": \"Donaciones y Regalos\",\n \"color\": \"#F3960B\",\n \"active\": true,\n \"short_name\": \"DONACIONES\",\n \"color_class\": \"cat-donaciones\",\n \"description\": \"Donaciones o regalos a terceros\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/donaciones_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/donaciones_primary.svg\"\n }\n },\n {\n \"id\": \"a249c468-bb4d-4365-83f4-108d456bb494\",\n \"catalog\": \"1ec6a6b5-65d5-4a8c-85d0-4364c141aefd\",\n \"item_name\": \"Restaurantes\",\n \"description\": \"Apps de pedidos, restaurantes, bares y nightclubs\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/restaurantes.svg\",\n \"name\": \"Restaurantes\",\n \"color\": \"#7D47EF\",\n \"active\": true,\n \"short_name\": \"RESTAURANTES\",\n \"color_class\": \"cat-restaurantes\",\n \"description\": \"Cafeterías, bares, restaurantes\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/restaurantes_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/restaurantes_primary.svg\"\n }\n },\n {\n \"id\": \"f37b6770-7fc5-43e0-a837-50926e1ee459\",\n \"catalog\": \"1ec6a6b5-65d5-4a8c-85d0-4364c141aefd\",\n \"item_name\": \"Sin categoría\",\n \"description\": \"Transacción sin categoría\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/sin_categoria.svg\",\n \"name\": \"Añadir Categoría\",\n \"color\": \"#6F6F6F\",\n \"active\": false,\n \"short_name\": \"SINCATEGORIA\",\n \"color-class\": \"\",\n \"description\": \"Categoría\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/sin_categoria.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/sin_categoria.svg\"\n }\n },\n {\n \"id\": \"84e6fa2f-8790-4d94-8f65-6944c7bcba10\",\n \"catalog\": \"1ec6a6b5-65d5-4a8c-85d0-4364c141aefd\",\n \"item_name\": \"Vacaciones & Viajes\",\n \"description\": \"Plataformas de viajes, hoteles, cabañas, arriendo de auto\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/viajes.svg\",\n \"name\": \"Viajes y Vacaciones\",\n \"color\": \"#E55E6E\",\n \"active\": true,\n \"short_name\": \"VIAJES\",\n \"color_class\": \"cat-viajes\",\n \"description\": \"Pasajes, hoteles, reservas\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/viajes_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/viajes_primary.svg\"\n }\n },\n {\n \"id\": \"ab0e1c52-4ab1-46b3-9384-7db452b282b2\",\n \"catalog\": \"1ec6a6b5-65d5-4a8c-85d0-4364c141aefd\",\n \"item_name\": \"Supermercados\",\n \"description\": \"Tienda de comestibles, panaderia, pasteleria\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/supermercados.svg\",\n \"name\": \"Supermercados\",\n \"color\": \"#FCC442\",\n \"active\": true,\n \"short_name\": \"SUPERMERCADOS\",\n \"color_class\": \"cat-supermercados\",\n \"description\": \"Almacén, alimentos, abarrotes\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/supermercados_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/supermercados_primary.svg\"\n }\n },\n {\n \"id\": \"d26e9eb4-5c2a-45f2-af03-571af93ae7e2\",\n \"catalog\": \"1ec6a6b5-65d5-4a8c-85d0-4364c141aefd\",\n \"item_name\": \"Transferencias & Retiros\",\n \"description\": \"Transferencias a terceros, retiros en cajeros, retiros en caja\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/retiros.svg\",\n \"name\": \"Transferencias y Retiros\",\n \"color\": \"#5D95E8\",\n \"active\": true,\n \"short_name\": \"RETIROS\",\n \"color_class\": \"cat-retiros\",\n \"description\": \"Cajeros, transferencias a otros bancos\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/retiros_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/retiros_primary.svg\"\n }\n },\n {\n \"id\": \"53566d37-4b4d-4598-8b6c-09f5970c33cd\",\n \"catalog\": \"1ec6a6b5-65d5-4a8c-85d0-4364c141aefd\",\n \"item_name\": \"Automóvil & Transporte\",\n \"description\": \"Gasolina, estacionamiento, seguro auto, app taxi\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/transporte.svg\",\n \"name\": \"Automóvil y Transporte\",\n \"color\": \"#577590\",\n \"active\": true,\n \"short_name\": \"TRANSPORTE\",\n \"color_class\": \"cat-transporte\",\n \"description\": \"Gasolina, metro, uber, seguro auto\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/transporte_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/transporte_primary.svg\"\n }\n },\n {\n \"id\": \"72fb8abb-d236-469d-a511-0e7d81c4af1e\",\n \"catalog\": \"1ec6a6b5-65d5-4a8c-85d0-4364c141aefd\",\n \"item_name\": \"Hogar & Familia\",\n \"description\": \"Renta, hipotecario, educación, mascota, veterinario, colegio\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/hogar.svg\",\n \"name\": \"Hogar y Familia\",\n \"color\": \"#7B80E3\",\n \"active\": true,\n \"short_name\": \"HOGAR\",\n \"color_class\": \"cat-hogar\",\n \"description\": \"Mascota, renta, educación, decoración\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/hogar_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/hogar_primary.svg\"\n }\n },\n {\n \"id\": \"cf01dce7-6d5e-4ad6-8e5a-8ba5c6d6f94c\",\n \"catalog\": \"1ec6a6b5-65d5-4a8c-85d0-4364c141aefd\",\n \"item_name\": \"Gastos Financieros & Seguros\",\n \"description\": \"Seguros, comisiones, impuestos\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/finanzas.svg\",\n \"name\": \"Gastos Financieros\",\n \"color\": \"#6E8D9E\",\n \"active\": true,\n \"short_name\": \"FINANZAS\",\n \"color_class\": \"cat-finanzas\",\n \"description\": \"Seguro, comisiones, impuestos\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/finanzas_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/finanzas_primary.svg\"\n }\n },\n {\n \"id\": \"22118f55-e6a9-46b0-ae8f-a063dda396e0\",\n \"catalog\": \"1ec6a6b5-65d5-4a8c-85d0-4364c141aefd\",\n \"item_name\": \"Shopping\",\n \"description\": \"Deportes, electrónica, vestuario y calzado\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/shopping.svg\",\n \"name\": \"Shopping\",\n \"color\": \"#6A994E\",\n \"active\": true,\n \"short_name\": \"SHOPPING\",\n \"color_class\": \"cat-shopping\",\n \"description\": \"Vestuario, calzado, electrónica\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/shopping_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/shopping_primary.svg\"\n }\n },\n {\n \"id\": \"0f7b3aa0-365f-475d-b3bc-39d960916a23\",\n \"catalog\": \"1ec6a6b5-65d5-4a8c-85d0-4364c141aefd\",\n \"item_name\": \"Ahorro e Inversión\",\n \"description\": \"Ahorros, propiedades, vehículos\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/ahorro.svg\",\n \"name\": \"Ahorro e Inversión\",\n \"color\": \"#9D6B53\",\n \"active\": true,\n \"short_name\": \"AHORRO\",\n \"color_class\": \"cat-ahorro\",\n \"description\": \"Ahorros, propiedades, vehículos\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/ahorro_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/ahorro_primary.svg\"\n }\n },\n {\n \"id\": \"8442c4fa-64e6-4470-af7c-8d007d5f572f\",\n \"catalog\": \"1ec6a6b5-65d5-4a8c-85d0-4364c141aefd\",\n \"item_name\": \"Cuentas & Servicios\",\n \"description\": \"Consumo de luz, agua, gas, internet, telefonía\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/servicios.svg\",\n \"name\": \"Cuentas y Servicios\",\n \"color\": \"#95B8D1\",\n \"active\": true,\n \"short_name\": \"SERVICIOS\",\n \"color_class\": \"cat-servicios\",\n \"description\": \"Gas, luz, agua, internet, telefonía\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/servicios_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/servicios_primary.svg\"\n }\n },\n {\n \"id\": \"f0eae548-64e6-45b4-9bfd-4059d2b9d4df\",\n \"catalog\": \"1ec6a6b5-65d5-4a8c-85d0-4364c141aefd\",\n \"item_name\": \"Salud & Bienestar\",\n \"description\": \"Farmacia, doctores, dentista, gimnasio, salon de belleza, peluqueria\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/salud.svg\",\n \"name\": \"Salud y Bienestar\",\n \"color\": \"#48A2BD\",\n \"active\": true,\n \"short_name\": \"SALUD\",\n \"color_class\": \"cat-salud\",\n \"description\": \"Farmacia, hospital, clínica, dentista\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/salud_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/salud_primary.svg\"\n }\n },\n {\n \"id\": \"9abd4759-ab14-4e09-adc2-9c5dea1041b1\",\n \"catalog\": \"1ec6a6b5-65d5-4a8c-85d0-4364c141aefd\",\n \"item_name\": \"Entretenimiento\",\n \"description\": \"Netflix, spotify, cine, apps store, videojuegos\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/entretenimiento.svg\",\n \"name\": \"Entretenimiento\",\n \"color\": \"#6CD1B8\",\n \"active\": true,\n \"short_name\": \"ENTRETENIMIENTO\",\n \"color_class\": \"cat-entretenimiento\",\n \"description\": \"Netflix, juegos, streaming, discotecas\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/entretenimiento_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/entretenimiento_primary.svg\"\n }\n }\n ]\n },\n {\n \"id\": \"4625b3a0-b3dc-48e8-b495-1eda09e58222\",\n \"catalog_name\": \"budget_status\",\n \"description\": \"Estado del presupuesto\",\n \"items\": [\n {\n \"id\": \"cbf5eacb-6b1c-42f4-bdba-5a6f6276e0ac\",\n \"catalog\": \"4625b3a0-b3dc-48e8-b495-1eda09e58222\",\n \"item_name\": \"Activo\",\n \"description\": \"Presupuesto activo\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/shopping.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"ACTIVE\"\n }\n },\n {\n \"id\": \"f1ba1236-b4fd-4ed6-9d35-8114ed66726f\",\n \"catalog\": \"4625b3a0-b3dc-48e8-b495-1eda09e58222\",\n \"item_name\": \"Eliminado\",\n \"description\": \"Presupuesto eliminado\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/shopping.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"DELETED\"\n }\n }\n ]\n },\n {\n \"id\": \"f1895069-e723-4cc8-9331-d1cb4110ab7a\",\n \"catalog_name\": \"accounts_types\",\n \"description\": \"Tipos de cuentas\",\n \"items\": [\n {\n \"id\": \"f3029ccb-8f07-4c15-a55d-5fc628cc4230\",\n \"catalog\": \"f1895069-e723-4cc8-9331-d1cb4110ab7a\",\n \"item_name\": \"cuenta_corriente\",\n \"description\": \"Cuenta Corriente\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/products/cc.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"CUENTACORRIENTE\"\n }\n },\n {\n \"id\": \"e480d1b0-cb8e-448c-9864-ed7ae4ce20b3\",\n \"catalog\": \"f1895069-e723-4cc8-9331-d1cb4110ab7a\",\n \"item_name\": \"cuenta_vista\",\n \"description\": \"Cuenta Vista\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/cuenta_vista.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"CUENTAVISTA\"\n }\n },\n {\n \"id\": \"93909b64-0e8c-4494-bec5-c84906430182\",\n \"catalog\": \"f1895069-e723-4cc8-9331-d1cb4110ab7a\",\n \"item_name\": \"cuenta_ahorro\",\n \"description\": \"Cuenta Ahorro\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/cuenta_ahorro.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"CUENTAAHORRO\"\n }\n },\n {\n \"id\": \"18743d7e-4fee-4e13-b2fc-00f86d8f8511\",\n \"catalog\": \"f1895069-e723-4cc8-9331-d1cb4110ab7a\",\n \"item_name\": \"cuenta_inversion\",\n \"description\": \"Cuenta Inversión\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/cuenta_inversion.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"CUENTAINVERSION\"\n }\n },\n {\n \"id\": \"d9a4b159-8e15-48ea-aa88-72f1c21bb0d0\",\n \"catalog\": \"f1895069-e723-4cc8-9331-d1cb4110ab7a\",\n \"item_name\": \"tarjeta_debito\",\n \"description\": \"Tarjeta Débito\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/tarjeta_debito.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"TARJETADEBITO\"\n }\n },\n {\n \"id\": \"e655b55f-e39c-49c0-a77e-aed53e1b5d15\",\n \"catalog\": \"f1895069-e723-4cc8-9331-d1cb4110ab7a\",\n \"item_name\": \"tarjeta_credito\",\n \"description\": \"Tarjeta Crédito\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/tarjeta_credito.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"TARJETACREDITO\"\n }\n }\n ]\n },\n {\n \"id\": \"dc34207f-34ba-4bd5-99ec-8ee4bbcdf927\",\n \"catalog_name\": \"currencies\",\n \"description\": \"Monedas\",\n \"items\": [\n {\n \"id\": \"cea03b6b-96a3-4d5b-a84e-a74d5c88be0a\",\n \"catalog\": \"dc34207f-34ba-4bd5-99ec-8ee4bbcdf927\",\n \"item_name\": \"USD\",\n \"description\": \"USD\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/currencies/usd.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"USD\"\n }\n }\n ]\n },\n {\n \"id\": \"a5b7cfeb-fe11-44ad-b251-64aaccd12bec\",\n \"catalog_name\": \"deprecated_categories\",\n \"description\": \"Categorías deprecadas\",\n \"items\": [\n {\n \"id\": \"693b9aed-83a6-426a-8eb4-84adb64f10dd\",\n \"catalog\": \"a5b7cfeb-fe11-44ad-b251-64aaccd12bec\",\n \"item_name\": \"Yape Ingreso\",\n \"description\": \"Yape Ingreso\",\n \"metadata\": {}\n },\n {\n \"id\": \"35f5e608-4285-49a4-90ca-d90102131e14\",\n \"catalog\": \"a5b7cfeb-fe11-44ad-b251-64aaccd12bec\",\n \"item_name\": \"Warda Ingreso\",\n \"description\": \"Warda Ingreso\",\n \"metadata\": {}\n },\n {\n \"id\": \"cb5aa1ec-493b-49cf-8499-bf6f290345ff\",\n \"catalog\": \"a5b7cfeb-fe11-44ad-b251-64aaccd12bec\",\n \"item_name\": \"Warda Egreso\",\n \"description\": \"Warda Egreso\",\n \"metadata\": {}\n },\n {\n \"id\": \"9c7ac7a6-1051-4c29-b794-5c1fecee9ec5\",\n \"catalog\": \"a5b7cfeb-fe11-44ad-b251-64aaccd12bec\",\n \"item_name\": \"Yape Egreso\",\n \"description\": \"Yape Egreso\",\n \"metadata\": {}\n }\n ]\n }\n]"}],"_postman_id":"d57176a9-486c-4074-99e9-74f816955a4c"},{"name":"Estados de presupuestos","event":[{"listen":"test","script":{"id":"299ec8c8-53e5-49b7-8cf4-2bc26bdc70e2","exec":[" const xerpaTestApi = pm.require('@getxerpa/xerpa_test_api');\r","\r","xerpaTestApi.testResponseTime();\r","xerpaTestApi.testSuccessfulGet();\r","\r","// Parse the response JSON\r","const responseJson = pm.response.json();\r","\r","// Define the expected property types\r","const topLevelProperties = {\r"," id: 'string',\r"," catalog_name: 'string',\r"," description: 'string',\r"," items: 'array'\r","};\r","\r","const itemProperties = {\r"," id: 'string',\r"," catalog: 'string',\r"," item_name: 'string',\r"," description: 'string',\r"," metadata: 'object'\r","};\r","\r","const metadataProperties = {\r"," icon: 'string',\r"," color: 'string',\r"," active: 'boolean',\r"," short_name: 'string'\r","};\r","\r","// Check top-level properties\r","pm.test(\"Response has expected top-level properties with correct types\", () => {\r"," if (responseJson && responseJson.length > 0) {\r"," xerpaTestApi.checkObjectProperties(responseJson[0], topLevelProperties);\r"," }\r","});\r","\r","// Check properties within the items array of the first catalog\r","pm.test(\"Items have expected properties with correct types\", () => {\r"," if (responseJson[0].items && responseJson[0].items.length > 0) {\r"," xerpaTestApi.checkObjectProperties(responseJson[0].items[0], itemProperties);\r"," \r"," // Check metadata properties of the first item\r"," xerpaTestApi.checkObjectProperties(responseJson[0].items[0].metadata, metadataProperties);\r"," }\r","});"],"type":"text/javascript","packages":{"@getxerpa/xerpa_test_api":{"id":"01929aee-a3be-7f8c-91f1-e7a772cc76dc"}}}}],"id":"25fd307d-a617-452a-af52-2e84c15e6571","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token_user}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{host_app}}/api-pfm/v1/pfm-service/catalogs-items/?catalog=budget_status","description":"El endpoint entrega un listado de los estados de los presupuestos.
\nEste catálogo no permite agregar ni eliminar registros, sólo se puede modificar la metadata de cada unao.
\n\n
Request
\n- \n
Método:
\nGET\nURL: {{host_app}}/api-pfm/v1/pfm-service/catalogs-items/
\n \nParámetros de query:
\n- \n
\ncatalog(string): Id del catalogo que se desea consultar. Este puede tomar los valores:- \n
\"incomes_categories\": Categorias de ingresos.
\n \n\"expenses_categories\": Categorias de gastos
\n \n\"accounts_types\": Tipo de categoria
\n \n
\n
\n
Request Body
\n- \n
- Este request de tipo
GETno requiere cuerpo. El cuerpo de la solicitud debe enviarse vacío. \n
Response
\nLa respuesta es un arreglo de estados de presupuestos (budget_status):
\n- \n
\nid(string): Identificador único del estado. \n
\ncatalog(string): Nombre del catálogo al que pertenece. \n
\nitem_name(string): Clave técnica o interna del ítem. \n
\ndescription(string): Descripción legible del ítem. \n
\nmetadata(object): Metadatos adicionales, como:- \n
\nicon(string): Ícono asociado. \n
\ntitle(string): Título para interfaces gráficas. \ncolor (object): RGB del color del estado
\n \nOtros campos personalizados según el catálogo.
\n \n
\n
Response Format
\nPara la informacion de cada categoria se mantiene el siguiente formato:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"catalog\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"item_name\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"icon\": { \"type\": \"string\" },\n \"color\": { \"type\": \"string\" },\n \"active\": { \"type\": \"boolean\" },\n \"short_name\": { \"type\": \"string\" },\n \"color_class\": { \"type\": \"string\" }\n }\n }\n }\n}\n\nincomes_categories, expenses_categories, accounts_types
\n","type":"text/plain"},"key":"catalog","value":"budget_status"}],"variable":[]}},"response":[{"id":"c4dbc4d5-fd7f-4e9a-93b7-96140c9e0d80","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host_app}}/api-pfm/v1/pfm-service/catalogs-items/?catalog=budget_status","host":["{{host_app}}"],"path":["api-pfm","v1","pfm-service","catalogs-items",""],"query":[{"key":"catalog","value":"budget_status","description":"incomes_categories, expenses_categories, accounts_types"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"budget_status\": [\n {\n \"id\": \"cbf5eacb-6b1c-42f4-bdba-5a6f6276e0ac\",\n \"catalog\": \"4625b3a0-b3dc-48e8-b495-1eda09e58222\",\n \"item_name\": \"Activo\",\n \"description\": \"Presupuesto activo\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/shopping.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"ACTIVE\"\n }\n },\n {\n \"id\": \"f1ba1236-b4fd-4ed6-9d35-8114ed66726f\",\n \"catalog\": \"4625b3a0-b3dc-48e8-b495-1eda09e58222\",\n \"item_name\": \"Eliminado\",\n \"description\": \"Presupuesto eliminado\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/shopping.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"DELETED\"\n }\n }\n ]\n}"}],"_postman_id":"25fd307d-a617-452a-af52-2e84c15e6571"},{"name":"Tipos de cuentas","event":[{"listen":"test","script":{"id":"299ec8c8-53e5-49b7-8cf4-2bc26bdc70e2","exec":[" const xerpaTestApi = pm.require('@getxerpa/xerpa_test_api');\r","\r","xerpaTestApi.testResponseTime();\r","xerpaTestApi.testSuccessfulGet();\r","\r","// Parse the response JSON\r","const responseJson = pm.response.json();\r","\r","// Define the expected property types\r","const topLevelProperties = {\r"," id: 'string',\r"," catalog_name: 'string',\r"," description: 'string',\r"," items: 'array'\r","};\r","\r","const itemProperties = {\r"," id: 'string',\r"," catalog: 'string',\r"," item_name: 'string',\r"," description: 'string',\r"," metadata: 'object'\r","};\r","\r","const metadataProperties = {\r"," icon: 'string',\r"," color: 'string',\r"," active: 'boolean',\r"," short_name: 'string'\r","};\r","\r","// Check top-level properties\r","pm.test(\"Response has expected top-level properties with correct types\", () => {\r"," if (responseJson && responseJson.length > 0) {\r"," xerpaTestApi.checkObjectProperties(responseJson[0], topLevelProperties);\r"," }\r","});\r","\r","// Check properties within the items array of the first catalog\r","pm.test(\"Items have expected properties with correct types\", () => {\r"," if (responseJson[0].items && responseJson[0].items.length > 0) {\r"," xerpaTestApi.checkObjectProperties(responseJson[0].items[0], itemProperties);\r"," \r"," // Check metadata properties of the first item\r"," xerpaTestApi.checkObjectProperties(responseJson[0].items[0].metadata, metadataProperties);\r"," }\r","});"],"type":"text/javascript","packages":{"@getxerpa/xerpa_test_api":{"id":"01929aee-a3be-7f8c-91f1-e7a772cc76dc"}}}}],"id":"73655709-4bd2-4a90-9234-3638132dfbab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token_user}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{host_app}}/api-pfm/v1/pfm-service/catalogs-items/?catalog=accounts_types","description":"Request Description
\nEste endpoint permite obtener una lista de tipos de cuentas desde el catálogo. Es útil para acceder a información detallada sobre cada tipo de cuenta, incluyendo los ítems asociados y sus metadatos.
\nRequest
\n- \n
Método:
\nGET\nURL:
\n{{host_app}}/api-pfm/v1/pfm-service/catalogs-items/\nParámetros de query:
\n- \n
\ncatalog(string): Identificador del catálogo que se desea consultar. Este puede tomar los siguientes valores:- \n
\n\"incomes_categories\": Categorías de ingresos. \n
\n\"expenses_categories\": Categorías de gastos. \n
\n\"accounts_types\": Tipos de categoría. \n
\n
\n
Request Body
\n- \n
- Este request de tipo
GETno requiere cuerpo. El cuerpo de la solicitud debe enviarse vacío. \n
Response
\nLa respuesta es un arreglo que contiene categorías de diccionarios, donde cada categoría incluye un arreglo que agrupa los catálogos. Cada catálogo contiene los siguientes campos:
\n- \n
\nid(string): ID del catálogo. \n
\ncatalog(string): Nombre del catálogo. \n
\nitem_name(string): Clave técnica o interna del ítem. \n
\ndescription(string): Descripción legible del ítem. \n
\nmetadata(object): Metadatos adicionales, que incluyen:- \n
\nicon(string): Ícono asociado. \n
\ncolor(string): Color del ítem. \n
\nactive(boolean): Estado de actividad del ítem. \n
\nshort_name(string): Nombre corto del ítem. \n
\n
Response Format
\nPara la información de cada categoría se mantiene el siguiente formato:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"catalog\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"item_name\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"icon\": { \"type\": \"string\" },\n \"color\": { \"type\": \"string\" },\n \"active\": { \"type\": \"boolean\" },\n \"short_name\": { \"type\": \"string\" }\n }\n }\n }\n}\n\nEste formato asegura que la respuesta sea consistente y fácil de interpretar, facilitando la integración con otras partes del sistema.
\n","urlObject":{"path":["api-pfm","v1","pfm-service","catalogs-items",""],"host":["{{host_app}}"],"query":[{"description":{"content":"incomes_categories, expenses_categories, accounts_types
\n","type":"text/plain"},"key":"catalog","value":"accounts_types"}],"variable":[]}},"response":[{"id":"14e86586-6ea1-4be1-a74b-523b029c636c","name":"Tipos de cuentas","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host_app}}/api-pfm/v1/pfm-service/catalogs-items/?catalog=accounts_types","host":["{{host_app}}"],"path":["api-pfm","v1","pfm-service","catalogs-items",""],"query":[{"key":"catalog","value":"accounts_types","description":"incomes_categories, expenses_categories, accounts_types"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"accounts_types\": [\n {\n \"id\": \"f3029ccb-8f07-4c15-a55d-5fc628cc4230\",\n \"catalog\": \"f1895069-e723-4cc8-9331-d1cb4110ab7a\",\n \"item_name\": \"cuenta_corriente\",\n \"description\": \"Cuenta Corriente\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/products/cc.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"CUENTACORRIENTE\"\n }\n },\n {\n \"id\": \"e480d1b0-cb8e-448c-9864-ed7ae4ce20b3\",\n \"catalog\": \"f1895069-e723-4cc8-9331-d1cb4110ab7a\",\n \"item_name\": \"cuenta_vista\",\n \"description\": \"Cuenta Vista\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/cuenta_vista.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"CUENTAVISTA\"\n }\n },\n {\n \"id\": \"93909b64-0e8c-4494-bec5-c84906430182\",\n \"catalog\": \"f1895069-e723-4cc8-9331-d1cb4110ab7a\",\n \"item_name\": \"cuenta_ahorro\",\n \"description\": \"Cuenta Ahorro\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/cuenta_ahorro.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"CUENTAAHORRO\"\n }\n },\n {\n \"id\": \"18743d7e-4fee-4e13-b2fc-00f86d8f8511\",\n \"catalog\": \"f1895069-e723-4cc8-9331-d1cb4110ab7a\",\n \"item_name\": \"cuenta_inversion\",\n \"description\": \"Cuenta Inversión\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/cuenta_inversion.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"CUENTAINVERSION\"\n }\n },\n {\n \"id\": \"d9a4b159-8e15-48ea-aa88-72f1c21bb0d0\",\n \"catalog\": \"f1895069-e723-4cc8-9331-d1cb4110ab7a\",\n \"item_name\": \"tarjeta_debito\",\n \"description\": \"Tarjeta Débito\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/tarjeta_debito.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"TARJETADEBITO\"\n }\n },\n {\n \"id\": \"e655b55f-e39c-49c0-a77e-aed53e1b5d15\",\n \"catalog\": \"f1895069-e723-4cc8-9331-d1cb4110ab7a\",\n \"item_name\": \"tarjeta_credito\",\n \"description\": \"Tarjeta Crédito\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/tarjeta_credito.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"TARJETACREDITO\"\n }\n }\n ]\n}"}],"_postman_id":"73655709-4bd2-4a90-9234-3638132dfbab"},{"name":"Tipos de monedas","event":[{"listen":"test","script":{"id":"299ec8c8-53e5-49b7-8cf4-2bc26bdc70e2","exec":[" const xerpaTestApi = pm.require('@getxerpa/xerpa_test_api');\r","\r","xerpaTestApi.testResponseTime();\r","xerpaTestApi.testSuccessfulGet();\r","\r","// Parse the response JSON\r","const responseJson = pm.response.json();\r","\r","// Define the expected property types\r","const topLevelProperties = {\r"," id: 'string',\r"," catalog_name: 'string',\r"," description: 'string',\r"," items: 'array'\r","};\r","\r","const itemProperties = {\r"," id: 'string',\r"," catalog: 'string',\r"," item_name: 'string',\r"," description: 'string',\r"," metadata: 'object'\r","};\r","\r","const metadataProperties = {\r"," icon: 'string',\r"," color: 'string',\r"," active: 'boolean',\r"," short_name: 'string'\r","};\r","\r","// Check top-level properties\r","pm.test(\"Response has expected top-level properties with correct types\", () => {\r"," if (responseJson && responseJson.length > 0) {\r"," xerpaTestApi.checkObjectProperties(responseJson[0], topLevelProperties);\r"," }\r","});\r","\r","// Check properties within the items array of the first catalog\r","pm.test(\"Items have expected properties with correct types\", () => {\r"," if (responseJson[0].items && responseJson[0].items.length > 0) {\r"," xerpaTestApi.checkObjectProperties(responseJson[0].items[0], itemProperties);\r"," \r"," // Check metadata properties of the first item\r"," xerpaTestApi.checkObjectProperties(responseJson[0].items[0].metadata, metadataProperties);\r"," }\r","});"],"type":"text/javascript","packages":{"@getxerpa/xerpa_test_api":{"id":"01929aee-a3be-7f8c-91f1-e7a772cc76dc"}}}}],"id":"e0de52a3-13a2-40e7-a2ee-7d2d452fd82e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token_user}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{host_app}}/api-pfm/v1/pfm-service/catalogs-items/?catalog=currencies","description":"El endpoint entrega una lista de categorías de gastos del catálogo. Permite a obtener información detallada sobre cada categoría, incluyendo los items asociados y sus metadatos.
\n\n
Request
\n- \n
Método:
\nGET\nURL: {{host_app}}/api-pfm/v1/pfm-service/catalogs-items/
\n \nParámetros de query:
\n- \n
\ncatalog(string): Id del catalogo que se desea consultar. Este puede tomar los valores:- \n
\"incomes_categories\": Categorias de ingresos.
\n \n\"expenses_categories\": Categorias de gastos
\n \n\"accounts_types\": Tipo de categoria
\n \n
\n
\n
Request Body
\n- \n
- Este request de tipo
GETno requiere cuerpo. El cuerpo de la solicitud debe enviarse vacío. \n
Response
\nLa respuesta es un arreglo de categorias de diccionarios, en donde cada categoria contiene otro arreglo que agrupa los catalogos, los cuales contien:
\n- \n
\nid(string): ID del catalogo. \n
\ncatalog_name(string): Nombre del catalogo. \n
\ndescription(string): Descripcion del catalogo. \n
\nitems(array of objects): Lista de ítems pertenecientes al catálogo consultado, donde cada uno incluye:- \n
\nid(string): Identificador único del ítem. \n
\ncatalog(string): Nombre del catálogo al que pertenece. \n
\nitem_name(string): Clave técnica o interna del ítem. \n
\ndescription(string): Descripción legible del ítem. \n
\nmetadata(object): Metadatos adicionales, como:- \n
\nicon(string): Ícono asociado. \n
\ntitle(string): Título para interfaces gráficas. \n
\nmessage(object): Mensajes contextualizados por canal o lenguaje (A,E,G, etc.). \nOtros campos personalizados según el catálogo.
\n \n
\n
\n
Response Format
\nPara la informacion de cada categoria se mantiene el siguiente formato:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"catalog\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"item_name\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"bg\": { \"type\": \"string\" },\n \"icon\": { \"type\": \"string\" },\n \"name\": { \"type\": \"string\" },\n \"color\": { \"type\": \"string\" },\n \"active\": { \"type\": \"boolean\" },\n \"short_name\": { \"type\": \"string\" },\n \"color_class\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"icon_ignore\": { \"type\": \"string\" },\n \"icon_primary\": { \"type\": \"string\" }\n }\n }\n }\n}\n\nEste endpoint permite recuperar todos los catálogos registrados en PFM. Los catálogos contienen información utilizada para poblar menús desplegables, filtrar datos o representar entidades de negocio como tipos de evento, estados de cuenta, categorías de gastos, entre otros.
\n\n
Request
\n- \n
Método:
\nGET\nURL: {{host_app}}/api-pfm/v1/pfm-service/catalogs/
\n \n
Request Body
\n- \n
- Este request de tipo
GETno requiere cuerpo. El cuerpo de la solicitud debe enviarse vacío. \n
Reponse
\nLa respuesta será un objeto JSON que incluye un arreglo de ítems catalogados, agrupables por tipocatalog, donde cada uno incluye:
- \n
\nid(string): Identificador único del ítem. \n
\ncatalog(string): Nombre del catálogo al que pertenece \n
\nitem_name(string): Clave técnica del ítem dentro del catálogo. \n
\ndescription(string): Descripción legible o funcional del ítem. \n
\nmetadata(object): Información adicional (opcional), que puede incluir:- \n
\nbg(string): Color en formato HEX del fondo \n
\nicon(string): Ícono visual asociado. \n
\nname(string): Nombre del item. \nOtros campos específicos según el catálogo.
\n \n
\n
Response Format
\n{\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"catalog_name\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"catalog\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"item_name\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"icon\": { \"type\": \"string\" },\n \"color\": { \"type\": \"string\" },\n \"active\": { \"type\": \"boolean\" },\n \"short_name\": { \"type\": \"string\" }\n }\n }\n }\n }\n }\n }\n }\n}\n\nEste endpoint permite consultar todos los ítems de un catálogo específico del sistema, utilizando el nombre del catálogo como parámetro.
\n- \n
Este endpoint permite filtrar directamente por catálogo, a diferencia del listado general.
\n \nEs ideal para mostrar opciones filtradas en formularios, reglas, reportes o visualizaciones.
\n \nSi el catálogo no existe o está vacío, se devolverá un arreglo vacío sin error.
\n \n
\n
Request
\n- \n
Método:
\nGET\nURL: {{host_app}}api-pfm/v1/pfm-service/catalogs/{{catalog_pfm_id}}/
\n \nParámetros de ruta:
\n- \n
catalog_pfm_id(string): Id del catalogo que se desea consultar. \n
\n
Request Body
\n- \n
- Este request de tipo
GETno requiere cuerpo. El cuerpo de la solicitud debe enviarse vacío. \n
Response
\nLa respuesta es un JSON con lo items agrupados por catalogo.
\n- \n
\nid(string): ID del catalogo. \n
\ncatalog_name(string): Nombre del catalogo. \n
\ndescription(string): Descripcion del catalogo. \n
\nitems(array of objects): Lista de ítems pertenecientes al catálogo consultado, donde cada uno incluye:- \n
\nid(string): Identificador único del ítem. \n
\ncatalog(string): Nombre del catálogo al que pertenece. \n
\nitem_name(string): Clave técnica o interna del ítem. \n
\ndescription(string): Descripción legible del ítem. \n
\nmetadata(object): Metadatos adicionales, como:- \n
\nicon(string): Ícono asociado. \n
\ntitle(string): Título para interfaces gráficas. \n
\nmessage(object): Mensajes contextualizados por canal o lenguaje (A,E,G, etc.). \nOtros campos personalizados según el catálogo.
\n \n
\n
\n
Response Format
\n{\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"catalog_name\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"catalog\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"item_name\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"icon\": { \"type\": \"string\" },\n \"color\": { \"type\": \"string\" },\n \"active\": { \"type\": \"boolean\" },\n \"short_name\": { \"type\": \"string\" }\n }\n }\n }\n }\n }\n }\n}\n\nEste endpoint permite consultar los detalles de un ítem específico dentro de un catálogo del sistema.
\n- \n
Este endpoint es útil para obtener el detalle completo de un ítem sin tener que recorrer todo el catálogo.
\n \nEs ideal para mostrar etiquetas, íconos o comportamientos dinámicos en interfaces que dependan de la configuración del ítem.
\n \nEl contenido del campo
\nmetadatapuede variar ampliamente según el tipo de catálogo al que pertenezca el ítem. \n
\n
Request
\n- \n
Método:
\nGET\nURL:{{host_app}}/api-pfm/v1/pfm-service/items/{{item_pfm_core}}/
\n \nParámetros de ruta
\n- \n
item_pfm_id(string): ID único del ítem que se desea consultar. \n
\n
Request Body:
\n- \n
- Este request de tipo
GETno requiere cuerpo. El cuerpo de la solicitud debe enviarse vacío. \n
\n
Response
\nLa respuesta será un objeto JSON que contiene la información detallada del ítem:
\n- \n
\nid(string): Identificador único del ítem. \n
\ncatalog(string): Nombre del catálogo al que pertenece. \n
\nitem_name(string): Clave interna del ítem. \n
\ndescription(string): Descripción legible del ítem. \n
\nmetadata(object): Objeto con metadatos adicionales que pueden incluir:- \n
\nicon(string): Ícono representativo. \n
\ntitle(string): Título para mostrar en interfaz. \n
\nmessage(object): Mensajes por canal o formato (A,E,G, etc.). \nOtros campos personalizados según el catálogo (color, orden, estado, etc.).
\n \n
\n
Response Format
\n{\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"catalog\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"item_name\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"icon\": { \"type\": \"string\" },\n \"color\": { \"type\": \"string\" },\n \"active\": { \"type\": \"boolean\" },\n \"short_name\": { \"type\": \"string\" }\n }\n }\n }\n}\n\nEl endpoint entrega una lista de categorías de gastos del catálogo. Permite a obtener información detallada sobre cada categoría, incluyendo los items asociados y sus metadatos.
\n\n
Request
\n- \n
Método:
\nGET\nURL: {{host_app}}/api-pfm/v1/pfm-service/catalogs-items/
\n \nParámetros de query:
\n- \n
\ncatalog(string): Id del catalogo que se desea consultar. Este puede tomar los valores:- \n
\"incomes_categories\": Categorias de ingresos.
\n \n\"expenses_categories\": Categorias de gastos
\n \n\"accounts_types\": Tipo de categoria
\n \n
\n
\n
Request Body
\n- \n
- Este request de tipo
GETno requiere cuerpo. El cuerpo de la solicitud debe enviarse vacío. \n
Response
\nLa respuesta es un arreglo de categorias de diccionarios, en donde cada categoria contiene otro arreglo que agrupa los catalogos, los cuales contien:
\n- \n
\nid(string): ID del catalogo. \n
\ncatalog_name(string): Nombre del catalogo. \n
\ndescription(string): Descripcion del catalogo. \n
\nitems(array of objects): Lista de ítems pertenecientes al catálogo consultado, donde cada uno incluye:- \n
\nid(string): Identificador único del ítem. \n
\ncatalog(string): Nombre del catálogo al que pertenece. \n
\nitem_name(string): Clave técnica o interna del ítem. \n
\ndescription(string): Descripción legible del ítem. \n
\nmetadata(object): Metadatos adicionales, como:- \n
\nicon(string): Ícono asociado. \n
\ntitle(string): Título para interfaces gráficas. \n
\nmessage(object): Mensajes contextualizados por canal o lenguaje (A,E,G, etc.). \nOtros campos personalizados según el catálogo.
\n \n
\n
\n
Response Format
\nPara la informacion de cada categoria se mantiene el siguiente formato:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"catalog\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"item_name\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"bg\": { \"type\": \"string\" },\n \"icon\": { \"type\": \"string\" },\n \"name\": { \"type\": \"string\" },\n \"color\": { \"type\": \"string\" },\n \"active\": { \"type\": \"boolean\" },\n \"short_name\": { \"type\": \"string\" },\n \"color_class\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"icon_ignore\": { \"type\": \"string\" },\n \"icon_primary\": { \"type\": \"string\" }\n }\n }\n }\n}\n\nincomes_categories, expenses_categories, accounts_types
\n","type":"text/plain"},"key":"catalog","value":"expenses_categories"}],"variable":[]}},"response":[{"id":"3967f3a6-cebc-4751-bf9f-4fe14def170f","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host_app}}/api-pfm/v1/pfm-service/catalogs/","host":["{{host_app}}"],"path":["api-pfm","v1","pfm-service","catalogs",""],"query":[{"key":"paginate","value":"true","disabled":true},{"key":"page","value":"1","type":"text","disabled":true},{"key":"page_size","value":"1","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 07 Aug 2024 18:52:41 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"17897"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"8b0036fc-d038-4a78-a6e6-07901e67429b"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"cJtS9HflIAMELrA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66b3c279-1e14b50207b555c73a555e33;Parent=7e9f95efc2eaeb5e;Sampled=0;lineage=e7de7122:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"c2a07389-da13-4420-9060-c6bef2d6bd03\",\n \"catalog_name\": \"incomes_categories\",\n \"description\": \"Categorías de ingresos\",\n \"items\": [\n {\n \"id\": \"e131ca4e-28d2-48fc-ab73-ea92e48b084f\",\n \"catalog\": \"c2a07389-da13-4420-9060-c6bef2d6bd03\",\n \"item_name\": \"Rendimientos\",\n \"description\": \"Pago de dividendos e intereses ganados\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/inc_rendimientos.svg\",\n \"name\": \"Rendimientos\",\n \"color\": \"#4D9932\",\n \"active\": true,\n \"short_name\": \"INCRENDIMIENTOS\",\n \"color_class\": \"cat-inc-rendimientos\",\n \"description\": \"Intereses y pago de dividendos\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/inc_rendimientos_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/inc_rendimientos_primary.svg\"\n }\n },\n {\n \"id\": \"3954361d-ddf5-46dc-a8f8-af98ee9811da\",\n \"catalog\": \"c2a07389-da13-4420-9060-c6bef2d6bd03\",\n \"item_name\": \"Sueldo\",\n \"description\": \"Sueldos, salarios, honorarios e ingresos por trabajo\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/inc_sueldo.svg\",\n \"name\": \"Ingresos\",\n \"color\": \"#01C38E\",\n \"active\": true,\n \"short_name\": \"INCSUELDO\",\n \"color_class\": \"cat-inc-sueldo\",\n \"description\": \"Salarios, honorarios y por contrato\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/inc_sueldo_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/inc_sueldo_primary.svg\"\n }\n },\n {\n \"id\": \"763d39ca-45e8-4171-8a97-29ba9a37665c\",\n \"catalog\": \"c2a07389-da13-4420-9060-c6bef2d6bd03\",\n \"item_name\": \"Regalos y otros ingresos\",\n \"description\": \"Regalos hechos por transferencias y otros ingresos\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/inc_regalos.svg\",\n \"name\": \"Regalos y otros ingresos\",\n \"color\": \"#5C9961\",\n \"active\": true,\n \"short_name\": \"INCREGALOS\",\n \"color_class\": \"cat-inc-regalos\",\n \"description\": \"Otros tipos de ingresos\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/inc_regalos_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/inc_regalos_primary.svg\"\n }\n },\n {\n \"id\": \"8ebba319-0042-41ff-bdbb-ba05cd824d52\",\n \"catalog\": \"c2a07389-da13-4420-9060-c6bef2d6bd03\",\n \"item_name\": \"Transferencias\",\n \"description\": \"Transferencias, depósitos y reembolsos recibidos\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/inc_transferencias.svg\",\n \"name\": \"Depósitos y Transferencias\",\n \"color\": \"#40916C\",\n \"active\": true,\n \"short_name\": \"INCTRANSFERENCIAS\",\n \"color_class\": \"cat-inc-trasferencias\",\n \"description\": \"Transferencias, depósitos y reembolsos\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/inc_transferencias_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/inc_transferencias_primary.svg\"\n }\n },\n {\n \"id\": \"593cea05-8f4d-4b40-ad1b-d73e43c8d53d\",\n \"catalog\": \"c2a07389-da13-4420-9060-c6bef2d6bd03\",\n \"item_name\": \"Devolución de impuestos\",\n \"description\": \"Devoluciones del Servicio de Impuestos Internos\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/inc_devolucion.svg\",\n \"name\": \"Devolución de impuestos\",\n \"color\": \"#25A244\",\n \"active\": true,\n \"short_name\": \"INCDEVOLUCION\",\n \"color_class\": \"cat-inc-devolucion\",\n \"description\": \"Reembolso o reducción de impuestos\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/inc_devolucion_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/inc_devolucion_primary.svg\"\n }\n },\n {\n \"id\": \"5f342655-bf27-4523-aa32-40d7cb48ae38\",\n \"catalog\": \"c2a07389-da13-4420-9060-c6bef2d6bd03\",\n \"item_name\": \"Subvención\",\n \"description\": \"Pensión, becas, subvención y ayudas familiares\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/inc_subvencion.svg\",\n \"name\": \"Subvención y Pensión\",\n \"color\": \"#47783F\",\n \"active\": true,\n \"short_name\": \"INCSUBVENCION\",\n \"color_class\": \"cat-inc-subvencion\",\n \"description\": \"Pensión y ayuda económica\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/inc_subvencion_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/inc_subvencion_primary.svg\"\n }\n },\n {\n \"id\": \"9abd4759-ab14-4e09-adc2-9c5dea1041b2\",\n \"catalog\": \"c2a07389-da13-4420-9060-c6bef2d6bd03\",\n \"item_name\": \"Rentas y arriendos\",\n \"description\": \"Ingresos por arriendos de muebles e inmuebles\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/inc_rentas.svg\",\n \"name\": \"Rentas y Arriendos\",\n \"color\": \"#01936C\",\n \"active\": true,\n \"short_name\": \"INCRENTAS\",\n \"color_class\": \"cat-inc-rentas\",\n \"description\": \"Arriendo de muebles e inmuebles\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/inc_rentas_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/inc_rentas_primary.svg\"\n }\n }\n ]\n },\n {\n \"id\": \"1ec6a6b5-65d5-4a8c-85d0-4364c141aefd\",\n \"catalog_name\": \"expenses_categories\",\n \"description\": \"Categorías de egresos\",\n \"items\": [\n {\n \"id\": \"bf50dc35-43d0-4f60-9860-770b8afc96f4\",\n \"catalog\": \"1ec6a6b5-65d5-4a8c-85d0-4364c141aefd\",\n \"item_name\": \"Ignorar\",\n \"description\": \"Transacciones que no quieres que se agreguen a una categoría\",\n \"metadata\": {\n \"icon\": \"/assets/img/category/ignore.svg\",\n \"color\": \"#CFA7DC\",\n \"active\": true,\n \"short_name\": \"IGNORE\"\n }\n },\n {\n \"id\": \"38e570af-1241-426c-afa5-f874b1c49128\",\n \"catalog\": \"1ec6a6b5-65d5-4a8c-85d0-4364c141aefd\",\n \"item_name\": \"Otros\",\n \"description\": \"Otros\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/ahorro.svg\",\n \"color\": \"#9C9A9F\",\n \"active\": true,\n \"short_name\": \"OTROS\"\n }\n },\n {\n \"id\": \"4419f198-e4d5-4352-aba6-c6f173b748b2\",\n \"catalog\": \"1ec6a6b5-65d5-4a8c-85d0-4364c141aefd\",\n \"item_name\": \"Pago Tarjeta de Crédito\",\n \"description\": \"Compra de divisas, pago tarjeta de crédito\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/credit_card.svg\",\n \"name\": \"Pago Créditos\",\n \"color\": \"#E57465\",\n \"active\": true,\n \"short_name\": \"CREDITCARD\",\n \"color_class\": \"cat-credit-card\",\n \"description\": \"Tarjeta, créditos de consumo\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/credit_card_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/credit_card_primary.svg\"\n }\n },\n {\n \"id\": \"4cdad960-1ec7-4a9b-aae8-71eeb6ba2ad7\",\n \"catalog\": \"1ec6a6b5-65d5-4a8c-85d0-4364c141aefd\",\n \"item_name\": \"Transferencias entre Cuentas Propias\",\n \"description\": \"Transferencias entre mis cuentas personales\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/trans_cuentas.svg\",\n \"name\": \"Transf. entre mis Cuentas\",\n \"color\": \"#E07591\",\n \"active\": true,\n \"short_name\": \"TRANSCUENTAS\",\n \"color_class\": \"cat-trans-cuentas\",\n \"description\": \"Transf. entre cuentas propias\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/trans_cuentas_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/trans_cuentas_primary.svg\"\n }\n },\n {\n \"id\": \"f7f2f8aa-2297-41a2-9fcf-d65aa9cfb180\",\n \"catalog\": \"1ec6a6b5-65d5-4a8c-85d0-4364c141aefd\",\n \"item_name\": \"Donaciones & Regalos\",\n \"description\": \"Donaciones, regalos a terceros\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/donaciones.svg\",\n \"name\": \"Donaciones y Regalos\",\n \"color\": \"#F3960B\",\n \"active\": true,\n \"short_name\": \"DONACIONES\",\n \"color_class\": \"cat-donaciones\",\n \"description\": \"Donaciones o regalos a terceros\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/donaciones_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/donaciones_primary.svg\"\n }\n },\n {\n \"id\": \"a249c468-bb4d-4365-83f4-108d456bb494\",\n \"catalog\": \"1ec6a6b5-65d5-4a8c-85d0-4364c141aefd\",\n \"item_name\": \"Restaurantes\",\n \"description\": \"Apps de pedidos, restaurantes, bares y nightclubs\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/restaurantes.svg\",\n \"name\": \"Restaurantes\",\n \"color\": \"#7D47EF\",\n \"active\": true,\n \"short_name\": \"RESTAURANTES\",\n \"color_class\": \"cat-restaurantes\",\n \"description\": \"Cafeterías, bares, restaurantes\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/restaurantes_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/restaurantes_primary.svg\"\n }\n },\n {\n \"id\": \"f37b6770-7fc5-43e0-a837-50926e1ee459\",\n \"catalog\": \"1ec6a6b5-65d5-4a8c-85d0-4364c141aefd\",\n \"item_name\": \"Sin categoría\",\n \"description\": \"Transacción sin categoría\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/sin_categoria.svg\",\n \"name\": \"Añadir Categoría\",\n \"color\": \"#6F6F6F\",\n \"active\": false,\n \"short_name\": \"SINCATEGORIA\",\n \"color-class\": \"\",\n \"description\": \"Categoría\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/sin_categoria.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/sin_categoria.svg\"\n }\n },\n {\n \"id\": \"84e6fa2f-8790-4d94-8f65-6944c7bcba10\",\n \"catalog\": \"1ec6a6b5-65d5-4a8c-85d0-4364c141aefd\",\n \"item_name\": \"Vacaciones & Viajes\",\n \"description\": \"Plataformas de viajes, hoteles, cabañas, arriendo de auto\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/viajes.svg\",\n \"name\": \"Viajes y Vacaciones\",\n \"color\": \"#E55E6E\",\n \"active\": true,\n \"short_name\": \"VIAJES\",\n \"color_class\": \"cat-viajes\",\n \"description\": \"Pasajes, hoteles, reservas\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/viajes_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/viajes_primary.svg\"\n }\n },\n {\n \"id\": \"ab0e1c52-4ab1-46b3-9384-7db452b282b2\",\n \"catalog\": \"1ec6a6b5-65d5-4a8c-85d0-4364c141aefd\",\n \"item_name\": \"Supermercados\",\n \"description\": \"Tienda de comestibles, panaderia, pasteleria\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/supermercados.svg\",\n \"name\": \"Supermercados\",\n \"color\": \"#FCC442\",\n \"active\": true,\n \"short_name\": \"SUPERMERCADOS\",\n \"color_class\": \"cat-supermercados\",\n \"description\": \"Almacén, alimentos, abarrotes\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/supermercados_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/supermercados_primary.svg\"\n }\n },\n {\n \"id\": \"d26e9eb4-5c2a-45f2-af03-571af93ae7e2\",\n \"catalog\": \"1ec6a6b5-65d5-4a8c-85d0-4364c141aefd\",\n \"item_name\": \"Transferencias & Retiros\",\n \"description\": \"Transferencias a terceros, retiros en cajeros, retiros en caja\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/retiros.svg\",\n \"name\": \"Transferencias y Retiros\",\n \"color\": \"#5D95E8\",\n \"active\": true,\n \"short_name\": \"RETIROS\",\n \"color_class\": \"cat-retiros\",\n \"description\": \"Cajeros, transferencias a otros bancos\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/retiros_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/retiros_primary.svg\"\n }\n },\n {\n \"id\": \"53566d37-4b4d-4598-8b6c-09f5970c33cd\",\n \"catalog\": \"1ec6a6b5-65d5-4a8c-85d0-4364c141aefd\",\n \"item_name\": \"Automóvil & Transporte\",\n \"description\": \"Gasolina, estacionamiento, seguro auto, app taxi\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/transporte.svg\",\n \"name\": \"Automóvil y Transporte\",\n \"color\": \"#577590\",\n \"active\": true,\n \"short_name\": \"TRANSPORTE\",\n \"color_class\": \"cat-transporte\",\n \"description\": \"Gasolina, metro, uber, seguro auto\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/transporte_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/transporte_primary.svg\"\n }\n },\n {\n \"id\": \"72fb8abb-d236-469d-a511-0e7d81c4af1e\",\n \"catalog\": \"1ec6a6b5-65d5-4a8c-85d0-4364c141aefd\",\n \"item_name\": \"Hogar & Familia\",\n \"description\": \"Renta, hipotecario, educación, mascota, veterinario, colegio\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/hogar.svg\",\n \"name\": \"Hogar y Familia\",\n \"color\": \"#7B80E3\",\n \"active\": true,\n \"short_name\": \"HOGAR\",\n \"color_class\": \"cat-hogar\",\n \"description\": \"Mascota, renta, educación, decoración\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/hogar_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/hogar_primary.svg\"\n }\n },\n {\n \"id\": \"cf01dce7-6d5e-4ad6-8e5a-8ba5c6d6f94c\",\n \"catalog\": \"1ec6a6b5-65d5-4a8c-85d0-4364c141aefd\",\n \"item_name\": \"Gastos Financieros & Seguros\",\n \"description\": \"Seguros, comisiones, impuestos\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/finanzas.svg\",\n \"name\": \"Gastos Financieros\",\n \"color\": \"#6E8D9E\",\n \"active\": true,\n \"short_name\": \"FINANZAS\",\n \"color_class\": \"cat-finanzas\",\n \"description\": \"Seguro, comisiones, impuestos\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/finanzas_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/finanzas_primary.svg\"\n }\n },\n {\n \"id\": \"22118f55-e6a9-46b0-ae8f-a063dda396e0\",\n \"catalog\": \"1ec6a6b5-65d5-4a8c-85d0-4364c141aefd\",\n \"item_name\": \"Shopping\",\n \"description\": \"Deportes, electrónica, vestuario y calzado\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/shopping.svg\",\n \"name\": \"Shopping\",\n \"color\": \"#6A994E\",\n \"active\": true,\n \"short_name\": \"SHOPPING\",\n \"color_class\": \"cat-shopping\",\n \"description\": \"Vestuario, calzado, electrónica\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/shopping_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/shopping_primary.svg\"\n }\n },\n {\n \"id\": \"0f7b3aa0-365f-475d-b3bc-39d960916a23\",\n \"catalog\": \"1ec6a6b5-65d5-4a8c-85d0-4364c141aefd\",\n \"item_name\": \"Ahorro e Inversión\",\n \"description\": \"Ahorros, propiedades, vehículos\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/ahorro.svg\",\n \"name\": \"Ahorro e Inversión\",\n \"color\": \"#9D6B53\",\n \"active\": true,\n \"short_name\": \"AHORRO\",\n \"color_class\": \"cat-ahorro\",\n \"description\": \"Ahorros, propiedades, vehículos\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/ahorro_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/ahorro_primary.svg\"\n }\n },\n {\n \"id\": \"8442c4fa-64e6-4470-af7c-8d007d5f572f\",\n \"catalog\": \"1ec6a6b5-65d5-4a8c-85d0-4364c141aefd\",\n \"item_name\": \"Cuentas & Servicios\",\n \"description\": \"Consumo de luz, agua, gas, internet, telefonía\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/servicios.svg\",\n \"name\": \"Cuentas y Servicios\",\n \"color\": \"#95B8D1\",\n \"active\": true,\n \"short_name\": \"SERVICIOS\",\n \"color_class\": \"cat-servicios\",\n \"description\": \"Gas, luz, agua, internet, telefonía\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/servicios_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/servicios_primary.svg\"\n }\n },\n {\n \"id\": \"f0eae548-64e6-45b4-9bfd-4059d2b9d4df\",\n \"catalog\": \"1ec6a6b5-65d5-4a8c-85d0-4364c141aefd\",\n \"item_name\": \"Salud & Bienestar\",\n \"description\": \"Farmacia, doctores, dentista, gimnasio, salon de belleza, peluqueria\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/salud.svg\",\n \"name\": \"Salud y Bienestar\",\n \"color\": \"#48A2BD\",\n \"active\": true,\n \"short_name\": \"SALUD\",\n \"color_class\": \"cat-salud\",\n \"description\": \"Farmacia, hospital, clínica, dentista\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/salud_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/salud_primary.svg\"\n }\n },\n {\n \"id\": \"9abd4759-ab14-4e09-adc2-9c5dea1041b1\",\n \"catalog\": \"1ec6a6b5-65d5-4a8c-85d0-4364c141aefd\",\n \"item_name\": \"Entretenimiento\",\n \"description\": \"Netflix, spotify, cine, apps store, videojuegos\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/entretenimiento.svg\",\n \"name\": \"Entretenimiento\",\n \"color\": \"#6CD1B8\",\n \"active\": true,\n \"short_name\": \"ENTRETENIMIENTO\",\n \"color_class\": \"cat-entretenimiento\",\n \"description\": \"Netflix, juegos, streaming, discotecas\",\n \"icon_ignore\": \"/assets/xerpa/global/img/categories/entretenimiento_ignore.svg\",\n \"icon_primary\": \"/assets/xerpa/global/img/categories/entretenimiento_primary.svg\"\n }\n }\n ]\n },\n {\n \"id\": \"4625b3a0-b3dc-48e8-b495-1eda09e58222\",\n \"catalog_name\": \"budget_status\",\n \"description\": \"Estado del presupuesto\",\n \"items\": [\n {\n \"id\": \"cbf5eacb-6b1c-42f4-bdba-5a6f6276e0ac\",\n \"catalog\": \"4625b3a0-b3dc-48e8-b495-1eda09e58222\",\n \"item_name\": \"Activo\",\n \"description\": \"Presupuesto activo\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/shopping.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"ACTIVE\"\n }\n },\n {\n \"id\": \"f1ba1236-b4fd-4ed6-9d35-8114ed66726f\",\n \"catalog\": \"4625b3a0-b3dc-48e8-b495-1eda09e58222\",\n \"item_name\": \"Eliminado\",\n \"description\": \"Presupuesto eliminado\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/shopping.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"DELETED\"\n }\n }\n ]\n },\n {\n \"id\": \"f1895069-e723-4cc8-9331-d1cb4110ab7a\",\n \"catalog_name\": \"accounts_types\",\n \"description\": \"Tipos de cuentas\",\n \"items\": [\n {\n \"id\": \"f3029ccb-8f07-4c15-a55d-5fc628cc4230\",\n \"catalog\": \"f1895069-e723-4cc8-9331-d1cb4110ab7a\",\n \"item_name\": \"cuenta_corriente\",\n \"description\": \"Cuenta Corriente\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/products/cc.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"CUENTACORRIENTE\"\n }\n },\n {\n \"id\": \"e480d1b0-cb8e-448c-9864-ed7ae4ce20b3\",\n \"catalog\": \"f1895069-e723-4cc8-9331-d1cb4110ab7a\",\n \"item_name\": \"cuenta_vista\",\n \"description\": \"Cuenta Vista\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/cuenta_vista.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"CUENTAVISTA\"\n }\n },\n {\n \"id\": \"93909b64-0e8c-4494-bec5-c84906430182\",\n \"catalog\": \"f1895069-e723-4cc8-9331-d1cb4110ab7a\",\n \"item_name\": \"cuenta_ahorro\",\n \"description\": \"Cuenta Ahorro\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/cuenta_ahorro.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"CUENTAAHORRO\"\n }\n },\n {\n \"id\": \"18743d7e-4fee-4e13-b2fc-00f86d8f8511\",\n \"catalog\": \"f1895069-e723-4cc8-9331-d1cb4110ab7a\",\n \"item_name\": \"cuenta_inversion\",\n \"description\": \"Cuenta Inversión\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/cuenta_inversion.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"CUENTAINVERSION\"\n }\n },\n {\n \"id\": \"d9a4b159-8e15-48ea-aa88-72f1c21bb0d0\",\n \"catalog\": \"f1895069-e723-4cc8-9331-d1cb4110ab7a\",\n \"item_name\": \"tarjeta_debito\",\n \"description\": \"Tarjeta Débito\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/tarjeta_debito.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"TARJETADEBITO\"\n }\n },\n {\n \"id\": \"e655b55f-e39c-49c0-a77e-aed53e1b5d15\",\n \"catalog\": \"f1895069-e723-4cc8-9331-d1cb4110ab7a\",\n \"item_name\": \"tarjeta_credito\",\n \"description\": \"Tarjeta Crédito\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/categories/tarjeta_credito.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"TARJETACREDITO\"\n }\n }\n ]\n },\n {\n \"id\": \"dc34207f-34ba-4bd5-99ec-8ee4bbcdf927\",\n \"catalog_name\": \"currencies\",\n \"description\": \"Monedas\",\n \"items\": [\n {\n \"id\": \"cea03b6b-96a3-4d5b-a84e-a74d5c88be0a\",\n \"catalog\": \"dc34207f-34ba-4bd5-99ec-8ee4bbcdf927\",\n \"item_name\": \"USD\",\n \"description\": \"USD\",\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/currencies/usd.svg\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"short_name\": \"USD\"\n }\n }\n ]\n },\n {\n \"id\": \"a5b7cfeb-fe11-44ad-b251-64aaccd12bec\",\n \"catalog_name\": \"deprecated_categories\",\n \"description\": \"Categorías deprecadas\",\n \"items\": [\n {\n \"id\": \"693b9aed-83a6-426a-8eb4-84adb64f10dd\",\n \"catalog\": \"a5b7cfeb-fe11-44ad-b251-64aaccd12bec\",\n \"item_name\": \"Yape Ingreso\",\n \"description\": \"Yape Ingreso\",\n \"metadata\": {}\n },\n {\n \"id\": \"35f5e608-4285-49a4-90ca-d90102131e14\",\n \"catalog\": \"a5b7cfeb-fe11-44ad-b251-64aaccd12bec\",\n \"item_name\": \"Warda Ingreso\",\n \"description\": \"Warda Ingreso\",\n \"metadata\": {}\n },\n {\n \"id\": \"cb5aa1ec-493b-49cf-8499-bf6f290345ff\",\n \"catalog\": \"a5b7cfeb-fe11-44ad-b251-64aaccd12bec\",\n \"item_name\": \"Warda Egreso\",\n \"description\": \"Warda Egreso\",\n \"metadata\": {}\n },\n {\n \"id\": \"9c7ac7a6-1051-4c29-b794-5c1fecee9ec5\",\n \"catalog\": \"a5b7cfeb-fe11-44ad-b251-64aaccd12bec\",\n \"item_name\": \"Yape Egreso\",\n \"description\": \"Yape Egreso\",\n \"metadata\": {}\n }\n ]\n }\n]"}],"_postman_id":"5349d110-d44e-4805-ab00-859a08a8facf"}],"id":"75c6dbaa-c0f0-423c-821d-bd6941b4c6fa","description":"🗂️ Catálogos del sistema PFM
\nLa carpeta Catalogs contiene los endpoints para consultar, explorar y administrar los catálogos de datos maestros que utiliza el sistema de finanzas personales. Estos catálogos agrupan elementos como tipos de transacción, categorías de gasto e ingreso, estados, íconos y otras propiedades de configuración clave para el funcionamiento y visualización de la plataforma.
\n\n
📌 Funcionalidades incluidas
\nA través de esta carpeta es posible:
\n- \n
Obtener todos los catálogos disponibles en el sistema.
\n \nConsultar el detalle de un catálogo específico.
\n \nObtener la información detallada de un ítem dentro de un catálogo.
\n \nActualizar un ítem existente para modificar su nombre, descripción, metadatos o ícono.
\n \nFiltrar catálogos por tipo (por ejemplo,
\nproject_type,activity_type,transaction_category, etc.). \n
\n
🧠 Casos de uso
\n- \n
Personalizar la visualización de categorías en apps embebidas o móviles.
\n \nAgregar nuevas categorías o editar ítems existentes según la evolución del producto.
\n \nMostrar nombres amigables, íconos y colores asociados a cada tipo de gasto o ingreso.
\n \nFacilitar el mantenimiento y escalabilidad de componentes del sistema basados en catálogos.
\n \n
\n
🧩 Estructura típica de un ítem
\nCada ítem de catálogo incluye:
\n- \n
\nid,catalog,item_name,description\n
\nmetadata: información visual o técnica como:- \n
icon,color,name,order,active,short_name,frequency_description, etc. \n
\n
\n
🔐 Seguridad
\n- \n
Todos los endpoints requieren autenticación.
\n \nSolo usuarios o servicios autorizados pueden realizar modificaciones (
\nPUT). \n
API Spendings
\nAgrupa todos los endpoints relacionados con la gestión de datos financieros personales del usuario. A través de esta API, se permite consultar, modificar y analizar las transacciones económicas que realiza una persona usuaria, facilitando la visualización de su comportamiento financiero y el control de su presupuesto.
\nEste módulo está diseñado para integrarse con aplicaciones que ofrecen funcionalidades de administración de gastos, categorización inteligente, reglas personalizadas y generación de métricas de ahorro y consumo.
\n\n
📌 Casos de uso comunes
\nLa carpeta contiene subgrupos de endpoints organizados en las siguientes categorías:
\n- \n
Consulta y validación de información del usuario.
\n \nGestión de cuentas personales y validación de actividad.
\n \nRegistro de eventos del sistema y acciones del usuario.
\n \nConsulta y administración de catálogos del sistema (categorías, estados, tipos, etc.).
\n \nCreación, edición y control de presupuestos personalizados.
\n \nConsulta, edición, clasificación y análisis de transacciones registradas.
\n \nGestión de reglas personalizadas de clasificación de transacciones por el usuario.
\n \n
🔐 Autenticación requerida
\nTodos los endpoints requieren un User Token válido, ya que cada solicitud se vincula a un usuario específico.
\n\n\nEl token debe enviarse como:
\nAuthorization: Bearer {{user_token}}
\n
🎯 Consideraciones
\n- \n
Todos los endpoints requieren autenticación previa mediante token.
\n \nEl sistema de categorización se apoya en modelos de Machine Learning, pero permite intervención manual mediante reglas.
\n \nLos resultados pueden filtrarse por fechas, categorías, cuentas o tipos de transacción.
\n \nLa mayoría de los recursos implementan paginación y ordenamiento.
\n \n
Este endpoint permite consultar todas las cuentas asociadas a un usuario específico dentro del servicio de ahorro.
\nRequest
\n- \n
Método:
\nGET\nURL: {{host_app}}/api-saving/v1/saving-service/users/{{user_id}}/accounts/
\n \nParámetros de ruta:
\n- \n
user_id(string): ID del usuario asociado al proyecto. \n
\n
Request Body
\n- \n
- Este request de tipo
GETno requiere cuerpo. El cuerpo de la solicitud debe enviarse vacío. \n
Response
\nLa respuesta será un arreglo de objetos, donde cada objeto representa una cuenta del usuario, e incluye los siguientes campos:
\n- \n
\nid(string): Identificador único de la cuenta. \n
\nproduct_type(object): Detalles del tipo de producto financiero asociado, este incluye:- \n
\nid(string): ID del tipo de producto. \n
\nitem_name(string): Nombre del tipo de producto. \n
\ndescription(string): Descripción del producto. \n
\nmetadata(object): Información adicional, incluyendo:- \n
\nicon(string): Ícono representativo. \n
\ntype(string): Tipo del producto. \n
\ncolor(string): Color asignado. \n
\nactive(boolean): Estado de activación del producto. \n
\n
\n
\nproduct_status(object): Estado actual del producto asociado, este incluye:- \n
\nid(string): ID del estado. \n
\nitem_name(string): Nombre del estado. \n
\ndescription(string): Descripción del estado. \n
\nmetadata(object): Incluye:- \n
\nicon(string): Ícono del estado. \n
\ncolor(string): Color visual. \n
\nactive(boolean): Si el estado está activo. \n
\n
\n
\nactive_pfm(boolean): Indica si la cuenta está activa en la plataforma de gestión financiera personal (PFM). \n
\nexternal_id(string): Identificador externo de la cuenta (por ejemplo, desde el core bancario). \n
\naccount_number(string): Número de cuenta del usuario. \n
\ncreated_at(string): Fecha y hora de creación de la cuenta. \n
\nupdated_at(string): Fecha y hora de la última actualización. \n
\nuser(string): ID del usuario asociado a la cuenta. \n
\naccount_type(string): Tipo de cuenta (por ejemplo: ahorro, corriente, inversión). \n
\naccount_status(string): Estado general de la cuenta. \n
Response Format
\n{\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"product_type\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"item_name\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"icon\": { \"type\": \"string\" },\n \"type\": { \"type\": \"string\" },\n \"color\": { \"type\": \"string\" },\n \"active\": { \"type\": \"boolean\" },\n \"short_name\": { \"type\": \"string\" }\n },\n }\n },\n },\n \"product_status\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"item_name\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"icon\": { \"type\": \"string\" },\n \"color\": { \"type\": \"string\" },\n \"active\": { \"type\": \"boolean\" },\n \"short_name\": { \"type\": \"string\" }\n },\n }\n }, \n },\n \"active_pfm\": { \"type\": \"boolean\" },\n \"external_id\": { \"type\": \"string\" },\n \"account_number\": { \"type\": \"string\" },\n \"created_at\": { \"type\": \"string\", \"format\": \"date-time\" },\n \"updated_at\": { \"type\": \"string\", \"format\": \"date-time\" },\n \"user\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"account_type\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"account_status\": { \"type\": \"string\", \"format\": \"uuid\" }\n }\n }\n}\n\nEste endpoint recupera las cuentas asociadas al usuario autenticado.
\n\n
Request
\n- \n
Method: GET
\n \nEndpoint: {{host_app}}/api-pfm/v1/core-service/users/{{user_id}}/accounts/
\n \nParámetros de ruta:
\n- \n
user_id(string): ID del usuario. \n
\n
Request Body
\nEste request de tipo GET no requiere cuerpo.
El cuerpo de la solicitud debe enviarse vacío.
Response
\nLa respuesta es un arreglo de elementos account en donde cada item incluye:
- \n
\nid(string): ID único de la cuenta. \n
\nuser(string): ID del usuario asociado a la cuenta. \n
\nexternal_id(string): Identificador externo de la cuenta (ej. del banco). \n
\naccount_number(string): Número de cuenta. \n
\naccount_type(string): Tipo de cuenta. \n
\naccount_status(string): Estado actual de la cuenta. \n
\ncreated_at(string): Fecha de creación de la cuenta. \n
\nupdated_at(string): Fecha de última actualización de la cuenta. \n
\nactive_pfm(boolean): Indica si la cuenta está activa en el sistema de gestión financiera personal (PFM). \n
Response Format
\n{\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\"type\": \"string\"},\n \"user\": {\"type\": \"string\"},\n \"external_id\": {\"type\": \"string\"},\n \"account_number\": {\"type\": \"string\"},\n \"account_type\": {\"type\": \"string\"},\n \"account_status\": {\"type\": \"string\"},\n \"created_at\": {\"type\": \"string\"},\n \"updated_at\": {\"type\": \"string\"},\n \"active_pfm\": {\"type\": \"boolean\"}\n }\n }\n}\n\nEste endpoint permite consultar los detalles de una cuenta específica asociada a un usuario.
\n\n
Request
\n- \n
Method: GET
\n \nEndpoint: {{host_app}}/api-pfm/v1/core-service/users/{{user_id}}/accounts/{{obtain_account_detail_account_id}}/
\n \nParámetros de ruta:
\n- \n
\nuser_id(string): ID del usuario. \n
\naccount_id(string): ID de la cuenta del usuario. \n
\n
Request Body
\nEste request de tipo GET no requiere cuerpo.
El cuerpo de la solicitud debe enviarse vacío.
Response
\nLa respuesta será un objeto JSON con los siguientes campos:
\n- \n
\nid(string): ID único de la cuenta. \n
\nuser(string): ID del usuario asociado a la cuenta. \n
\nexternal_id(string): Identificador externo de la cuenta (ej. del banco). \n
\naccount_number(string): Número de cuenta. \n
\naccount_type(string): Tipo de cuenta. \n
\naccount_status(string): Estado actual de la cuenta. \n
\ncreated_at(string): Fecha de creación de la cuenta. \n
\nupdated_at(string): Fecha de última actualización de la cuenta. \n
\nactive_pfm(boolean): Indica si la cuenta está activa en el sistema de gestión financiera personal (PFM). \n
JSON Schema
\n{\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\"type\": \"string\"},\n \"user\": {\"type\": \"string\"},\n \"external_id\": {\"type\": \"string\"},\n \"account_number\": {\"type\": \"string\"},\n \"account_type\": {\"type\": \"string\"},\n \"account_status\": {\"type\": \"string\"},\n \"created_at\": {\"type\": \"string\"},\n \"updated_at\": {\"type\": \"string\"},\n \"active_pfm\": {\"type\": \"boolean\"}\n }\n}\n\nEste endpoint permite obtener las cuentas activas de un usuario en el sistema de gestión financiera personal (PFM).
\n\n
Request
\n- \n
Método:
\nGET\nURL: {{host_app}}/api-pfm/v1/core-service/users/{{user_id}}/accounts/activation/
\n \nParámetros:
\n- \n
user_id(string): ID del usuario \n
\n
Request Body
\nEste request de tipo GET no requiere cuerpo.
El cuerpo de la solicitud debe enviarse vacío.
Response
\nLa respuesta será un objeto JSON que contiene un arreglo de cuentas, donde cada objeto incluye:
\n- \n
\naccount_id(string): Identificador único de la cuenta. \n
\nactive_pfm(boolean): Indica si la cuenta está activa en el sistema PFM. \n
Response Format
\n{\n \"type\": \"object\",\n \"properties\": {\n \"accounts\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"account_id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"active_pfm\": { \"type\": \"boolean\" }\n },\n }\n }\n },\n}\n\nEste endpoint permite activar cuentas de usuario en el sistema de gestión financiera personal (PFM) mediante una solicitud HTTP POST. La activación de cuentas es esencial para que los usuarios puedan gestionar sus finanzas a través de la plataforma.
\n
Request
\n- \n
Metodo: POST
\n \nURL: {{host_app}}api-pfm/v1/core-service/users/{{user_id}}/accounts/activation/
\n \nParámetros:
\n- \n
user_id(string): ID del usuario asociado. \n
\n
Request Body
\nLa solicitud debe enviarse en formato JSON e incluir un arreglo de objetos bajo la clave accounts. Cada objeto debe contener los siguientes parámetros:
- \n
\naccount_id(string): Identificador único de la cuenta a activar. Este valor es necesario para identificar la cuenta específica que se desea activar. \n
\nactive_pfm(boolean): Valor que indica si la cuenta debe marcarse como activa. Debe establecerse entruepara activar la cuenta en el sistema. \n
Request Body Example
\n{\n \"accounts\": [\n {\n \"account_id\": \"03b8ac8a-965a-4c1f-844f-5df382...\",\n \"active_pfm\": true\n }\n ]\n}\n\nResponse
\nLa respuesta será un objeto JSON que confirma el estado actualizado de las cuentas. En caso de éxito, la respuesta incluirá el mismo formato que se envió en la solicitud, reflejando el estado de activación.
\nResponse Format
\n{\n \"type\": \"object\",\n \"properties\": {\n \"accounts\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"account_id\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"active_pfm\": {\n \"type\": \"boolean\"\n }\n }\n }\n }\n }\n}\n\n🏦 Gestión de cuentas del usuario
\nContiene los endpoints necesarios para consultar, identificar y administrar las cuentas financieras asociadas a un usuario dentro del sistema de finanzas personales (PFM).
\nEstos endpoints permiten recuperar información estructurada sobre las cuentas activas del usuario, sus identificadores, estado, tipo de producto y metadatos relacionados, lo cual resulta fundamental para enlazar operaciones como transacciones, presupuestos y reglas de clasificación.
\n\n
📌 Funcionalidades incluidas
\nDentro de esta carpeta, encontrarás endpoints para:
\n- \n
Obtener todas las cuentas asociadas a un usuario.
\n \nConsultar el detalle de una cuenta específica mediante su
\naccount_id. \nBuscar una cuenta por número de cuenta (
\naccount_number). \nVerificar el estado de activación de las cuentas (
\nactive_pfm). \nActivar o desactivar cuentas manualmente desde un servicio autorizado.
\n \n
\n
🎯 Consideraciones
\n- \n
El campo
\nactive_pfmes esencial para saber si una cuenta debe incluirse en los cálculos del sistema. \nLas cuentas se vinculan al usuario mediante
\nuser_id, pero también pueden consultarse porexternal_idoaccount_number. \nToda cuenta activa puede participar en transacciones, presupuestos y reglas.
\n \nEl estado y tipo del producto bancario se determinan a través de catálogos del sistema.
\n \n
\n
🔒 Seguridad
\n- \n
Requiere autenticación vía token.
\n \nAlgunas operaciones (como activación masiva) pueden requerir privilegios de backend o servicio administrador.
\n \n
Este endpoint permite registrar manualmente un evento en el sistema, enviando una solicitud con los detalles del evento en el cuerpo de la solicitud.
\n\n
Request
\n- \n
Metodo:
\nPOST\nURL: {{host_app}}/api-pfm/v1/core-service/users/{{user_id}}/event/
\n \nParámetro de ruta:
\n- \n
user_id(string): ID del usuario \n
\n
\n
Request Body
\n- \n
\nevent_name(string): Nombre del evento. Este puede tomar los valores: \n
\nmetadata(object) (opcional): Objeto con información adicional específica del evento. \n
Request Body Example
\n{\n \"event_name\": \"Spendings-Home\",\n \"metadata\": {\n \"key\": \"value\"\n }\n}\n\nReponse
\nLa respuesta será un objeto JSON vacio, el cual indica que se creo correctamente el evento.
\n","urlObject":{"path":["api-pfm","v1","core-service","users","{{user_id}}","event",""],"host":["{{host_app}}"],"query":[],"variable":[]}},"response":[{"id":"e0dfa5f6-7789-43b9-a1eb-6a64de2699ce","name":"Successful Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"event_name\": \"Spendings-Home\",\r\n \"metadata\": {\r\n \"K\": \"V\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{host_app}}/api-pfm/v1/core-service/users/{{user_id}}/event/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 03 Jun 2025 16:26:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"b103c73a-c786-4c8d-94a5-c5be468bd3dd"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LmJHPHgGIAMEjwA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-683f222d-6efd0a0a1198c3f4209d16c2;Parent=17ff98d66dac261b;Sampled=0;Lineage=1:e7de7122:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"abc49a2b-018d-4b3e-9cfa-a64be6cad3d0"}],"id":"ad071880-c54b-4c62-8885-272c48399991","description":"📆 Registro de eventos del sistema
\nLos eventos representan acciones del usuario o registros relacionados con el procesamiento de reglas, métricas, activaciones o clasificaciones.
\nEl objetivo principal de estos endpoints es proveer trazabilidad y contexto sobre acciones relevantes, que pueden ser utilizados tanto para auditoría como para enriquecer experiencias personalizadas (como recomendaciones, recordatorios o reportes dinámicos).
\n\n
📌 Funcionalidades incluídas
\nLos endpoints disponibles permiten:
\n- \n
Registrar eventos desde frontend o plataformas externas.
\n \nConsultar el historial de eventos de un usuario en un periodo determinado.
\n \nFiltrar eventos por tipo, fecha u otros atributos relevantes.
\n \nObtener el detalle completo de un evento individual.
\n \n
\n
🧠 Casos de uso
\n- \n
Identificar cómo interactúan los usuarios con los flujos de frontend
\n \nRegistrar acciones que se utilicen para la segmentación de usuarios
\n \nTestear nuevas funcionalidades o iteraciones de funcionalidades actuales
\n \nIdentificar errores de navegación o bugs.
\n \nHabilitar notificaciones contextuales basadas en eventos recientes del usuario.
\n \n
\n
🎯Consideraciones
\n- \n
El
\nevent_typepermite categorizar los eventos para facilitar su análisis. \nLa respuesta incluye
\nmetadata, útil para almacenar detalles adicionales del evento. \n
Catálogo de event_type
\nSe adjuntan los eventos principales que se recomiendan implementar en los flusjo de frontend.
\nCada evento tiene una nomenclatura definida para facilitar
\nAhorros
\n- \n
- Pantalla Ahorros - Inicio:
\"Savings-Home\"\n
Flujo de creación de meta
\n- \n
Listado de tipos de metas de ahorro:
\n\"Savings-Projects-Create-List\"\nFormulario con los detalles de la meta:
\n\"Savings-Projects-Create-Detail\"\nRegistro exitoso de la meta:
\n\"Savings-Projects-Create-Success\"- \n
- Metadata: objeto de la meta que responde el endpoint \n
\n
Detalle y edición de una meta
\n- \n
Detalle de una meta de ahorro:
\n\"Savings-Projects-Detail\"\nFormulario de edición de la meta:
\n\"Savings-Projects-Edit\"\nEdición exitosa de la meta:
\n\"Savings-Projects-Edit-Success\"- \n
- Metadata: objeto de la meta que responde el endpoint \n
\n
Flujo de creación de una regla
\n- \n
Listado de reglas de ahorros disponibles:
\n\"Savings-Rules-Create-List\"\nFormulario de detalle de la regla:
\n\"Savings-Rules-Create-Detail\"\nRespuesta exitosa de la creación de la regla:
\n\"Savings-Rules-Create-Success\"- \n
- Metadata: objeto de la regla que responde el endpoint \n
\n
Detalle y edición de una regla
\n- \n
Lista de reglas de ahorro:
\n\"Savings-Rules-List\"\nDetalle de regla de ahorro:
\n\"Savings-Rules-Detail\"\nPantalla con formulario de edición de la regla:
\n\"Savings-Rules-Edit-Detail\"\nRespuesta exitosa de la regla editada:
\n\"Savings-Rules-Edit-Success\"- \n
- Metadata: objeto de la regla que responde el endpoint \n
\n
Listado y detalle de los ahorros
\n- \n
Lista de pagos de ahorros:
\n\"Savings-Payments-List\"\nDetalle de pagos de ahorros:
\n\"Savings-Payments-Detail\"\n
Reportes y Métricas
\n- \n
- Reporte mensual de ahorros:
\"Savings-Report-Monthly\"\n
Flujo de eliminación de meta
\nFlujo de retiro de abono y retiro manual
\nControl de Gastos
\n- \n
Crear presupuesto de gasto:
\n\"Spendings-Budget-Create\"\nCrear presupuesto de gasto - Éxito:
\n\"Spendings-Budget-Create-Success\"\nEditar presupuesto de gasto - Éxito:
\n\"Spendings-Budget-Edit-Success\"\nDetalle de categoría de gasto:
\n\"Spendings-Category-Detail\"\nDetalle de categoría de gasto al cambiar el mes:
\n\"Spendings-Category-Detail-Change-Month\"\nLista de categorías de gasto:
\n\"Spendings-Category-List\"\nLista de categorías de gasto al cambiar el mes:
\n\"Spendings-Category-List-Change-Month\"\nGastos de casa:
\n\"Spendings-Home\"\nGastos de casa al cambiar el mes:
\n\"Spendings-Home-Change-Month\"\nReporte mensual de gastos:
\n\"Spendings-Report-Monthly\"\nReporte semanal de gastos:
\n\"Spendings-Report-Weekly\"\nEditar categoría de transacción - Éxito:
\n\"Transactions-Category-Edit-Success\"\nSeleccionar categoría de transacción:
\n\"Transactions-Category-Select\"\nDetalle de transacción:
\n\"Transactions-Detail\"\nDetalle de transacción ignorada:
\n\"Transactions-Detail-Ignore\"\nLista de transacciones:
\n\"Transactions-List\"\nLista de transacciones al cambiar el mes:
\n\"Transactions-List-Change-Month\"\n
Este endpoint permite recuperar todos los catálogos registrados en Core. Los catálogos contienen información utilizada para poblar menús desplegables, filtrar datos o representar entidades de negocio como tipos de evento, estados de cuenta, categorías de gastos, entre otros.
\n\n
Request
\n- \n
Método:
\nGET\nURL: {{host_app}}/api-pfm/v1/core-service/catalogs/
\n \n
Request Body
\n- \n
- Este request de tipo
GETno requiere cuerpo. El cuerpo de la solicitud debe enviarse vacío. \n
Reponse
\nLa respuesta será un objeto JSON que incluye un arreglo de ítems catalogados, agrupables por tipocatalog, donde cada uno incluye:
- \n
\nid(string): Identificador único del ítem. \n
\ncatalog(string): Nombre del catálogo al que pertenece (ej.\"event_types\",\"account_status\"). \n
\nitem_name(string): Clave técnica del ítem dentro del catálogo. \n
\ndescription(string): Descripción legible o funcional del ítem. \n
\nmetadata(object): Información adicional (opcional), que puede incluir:- \n
\nicon(string): Ícono visual asociado. \n
\ntitle(string): Título para interfaces. \n
\nmessage(object): Mensajes contextuales (A,E,G,J, etc.). \nOtros campos específicos según el catálogo.
\n \n
\n
Response Format
\n{\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"catalog_name\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"catalog\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"item_name\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"icon\": { \"type\": \"string\" },\n \"color\": { \"type\": \"string\" },\n \"active\": { \"type\": \"boolean\" },\n \"short_name\": { \"type\": \"string\" }\n }\n }\n }\n }\n }\n }\n }\n}\n\nEste endpoint permite consultar todos los ítems de un catálogo específico del sistema, utilizando el nombre del catálogo como parámetro.
\n- \n
Este endpoint permite filtrar directamente por catálogo, a diferencia del listado general.
\n \nEs ideal para mostrar opciones filtradas en formularios, reglas, reportes o visualizaciones.
\n \nSi el catálogo no existe o está vacío, se devolverá un arreglo vacío sin error.
\n \n
\n
Request
\n- \n
Método:
\nGET\nURL: {{host_app}}/api-pfm/v1/core-service/catalogs/{{catalog_core_id}}
\n \nParámetros de ruta:
\n- \n
catalog_core_id(string): Id del catalogo que se desea consultar. \n
\n
Request Body
\n- \n
- Este request de tipo
GETno requiere cuerpo. El cuerpo de la solicitud debe enviarse vacío. \n
Response
\nLa respuesta es un JSON con los
\n- \n
\nid(string): ID del catalogo. \n
\ncatalog_name(string): Nombre del catalogo. \n
\ndescription(string): Descripcion del catalogo. \n
\nitems(array of objects): Lista de ítems pertenecientes al catálogo consultado, donde cada uno incluye:- \n
\nid(string): Identificador único del ítem. \n
\ncatalog(string): Nombre del catálogo al que pertenece. \n
\nitem_name(string): Clave técnica o interna del ítem. \n
\ndescription(string): Descripción legible del ítem. \n
\nmetadata(object): Metadatos adicionales, como:- \n
\nicon(string): Ícono asociado. \n
\ntitle(string): Título para interfaces gráficas. \n
\nmessage(object): Mensajes contextualizados por canal o lenguaje (A,E,G, etc.). \nOtros campos personalizados según el catálogo.
\n \n
\n
\n
Response Format
\n{\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"catalog_name\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"catalog\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"item_name\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"icon\": { \"type\": \"string\" },\n \"color\": { \"type\": \"string\" },\n \"active\": { \"type\": \"boolean\" },\n \"short_name\": { \"type\": \"string\" }\n }\n }\n }\n }\n }\n }\n}\n\nEste endpoint permite consultar los detalles de un ítem específico dentro de un catálogo del sistema.
\n- \n
Este endpoint es útil para obtener el detalle completo de un ítem sin tener que recorrer todo el catálogo.
\n \nEs ideal para mostrar etiquetas, íconos o comportamientos dinámicos en interfaces que dependan de la configuración del ítem.
\n \nEl contenido del campo
\nmetadatapuede variar ampliamente según el tipo de catálogo al que pertenezca el ítem. \n
\n
Request
\n- \n
Método:
\nGET\nURL:{{host_app}}/api-pfm/v1/core-service/items/{{item_core_id}}
\n \nParámetros de ruta
\n- \n
item_core_id(string): ID único del ítem que se desea consultar. \n
\n
Request Body:
\n- \n
- Este request de tipo
GETno requiere cuerpo. El cuerpo de la solicitud debe enviarse vacío. \n
\n
Response
\nLa respuesta será un objeto JSON que contiene la información detallada del ítem:
\n- \n
\nid(string): Identificador único del ítem. \n
\ncatalog(string): Nombre del catálogo al que pertenece. \n
\nitem_name(string): Clave interna del ítem. \n
\ndescription(string): Descripción legible del ítem. \n
\nmetadata(object): Objeto con metadatos adicionales que pueden incluir:- \n
\nicon(string): Ícono representativo. \n
\ntitle(string): Título para mostrar en interfaz. \n
\nmessage(object): Mensajes por canal o formato (A,E,G, etc.). \nOtros campos personalizados según el catálogo (color, orden, estado, etc.).
\n \n
\n
Response Format
\n{\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"catalog\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"item_name\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"icon\": { \"type\": \"string\" },\n \"color\": { \"type\": \"string\" },\n \"active\": { \"type\": \"boolean\" },\n \"short_name\": { \"type\": \"string\" }\n }\n }\n }\n}\n\nEnpoint que retorna las notificaciones para el usuario. Retorna una arreglo con múltiples notificaciones y permite filtrar por parámetros como estado, expiración, fecha entre otro parámetros.
\n","urlObject":{"path":["notification-service","v1","api","users","{{user_id}}","notifications",""],"host":["{{host_app}}"],"query":[{"disabled":true,"key":"paginate","value":"false"},{"disabled":true,"key":"page_size","value":"1"},{"disabled":true,"key":"page","value":"1"},{"disabled":true,"key":"active","value":"true"},{"disabled":true,"key":"ignored","value":"true"},{"disabled":true,"key":"read","value":"false"},{"disabled":true,"key":"sent","value":"true"},{"disabled":true,"key":"notification_campaign","value":"monthly_report_5_2024_demo"}],"variable":[]}},"response":[{"id":"53b13b70-1643-4267-94e1-28da07906bf2","name":"Listar notificaciones","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host_app}}/notification-service/v1/api/users/{{user_id}}/notifications/","host":["{{host_app}}"],"path":["notification-service","v1","api","users","{{user_id}}","notifications",""],"query":[{"key":"paginate","value":"false","disabled":true},{"key":"page_size","value":"25","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"active","value":"true","disabled":true},{"key":"ignored","value":"true","disabled":true},{"key":"read","value":"false","disabled":true},{"key":"sent","value":"true","disabled":true},{"key":"notification_campaign","value":"monthly_report_5_2024_demo","disabled":true}]}},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"next\": \"/notification-service/v1/api/users/me/notifications/?expired=true&page=1&page_size=25\",\n \"previous\": null,\n \"total_pages\": 27,\n \"current_page\": 1,\n \"offset\": 0,\n \"results\": [\n {\n \"id\": \"b70c211d-d8fe-45c5-be70-0e0c02c0d4ad\",\n \"created_at\": \"2025-09-30T18:05:26.659000-06:00\",\n \"updated_at\": \"2025-10-06T08:33:53.842950-06:00\",\n \"user_id\": \"8faa9093-4435-43d7-8f2e-df8950c2c707\",\n \"ignored\": false,\n \"read\": true,\n \"sent\": false,\n \"publication_date\": \"2025-10-01\",\n \"expiration_date\": \"2025-10-07\",\n \"priority_level\": 1,\n \"content\": {\n \"image\": \"/assets/xerpa/global/img/notifications/first_payment_month.svg\",\n \"title\": \"¡Hoy es un gran día para avanzar!\",\n \"action\": {\n \"event\": {\n \"projectID\": \"fbecd758-f058-4b7e-9698-17d18bc58858\",\n \"projectName\": \"alcanfores\"\n },\n \"route\": \"projectMakePayment\",\n \"origin\": \"projectDetail\"\n },\n \"subtitle\": \"Aporta a tu meta \\\"Alcanfores\\\" y supera tus objetivos este mes.\"\n },\n \"user_external_id\": \"frontend\",\n \"notification_type\": \"be82ee19-fb76-4b5f-aeff-df5a80a80037\",\n \"notification_campaign\": \"e84e054c-5e02-48e8-bad2-c8c3d9b5bd88\"\n },\n {\n \"id\": \"ebf7e933-8ff2-4cdd-ba4b-3a195427f995\",\n \"created_at\": \"2025-09-22T04:00:34.886189-06:00\",\n \"updated_at\": \"2025-09-22T04:00:34.886205-06:00\",\n \"user_id\": \"8faa9093-4435-43d7-8f2e-df8950c2c707\",\n \"ignored\": false,\n \"read\": false,\n \"sent\": false,\n \"publication_date\": \"2025-09-22\",\n \"expiration_date\": \"2025-09-25\",\n \"priority_level\": 5,\n \"content\": {\n \"image\": \"/assets/xerpa/global/img/notifications/weekly_savings_report.svg\",\n \"title\": \"Resumen semanal\",\n \"action\": {\n \"event\": {\n \"reportId\": \"16ee8caf-485e-4cc8-a8c4-9a84b554be37\",\n \"pageEvent\": \"\"\n },\n \"route\": \"reportDetail\",\n \"origin\": \"\"\n },\n \"subtitle\": \"Revisa el balance de tus ahorros de esta semana\"\n },\n \"user_external_id\": \"frontend\",\n \"notification_type\": \"d77af6e6-f577-46e4-bf62-ff57e98a328e\",\n \"notification_campaign\": \"a16cb36b-7d5a-44fd-9f0a-1b4c90bf3e08\"\n }\n ]\n}"}],"_postman_id":"4e4740ac-e242-45f8-887d-c2a7e0517d09"},{"name":"Detalles de una notificación","id":"d60de35f-7622-4b14-9296-d31226a832a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token_user}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{host_app}}/notification-service/v1/api/users/{{user_id}}/notifications/{{notification_id}}/","description":"Endpoint para consultar el detalle de una notificación.
\n","urlObject":{"path":["notification-service","v1","api","users","{{user_id}}","notifications","{{notification_id}}",""],"host":["{{host_app}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d60de35f-7622-4b14-9296-d31226a832a6"},{"name":"Marcar notificación como leída","id":"9285cdad-1187-4dc0-afd8-02892498a04f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token_user}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"read\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{host_app}}/notification-service/v1/api/users/{{user_id}}/notifications/{{notification_id}}/change-read/","description":"Actualizar la condición de leída de una notificación modificando la propiedad read.
\nSi se quiere marcar la notificación como leida el parámetro read debe ser true.
Si se quiere marcar la notificación como no leída el parámetro read debe ser false.
Actualizar la condición de ignorada de una notificación modificando la propiedad ignore.
\nSi se quiere marcar la notificación como ignorada el parámetro ignored debe ser true.
Si se quiere marcar la notificación como no ignorada el parámetro ignored debe ser false.
API Notification
\nNotificaciones agrupa todos los endpoints relacionados con la consulta, gestión y actualización de las notificaciones generadas por el sistema para los usuarios.
\nEstas notificaciones pueden ser tanto informativas como transaccionales, y están diseñadas para mantener al usuario al tanto de eventos relevantes dentro de la plataforma, como reportes mensuales, movimientos financieros importantes, alertas personalizadas, entre otros.
\n📌 Casos de uso comunes
\n- \n
Consultar todas las notificaciones disponibles para un usuario o para uso interno del sistema, con múltiples filtros como estado de lectura, envío, expiración, entre otros.
\n \nAcceder a los datos completos de una notificación específica.
\n \nMarcar una notificación como ignorada por el usuario.
\n \nRegistrar el momento en que el usuario visualizó una notificación.
\n \nListar un catálogo de los distintos tipos de notificaciones utilizados por el sistema, útil para clasificación y presentación personalizada.
\n \n
\n
🧠 Consideraciones:
\n- \n
Las notificaciones pueden ser consumidas desde interfaces internas (backoffice, API middleware) o directamente por el usuario final.
\n \nEl modelo de notificación incluye atributos como prioridad, contenido enriquecido, temporalidad (expiración) y visibilidad.
\n \nMuchos de los endpoints incluyen filtros útiles para segmentar las notificaciones según su estado (activas, leídas, ignoradas, etc.).
\n \n
\n
Al integrar estos endpoints, los desarrolladores podrán construir interfaces de usuario que muestren de manera efectiva las notificaciones relevantes, proporcionando una experiencia de usuario fluida y personalizada en relación con las comunicaciones del sistema.
\nObjeto notificación
\n{\n \"id\": \"b70c211d-d8fe-45c5-be70-0e0c02c0d4ad\",\n \"created_at\": \"2025-09-30T18:05:26.659000-06:00\",\n \"updated_at\": \"2025-10-06T08:33:53.842950-06:00\",\n \"user_id\": \"8faa9093-4435-43d7-8f2e-df8950c2c707\",\n \"ignored\": false,\n \"read\": true,\n \"sent\": false,\n \"publication_date\": \"2025-10-01\",\n \"expiration_date\": \"2025-10-07\",\n \"priority_level\": 1,\n \"content\": {\n \"image\": \"/assets/xerpa/global/img/notifications/first_payment_month.svg\",\n \"title\": \"¡Hoy es un gran día para avanzar!\",\n \"action\": {\n \"event\": {\n \"projectID\": \"fbecd758-f058-4b7e-9698-17d18bc58858\",\n \"projectName\": \"alcanfores\"\n },\n \"route\": \"projectMakePayment\",\n \"origin\": \"projectDetail\"\n },\n \"subtitle\": \"Aporta a tu meta \\\"Alcanfores\\\" y supera tus objetivos este mes.\"\n },\n \"user_external_id\": \"frontend\",\n \"notification_type\": \"be82ee19-fb76-4b5f-aeff-df5a80a80037\",\n \"notification_campaign\": \"e84e054c-5e02-48e8-bad2-c8c3d9b5bd88\"\n }\n\nDescripción de campos
\n- \n
\nid: identificador único de la notificación \n
\ncreated_at: fecha de creación del registro \n
\nupdated_at: fecha del último cambio del registro \n
\nuser_id: identificador interno del usuario al que le pertenece el registro \n
\nignored: booleano que indica si el usuario ignoró/borró la notificación \n
\nread: booleano para indicar si el usuario leyó la notificación \n
\nsent: booleano para indicar si la notificación se compartió con el banco \n
\npublication_date: fecha de cuándo la notificación quedó visible para el usuario \n
\nexpiration_date: fecha de cuándo la notificación debe dejar de estar visible para el usuario. \n
\npriority_level: Nivel de prioridad de la notificación. Mientras más alto más prioritario \n
\ncontent: Objeto con el contenido de la notificación.- \n
\nimage: url a la imágen de la notificación \n
\ntitle: mensaje principal de la notificación \n
\nsubititle: mensaje secundario de la notificación \n
\naction: objeto para describir que debe realizar el usuario con la notificación- \n
\nevent: características del evento \n
\nroute: ruta interna de la aplicación a la que se debe redirigir al usuario \n
\norigin: \n
\n
\n
\nexternal_user_id: identificador del usuario \n
\nnotification_type: identificador del tipo de notificación \n
\nnotification_campaign: identificador de la campaña a la que pertenece la notificación \n
Tipos de notificaciones:
\nCampañas
\nLas notificaciones tienes asociadas campañas que corresponden a agrupaciones de mensajes que buscan un objetivo comunicacional para el usuario. Una campaña puede tener varios mensajes asociados.
\n","_postman_id":"9cbce9da-ac96-448c-888a-5134517ba627"},{"name":"Insights","item":[{"name":"Reportes","item":[{"name":"Listar reportes de un usuario","id":"2688c7b9-d91a-4e8d-aa74-5270673cba80","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token_user}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{host_app}}/api-insight/v1/report-api/users/{{user_id}}/reports/?paginate=true&page_size=10&page=1","description":"Listado de los reportes disponibles para el usuario.
\nFiltros
\n- \n
\npaginate: (true/false) booleano para indicar si se quiere la respuesta con paginado. Default:false\n
\npage_size: número de registros por página \n
\npage: número de la página del que se espera una respuesta \n
\nis_read: (true/false) booleanom para específicar si se quieren los reportes leídos o no leídos. Default:false\n
\nreport_type: indicador para específicar que tipo de reportes se quieren listar de acuedo a catálogo de reportes. \n
Endpoint para consultar el detalle de un reporte basado en su id.
\n","urlObject":{"path":["api-insight","v1","report-api","users","{{user_id}}","reports","{{report_id}}"],"host":["{{host_app}}"],"query":[],"variable":[]}},"response":[{"id":"c2818a81-3931-4500-b120-122f6b354f46","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":"{{host_app}}/api-insight/v1/report-api/users/{{user_id}}/reports/{{report_id}}"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Tue, 16 Sep 2025 19:41:18 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"619"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"baa8ebb7-0382-4042-b028-5d0ee5b4b9bb"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"RAqG2EbeIAMEbsg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-68c9bd5e-37753cd5769aafc26859b1f4;Parent=05347092f6c13bb4;Sampled=0;Lineage=1:e7de7122:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"fc45af48-943b-4594-9339-069b57545b85\",\n \"user_id\": \"7a1cb76c-9af3-4557-bc6c-f56f9ee8ef8e\",\n \"metadata\": {\n \"no_show\": false,\n \"balance_short\": {\n \"type\": \"growth_no_withdrawals\",\n \"year\": 2025,\n \"month\": 2,\n \"month_name\": \"febrero\",\n \"monthly_grow\": 2588,\n \"monthly_saving\": 2588,\n \"monthly_balance\": 12060.2,\n \"monthly_withdrawal\": 0,\n \"monthly_projects_count\": 3\n },\n \"configuration\": [\n {\n \"page\": \"balance_short\",\n \"type\": \"growth_no_withdrawals\"\n }\n ]\n },\n \"year\": 2025,\n \"month\": 2,\n \"week\": 9,\n \"day\": 28,\n \"is_read\": true,\n \"created_at\": \"2025-03-18T11:57:50.454413-06:00\",\n \"updated_at\": \"2025-03-18T11:57:50.454423-06:00\",\n \"report_type\": \"956a5ecf-090e-43b8-be02-1027e783e2b1\"\n}"},{"id":"8c683c4c-b4e1-485d-95a0-f4b9e10b78d0","name":"Gastos semanal","originalRequest":{"method":"GET","header":[],"url":"{{host_app}}/api-insight/v1/report-api/users/{{user_id}}/reports/{{report_id}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"e63ad5e1-20e8-47c8-832c-63190e6f040f","name":"Gastos mensual","originalRequest":{"method":"GET","header":[],"url":"{{host_app}}/api-insight/v1/report-api/users/{{user_id}}/reports/{{report_id}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"7283fcda-1de5-420b-bcb1-84c416fb7347","name":"Ahorros semanal","originalRequest":{"method":"GET","header":[],"url":"{{host_app}}/api-insight/v1/report-api/users/{{user_id}}/reports/{{report_id}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"16ee8caf-485e-4cc8-a8c4-9a84b554be37\",\n \"user_id\": \"8faa9093-4435-43d7-8f2e-df8950c2c707\",\n \"metadata\": {\n \"no_show\": false,\n \"weekly_short\": {\n \"type\": \"growth_no_withdrawals\",\n \"weekly_grow\": 165938.16,\n \"weekly_saving\": 165938.16,\n \"weekly_balance\": 1964366.05,\n \"weekly_withdrawal\": 0,\n \"weekly_savings_count\": 110,\n \"weekly_projects_count\": 30\n },\n \"configuration\": [\n {\n \"page\": \"weekly_short\",\n \"type\": \"growth_no_withdrawals\"\n }\n ]\n },\n \"year\": 2025,\n \"month\": 9,\n \"week\": 38,\n \"day\": 21,\n \"is_read\": true,\n \"created_at\": \"2025-09-22T04:00:34.804305-06:00\",\n \"updated_at\": \"2025-09-22T04:00:34.804313-06:00\",\n \"report_type\": \"62f78e2e-7634-4b94-8b79-e87d7186754a\"\n}"},{"id":"bfcde349-ed95-4162-bc03-4c547858bea9","name":"Ahorros mensual","originalRequest":{"method":"GET","header":[],"url":"{{host_app}}/api-insight/v1/report-api/users/{{user_id}}/reports/{{report_id}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"total\": {\n \"type\": \"growth\",\n \"monthly_balance\": 1244232.13,\n \"monthly_projects\": [\n {\n \"progress\": 5707.12,\n \"project_id\": \"a6f69e6b-d8de-4516-b62b-4284a94d5bad\",\n \"category_id\": \"461a96b0-96d1-4259-a965-c599e1d7da1b\",\n \"project_name\": \"test del\",\n \"project_progress\": 570.71,\n \"category_metadata\": {\n \"icon\": \"/assets/xerpa/global/img/projects/deudas.png\",\n \"name\": \"Deudas\",\n \"color\": \"#7C2582\",\n \"group\": \"premium\",\n \"order\": 6,\n \"active\": true,\n \"short_name\": \"PROJECT_TYPE_DEBTS\",\n \"description\": \"\"\n }\n },\n {\n \"progress\": 14719.7,\n \"project_id\": \"3aea8624-9ba5-491b-892a-2695fa8ae5b0\",\n \"category_id\": \"461a96b0-96d1-4259-a965-c599e1d7da1b\",\n \"project_name\": \"1007 ✅\",\n \"project_progress\": 147.19,\n \"category_metadata\": {\n \"icon\": \"/assets/xerpa/global/img/projects/deudas.png\",\n \"name\": \"Deudas\",\n \"color\": \"#7C2582\",\n \"group\": \"premium\",\n \"order\": 6,\n \"active\": true,\n \"short_name\": \"PROJECT_TYPE_DEBTS\",\n \"description\": \"\"\n }\n }\n ],\n \"monthly_projects_count\": 30\n },\n \"balance\": {\n \"type\": \"growth_with_withdrawals\",\n \"monthly_grow\": 376758.93,\n \"monthly_saving\": 376764.93,\n \"monthly_balance\": 1244232.13,\n \"monthly_withdrawal\": 6.0,\n \"monthly_projects_count\": 30\n },\n \"monthly\": {\n \"type\": \"first_page\",\n \"year\": 2025,\n \"month\": 8,\n \"month_name\": \"agosto\"\n },\n \"no_show\": false,\n \"summary\": {\n \"type\": \"savings\",\n \"monthly_grow\": 376758.93999999994,\n \"monthly_rules\": [\n {\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/rules/monto_fijo.svg\",\n \"name\": \"Monto fijo\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"icon_pause\": \"/assets/xerpa/global/img/rules/monto_fijo_pausa.svg\",\n \"short_name\": \"RULE_TYPE_FIX_AMOUNT\",\n \"description\": \"Fija un monto para ahorrarlo recurrentemente cada día, semana o mes\",\n \"icon_primary\": \"/assets/xerpa/global/img/rules/monto_fijo_circle.svg\",\n \"frequency_description\": \"Ahorra {amount} cada {description}\"\n },\n \"rule_name\": \"rule_type_fixed_amount\",\n \"rule_amount\": 353813.72,\n \"rule_type_id\": \"7c8fbf63-545a-4f60-8c87-14f1f1d52f8c\"\n },\n {\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/rules/desafio_52.svg\",\n \"name\": \"Desafío 52 semanas\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"icon_pause\": \"/assets/xerpa/global/img/rules/desafio_52_pausa.svg\",\n \"short_name\": \"RULE_TYPE_52_WEEKS\",\n \"description\": \"Ahorra $1 la primera semana, $2 la segunda semana y así hasta la semana 52.\",\n \"icon_primary\": \"/assets/xerpa/global/img/rules/desafio_52_circle.svg\",\n \"frequency_description\": \"Ahorra $1 primera semana, $2 la segunda, $3 la tercera y así hasta la semana 52 en que ahorras $52 {description}\"\n },\n \"rule_name\": \"rule_type_52_weeks\",\n \"rule_amount\": 101.0,\n \"rule_type_id\": \"90832d0a-3879-40b5-a45b-729e4a964749\"\n },\n {\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/rules/pasion_futbolera.svg\",\n \"name\": \"Pasion futbolera\",\n \"color\": \"#7C2582\",\n \"active\": false,\n \"icon_pause\": \"/assets/xerpa/global/img/rules/pasion_futbolera_pausa.svg\",\n \"short_name\": \"RULE_TYPE_SOCCER\",\n \"description\": \"Ahorra cada vez que tu equipo juega, gana, empata o anota un gol\",\n \"icon_primary\": \"/assets/xerpa/global/img/rules/pasion_futbolera_circle.svg\",\n \"frequency_description\": \"Ahorra {amount} cuando {description}\"\n },\n \"rule_name\": \"rule_type_soccer\",\n \"rule_amount\": 60.0,\n \"rule_type_id\": \"a3125075-ff44-4b8b-be29-6c73fd846872\"\n },\n {\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/rules/placer_culpable.svg\",\n \"name\": \"Placer culpable\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"icon_pause\": \"/assets/xerpa/global/img/rules/placer_culpable_pausa.svg\",\n \"short_name\": \"RULE_TYPE_GUILTY_PLEASURE\",\n \"description\": \"Ahorra cuando te das un gustito en tus comercios favoritos.\",\n \"icon_primary\": \"/assets/xerpa/global/img/rules/placer_culpable_circle.svg\",\n \"frequency_description\": \"Ahorra {amount} en {description}\"\n },\n \"rule_name\": \"rule_type_guilty_pleasure\",\n \"rule_amount\": 0.0,\n \"rule_type_id\": \"229011e5-fb7a-447c-bada-bb48010175ce\"\n }\n ],\n \"monthly_balance\": 1244232.13,\n \"monthly_savings_count\": 255.0,\n \"monthly_projects_count\": 30\n },\n \"top_rules\": {\n \"type\": \"list_rules\",\n \"monthly_rules\": [\n {\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/rules/monto_fijo.svg\",\n \"name\": \"Monto fijo\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"icon_pause\": \"/assets/xerpa/global/img/rules/monto_fijo_pausa.svg\",\n \"short_name\": \"RULE_TYPE_FIX_AMOUNT\",\n \"description\": \"Fija un monto para ahorrarlo recurrentemente cada día, semana o mes\",\n \"icon_primary\": \"/assets/xerpa/global/img/rules/monto_fijo_circle.svg\",\n \"frequency_description\": \"Ahorra {amount} cada {description}\"\n },\n \"rule_name\": \"rule_type_fixed_amount\",\n \"rule_amount\": 353813.72,\n \"rule_type_id\": \"7c8fbf63-545a-4f60-8c87-14f1f1d52f8c\"\n },\n {\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/rules/desafio_52.svg\",\n \"name\": \"Desafío 52 semanas\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"icon_pause\": \"/assets/xerpa/global/img/rules/desafio_52_pausa.svg\",\n \"short_name\": \"RULE_TYPE_52_WEEKS\",\n \"description\": \"Ahorra $1 la primera semana, $2 la segunda semana y así hasta la semana 52.\",\n \"icon_primary\": \"/assets/xerpa/global/img/rules/desafio_52_circle.svg\",\n \"frequency_description\": \"Ahorra $1 primera semana, $2 la segunda, $3 la tercera y así hasta la semana 52 en que ahorras $52 {description}\"\n },\n \"rule_name\": \"rule_type_52_weeks\",\n \"rule_amount\": 101.0,\n \"rule_type_id\": \"90832d0a-3879-40b5-a45b-729e4a964749\"\n },\n {\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/rules/pasion_futbolera.svg\",\n \"name\": \"Pasion futbolera\",\n \"color\": \"#7C2582\",\n \"active\": false,\n \"icon_pause\": \"/assets/xerpa/global/img/rules/pasion_futbolera_pausa.svg\",\n \"short_name\": \"RULE_TYPE_SOCCER\",\n \"description\": \"Ahorra cada vez que tu equipo juega, gana, empata o anota un gol\",\n \"icon_primary\": \"/assets/xerpa/global/img/rules/pasion_futbolera_circle.svg\",\n \"frequency_description\": \"Ahorra {amount} cuando {description}\"\n },\n \"rule_name\": \"rule_type_soccer\",\n \"rule_amount\": 60.0,\n \"rule_type_id\": \"a3125075-ff44-4b8b-be29-6c73fd846872\"\n },\n {\n \"metadata\": {\n \"icon\": \"/assets/xerpa/global/img/rules/placer_culpable.svg\",\n \"name\": \"Placer culpable\",\n \"color\": \"#7C2582\",\n \"active\": true,\n \"icon_pause\": \"/assets/xerpa/global/img/rules/placer_culpable_pausa.svg\",\n \"short_name\": \"RULE_TYPE_GUILTY_PLEASURE\",\n \"description\": \"Ahorra cuando te das un gustito en tus comercios favoritos.\",\n \"icon_primary\": \"/assets/xerpa/global/img/rules/placer_culpable_circle.svg\",\n \"frequency_description\": \"Ahorra {amount} en {description}\"\n },\n \"rule_name\": \"rule_type_guilty_pleasure\",\n \"rule_amount\": 0.0,\n \"rule_type_id\": \"229011e5-fb7a-447c-bada-bb48010175ce\"\n },\n ]\n },\n \"end_report\": {\n \"type\": \"closing\",\n \"month\": 8,\n \"month_name\": \"agosto\"\n },\n \"main_project\": {\n \"type\": \"savings\",\n \"monthly_balance\": 1244232.13,\n \"monthly_projects\": [\n {\n \"progress\": 5707.12,\n \"project_id\": \"a6f69e6b-d8de-4516-b62b-4284a94d5bad\",\n \"category_id\": \"461a96b0-96d1-4259-a965-c599e1d7da1b\",\n \"project_name\": \"test del\",\n \"project_progress\": 570.71,\n \"category_metadata\": {\n \"icon\": \"/assets/xerpa/global/img/projects/deudas.png\",\n \"name\": \"Deudas\",\n \"color\": \"#7C2582\",\n \"group\": \"premium\",\n \"order\": 6,\n \"active\": true,\n \"short_name\": \"PROJECT_TYPE_DEBTS\",\n \"description\": \"\"\n }\n },\n {\n \"progress\": 14719.7,\n \"project_id\": \"3aea8624-9ba5-491b-892a-2695fa8ae5b0\",\n \"category_id\": \"461a96b0-96d1-4259-a965-c599e1d7da1b\",\n \"project_name\": \"1007 ✅\",\n \"project_progress\": 147.19,\n \"category_metadata\": {\n \"icon\": \"/assets/xerpa/global/img/projects/deudas.png\",\n \"name\": \"Deudas\",\n \"color\": \"#7C2582\",\n \"group\": \"premium\",\n \"order\": 6,\n \"active\": true,\n \"short_name\": \"PROJECT_TYPE_DEBTS\",\n \"description\": \"\"\n }\n },\n {\n \"progress\": 15765.48,\n \"project_id\": \"1734b667-1c0c-4004-b135-779927a155ba\",\n \"category_id\": \"5877afb7-c6d8-4023-8498-9280890f3155\",\n \"project_name\": \"1010\",\n \"project_progress\": 78.82,\n \"category_metadata\": {\n \"icon\": \"/assets/xerpa/global/img/projects/otros.png\",\n \"name\": \"Otro\",\n \"color\": \"#7C2582\",\n \"group\": \"vivienda\",\n \"order\": 8,\n \"active\": true,\n \"short_name\": \"PROJECT_TYPE_OTHER\",\n \"description\": \"\"\n }\n }\n ],\n \"monthly_projects_count\": 30\n },\n \"configuration\": [\n {\n \"page\": \"monthly\",\n \"type\": \"first_page\"\n },\n {\n \"page\": \"balance\",\n \"type\": \"growth_with_withdrawals\"\n },\n {\n \"page\": \"main_project\",\n \"type\": \"savings\"\n },\n {\n \"page\": \"total\",\n \"type\": \"growth\"\n },\n {\n \"page\": \"top_rules\",\n \"type\": \"list_rules\"\n },\n {\n \"page\": \"summary\",\n \"type\": \"savings\"\n },\n {\n \"page\": \"end_report\",\n \"type\": \"closing\"\n }\n ]\n}"}],"_postman_id":"1beded83-6156-4963-8b77-74564c0f8e9b"},{"name":"Tipos de reportes","id":"3d9ee475-adc4-4e41-88d8-c5520b2afec9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token_user}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{host_app}}/api-insight/v1/catalogs/?catalog=report","description":"Endpoint para consultar el catálogo de tipos de reportes disponibles.
\n","urlObject":{"path":["api-insight","v1","catalogs",""],"host":["{{host_app}}"],"query":[{"key":"catalog","value":"report"}],"variable":[]}},"response":[{"id":"9a49fcce-1445-4f85-b01c-b0c9edd52327","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host_app}}/api-insight/v1/catalogs/?catalog=report","host":["{{host_app}}"],"path":["api-insight","v1","catalogs",""],"query":[{"key":"catalog","value":"report"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Tue, 16 Sep 2025 19:56:42 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1193"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"c1c21a78-981a-4346-b1dc-bd5b73b383b5"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"RAsXKGKnoAMESxA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-68c9c0fa-259024fb331481ad07652606;Parent=596e40f5900661a4;Sampled=0;Lineage=1:e7de7122:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"report\": [\n {\n \"id\": \"956a5ecf-090e-43b8-be02-1027e783e2b1\",\n \"catalog\": \"428e7e05-2c5d-4198-8d21-cd0a7b89f528\",\n \"item_name\": \"monthly_report_short\",\n \"description\": \"Reporte mensual corto de ahorro por usuario\",\n \"metadata\": {}\n },\n {\n \"id\": \"8ef9ddf5-c952-4235-a35e-3971bf738c6f\",\n \"catalog\": \"428e7e05-2c5d-4198-8d21-cd0a7b89f528\",\n \"item_name\": \"monthly_report\",\n \"description\": \"Reporte mensual de ahorro por usuario\",\n \"metadata\": {}\n },\n {\n \"id\": \"62f78e2e-7634-4b94-8b79-e87d7186754a\",\n \"catalog\": \"428e7e05-2c5d-4198-8d21-cd0a7b89f528\",\n \"item_name\": \"weekly_report_short\",\n \"description\": \"Reporte semanal corto de ahorro por usuario\",\n \"metadata\": {}\n },\n {\n \"id\": \"563e93b3-1644-49f1-8d7d-743c64484e61\",\n \"catalog\": \"428e7e05-2c5d-4198-8d21-cd0a7b89f528\",\n \"item_name\": \"weekly_report\",\n \"description\": \"Reporte semanal de ahorro por usuario\",\n \"metadata\": {}\n },\n {\n \"id\": \"ccbdc72b-9401-4a9d-9b7b-3c17ec07c509\",\n \"catalog\": \"428e7e05-2c5d-4198-8d21-cd0a7b89f528\",\n \"item_name\": \"weekly_report_pfm\",\n \"description\": \"Reporte semanal de gastos por usuario\",\n \"metadata\": {}\n },\n {\n \"id\": \"36485e1f-bb46-407d-afd5-cb17fbc07f8f\",\n \"catalog\": \"428e7e05-2c5d-4198-8d21-cd0a7b89f528\",\n \"item_name\": \"monthly_report_pfm\",\n \"description\": \"Reporte mensual de gastos por usuario\",\n \"metadata\": {}\n }\n ]\n}"}],"_postman_id":"3d9ee475-adc4-4e41-88d8-c5520b2afec9"}],"id":"88041cf0-91b3-4dc0-b5af-c1aad80235fc","description":"Los reportes son resúmenes semanales, mensuales o anuales de la actividad del usuario con respecto a las funcionalidades de ahorro aumático o control de gastos.
\nLos reportes son generados periodicamente se entregan las principales métricas e insights del período analizado.
\nEstructura de un reporte
\n{\n \"id\": \"0af185c0-d437-421e-a268-459020daa459\",\n \"user_id\": \"8faa9093-4435-43d7-8f2e-df8950c2c707\",\n \"metadata\": {},\n \"year\": 2025,\n \"month\": 3,\n \"week\": 14,\n \"day\": 31,\n \"is_read\": true,\n \"created_at\": \"2025-04-01T04:00:50.136852-06:00\",\n \"updated_at\": \"2025-04-01T04:00:50.136862-06:00\",\n \"report_type\": \"8ef9ddf5-c952-4235-a35e-3971bf738c6f\"\n}\n\nDescripción de campos
\n- \n
\nid: identificador del reporte \n
\nuser_id: identificador del usuario \n
\nmetadata: métricas e información específica del reporte. Cada tipo reporte tendrá una estructura específica que dependerá de la información analizada \n
\nyear: año del reporte \n
\nmonth: mes del reporte \n
\nweek: semana del reporte \n
\nday: día del reporte \n
\nis_read: booleano para marcar si el reporte fue leído por el usuario \n
\nreport_type: identificador del tipo de reporte según catálogo \n
\ncreated_at: fecha de creación del reporte \n
\nupdated_at: fecha de la ultima actualización del registro \n
API para disponiblizar información de insights, reportes y otros recursos para que los usuarios tengan un mejor entendmiento de sus finanzas personales.
\nLos insights y reportes son generados automáticamente por Xerpa en base a la información de cada usuario recibida por el banco y la generada por él en la interacción con los productos de Xerpa.
\n","_postman_id":"d649e3e1-831c-4a59-8384-826e08059813"},{"name":"New Request","id":"a8c22729-9af1-4dc7-ab6a-e28ffedbbb38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"a8c22729-9af1-4dc7-ab6a-e28ffedbbb38"}],"event":[{"listen":"prerequest","script":{"id":"0a4d5941-84e6-419f-8f38-91f08c727f34","type":"text/javascript","requests":{},"exec":["const token_bff_user = pm.environment.get(\"token_bff_user\");","","pm.request.headers.add({"," key: \"X-User-Token\","," value: `${token_bff_user}`","});"]}},{"listen":"test","script":{"id":"a9afac82-6566-4aba-bfe1-73cf33f12d94","type":"text/javascript","requests":{},"exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://farming-simulator.pstmn.io"}]}