{"openapi":"3.1.0","info":{"title":"Smart Cash \u00b7 API p\u00fablica","version":"1.0.0","description":"Consulta y registra movimientos, traslados, deudas y pr\u00e9stamos de tus espacios, y arma sus cuentas y categor\u00edas.\n\nSe entra con una clave de API que se crea en Ajustes. La clave se ve una sola vez: si se pierde, se revoca y se crea otra.\n\nTodas las respuestas van en el mismo sobre: `satisfactory` dice si sali\u00f3 bien, `data` trae el contenido y `title` y `message` son texto para ense\u00f1ar a una persona."},"servers":[{"url":"https:\/\/api.smart-cash.app\/api\/v1"}],"components":{"securitySchemes":{"claveDeApi":{"type":"http","scheme":"bearer","description":"Manda `Authorization: Bearer sk_...`. Si tu entorno se come esa cabecera, vale igual `X-Api-Key: sk_...`."}}},"security":[{"claveDeApi":[]}],"paths":{"\/accounts":{"get":{"summary":"Las cuentas","description":"Las cuentas de dinero del espacio, con su saldo.","x-scope":"accounts:read","responses":{"200":{"description":"Sali\u00f3 bien"}}},"post":{"summary":"Crear una cuenta o una tarjeta","description":"Campos: `entity_id`, `name`, `type` (`CASH`, `BANK_ACCOUNT`, `DIGITAL_WALLET`, `INVESTMENT_ACCOUNT`, `PETTY_CASH`, `SAFE`, `SAVINGS_ACCOUNT` o `CREDIT_CARD`), `current_balance`, `currency`, y en tarjetas `credit_limit`, `statement_day` y `due_day`.","x-scope":"accounts:write","responses":{"200":{"description":"Sali\u00f3 bien"}}}},"\/accounts\/{account}":{"patch":{"summary":"Editar una cuenta","description":"Nombre, tipo, moneda, cupo y d\u00edas de corte y pago. `opening_balance` fija el saldo con el que arranca, solo si la cuenta no tiene movimientos: si los tiene, 409 `ACCOUNT_HAS_TRANSACTIONS`.","x-scope":"accounts:write","responses":{"200":{"description":"Sali\u00f3 bien"}}}},"\/accounts\/{account}\/installment-plans":{"get":{"summary":"Diferidos de una tarjeta","description":"Cada plan con sus cuotas, lo cobrado y lo que falta.","x-scope":"cards:read","responses":{"200":{"description":"Sali\u00f3 bien"}}},"post":{"summary":"Crear un diferido","description":"Campos: `description`, `total_amount`, `months` (2 o m\u00e1s), `first_due_date`, `transactions_category_id` y `purchased_on` opcionales. Reparte las cuotas y NO mueve dinero.","x-scope":"cards:write","responses":{"200":{"description":"Sali\u00f3 bien"}}}},"\/accounts\/{account}\/pay-card":{"post":{"summary":"Pagar una tarjeta","description":"La direcci\u00f3n lleva la tarjeta. Campos: `account_id` (de d\u00f3nde sale), `amount`, `date` y `description`. Baja la deuda y no cuenta como gasto.","x-scope":"transactions:write","responses":{"200":{"description":"Sali\u00f3 bien"}}}},"\/accounts\/{account}\/statements":{"get":{"summary":"Estados de cuenta","description":"Los subidos a esa tarjeta, con su estado de lectura y cu\u00e1ntos renglones quedan por confirmar.","x-scope":"cards:read","responses":{"200":{"description":"Sali\u00f3 bien"}}},"post":{"summary":"Subir un estado de cuenta","description":"Multipart con `file` (PDF o foto, hasta 12 MB). Lo lee EVA y CUESTA TOKENS del due\u00f1o de la clave. Responde enseguida con estado `READING`.","x-scope":"cards:write","responses":{"200":{"description":"Sali\u00f3 bien"}}}},"\/card-installments\/{cardInstallment}\/charge":{"post":{"summary":"Cobrar una cuota","description":"Anota el gasto en la tarjeta con el monto real del banco y sube su deuda.","x-scope":"cards:write","responses":{"200":{"description":"Sali\u00f3 bien"}}}},"\/card-statement-lines\/{cardStatementLine}\/confirm":{"post":{"summary":"Confirmar un rengl\u00f3n","description":"Lo anota como gasto de la tarjeta. El rengl\u00f3n del pago no se confirma: eso se registra con \u00abpagar tarjeta\u00bb.","x-scope":"cards:write","responses":{"200":{"description":"Sali\u00f3 bien"}}}},"\/card-statement-lines\/{cardStatementLine}\/discard":{"post":{"summary":"Descartar un rengl\u00f3n","description":"Ni se anota ni vuelve a aparecer.","x-scope":"cards:write","responses":{"200":{"description":"Sali\u00f3 bien"}}}},"\/card-statements\/{cardStatement}":{"get":{"summary":"Un estado de cuenta","description":"Con su per\u00edodo, total, pago m\u00ednimo y los renglones le\u00eddos.","x-scope":"cards:read","responses":{"200":{"description":"Sali\u00f3 bien"}}},"delete":{"summary":"Borrar un estado de cuenta","description":"Borra el archivo y sus renglones; lo ya anotado se queda.","x-scope":"cards:write","responses":{"200":{"description":"Sali\u00f3 bien"}}}},"\/categories":{"get":{"summary":"Las categor\u00edas","description":"Las categor\u00edas de ingreso y de gasto del espacio.","x-scope":"categories:read","responses":{"200":{"description":"Sali\u00f3 bien"}}},"post":{"summary":"Crear una categor\u00eda","description":"Campos: `entity_id`, `name` (hasta 40), `type` (`INCOME`, `EXPENSE` o `FIXED_EXPENSE`) y `color_hexadecimal` opcional. Un nombre repetido en el espacio se rechaza.","x-scope":"categories:write","responses":{"200":{"description":"Sali\u00f3 bien"}}}},"\/credits":{"get":{"summary":"Deudas y pr\u00e9stamos","description":"Lo que debes y lo que te deben, con lo que queda por pagar.","x-scope":"credits:read","responses":{"200":{"description":"Sali\u00f3 bien"}}},"post":{"summary":"Crear una deuda o un pr\u00e9stamo","description":"Genera el calendario de cuotas. Con cuenta, mueve el dinero.","x-scope":"credits:write","responses":{"200":{"description":"Sali\u00f3 bien"}}}},"\/credits\/installments\/{installment}\/pay":{"post":{"summary":"Pagar o cobrar una cuota","description":"Mueve el dinero y deja el movimiento anotado.","x-scope":"credits:write","responses":{"200":{"description":"Sali\u00f3 bien"}}}},"\/credits\/{credit}":{"get":{"summary":"Una deuda","description":"Con su calendario de cuotas y cu\u00e1les est\u00e1n pagadas.","x-scope":"credits:read","responses":{"200":{"description":"Sali\u00f3 bien"}}}},"\/entities":{"get":{"summary":"Tus espacios","description":"Los espacios a los que llega esta clave, con su saldo y lo del mes.","x-scope":"entities:read","responses":{"200":{"description":"Sali\u00f3 bien"}}}},"\/fixed-expenses":{"get":{"summary":"Gastos e ingresos fijos","description":"Lo que se repite cada mes. `type=INCOME` trae los ingresos fijos y `ALL` los dos; sin `type`, solo gastos. Cada uno dice si ya se pag\u00f3 o cobr\u00f3 este mes.","x-scope":"fixed:read","responses":{"200":{"description":"Sali\u00f3 bien"}}},"post":{"summary":"Crear un fijo","description":"Campos: `entity_id`, `description`, `amount`, `transactions_category_id`, `type` (`EXPENSE` o `INCOME`), `start_date` y `end_date` opcionales. La categor\u00eda tiene que ir en la misma direcci\u00f3n que el fijo.","x-scope":"fixed:write","responses":{"200":{"description":"Sali\u00f3 bien"}}}},"\/fixed-expenses\/{fixedExpense}":{"put":{"summary":"Editar un fijo","description":"Descripci\u00f3n, monto, fecha final y categor\u00eda (de la misma direcci\u00f3n). La direcci\u00f3n no se cambia.","x-scope":"fixed:write","responses":{"200":{"description":"Sali\u00f3 bien"}}},"delete":{"summary":"Dar de baja un fijo","description":"Deja de verse y de contar desde hoy; lo pasado se conserva.","x-scope":"fixed:write","responses":{"200":{"description":"Sali\u00f3 bien"}}}},"\/fixed-expenses\/{fixedExpense}\/pay":{"post":{"summary":"Pagar o cobrar un fijo","description":"Campos: `account_id`, `amount` (el real), `date` y `description`. En un gasto fijo sale dinero; en un ingreso fijo, entra.","x-scope":"fixed:write","responses":{"200":{"description":"Sali\u00f3 bien"}}}},"\/fixed-expenses\/{fixedExpense}\/payments":{"get":{"summary":"Historial de un fijo","description":"Los movimientos de los \u00faltimos doce meses, con su cuenta, el promedio real y cu\u00e1ntos meses lleva.","x-scope":"fixed:read","responses":{"200":{"description":"Sali\u00f3 bien"}}}},"\/installment-plans\/{cardInstallmentPlan}":{"delete":{"summary":"Cancelar un diferido","description":"Solo si ninguna cuota se cobr\u00f3.","x-scope":"cards:write","responses":{"200":{"description":"Sali\u00f3 bien"}}}},"\/me":{"get":{"summary":"Tu clave","description":"Confirma que la clave lleg\u00f3 bien y dice qu\u00e9 permisos tiene.","responses":{"200":{"description":"Sali\u00f3 bien"}}}},"\/planned-payments":{"get":{"summary":"Por pagar","description":"Los pagos planificados. `status` filtra `PENDING` (por omisi\u00f3n), `PAID` o `CANCELED`.","x-scope":"planned:read","responses":{"200":{"description":"Sali\u00f3 bien"}}},"post":{"summary":"Planificar un pago","description":"Campos: `entity_id`, `description`, `amount`, `due_date` y `transactions_category_id` opcional. No mueve dinero.","x-scope":"planned:write","responses":{"200":{"description":"Sali\u00f3 bien"}}}},"\/planned-payments\/{plannedPayment}":{"put":{"summary":"Editar un por pagar","description":"Solo mientras est\u00e1 pendiente.","x-scope":"planned:write","responses":{"200":{"description":"Sali\u00f3 bien"}}},"delete":{"summary":"Cancelar un por pagar","description":"Queda en `CANCELED` y no mueve dinero.","x-scope":"planned:write","responses":{"200":{"description":"Sali\u00f3 bien"}}}},"\/planned-payments\/{plannedPayment}\/pay":{"post":{"summary":"Pagar lo planificado","description":"Campos: `account_id`, `amount` (el real), `date` y la categor\u00eda si el pendiente no ten\u00eda. Anota el gasto y lo marca pagado.","x-scope":"planned:write","responses":{"200":{"description":"Sali\u00f3 bien"}}}},"\/transactions":{"get":{"summary":"Los movimientos","description":"Paginado. Filtra por `from`, `to`, `type`, `account_id` y `search`.","x-scope":"transactions:read","responses":{"200":{"description":"Sali\u00f3 bien"}}},"post":{"summary":"Anotar un movimiento","description":"Descuenta o suma en la cuenta. Un gasto mayor al saldo se rechaza.","x-scope":"transactions:write","responses":{"200":{"description":"Sali\u00f3 bien"}}}},"\/transactions\/{transaction}":{"delete":{"summary":"Anular un movimiento","description":"Devuelve el dinero a la cuenta. No lo borra del hist\u00f3rico.","x-scope":"transactions:write","responses":{"200":{"description":"Sali\u00f3 bien"}}}},"\/transfers":{"post":{"summary":"Pasar dinero entre cuentas","description":"Campos: `from_account_id`, `to_account_id`, `amount`, `date` y `description`. Mismo espacio. Desde una tarjeta es un avance y sube su deuda. Hacia una tarjeta, 422 `USE_PAY_CARD`. No cuenta como gasto ni como ingreso.","x-scope":"transactions:write","responses":{"200":{"description":"Sali\u00f3 bien"}}}}},"x-scopes":{"entities:read":"Ver los espacios","accounts:read":"Ver las cuentas y sus saldos","accounts:write":"Crear cuentas y tarjetas y fijar su saldo inicial","categories:read":"Ver las categor\u00edas","categories:write":"Crear categor\u00edas","transactions:read":"Ver los movimientos","transactions:write":"Anotar y anular movimientos, traslados y pagos de tarjeta","credits:read":"Ver las deudas y los pr\u00e9stamos","credits:write":"Crear deudas y registrar pagos de cuotas","fixed:read":"Ver los gastos e ingresos fijos","fixed:write":"Crear fijos y registrar sus pagos o cobros","planned:read":"Ver los pagos planificados (por pagar)","planned:write":"Planificar pagos y registrarlos como pagados","cards:read":"Ver diferidos y estados de cuenta de las tarjetas","cards:write":"Crear diferidos, cobrar cuotas y subir estados de cuenta"}}