Necesita un presupuesto (publicador independiente)
Necesita un presupuesto (YNAB) le permite crear una aplicación personal para interactuar con su propio presupuesto o crear una aplicación que cualquier otro YNABer pueda autorizar y usar.
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Aplicaciones lógicas | Estándar | Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD) |
| Power Apps | Premium | Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Power Automate | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Contacto | |
|---|---|
| Nombre | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| Correo Electrónico | ttaylor@hitachisolutions.com |
| Metadatos del conector | |
|---|---|
| Publicador | Troy Taylor |
| Sitio web | https://www.youneedabudget.com/ |
| Directiva de privacidad | https://www.youneedabudget.com/privacy-policy/ |
| Categorías | Finanzas |
Creación de una conexión
El conector admite los siguientes tipos de autenticación:
| Predeterminado | Parámetros para crear una conexión. | Todas las regiones | No se puede compartir |
Predeterminado
Aplicable: Todas las regiones
Parámetros para crear una conexión.
Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.
| Nombre | Tipo | Description | Obligatorio |
|---|---|---|---|
| Token de acceso (en el formato "Bearer AccessToken) | securestring | Token de acceso (con el formato "Bearer AccessToken) para esta API | Cierto |
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Actualizar transacciones |
Actualiza varias transacciones, por |
| Actualizar transacción |
Actualiza una sola transacción. |
| Categoría Actualizar mes |
Actualizar una categoría para un mes específico. Solo |
| Creación masiva de transacciones |
Crea varias transacciones. Aunque este punto de conexión sigue siendo compatible, se recomienda usar "POST /budgets/{budget_id}/transactions" para crear varias transacciones. |
| Crear cuenta |
Crea una nueva cuenta. |
| Crear transacción |
Crea una sola transacción o varias transacciones. Si proporciona un cuerpo que contiene un |
| Importación de transacciones |
Importa las transacciones disponibles en todas las cuentas vinculadas del presupuesto especificado. Las cuentas vinculadas permiten importar transacciones directamente desde una entidad financiera especificada y este punto de conexión inicia esa importación. Enviar una solicitud a este punto de conexión es equivalente a hacer clic en "Importar" en cada cuenta de la aplicación web o pulsar el banner "Nuevas transacciones" en las aplicaciones móviles. La respuesta de este punto de conexión contiene los identificadores de transacción que se han importado. |
| Obtención de la configuración del presupuesto por identificador |
Devuelve la configuración de un presupuesto. |
| Obtención de la cuenta por identificador |
Devuelve una sola cuenta. |
| Obtención de la transacción programada por identificador |
Devuelve una única transacción programada. |
| Obtención de la ubicación del destinatario por identificador |
Devuelve una única ubicación de receptor. |
| Obtención de transacciones |
Devuelve transacciones presupuestarias. |
| Obtención de transacciones por cuenta |
Devuelve todas las transacciones de una cuenta especificada. |
| Obtención de transacciones por identificador |
Devuelve una sola transacción. |
| Obtención de transacciones por parte del beneficiario |
Devuelve todas las transacciones de un receptor especificado. |
| Obtención de transacciones programadas |
Devuelve todas las transacciones programadas. |
| Obtención de ubicaciones de destinatarios |
Devuelve todas las ubicaciones de los receptores. |
| Obtención de ubicaciones de destinatarios por parte del beneficiario |
Devuelve todas las ubicaciones de los beneficiarios de un receptor especificado. |
| Obtención del presupuesto por identificador |
Devuelve un único presupuesto con todas las entidades relacionadas. Este recurso es efectivamente una exportación de presupuesto completa. |
| Obtención del receptor por identificador |
Devuelve un solo beneficiario. |
| Obtener categoría de mes por identificador |
Devuelve una sola categoría para un mes presupuestado específico. Los importes (presupuestados, actividad, saldo, etc.) son específicos del mes presupuestado actual (UTC). |
| Obtener categoría por identificador |
Devuelve una sola categoría. Los importes (presupuestados, actividad, saldo, etc.) son específicos del mes presupuestado actual (UTC). |
| Obtener categorías |
Devuelve todas las categorías agrupadas por grupo de categorías. Los importes (presupuestados, actividad, saldo, etc.) son específicos del mes presupuestado actual (UTC). |
| Obtener cuentas |
Devuelve todas las cuentas. |
| Obtener mes presupuestado |
Devuelve un solo mes presupuestado. |
| Obtener meses de presupuesto |
Devuelve todos los meses presupuestado. |
| Obtener payees |
Devuelve todos los payees. |
| Obtener presupuestos |
Devuelve la lista de presupuestos con información de resumen. |
| Obtener transacciones por categoría |
Devuelve todas las transacciones de una categoría especificada. |
| Obtener usuario |
Devuelve información de usuario autenticada. |
Actualizar transacciones
Actualiza varias transacciones, por id o import_id.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de presupuesto
|
budget_id | True | string |
Identificador del presupuesto. Se puede usar "last-used" para especificar el último presupuesto usado y "default" se puede usar si la selección de presupuesto predeterminada está habilitada (consulte: https://api.youneedabudget.com/#oauth-default-budget). |
|
identificación
|
id | True | string |
Identificador. |
|
Id. de cuenta
|
account_id | True | string |
Identificador de cuenta. |
|
Fecha
|
date | True | date |
Fecha de transacción en formato ISO (por ejemplo, 2016-12-01). No se permiten fechas futuras (transacciones programadas). No se pueden cambiar las fechas de transacción divididas y si se proporciona una fecha diferente, se omitirá. |
|
Importe
|
amount | True | integer |
El importe de la transacción en formato milliunits. No se pueden cambiar los importes de transacción divididos y si se proporciona una cantidad diferente, se omitirá. |
|
Id. de destinatario
|
payee_id | uuid |
El beneficiario de la transacción. Para crear una transferencia entre dos cuentas, use el receptor de transferencia de cuenta que apunte a la cuenta de destino. Los payees de transferencia de cuentas se especifican como |
|
|
Beneficiario
|
payee_name | string |
Nombre del beneficiario. Si se proporciona un |
|
|
Id. de categoría
|
category_id | uuid |
Categoría de la transacción. Para configurar una transacción dividida, puede especificar null para |
|
|
Memorándum
|
memo | string |
El memo. |
|
|
Desactivado
|
cleared | string |
Estado borrado de la transacción. |
|
|
Aprobado
|
approved | boolean |
Indica si se aprueba o no la transacción. Si no se proporciona, la transacción no se aprobará de forma predeterminada. |
|
|
Color de marca
|
flag_color | string |
Marca de transacción. |
|
|
Id. de importación
|
import_id | string |
Si se especifica, se le asignará |
|
|
Importe
|
amount | True | integer |
Cantidad de subtransacción en formato miliunits. |
|
Id. de destinatario
|
payee_id | uuid |
El beneficiario de la subtransacción. |
|
|
Beneficiario
|
payee_name | string |
Nombre del beneficiario. Si se proporciona un |
|
|
Id. de categoría
|
category_id | uuid |
Categoría de la subtransacción. No se permiten las categorías de pago con tarjeta de crédito y se omitirán si se proporciona. |
|
|
Memorándum
|
memo | string |
El memo. |
Devoluciones
- Guardar respuesta de transacciones
- SaveTransactionsResponse
Actualizar transacción
Actualiza una sola transacción.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de presupuesto
|
budget_id | True | string |
Identificador del presupuesto. Se puede usar "last-used" para especificar el último presupuesto usado y "default" se puede usar si la selección de presupuesto predeterminada está habilitada (consulte: https://api.youneedabudget.com/#oauth-default-budget). |
|
Id. de transacción
|
transaction_id | True | string |
Identificador de la transacción. |
|
Id. de cuenta
|
account_id | True | string |
Identificador de cuenta. |
|
Fecha
|
date | True | date |
Fecha de transacción en formato ISO (por ejemplo, 2016-12-01). No se permiten fechas futuras (transacciones programadas). No se pueden cambiar las fechas de transacción divididas y si se proporciona una fecha diferente, se omitirá. |
|
Importe
|
amount | True | integer |
El importe de la transacción en formato milliunits. No se pueden cambiar los importes de transacción divididos y si se proporciona una cantidad diferente, se omitirá. |
|
Id. de destinatario
|
payee_id | uuid |
El beneficiario de la transacción. Para crear una transferencia entre dos cuentas, use el receptor de transferencia de cuenta que apunte a la cuenta de destino. Los payees de transferencia de cuentas se especifican como |
|
|
Beneficiario
|
payee_name | string |
Nombre del beneficiario. Si se proporciona un |
|
|
Id. de categoría
|
category_id | uuid |
Categoría de la transacción. Para configurar una transacción dividida, puede especificar null para |
|
|
Memorándum
|
memo | string |
El memo. |
|
|
Desactivado
|
cleared | string |
Estado borrado de la transacción. |
|
|
Aprobado
|
approved | boolean |
Indica si se aprueba o no la transacción. Si no se proporciona, la transacción no se aprobará de forma predeterminada. |
|
|
Color de marca
|
flag_color | string |
Marca de transacción. |
|
|
Id. de importación
|
import_id | string |
Si se especifica, se le asignará |
|
|
Importe
|
amount | True | integer |
Cantidad de subtransacción en formato miliunits. |
|
Id. de destinatario
|
payee_id | uuid |
El beneficiario de la subtransacción. |
|
|
Beneficiario
|
payee_name | string |
Nombre del beneficiario. Si se proporciona un |
|
|
Id. de categoría
|
category_id | uuid |
Categoría de la subtransacción. No se permiten las categorías de pago con tarjeta de crédito y se omitirán si se proporciona. |
|
|
Memorándum
|
memo | string |
El memo. |
Devoluciones
- Respuesta de transacción
- TransactionResponse
Categoría Actualizar mes
Actualizar una categoría para un mes específico. Solo budgeted se puede actualizar la cantidad.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de presupuesto
|
budget_id | True | string |
Identificador del presupuesto. Se puede usar "last-used" para especificar el último presupuesto usado y "default" se puede usar si la selección de presupuesto predeterminada está habilitada (consulte: https://api.youneedabudget.com/#oauth-default-budget). |
|
Mes
|
month | True | date |
Mes presupuestado en formato ISO (por ejemplo, 2016-12-01). ("current" también se puede usar para especificar el mes natural actual (UTC)) |
|
Id. de categoría
|
category_id | True | string |
Identificador de la categoría. |
|
Presupuestado
|
budgeted | True | integer |
Importe presupuestado en formato milliunits. |
Devoluciones
- Guardar respuesta de categoría
- SaveCategoryResponse
Creación masiva de transacciones
Crea varias transacciones. Aunque este punto de conexión sigue siendo compatible, se recomienda usar "POST /budgets/{budget_id}/transactions" para crear varias transacciones.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de presupuesto
|
budget_id | True | string |
Identificador del presupuesto. Se puede usar "last-used" para especificar el último presupuesto usado y "default" se puede usar si la selección de presupuesto predeterminada está habilitada (consulte: https://api.youneedabudget.com/#oauth-default-budget). |
|
Id. de cuenta
|
account_id | True | string |
Identificador de cuenta. |
|
Fecha
|
date | True | date |
Fecha de transacción en formato ISO (por ejemplo, 2016-12-01). No se permiten fechas futuras (transacciones programadas). No se pueden cambiar las fechas de transacción divididas y si se proporciona una fecha diferente, se omitirá. |
|
Importe
|
amount | True | integer |
El importe de la transacción en formato milliunits. No se pueden cambiar los importes de transacción divididos y si se proporciona una cantidad diferente, se omitirá. |
|
Id. de destinatario
|
payee_id | uuid |
El beneficiario de la transacción. Para crear una transferencia entre dos cuentas, use el receptor de transferencia de cuenta que apunte a la cuenta de destino. Los payees de transferencia de cuentas se especifican como |
|
|
Beneficiario
|
payee_name | string |
Nombre del beneficiario. Si se proporciona un |
|
|
Id. de categoría
|
category_id | uuid |
Categoría de la transacción. Para configurar una transacción dividida, puede especificar null para |
|
|
Memorándum
|
memo | string |
El memo. |
|
|
Desactivado
|
cleared | string |
Estado borrado de la transacción. |
|
|
Aprobado
|
approved | boolean |
Indica si se aprueba o no la transacción. Si no se proporciona, la transacción no se aprobará de forma predeterminada. |
|
|
Color de marca
|
flag_color | string |
Marca de transacción. |
|
|
Id. de importación
|
import_id | string |
Si se especifica, se le asignará |
|
|
Importe
|
amount | True | integer |
Cantidad de subtransacción en formato miliunits. |
|
Id. de destinatario
|
payee_id | uuid |
El beneficiario de la subtransacción. |
|
|
Beneficiario
|
payee_name | string |
Nombre del beneficiario. Si se proporciona un |
|
|
Id. de categoría
|
category_id | uuid |
Categoría de la subtransacción. No se permiten las categorías de pago con tarjeta de crédito y se omitirán si se proporciona. |
|
|
Memorándum
|
memo | string |
El memo. |
Devoluciones
- Respuesta masiva
- BulkResponse
Crear cuenta
Crea una nueva cuenta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de presupuesto
|
budget_id | True | string |
El identificador del presupuesto ("último uso" se puede usar para especificar el último presupuesto usado y "valor predeterminado" se puede usar si la selección de presupuesto predeterminada está habilitada (consulte: https://api.youneedabudget.com/#oauth-default-budget) |
|
Nombre
|
name | True | string |
Nombre de la cuenta. |
|
Type2
|
type | True | string |
El tipo de cuenta |
|
Saldo
|
balance | True | integer |
Saldo actual de la cuenta en formato milliunits. |
Devoluciones
- Respuesta de la cuenta
- AccountResponse
Crear transacción
Crea una sola transacción o varias transacciones. Si proporciona un cuerpo que contiene un transaction objeto, se creará una sola transacción y, si proporciona un cuerpo que contiene una transactions matriz, se crearán varias transacciones. No se pueden crear transacciones programadas en este punto de conexión.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de presupuesto
|
budget_id | True | string |
Identificador del presupuesto. Se puede usar "last-used" para especificar el último presupuesto usado y "default" se puede usar si la selección de presupuesto predeterminada está habilitada (consulte: https://api.youneedabudget.com/#oauth-default-budget). |
|
Id. de cuenta
|
account_id | True | string |
Identificador de cuenta. |
|
Fecha
|
date | True | date |
Fecha de transacción en formato ISO (por ejemplo, 2016-12-01). No se permiten fechas futuras (transacciones programadas). No se pueden cambiar las fechas de transacción divididas y si se proporciona una fecha diferente, se omitirá. |
|
Importe
|
amount | True | integer |
El importe de la transacción en formato milliunits. No se pueden cambiar los importes de transacción divididos y si se proporciona una cantidad diferente, se omitirá. |
|
Id. de destinatario
|
payee_id | uuid |
El beneficiario de la transacción. Para crear una transferencia entre dos cuentas, use el receptor de transferencia de cuenta que apunte a la cuenta de destino. Los payees de transferencia de cuentas se especifican como |
|
|
Beneficiario
|
payee_name | string |
Nombre del beneficiario. Si se proporciona un |
|
|
Id. de categoría
|
category_id | uuid |
Categoría de la transacción. Para configurar una transacción dividida, puede especificar null para |
|
|
Memorándum
|
memo | string |
El memo. |
|
|
Desactivado
|
cleared | string |
Estado borrado de la transacción. |
|
|
Aprobado
|
approved | boolean |
Indica si se aprueba o no la transacción. Si no se proporciona, la transacción no se aprobará de forma predeterminada. |
|
|
Color de marca
|
flag_color | string |
Marca de transacción. |
|
|
Id. de importación
|
import_id | string |
Si se especifica, se le asignará |
|
|
Importe
|
amount | True | integer |
Cantidad de subtransacción en formato miliunits. |
|
Id. de destinatario
|
payee_id | uuid |
El beneficiario de la subtransacción. |
|
|
Beneficiario
|
payee_name | string |
Nombre del beneficiario. Si se proporciona un |
|
|
Id. de categoría
|
category_id | uuid |
Categoría de la subtransacción. No se permiten las categorías de pago con tarjeta de crédito y se omitirán si se proporciona. |
|
|
Memorándum
|
memo | string |
El memo. |
|
|
Id. de cuenta
|
account_id | True | string |
Identificador de cuenta. |
|
Fecha
|
date | True | date |
Fecha de transacción en formato ISO (por ejemplo, 2016-12-01). No se permiten fechas futuras (transacciones programadas). No se pueden cambiar las fechas de transacción divididas y si se proporciona una fecha diferente, se omitirá. |
|
Importe
|
amount | True | integer |
El importe de la transacción en formato milliunits. No se pueden cambiar los importes de transacción divididos y si se proporciona una cantidad diferente, se omitirá. |
|
Id. de destinatario
|
payee_id | uuid |
El beneficiario de la transacción. Para crear una transferencia entre dos cuentas, use el receptor de transferencia de cuenta que apunte a la cuenta de destino. Los payees de transferencia de cuentas se especifican como |
|
|
Beneficiario
|
payee_name | string |
Nombre del beneficiario. Si se proporciona un |
|
|
Id. de categoría
|
category_id | uuid |
Categoría de la transacción. Para configurar una transacción dividida, puede especificar null para |
|
|
Memorándum
|
memo | string |
El memo. |
|
|
Desactivado
|
cleared | string |
Estado borrado de la transacción. |
|
|
Aprobado
|
approved | boolean |
Indica si se aprueba o no la transacción. Si no se proporciona, la transacción no se aprobará de forma predeterminada. |
|
|
Color de marca
|
flag_color | string |
Marca de transacción. |
|
|
Id. de importación
|
import_id | string |
Si se especifica, se le asignará |
|
|
Importe
|
amount | True | integer |
Cantidad de subtransacción en formato miliunits. |
|
Id. de destinatario
|
payee_id | uuid |
El beneficiario de la subtransacción. |
|
|
Beneficiario
|
payee_name | string |
Nombre del beneficiario. Si se proporciona un |
|
|
Id. de categoría
|
category_id | uuid |
Categoría de la subtransacción. No se permiten las categorías de pago con tarjeta de crédito y se omitirán si se proporciona. |
|
|
Memorándum
|
memo | string |
El memo. |
Devoluciones
- Guardar respuesta de transacciones
- SaveTransactionsResponse
Importación de transacciones
Importa las transacciones disponibles en todas las cuentas vinculadas del presupuesto especificado. Las cuentas vinculadas permiten importar transacciones directamente desde una entidad financiera especificada y este punto de conexión inicia esa importación. Enviar una solicitud a este punto de conexión es equivalente a hacer clic en "Importar" en cada cuenta de la aplicación web o pulsar el banner "Nuevas transacciones" en las aplicaciones móviles. La respuesta de este punto de conexión contiene los identificadores de transacción que se han importado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de presupuesto
|
budget_id | True | string |
Identificador del presupuesto. Se puede usar "last-used" para especificar el último presupuesto usado y "default" se puede usar si la selección de presupuesto predeterminada está habilitada (consulte: https://api.youneedabudget.com/#oauth-default-budget). |
Devoluciones
- Respuesta de importación de transacciones
- TransactionsImportResponse
Obtención de la configuración del presupuesto por identificador
Devuelve la configuración de un presupuesto.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de presupuesto
|
budget_id | True | string |
Identificador del presupuesto. Se puede usar "last-used" para especificar el último presupuesto usado y "default" se puede usar si la selección de presupuesto predeterminada está habilitada (consulte: https://api.youneedabudget.com/#oauth-default-budget). |
Devoluciones
- Respuesta de configuración de presupuesto
- BudgetSettingsResponse
Obtención de la cuenta por identificador
Devuelve una sola cuenta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de presupuesto
|
budget_id | True | string |
Identificador del presupuesto. Se puede usar "last-used" para especificar el último presupuesto usado y "default" se puede usar si la selección de presupuesto predeterminada está habilitada (consulte: https://api.youneedabudget.com/#oauth-default-budget). |
|
Id. de cuenta
|
account_id | True | uuid |
Identificador de la cuenta. |
Devoluciones
- Respuesta de la cuenta
- AccountResponse
Obtención de la transacción programada por identificador
Devuelve una única transacción programada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de presupuesto
|
budget_id | True | string |
Identificador del presupuesto. Se puede usar "last-used" para especificar el último presupuesto usado y "default" se puede usar si la selección de presupuesto predeterminada está habilitada (consulte: https://api.youneedabudget.com/#oauth-default-budget). |
|
Id. de transacción programada
|
scheduled_transaction_id | True | string |
Identificador de la transacción programada. |
Devoluciones
- Respuesta de transacción programada
- ScheduledTransactionResponse
Obtención de la ubicación del destinatario por identificador
Devuelve una única ubicación de receptor.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de presupuesto
|
budget_id | True | string |
Identificador del presupuesto. Se puede usar "last-used" para especificar el último presupuesto usado y "default" se puede usar si la selección de presupuesto predeterminada está habilitada (consulte: https://api.youneedabudget.com/#oauth-default-budget). |
|
Id. de ubicación del receptor
|
payee_location_id | True | string |
Identificador de la ubicación del receptor. |
Devoluciones
- Respuesta de ubicación del receptor
- PayeeLocationResponse
Obtención de transacciones
Devuelve transacciones presupuestarias.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de presupuesto
|
budget_id | True | string |
Identificador del presupuesto. Se puede usar "last-used" para especificar el último presupuesto usado y "default" se puede usar si la selección de presupuesto predeterminada está habilitada (consulte: https://api.youneedabudget.com/#oauth-default-budget). |
|
Desde fecha
|
since_date | date |
Si se especifica, solo se incluirán las transacciones en o después de esta fecha. La fecha debe tener el formato ISO (por ejemplo, 2016-12-30). |
|
|
Tipo
|
type | string |
Si se especifica, solo se incluirán las transacciones del tipo especificado. Actualmente se admiten "no clasificados" y "no aprobados". |
|
|
Último conocimiento del servidor
|
last_knowledge_of_server | integer |
Conocimientos del servidor de inicio. Si se proporciona, solo se incluirán las entidades que han cambiado desde |
Devoluciones
- Respuesta de transacciones
- TransactionsResponse
Obtención de transacciones por cuenta
Devuelve todas las transacciones de una cuenta especificada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de presupuesto
|
budget_id | True | string |
Identificador del presupuesto. Se puede usar "last-used" para especificar el último presupuesto usado y "default" se puede usar si la selección de presupuesto predeterminada está habilitada (consulte: https://api.youneedabudget.com/#oauth-default-budget). |
|
Id. de cuenta
|
account_id | True | string |
Identificador de la cuenta. |
|
Desde fecha
|
since_date | date |
Si se especifica, solo se incluirán las transacciones en o después de esta fecha. La fecha debe tener el formato ISO (por ejemplo, 2016-12-30). |
|
|
Tipo
|
type | string |
Si se especifica, solo se incluirán las transacciones del tipo especificado. Actualmente se admiten "no clasificados" y "no aprobados". |
|
|
Último conocimiento del servidor
|
last_knowledge_of_server | integer |
Conocimientos del servidor de inicio. Si se proporciona, solo se incluirán las entidades que han cambiado desde |
Devoluciones
- Respuesta de transacciones
- TransactionsResponse
Obtención de transacciones por identificador
Devuelve una sola transacción.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de presupuesto
|
budget_id | True | string |
Identificador del presupuesto. Se puede usar "last-used" para especificar el último presupuesto usado y "default" se puede usar si la selección de presupuesto predeterminada está habilitada (consulte: https://api.youneedabudget.com/#oauth-default-budget). |
|
Id. de transacción
|
transaction_id | True | string |
Identificador de la transacción. |
Devoluciones
- Respuesta de transacción
- TransactionResponse
Obtención de transacciones por parte del beneficiario
Devuelve todas las transacciones de un receptor especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de presupuesto
|
budget_id | True | string |
Identificador del presupuesto. Se puede usar "last-used" para especificar el último presupuesto usado y "default" se puede usar si la selección de presupuesto predeterminada está habilitada (consulte: https://api.youneedabudget.com/#oauth-default-budget). |
|
Id. de destinatario
|
payee_id | True | string |
Identificador del receptor. |
|
Desde fecha
|
since_date | date |
Si se especifica, solo se incluirán las transacciones en o después de esta fecha. La fecha debe tener el formato ISO (por ejemplo, 2016-12-30). |
|
|
Tipo
|
type | string |
Si se especifica, solo se incluirán las transacciones del tipo especificado. Actualmente se admiten "no clasificados" y "no aprobados". |
|
|
Último conocimiento del servidor
|
last_knowledge_of_server | integer |
Conocimientos del servidor de inicio. Si se proporciona, solo se incluirán las entidades que han cambiado desde |
Devoluciones
- Respuesta de transacciones híbridas
- HybridTransactionsResponse
Obtención de transacciones programadas
Devuelve todas las transacciones programadas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de presupuesto
|
budget_id | True | string |
Identificador del presupuesto. Se puede usar "last-used" para especificar el último presupuesto usado y "default" se puede usar si la selección de presupuesto predeterminada está habilitada (consulte: https://api.youneedabudget.com/#oauth-default-budget). |
|
Último conocimiento del servidor
|
last_knowledge_of_server | integer |
Conocimientos del servidor de inicio. Si se proporciona, solo se incluirán las entidades que han cambiado desde |
Devoluciones
- Respuesta de transacciones programadas
- ScheduledTransactionsResponse
Obtención de ubicaciones de destinatarios
Devuelve todas las ubicaciones de los receptores.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de presupuesto
|
budget_id | True | string |
Identificador del presupuesto. Se puede usar "last-used" para especificar el último presupuesto usado y "default" se puede usar si la selección de presupuesto predeterminada está habilitada (consulte: https://api.youneedabudget.com/#oauth-default-budget). |
Devoluciones
- Respuesta de ubicaciones de pago
- PayeeLocationsResponse
Obtención de ubicaciones de destinatarios por parte del beneficiario
Devuelve todas las ubicaciones de los beneficiarios de un receptor especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de presupuesto
|
budget_id | True | string |
Identificador del presupuesto. Se puede usar "last-used" para especificar el último presupuesto usado y "default" se puede usar si la selección de presupuesto predeterminada está habilitada (consulte: https://api.youneedabudget.com/#oauth-default-budget). |
|
Id. de destinatario
|
payee_id | True | string |
Identificador del receptor. |
Devoluciones
- Respuesta de ubicaciones de pago
- PayeeLocationsResponse
Obtención del presupuesto por identificador
Devuelve un único presupuesto con todas las entidades relacionadas. Este recurso es efectivamente una exportación de presupuesto completa.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de presupuesto
|
budget_id | True | string |
Identificador del presupuesto. |
|
Último conocimiento del servidor
|
last_knowledge_of_server | integer |
Conocimientos del servidor de inicio. Si se proporciona, solo se incluirán las entidades que han cambiado desde |
Devoluciones
- Respuesta de detalles del presupuesto
- BudgetDetailResponse
Obtención del receptor por identificador
Devuelve un solo beneficiario.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de presupuesto
|
budget_id | True | string |
Identificador del presupuesto. Se puede usar "last-used" para especificar el último presupuesto usado y "default" se puede usar si la selección de presupuesto predeterminada está habilitada (consulte: https://api.youneedabudget.com/#oauth-default-budget). |
|
Id. de destinatario
|
payee_id | True | string |
Identificador del receptor. |
Devoluciones
- Respuesta del beneficiario
- PayeeResponse
Obtener categoría de mes por identificador
Devuelve una sola categoría para un mes presupuestado específico. Los importes (presupuestados, actividad, saldo, etc.) son específicos del mes presupuestado actual (UTC).
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de presupuesto
|
budget_id | True | string |
Identificador del presupuesto. Se puede usar "last-used" para especificar el último presupuesto usado y "default" se puede usar si la selección de presupuesto predeterminada está habilitada (consulte: https://api.youneedabudget.com/#oauth-default-budget). |
|
Mes
|
month | True | date |
Mes presupuestado en formato ISO (por ejemplo, 2016-12-01). ("current" también se puede usar para especificar el mes natural actual (UTC)) |
|
Id. de categoría
|
category_id | True | string |
Identificador de la categoría. |
Devoluciones
- Respuesta de categoría
- CategoryResponse
Obtener categoría por identificador
Devuelve una sola categoría. Los importes (presupuestados, actividad, saldo, etc.) son específicos del mes presupuestado actual (UTC).
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de presupuesto
|
budget_id | True | string |
Identificador del presupuesto. Se puede usar "last-used" para especificar el último presupuesto usado y "default" se puede usar si la selección de presupuesto predeterminada está habilitada (consulte: https://api.youneedabudget.com/#oauth-default-budget). |
|
Id. de categoría
|
category_id | True | string |
Identificador de la categoría. |
Devoluciones
- Respuesta de categoría
- CategoryResponse
Obtener categorías
Devuelve todas las categorías agrupadas por grupo de categorías. Los importes (presupuestados, actividad, saldo, etc.) son específicos del mes presupuestado actual (UTC).
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de presupuesto
|
budget_id | True | string |
Identificador del presupuesto. Se puede usar "last-used" para especificar el último presupuesto usado y "default" se puede usar si la selección de presupuesto predeterminada está habilitada (consulte: https://api.youneedabudget.com/#oauth-default-budget). |
|
Último conocimiento del servidor
|
last_knowledge_of_server | integer |
Conocimientos del servidor de inicio. Si se proporciona, solo se incluirán las entidades que han cambiado desde |
Devoluciones
- Respuesta de categorías
- CategoriesResponse
Obtener cuentas
Devuelve todas las cuentas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de presupuesto
|
budget_id | True | string |
Identificador del presupuesto. Se puede usar "last-used" para especificar el último presupuesto usado y "default" se puede usar si la selección de presupuesto predeterminada está habilitada (consulte: https://api.youneedabudget.com/#oauth-default-budget). |
|
Último conocimiento del servidor
|
last_knowledge_of_server | integer |
Conocimientos del servidor de inicio. Si se proporciona, solo se incluirán las entidades que han cambiado desde |
Devoluciones
- Respuesta de cuentas
- AccountsResponse
Obtener mes presupuestado
Devuelve un solo mes presupuestado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de presupuesto
|
budget_id | True | string |
Identificador del presupuesto. Se puede usar "last-used" para especificar el último presupuesto usado y "default" se puede usar si la selección de presupuesto predeterminada está habilitada (consulte: https://api.youneedabudget.com/#oauth-default-budget). |
|
Mes
|
month | True | date |
Mes presupuestado en formato ISO (por ejemplo, 2016-12-01). ("current" también se puede usar para especificar el mes natural actual (UTC)) |
Devoluciones
- Respuesta de detalles del mes
- MonthDetailResponse
Obtener meses de presupuesto
Devuelve todos los meses presupuestado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de presupuesto
|
budget_id | True | string |
Identificador del presupuesto. Se puede usar "last-used" para especificar el último presupuesto usado y "default" se puede usar si la selección de presupuesto predeterminada está habilitada (consulte: https://api.youneedabudget.com/#oauth-default-budget). |
|
Último conocimiento del servidor
|
last_knowledge_of_server | integer |
Conocimientos del servidor de inicio. Si se proporciona, solo se incluirán las entidades que han cambiado desde |
Devoluciones
- Respuesta de resúmenes de mes
- MonthSummariesResponse
Obtener payees
Devuelve todos los payees.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de presupuesto
|
budget_id | True | string |
Identificador del presupuesto. Se puede usar "last-used" para especificar el último presupuesto usado y "default" se puede usar si la selección de presupuesto predeterminada está habilitada (consulte: https://api.youneedabudget.com/#oauth-default-budget). |
|
Último conocimiento del servidor
|
last_knowledge_of_server | integer |
Conocimientos del servidor de inicio. Si se proporciona, solo se incluirán las entidades que han cambiado desde |
Devoluciones
- Respuesta de pago
- PayeesResponse
Obtener presupuestos
Devuelve la lista de presupuestos con información de resumen.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Incluir cuentas
|
include_accounts | boolean |
Si se debe incluir la lista de cuentas presupuestarias. |
Devoluciones
- Respuesta de resumen de presupuesto
- BudgetSummaryResponse
Obtener transacciones por categoría
Devuelve todas las transacciones de una categoría especificada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de presupuesto
|
budget_id | True | string |
Identificador del presupuesto. Se puede usar "last-used" para especificar el último presupuesto usado y "default" se puede usar si la selección de presupuesto predeterminada está habilitada (consulte: https://api.youneedabudget.com/#oauth-default-budget). |
|
Id. de categoría
|
category_id | True | string |
Identificador de la categoría. |
|
Desde fecha
|
since_date | date |
Si se especifica, solo se incluirán las transacciones en o después de esta fecha. La fecha debe tener el formato ISO (por ejemplo, 2016-12-30). |
|
|
Tipo
|
type | string |
Si se especifica, solo se incluirán las transacciones del tipo especificado. Actualmente se admiten "no clasificados" y "no aprobados". |
|
|
Último conocimiento del servidor
|
last_knowledge_of_server | integer |
Conocimientos del servidor de inicio. Si se proporciona, solo se incluirán las entidades que han cambiado desde |
Devoluciones
- Respuesta de transacciones híbridas
- HybridTransactionsResponse
Obtener usuario
Definiciones
UserResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Data
|
data | Data |
Usuario
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
DateFormat
Configuración de formato de fecha para el presupuesto. En algunos casos, el formato no estará disponible y se especificará como null.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Formato
|
format | string |
El formato. |
CurrencyFormat
Valor de formato de moneda para el presupuesto. En algunos casos, el formato no estará disponible y se especificará como null.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código ISO
|
iso_code | string |
Código ISO. |
|
Formato de ejemplo
|
example_format | string |
Formato de ejemplo. |
|
Dígitos decimales
|
decimal_digits | integer |
Dígitos decimales. |
|
Separador decimal
|
decimal_separator | string |
Separador decimal. |
|
Símbolo primero
|
symbol_first | boolean |
Si el símbolo es primero. |
|
Separador de grupo
|
group_separator | string |
Separador de grupo. |
|
Símbolo de la moneda
|
currency_symbol | string |
Símbolo de moneda. |
|
Símbolo mostrado
|
display_symbol | boolean |
Indica si se muestra el símbolo. |
BudgetSummaryResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Data1
|
data | Data1 |
BudgetSummary
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
Nombre
|
name | string |
Nombre. |
|
Última modificación en
|
last_modified_on | date-time |
La última vez que se realizaron cambios en el presupuesto desde un cliente web o móvil. |
|
Primer mes
|
first_month | date |
El primer mes presupuestado. |
|
Último mes
|
last_month | date |
El último mes presupuestado. |
|
Formato de fecha
|
date_format | DateFormat |
Configuración de formato de fecha para el presupuesto. En algunos casos, el formato no estará disponible y se especificará como null. |
|
Formato de moneda
|
currency_format | CurrencyFormat |
Valor de formato de moneda para el presupuesto. En algunos casos, el formato no estará disponible y se especificará como null. |
|
Accounts
|
accounts | array of Account |
Las cuentas presupuestarias (solo se incluyen si |
BudgetDetailResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Data2
|
data | Data2 |
BudgetDetail
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
Nombre
|
name | string |
Nombre. |
|
Última modificación en
|
last_modified_on | date-time |
La última vez que se realizaron cambios en el presupuesto desde un cliente web o móvil. |
|
Primer mes
|
first_month | date |
El primer mes presupuestado. |
|
Último mes
|
last_month | date |
El último mes presupuestado. |
|
Formato de fecha
|
date_format | DateFormat |
Configuración de formato de fecha para el presupuesto. En algunos casos, el formato no estará disponible y se especificará como null. |
|
Formato de moneda
|
currency_format | CurrencyFormat |
Valor de formato de moneda para el presupuesto. En algunos casos, el formato no estará disponible y se especificará como null. |
|
Accounts
|
accounts | array of Account |
Las cuentas presupuestarias (solo se incluyen si |
|
Beneficiarios
|
payees | array of Payee | |
|
Ubicaciones de destinatarios
|
payee_locations | array of PayeeLocation | |
|
Grupos de categorías
|
category_groups | array of CategoryGroup | |
|
Categorías
|
categories | array of Category | |
|
Meses
|
months | array of MonthDetail | |
|
Transactions
|
transactions | array of TransactionSummary | |
|
Subtransacciones
|
subtransactions | array of SubTransaction | |
|
Transacciones programadas
|
scheduled_transactions | array of ScheduledTransactionSummary | |
|
Subtransacciones programadas
|
scheduled_subtransactions | array of ScheduledSubTransaction |
BudgetSettingsResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Data3
|
data | Data3 |
BudgetSettings
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Formato de fecha
|
date_format | DateFormat |
Configuración de formato de fecha para el presupuesto. En algunos casos, el formato no estará disponible y se especificará como null. |
|
Formato de moneda
|
currency_format | CurrencyFormat |
Valor de formato de moneda para el presupuesto. En algunos casos, el formato no estará disponible y se especificará como null. |
CuentasResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Data4
|
data | Data4 |
AccountResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Data5
|
data | Data5 |
Cuenta
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
Nombre
|
name | string |
Nombre. |
|
Tipo
|
type | Type |
Tipo de cuenta. Nota: PayPal, merchantAccount, investmentAccount y los tipos de hipoteca han quedado en desuso y se eliminarán en el futuro. |
|
On Budget
|
on_budget | boolean |
Si esta cuenta está en el presupuesto o no |
|
Cerrada
|
closed | boolean |
Si esta cuenta está cerrada o no |
|
Nota:
|
note | string |
La nota. |
|
Saldo
|
balance | integer |
Saldo actual de la cuenta en formato milliunits. |
|
Saldo borrado
|
cleared_balance | integer |
Saldo borrado actual de la cuenta en formato miliunits. |
|
Saldo poco claro
|
uncleared_balance | integer |
El saldo actual no claro de la cuenta en formato miliunits. |
|
Transfer Payee ID
|
transfer_payee_id | string |
Identificador de receptor que se debe usar al transferir a esta cuenta. |
|
Importación directa vinculada
|
direct_import_linked | boolean |
Si la cuenta está vinculada o no a una institución financiera para la importación automática de transacciones. |
|
Importación directa en error
|
direct_import_in_error | boolean |
Si una cuenta vinculada a una entidad financiera (direct_import_linked=true) y la conexión vinculada no está en un estado correcto, esto será cierto. |
|
Borrado
|
deleted | boolean |
Indica si la cuenta se ha eliminado o no. Las cuentas eliminadas solo se incluirán en las solicitudes delta. |
CategoriesResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Data6
|
data | Data6 |
CategoryResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Data7
|
data | Data7 |
CategoryGroupWithCategories
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
Nombre
|
name | string |
Nombre. |
|
Oculto
|
hidden | boolean |
Indica si el grupo de categorías está oculto o no. |
|
Borrado
|
deleted | boolean |
Indica si se ha eliminado o no el grupo de categorías. Los grupos de categorías eliminados solo se incluirán en las solicitudes delta. |
|
Categorías
|
categories | array of Category |
Categorías de grupo de categorías. Los importes (presupuestados, actividad, saldo, etc.) son específicos del mes presupuestado actual (UTC). |
CategoryGroup
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
Nombre
|
name | string |
Nombre. |
|
Oculto
|
hidden | boolean |
Indica si el grupo de categorías está oculto o no. |
|
Borrado
|
deleted | boolean |
Indica si se ha eliminado o no el grupo de categorías. Los grupos de categorías eliminados solo se incluirán en las solicitudes delta. |
Categoría
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
Id. de grupo de categorías
|
category_group_id | string |
Identificador del grupo de categorías. |
|
Nombre
|
name | string |
Nombre. |
|
Oculto
|
hidden | boolean |
Indica si la categoría está oculta o no. |
|
Id. de grupo de categorías original
|
original_category_group_id | uuid |
Si la categoría está oculta, es el identificador del grupo de categorías al que pertenecía originalmente antes de que se ocultara. |
|
Nota:
|
note | string |
La nota. |
|
Presupuestado
|
budgeted | integer |
Importe presupuestado en formato milliunits. |
|
Activity
|
activity | integer |
Cantidad de actividad en formato milliunits. |
|
Saldo
|
balance | integer |
Equilibrar en miliunits formato. |
|
Tipo de objetivo
|
goal_type | GoalType |
El tipo de objetivo, si la categoría tiene un objetivo (TB='Saldo de categoría objetivo', TBD='Saldo de categoría de destino por fecha', MF='Monthly Funding', NEED='Plan Your Spending') |
|
Mes de creación de objetivos
|
goal_creation_month | date |
Mes en el que se creó un objetivo. |
|
Objetivo de destino
|
goal_target | integer |
Cantidad objetivo objetivo en miliunits. |
|
Mes objetivo objetivo
|
goal_target_month | date |
Mes de destino original del objetivo que se va a completar. Solo algunos tipos de objetivo especifican esta fecha. |
|
Porcentaje de objetivo completado
|
goal_percentage_complete | integer |
Porcentaje de finalización del objetivo. |
|
Meses de objetivo para el presupuesto
|
goal_months_to_budget | integer |
Número de meses, incluido el mes actual, dejado en el período objetivo actual. |
|
Objetivo subvencionado
|
goal_under_funded | integer |
La cantidad de financiación que todavía se necesita en el mes actual para seguir el camino hacia la finalización del objetivo dentro del período objetivo actual. Por lo general, esta cantidad se corresponderá con el importe "Infrafundado" de los clientes web y móviles, excepto cuando se visualiza una categoría con un Objetivo de gasto necesario en un mes futuro. Los clientes web y móviles omitirán los fondos de un período de objetivo anterior al ver la categoría con un objetivo necesario para el objetivo de gasto en un mes futuro. |
|
Objetivo total financiado
|
goal_overall_funded | integer |
Importe total financiado para el objetivo dentro del período de objetivo actual. |
|
Objetivo general izquierdo
|
goal_overall_left | integer |
La cantidad de financiación sigue siendo necesaria para completar el objetivo dentro del período objetivo actual. |
|
Borrado
|
deleted | boolean |
Indica si se ha eliminado o no la categoría. Las categorías eliminadas solo se incluirán en las solicitudes delta. |
SaveCategoryResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Datos8
|
data | Data8 |
PayeesResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Data9
|
data | Data9 |
PayeeResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Data10
|
data | Data10 |
Beneficiario
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
Nombre
|
name | string |
Nombre. |
|
Id. de cuenta de transferencia
|
transfer_account_id | string |
Si es un receptor de transferencia, al |
|
Borrado
|
deleted | boolean |
Si se ha eliminado o no el beneficiario. Los payees eliminados solo se incluirán en las solicitudes delta. |
PayeeLocationsResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Data11
|
data | Data11 |
PayeeLocationResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Data12
|
data | Data12 |
PayeeLocation
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
Id. de destinatario
|
payee_id | string |
Identificador del receptor. |
|
Latitude
|
latitude | string |
Latitud. |
|
Longitude
|
longitude | string |
Longitud. |
|
Borrado
|
deleted | boolean |
Si se ha eliminado o no la ubicación del receptor. Las ubicaciones de destinatario eliminadas solo se incluirán en las solicitudes diferenciales. |
TransactionsResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Data13
|
data | Data13 |
HybridTransactionsResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Data14
|
data | Data14 |
SaveTransactionsResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Data15
|
data | Data15 |
TransactionResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Data16
|
data | Data16 |
TransactionSummary
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
Fecha
|
date | date |
Fecha de transacción en formato ISO (por ejemplo, 2016-12-01). |
|
Importe
|
amount | integer |
El importe de la transacción en formato milliunits. |
|
Memorándum
|
memo | string |
El memo. |
|
Desactivado
|
cleared | Cleared |
Estado borrado de la transacción. |
|
Aprobado
|
approved | boolean |
Indica si se aprueba o no la transacción. |
|
Color de marca
|
flag_color | FlagColor |
Marca de transacción. |
|
Id. de cuenta
|
account_id | string |
Identificador de cuenta. |
|
Id. de destinatario
|
payee_id | string |
Identificador del receptor. |
|
Id. de categoría
|
category_id | string |
Identificador de categoría. |
|
Id. de cuenta de transferencia
|
transfer_account_id | uuid |
Si se trata de una transacción de transferencia, la cuenta a la que transfiere. |
|
Id. de transacción de transferencia
|
transfer_transaction_id | string |
Si es una transacción de transferencia, el identificador de la transacción en el otro lado de la transferencia. |
|
Id. de transacción coincidente
|
matched_transaction_id | string |
Si la transacción coincide, el identificador de la transacción coincidente. |
|
Id. de importación
|
import_id | string |
Si se importó la transacción, este campo es un identificador de importación único (por cuenta). Si esta transacción se importó a través de importación basada en archivos o importación directa y no a través de la API, el import_id tendrá el formato : "YNAB:[milliunit_amount]:[iso_date]:[repetición]". Por ejemplo, una transacción con fecha 2015-12-30 en el importe de -$294.23 USD tendría un import_id de "YNAB:-294230:2015-12-30:1". Si se importó una segunda transacción en la misma cuenta y tenía la misma fecha y la misma cantidad, su import_id sería "YNAB:-294230:2015-12-30:2". |
|
Borrado
|
deleted | boolean |
Indica si se ha eliminado o no la transacción. Las transacciones eliminadas solo se incluirán en las solicitudes delta. |
TransactionDetail
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
Fecha
|
date | date |
Fecha de transacción en formato ISO (por ejemplo, 2016-12-01). |
|
Importe
|
amount | integer |
El importe de la transacción en formato milliunits. |
|
Memorándum
|
memo | string |
El memo. |
|
Desactivado
|
cleared | Cleared |
Estado borrado de la transacción. |
|
Aprobado
|
approved | boolean |
Indica si se aprueba o no la transacción. |
|
Color de marca
|
flag_color | FlagColor |
Marca de transacción. |
|
Id. de cuenta
|
account_id | string |
Identificador de cuenta. |
|
Id. de destinatario
|
payee_id | string |
Identificador del receptor. |
|
Id. de categoría
|
category_id | string |
Identificador de categoría. |
|
Id. de cuenta de transferencia
|
transfer_account_id | uuid |
Si se trata de una transacción de transferencia, la cuenta a la que transfiere. |
|
Id. de transacción de transferencia
|
transfer_transaction_id | string |
Si es una transacción de transferencia, el identificador de la transacción en el otro lado de la transferencia. |
|
Id. de transacción coincidente
|
matched_transaction_id | string |
Si la transacción coincide, el identificador de la transacción coincidente. |
|
Id. de importación
|
import_id | string |
Si se importó la transacción, este campo es un identificador de importación único (por cuenta). Si esta transacción se importó a través de importación basada en archivos o importación directa y no a través de la API, el import_id tendrá el formato : "YNAB:[milliunit_amount]:[iso_date]:[repetición]". Por ejemplo, una transacción con fecha 2015-12-30 en el importe de -$294.23 USD tendría un import_id de "YNAB:-294230:2015-12-30:1". Si se importó una segunda transacción en la misma cuenta y tenía la misma fecha y la misma cantidad, su import_id sería "YNAB:-294230:2015-12-30:2". |
|
Borrado
|
deleted | boolean |
Indica si se ha eliminado o no la transacción. Las transacciones eliminadas solo se incluirán en las solicitudes delta. |
|
Nombre de cuenta
|
account_name | string |
Nombre de la cuenta. |
|
Beneficiario
|
payee_name | string |
Nombre del beneficiario. |
|
Categoría
|
category_name | string |
Nombre de categoría. |
|
Subtransacciones
|
subtransactions | array of SubTransaction |
Si se divide una transacción, las subtransacciones. |
HybridTransaction
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
Fecha
|
date | date |
Fecha de transacción en formato ISO (por ejemplo, 2016-12-01). |
|
Importe
|
amount | integer |
El importe de la transacción en formato milliunits. |
|
Memorándum
|
memo | string |
El memo. |
|
Desactivado
|
cleared | Cleared |
Estado borrado de la transacción. |
|
Aprobado
|
approved | boolean |
Indica si se aprueba o no la transacción. |
|
Color de marca
|
flag_color | FlagColor |
Marca de transacción. |
|
Id. de cuenta
|
account_id | string |
Identificador de cuenta. |
|
Id. de destinatario
|
payee_id | string |
Identificador del receptor. |
|
Id. de categoría
|
category_id | string |
Identificador de categoría. |
|
Id. de cuenta de transferencia
|
transfer_account_id | uuid |
Si se trata de una transacción de transferencia, la cuenta a la que transfiere. |
|
Id. de transacción de transferencia
|
transfer_transaction_id | string |
Si es una transacción de transferencia, el identificador de la transacción en el otro lado de la transferencia. |
|
Id. de transacción coincidente
|
matched_transaction_id | string |
Si la transacción coincide, el identificador de la transacción coincidente. |
|
Id. de importación
|
import_id | string |
Si se importó la transacción, este campo es un identificador de importación único (por cuenta). Si esta transacción se importó a través de importación basada en archivos o importación directa y no a través de la API, el import_id tendrá el formato : "YNAB:[milliunit_amount]:[iso_date]:[repetición]". Por ejemplo, una transacción con fecha 2015-12-30 en el importe de -$294.23 USD tendría un import_id de "YNAB:-294230:2015-12-30:1". Si se importó una segunda transacción en la misma cuenta y tenía la misma fecha y la misma cantidad, su import_id sería "YNAB:-294230:2015-12-30:2". |
|
Borrado
|
deleted | boolean |
Indica si se ha eliminado o no la transacción. Las transacciones eliminadas solo se incluirán en las solicitudes delta. |
|
Type3
|
type | Type3 |
Si la transacción híbrida representa una transacción normal o una subtransacción |
|
Id. de transacción principal
|
parent_transaction_id | string |
En el caso de los tipos de subtransacción, este es el identificador de la transacción primaria. En el caso de los tipos de transacción, este identificador siempre será NULL. |
|
Nombre de cuenta
|
account_name | string |
Nombre de la cuenta. |
|
Beneficiario
|
payee_name | string |
Nombre del beneficiario. |
|
Categoría
|
category_name | string |
Nombre de categoría. |
TransactionsImportResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Data17
|
data | Data17 |
BulkResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Data18
|
data | Data18 |
SubTransaction
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
Id. de transacción
|
transaction_id | string |
Transacción. |
|
Importe
|
amount | integer |
Cantidad de subtransacción en formato miliunits. |
|
Memorándum
|
memo | string |
El memo. |
|
Id. de destinatario
|
payee_id | string |
Identificador del receptor. |
|
Beneficiario
|
payee_name | string |
Nombre del beneficiario. |
|
Id. de categoría
|
category_id | string |
Identificador de categoría. |
|
Categoría
|
category_name | string |
Nombre de categoría. |
|
Id. de cuenta de transferencia
|
transfer_account_id | uuid |
Si es una transferencia, el account_id al que se transfiere la subtransacción. |
|
Id. de transacción de transferencia
|
transfer_transaction_id | string |
Si es una transferencia, el identificador de la transacción en el otro lado de la transferencia. |
|
Borrado
|
deleted | boolean |
Indica si se ha eliminado o no la subtransacción. Las subtransacciones eliminadas solo se incluirán en las solicitudes delta. |
ScheduledTransactionsResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Data19
|
data | Data19 |
ScheduledTransactionResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Data20
|
data | Data20 |
ScheduledTransactionSummary
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
Primera fecha
|
date_first | date |
La primera fecha para la que se programó la transacción programada. |
|
Fecha siguiente
|
date_next | date |
La siguiente fecha para la que se programa la transacción programada. |
|
Frecuencia
|
frequency | Frequency |
Frecuencia. |
|
Importe
|
amount | integer |
El importe de la transacción programada en formato miliunits. |
|
Memorándum
|
memo | string |
El memo. |
|
FlagColor1
|
flag_color | FlagColor1 |
Marca de transacción programada. |
|
Id. de cuenta
|
account_id | string |
Identificador de cuenta. |
|
Id. de destinatario
|
payee_id | string |
Identificador del receptor. |
|
Id. de categoría
|
category_id | string |
Identificador de categoría. |
|
Id. de cuenta de transferencia
|
transfer_account_id | uuid |
Si es una transferencia, la account_id a la que se transfiere la transacción programada. |
|
Borrado
|
deleted | boolean |
Indica si se ha eliminado o no la transacción programada. Las transacciones programadas eliminadas solo se incluirán en las solicitudes delta. |
ScheduledTransactionDetail
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
Primera fecha
|
date_first | date |
La primera fecha para la que se programó la transacción programada. |
|
Fecha siguiente
|
date_next | date |
La siguiente fecha para la que se programa la transacción programada. |
|
Frecuencia
|
frequency | Frequency |
Frecuencia. |
|
Importe
|
amount | integer |
El importe de la transacción programada en formato miliunits. |
|
Memorándum
|
memo | string |
El memo. |
|
FlagColor1
|
flag_color | FlagColor1 |
Marca de transacción programada. |
|
Id. de cuenta
|
account_id | string |
Identificador de cuenta. |
|
Id. de destinatario
|
payee_id | string |
Identificador del receptor. |
|
Id. de categoría
|
category_id | string |
Identificador de categoría. |
|
Id. de cuenta de transferencia
|
transfer_account_id | uuid |
Si es una transferencia, la account_id a la que se transfiere la transacción programada. |
|
Borrado
|
deleted | boolean |
Indica si se ha eliminado o no la transacción programada. Las transacciones programadas eliminadas solo se incluirán en las solicitudes delta. |
|
Nombre de cuenta
|
account_name | string |
Nombre de la cuenta. |
|
Beneficiario
|
payee_name | string |
Nombre del beneficiario. |
|
Categoría
|
category_name | string |
Nombre de categoría. |
|
subtransactions
|
subtransactions | array of ScheduledSubTransaction |
Si se divide una transacción programada, las subtransacciones. |
ScheduledSubTransaction
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
Id. de transacción programada
|
scheduled_transaction_id | string |
Identificador de transacción programado. |
|
Importe
|
amount | integer |
Cantidad de subtransacción programada en formato miliunits. |
|
Memorándum
|
memo | string |
El memo. |
|
Id. de destinatario
|
payee_id | string |
Identificador del receptor. |
|
Id. de categoría
|
category_id | string |
Identificador de categoría. |
|
Id. de cuenta de transferencia
|
transfer_account_id | uuid |
Si es una transferencia, el account_id al que se transfiere la subtransacción programada. |
|
Borrado
|
deleted | boolean |
Indica si se ha eliminado o no la subtransacción programada. Las subtransacciones programadas eliminadas solo se incluirán en las solicitudes delta. |
MonthSummariesResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Data21
|
data | Data21 |
MonthDetailResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Data22
|
data | Data22 |
MonthSummary
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Mes
|
month | date |
El mes. |
|
Nota:
|
note | string |
La nota. |
|
Ingresos
|
income | integer |
La cantidad total de transacciones clasificadas en "Flujo: Listo para asignar" en el mes. |
|
Presupuestado
|
budgeted | integer |
Importe total presupuestado en el mes. |
|
Activity
|
activity | integer |
La cantidad total de transacciones del mes, excepto las clasificadas como "Flujo: Listo para asignar". |
|
Para ser presupuestado
|
to_be_budgeted | integer |
Cantidad disponible para "Listo para asignar". |
|
Edad del dinero
|
age_of_money | integer |
La edad del dinero a partir del mes. |
|
Borrado
|
deleted | boolean |
Indica si se ha eliminado o no el mes. Los meses eliminados solo se incluirán en las solicitudes delta. |
MonthDetail
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Mes
|
month | date |
El mes. |
|
Nota:
|
note | string |
La nota. |
|
Ingresos
|
income | integer |
La cantidad total de transacciones clasificadas en "Flujo: Listo para asignar" en el mes. |
|
Presupuestado
|
budgeted | integer |
Importe total presupuestado en el mes. |
|
Activity
|
activity | integer |
La cantidad total de transacciones del mes, excepto las clasificadas como "Flujo: Listo para asignar". |
|
Para ser presupuestado
|
to_be_budgeted | integer |
Cantidad disponible para "Listo para asignar". |
|
Edad del dinero
|
age_of_money | integer |
La edad del dinero a partir del mes. |
|
Borrado
|
deleted | boolean |
Indica si se ha eliminado o no el mes. Los meses eliminados solo se incluirán en las solicitudes delta. |
|
Categorías
|
categories | array of Category |
Categorías del mes presupuestado. Los importes (presupuestado, actividad, saldo, etc.) son específicos del parámetro {month} especificado. |
Masivo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Identificadores de transacción
|
transaction_ids | array of string |
Lista de identificadores de transacción que se crearon. |
|
Identificadores de importación duplicados
|
duplicate_import_ids | array of string |
Si no se creó ninguna transacción porque ya tenía una |
Desactivado
Data
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Usuario
|
user | User |
Data1
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Budgets
|
budgets | array of BudgetSummary | |
|
Resumen del presupuesto
|
default_budget | BudgetSummary |
Data2
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Detalles del presupuesto
|
budget | BudgetDetail | |
|
Conocimiento del servidor
|
server_knowledge | integer |
Conocimientos del servidor. |
Data3
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Configuración del presupuesto
|
settings | BudgetSettings |
Data4
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Accounts
|
accounts | array of Account | |
|
Conocimiento del servidor
|
server_knowledge | integer |
Conocimientos del servidor. |
Data5
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Cuenta
|
account | Account |
Data6
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Grupos de categorías
|
category_groups | array of CategoryGroupWithCategories |
Los grupos de categorías. |
|
Conocimiento del servidor
|
server_knowledge | integer |
Conocimientos del servidor. |
Data7
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Categoría
|
category | Category |
Datos8
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Categoría
|
category | Category | |
|
Conocimiento del servidor
|
server_knowledge | integer |
Conocimientos del servidor. |
Data9
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Beneficiarios
|
payees | array of Payee |
Los payees. |
|
Conocimiento del servidor
|
server_knowledge | integer |
Conocimientos del servidor. |
Data10
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Beneficiario
|
payee | Payee |
Data11
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Ubicaciones de destinatarios
|
payee_locations | array of PayeeLocation |
Las ubicaciones de los beneficiarios. |
Data12
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Ubicación del receptor
|
payee_location | PayeeLocation |
Data13
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Transactions
|
transactions | array of TransactionDetail |
Transacciones. |
|
Conocimiento del servidor
|
server_knowledge | integer |
Conocimientos del servidor. |
Data14
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Transactions
|
transactions | array of HybridTransaction |
Transacciones. |
Data15
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Identificadores de transacción
|
transaction_ids | array of string |
Identificadores de transacción guardados. |
|
Detalle de la transacción
|
transaction | TransactionDetail | |
|
transacciones
|
transactions | array of TransactionDetail |
Si se especificaron varias transacciones, las transacciones que se guardaron. |
|
Identificadores de importación duplicados
|
duplicate_import_ids | array of string |
Si se especificaron varias transacciones, una lista de import_ids que no se crearon debido a un existente |
|
Conocimiento del servidor
|
server_knowledge | integer |
Conocimientos del servidor. |
Data16
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Detalle de la transacción
|
transaction | TransactionDetail |
Data17
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Identificadores de transacción
|
transaction_ids | array of string |
Lista de identificadores de transacción importados. |
Data18
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Masivo
|
bulk | Bulk |
Data19
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
scheduled_transactions
|
scheduled_transactions | array of ScheduledTransactionDetail | |
|
Conocimiento del servidor
|
server_knowledge | integer |
Conocimientos del servidor. |
Data20
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Detalles de la transacción programada
|
scheduled_transaction | ScheduledTransactionDetail |
Data21
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
meses
|
months | array of MonthSummary | |
|
Conocimiento del servidor
|
server_knowledge | integer |
Conocimientos del servidor. |
Data22
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Detalle del mes
|
month | MonthDetail |
FlagColor
FlagColor1
Frecuencia
GoalType
El tipo de objetivo, si la categoría tiene un objetivo (TB='Saldo de categoría objetivo', TBD='Saldo de categoría de destino por fecha', MF='Monthly Funding', NEED='Plan Your Spending')
El tipo de objetivo, si la categoría tiene un objetivo (TB='Saldo de categoría objetivo', TBD='Saldo de categoría de destino por fecha', MF='Monthly Funding', NEED='Plan Your Spending')
- Tipo de objetivo
- string
Tipo
Tipo de cuenta. Nota: PayPal, merchantAccount, investmentAccount y los tipos de hipoteca han quedado en desuso y se eliminarán en el futuro.
Tipo de cuenta. Nota: PayPal, merchantAccount, investmentAccount y los tipos de hipoteca han quedado en desuso y se eliminarán en el futuro.
- Tipo
- string
Type3
Si la transacción híbrida representa una transacción normal o una subtransacción
Si la transacción híbrida representa una transacción normal o una subtransacción
- Type3
- string