Partager via

Vous avez besoin d’un budget (éditeur indépendant)

Vous avez besoin d’un budget (YNAB) vous permet de créer une application personnelle pour interagir avec votre propre budget ou créer une application que tout autre YNABer peut autoriser et utiliser.

Ce connecteur est disponible dans les produits et régions suivants :

Service classe Régions
Copilot Studio Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Applications logiques Norme Toutes les régions Logic Apps , à l’exception des suivantes :
     - Régions Azure Government
     - Régions Azure Chine
     - Us Department of Defense (DoD)
Power Apps Premium Toutes les régions Power Apps , à l’exception des suivantes :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Power Automate Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Contact
Nom Troy Taylor
URL https://www.hitachisolutions.com
Messagerie électronique ttaylor@hitachisolutions.com
Métadonnées du connecteur
Éditeur Troy Taylor
Site internet https://www.youneedabudget.com/
Politique de confidentialité https://www.youneedabudget.com/privacy-policy/
Catégories Finances

Création d’une connexion

Le connecteur prend en charge les types d’authentification suivants :
Par défaut Paramètres de création de connexion. Toutes les régions Non partageable

Faire défaut

Applicable : Toutes les régions

Paramètres de création de connexion.

Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.

Nom Type Descriptif Obligatoire
Jeton d’accès (sous la forme « Bearer AccessToken ») securestring Jeton d’accès (sous la forme « Bearer AccessToken ») pour cette API Vrai

Limitations

Nom Appels Période de renouvellement
Appels d’API par connexion 100 60 secondes

Actions

Catégorie de mois de mise à jour

Mettez à jour une catégorie pour un mois spécifique. Seul budgeted le montant peut être mis à jour.
Créer des transactions en bloc

Crée plusieurs transactions. Bien que ce point de terminaison soit toujours pris en charge, il est recommandé d’utiliser « POST /budgets/{budget_id}/transactions » pour créer plusieurs transactions.
Créer le compte

Crée un compte.
Créer une transaction

Crée une transaction unique ou plusieurs transactions. Si vous fournissez un corps contenant un transaction objet, une transaction unique est créée et si vous fournissez un corps contenant un transactions tableau, plusieurs transactions seront créées. Les transactions planifiées ne peuvent pas être créées sur ce point de terminaison.
Importer des transactions

Importe les transactions disponibles sur tous les comptes liés pour le budget donné. Les comptes liés permettent aux transactions d’être importées directement à partir d’une institution financière spécifiée et ce point de terminaison lance cette importation. L’envoi d’une demande à ce point de terminaison équivaut à cliquer sur « Importer » sur chaque compte de l’application web ou en appuyant sur la bannière « Nouvelles transactions » dans les applications mobiles. La réponse de ce point de terminaison contient les ID de transaction qui ont été importés.
Mettre à jour la transaction

Met à jour une transaction unique.
Mettre à jour les transactions

Met à jour plusieurs transactions, par id ou import_id.
Obtenir des budgets

Retourne la liste des budgets avec des informations récapitulatives.
Obtenir des catégories

Retourne toutes les catégories regroupées par groupe de catégories. Les montants (budgétaire, activité, solde, etc.) sont spécifiques au mois budgétaire actuel (UTC).
Obtenir des comptes

Retourne tous les comptes.
Obtenir des emplacements de bénéficiaire par bénéficiaire

Retourne tous les emplacements du bénéficiaire pour un bénéficiaire spécifié.
Obtenir des mois de budget

Retourne tous les mois de budget.
Obtenir des salaires

Retourne tous les salaires.
Obtenir des transactions

Retourne des transactions budgétaires.
Obtenir des transactions par bénéficiaire

Retourne toutes les transactions pour un bénéficiaire spécifié.
Obtenir des transactions par catégorie

Retourne toutes les transactions pour une catégorie spécifiée.
Obtenir des transactions par compte

Retourne toutes les transactions pour un compte spécifié.
Obtenir des transactions planifiées

Retourne toutes les transactions planifiées.
Obtenir la catégorie mois par ID

Retourne une catégorie unique pour un mois budgétaire spécifique. Les montants (budgétaire, activité, solde, etc.) sont spécifiques au mois budgétaire actuel (UTC).
Obtenir la catégorie par ID

Retourne une seule catégorie. Les montants (budgétaire, activité, solde, etc.) sont spécifiques au mois budgétaire actuel (UTC).
Obtenir la transaction par ID

Retourne une transaction unique.
Obtenir la transaction planifiée par ID

Retourne une transaction planifiée unique.
Obtenir le budget par ID

Retourne un budget unique avec toutes les entités associées. Cette ressource est effectivement une exportation budgétaire complète.
Obtenir le mois budgétaire

Retourne un mois budgétaire unique.
Obtenir le paiement par ID

Retourne un seul bénéficiaire.
Obtenir les emplacements du bénéficiaire

Retourne tous les emplacements du bénéficiaire.
Obtenir les paramètres de budget par ID

Retourne les paramètres d’un budget
Obtenir l’emplacement du bénéficiaire par ID

Retourne un emplacement de bénéficiaire unique.
Obtenir un compte par ID

Retourne un seul compte.
Obtenir un utilisateur

Retourne des informations utilisateur authentifiées.

Catégorie de mois de mise à jour

ID d’opération :
UpdateMonthCategory

Mettez à jour une catégorie pour un mois spécifique. Seul budgeted le montant peut être mis à jour.

Paramètres

Nom Clé Obligatoire Type Description
Budget ID
 budget_id True string

Identificateur du budget. « last-used » peut être utilisé pour spécifier le dernier budget utilisé et « default » peut être utilisé si la sélection du budget par défaut est activée (voir : https://api.youneedabudget.com/#oauth-default-budget).
Mois
 month True date

Mois budgétaire au format ISO (par exemple, 2016-12-01). (« actuel » peut également être utilisé pour spécifier le mois calendrier actuel (UTC))
ID de catégorie
 category_id True string

Identificateur de la catégorie.
Budgétisé
 budgeted True integer

Montant budgété au format milliunits.

Retours

Enregistrer la réponse de catégorie
SaveCategoryResponse

Créer des transactions en bloc

ID d’opération :
BulkCreateTransactions

Crée plusieurs transactions. Bien que ce point de terminaison soit toujours pris en charge, il est recommandé d’utiliser « POST /budgets/{budget_id}/transactions » pour créer plusieurs transactions.

Paramètres

Nom Clé Obligatoire Type Description
Budget ID
 budget_id True string

Identificateur du budget. « last-used » peut être utilisé pour spécifier le dernier budget utilisé et « default » peut être utilisé si la sélection du budget par défaut est activée (voir : https://api.youneedabudget.com/#oauth-default-budget).
ID de compte
 account_id True string

Identificateur de compte.
Date
 date True date

Date de transaction au format ISO (par exemple, 2016-12-01). Les dates futures (transactions planifiées) ne sont pas autorisées. Les dates de transaction fractionnées ne peuvent pas être modifiées et si une date différente est fournie, elle sera ignorée.
Montant
 amount True integer

Quantité de transaction au format milliunits. Les montants des transactions fractionnées ne peuvent pas être modifiés et si un montant différent est fourni, il sera ignoré.
ID du bénéficiaire
 payee_id uuid

Bénéficiaire de la transaction. Pour créer un transfert entre deux comptes, utilisez le bénéficiaire de transfert de compte pointant vers le compte cible. Les payes de transfert de compte sont spécifiées comme transfer_payee_id sur la ressource de compte.
Bénéficiaire
 payee_name string

Nom du bénéficiaire. Si une payee_name valeur est fournie et payee_id a une valeur Null, la payee_name valeur est utilisée pour résoudre le bénéficiaire par l’un ou l’autre (1) d’une règle de renommage de bénéficiaire correspondante (uniquement si import_id elle est également spécifiée) ou (2) un bénéficiaire portant le même nom ou (3) création d’un nouveau bénéficiaire.
ID de catégorie
 category_id uuid

Catégorie de la transaction. Pour configurer une transaction fractionnée, vous pouvez spécifier null pour category_id et fournir un subtransactions tableau dans le cadre de l’objet transactionnel. Si une transaction existante est un fractionnement, la category_id transaction ne peut pas être modifiée. Les catégories de paiement par carte de crédit ne sont pas autorisées et seront ignorées si elles sont fournies.
Mémo
 memo string

Mémo.
Désactivé
 cleared string

État effacé de la transaction.
Approuvé
approved boolean

Indique si la transaction est approuvée ou non. Si elle n’est pas fournie, la transaction n’est pas approuvée par défaut.
Couleur de l’indicateur
 flag_color string

Indicateur de transaction.
ID d’importation
 import_id string

Si elle est spécifiée, la nouvelle transaction est affectée import_id et considérée comme « importée ». Nous tenterons également de faire correspondre cette transaction importée à une transaction « entrée par l’utilisateur » existante sur le même compte, avec le même montant et avec une date +/-10 jours à partir de la date de transaction importée.

Les transactions importées via l’importation basée sur des fichiers ou l’importation directe (pas via l’API) sont affectées à un import_id au format : « YNAB :[milliunit_amount] :[iso_date] :[occurrence] ». Par exemple, une transaction datant de 2015-12-30 au montant de -294,23 USD aurait un import_id de « YNAB :-294230:2015-12-30:1 ». Si une deuxième transaction sur le même compte a été importée et avait la même date et le même montant, son import_id serait « YNAB :-294230:2015-12-30:2 ». L’utilisation d’un format cohérent empêche les doublons via l’importation directe et l’importation basée sur des fichiers.

Si import_id est omis ou spécifié comme null, la transaction est traitée comme une transaction « entrée par l’utilisateur ». Par conséquent, il sera éligible pour être mis en correspondance par rapport aux transactions importées ultérieurement (via DI, FBI ou API).
Montant
 amount True integer

Quantité de sous-transaction au format milliunits.
ID du bénéficiaire
 payee_id uuid

Bénéficiaire de la sous-transaction.
Bénéficiaire
 payee_name string

Nom du bénéficiaire. Si une payee_name valeur est fournie et payee_id a une valeur Null, la payee_name valeur est utilisée pour résoudre le bénéficiaire par l’un ou l’autre (1) d’une règle de renommage de bénéficiaire correspondante (uniquement si import_id est également spécifié sur la transaction parente) ou (2) un bénéficiaire portant le même nom ou (3) création d’un nouveau bénéficiaire.
ID de catégorie
 category_id uuid

Catégorie de la sous-transaction. Les catégories de paiement par carte de crédit ne sont pas autorisées et seront ignorées si elles sont fournies.
Mémo
 memo string

Mémo.

Retours

Réponse en bloc
BulkResponse

Créer le compte

ID d’opération :
CreateAccount

Crée un compte.

Paramètres

Nom Clé Obligatoire Type Description
Budget ID
 budget_id True string

L’identificateur du budget (« dernier utilisé » peut être utilisé pour spécifier le dernier budget utilisé et « par défaut » peut être utilisé si la sélection budgétaire par défaut est activée (voir : https://api.youneedabudget.com/#oauth-default-budget)
Nom
 name True string

Nom du compte.
Type2
 type True string

Type de compte
Solde
 balance True integer

Solde actuel du compte au format milliunits.

Retours

Réponse du compte
AccountResponse

Créer une transaction

ID d’opération :
CreateTransaction

Crée une transaction unique ou plusieurs transactions. Si vous fournissez un corps contenant un transaction objet, une transaction unique est créée et si vous fournissez un corps contenant un transactions tableau, plusieurs transactions seront créées. Les transactions planifiées ne peuvent pas être créées sur ce point de terminaison.

Paramètres

Nom Clé Obligatoire Type Description
Budget ID
 budget_id True string

Identificateur du budget. « last-used » peut être utilisé pour spécifier le dernier budget utilisé et « default » peut être utilisé si la sélection du budget par défaut est activée (voir : https://api.youneedabudget.com/#oauth-default-budget).
ID de compte
 account_id True string

Identificateur de compte.
Date
 date True date

Date de transaction au format ISO (par exemple, 2016-12-01). Les dates futures (transactions planifiées) ne sont pas autorisées. Les dates de transaction fractionnées ne peuvent pas être modifiées et si une date différente est fournie, elle sera ignorée.
Montant
 amount True integer

Quantité de transaction au format milliunits. Les montants des transactions fractionnées ne peuvent pas être modifiés et si un montant différent est fourni, il sera ignoré.
ID du bénéficiaire
 payee_id uuid

Bénéficiaire de la transaction. Pour créer un transfert entre deux comptes, utilisez le bénéficiaire de transfert de compte pointant vers le compte cible. Les payes de transfert de compte sont spécifiées comme transfer_payee_id sur la ressource de compte.
Bénéficiaire
 payee_name string

Nom du bénéficiaire. Si une payee_name valeur est fournie et payee_id a une valeur Null, la payee_name valeur est utilisée pour résoudre le bénéficiaire par l’un ou l’autre (1) d’une règle de renommage de bénéficiaire correspondante (uniquement si import_id elle est également spécifiée) ou (2) un bénéficiaire portant le même nom ou (3) création d’un nouveau bénéficiaire.
ID de catégorie
 category_id uuid

Catégorie de la transaction. Pour configurer une transaction fractionnée, vous pouvez spécifier null pour category_id et fournir un subtransactions tableau dans le cadre de l’objet transactionnel. Si une transaction existante est un fractionnement, la category_id transaction ne peut pas être modifiée. Les catégories de paiement par carte de crédit ne sont pas autorisées et seront ignorées si elles sont fournies.
Mémo
 memo string

Mémo.
Désactivé
 cleared string

État effacé de la transaction.
Approuvé
approved boolean

Indique si la transaction est approuvée ou non. Si elle n’est pas fournie, la transaction n’est pas approuvée par défaut.
Couleur de l’indicateur
 flag_color string

Indicateur de transaction.
ID d’importation
 import_id string

Si elle est spécifiée, la nouvelle transaction est affectée import_id et considérée comme « importée ». Nous tenterons également de faire correspondre cette transaction importée à une transaction « entrée par l’utilisateur » existante sur le même compte, avec le même montant et avec une date +/-10 jours à partir de la date de transaction importée.

Les transactions importées via l’importation basée sur des fichiers ou l’importation directe (pas via l’API) sont affectées à un import_id au format : « YNAB :[milliunit_amount] :[iso_date] :[occurrence] ». Par exemple, une transaction datant de 2015-12-30 au montant de -294,23 USD aurait un import_id de « YNAB :-294230:2015-12-30:1 ». Si une deuxième transaction sur le même compte a été importée et avait la même date et le même montant, son import_id serait « YNAB :-294230:2015-12-30:2 ». L’utilisation d’un format cohérent empêche les doublons via l’importation directe et l’importation basée sur des fichiers.

Si import_id est omis ou spécifié comme null, la transaction est traitée comme une transaction « entrée par l’utilisateur ». Par conséquent, il sera éligible pour être mis en correspondance par rapport aux transactions importées ultérieurement (via DI, FBI ou API).
Montant
 amount True integer

Quantité de sous-transaction au format milliunits.
ID du bénéficiaire
 payee_id uuid

Bénéficiaire de la sous-transaction.
Bénéficiaire
 payee_name string

Nom du bénéficiaire. Si une payee_name valeur est fournie et payee_id a une valeur Null, la payee_name valeur est utilisée pour résoudre le bénéficiaire par l’un ou l’autre (1) d’une règle de renommage de bénéficiaire correspondante (uniquement si import_id est également spécifié sur la transaction parente) ou (2) un bénéficiaire portant le même nom ou (3) création d’un nouveau bénéficiaire.
ID de catégorie
 category_id uuid

Catégorie de la sous-transaction. Les catégories de paiement par carte de crédit ne sont pas autorisées et seront ignorées si elles sont fournies.
Mémo
 memo string

Mémo.
ID de compte
 account_id True string

Identificateur de compte.
Date
 date True date

Date de transaction au format ISO (par exemple, 2016-12-01). Les dates futures (transactions planifiées) ne sont pas autorisées. Les dates de transaction fractionnées ne peuvent pas être modifiées et si une date différente est fournie, elle sera ignorée.
Montant
 amount True integer

Quantité de transaction au format milliunits. Les montants des transactions fractionnées ne peuvent pas être modifiés et si un montant différent est fourni, il sera ignoré.
ID du bénéficiaire
 payee_id uuid

Bénéficiaire de la transaction. Pour créer un transfert entre deux comptes, utilisez le bénéficiaire de transfert de compte pointant vers le compte cible. Les payes de transfert de compte sont spécifiées comme transfer_payee_id sur la ressource de compte.
Bénéficiaire
 payee_name string

Nom du bénéficiaire. Si une payee_name valeur est fournie et payee_id a une valeur Null, la payee_name valeur est utilisée pour résoudre le bénéficiaire par l’un ou l’autre (1) d’une règle de renommage de bénéficiaire correspondante (uniquement si import_id elle est également spécifiée) ou (2) un bénéficiaire portant le même nom ou (3) création d’un nouveau bénéficiaire.
ID de catégorie
 category_id uuid

Catégorie de la transaction. Pour configurer une transaction fractionnée, vous pouvez spécifier null pour category_id et fournir un subtransactions tableau dans le cadre de l’objet transactionnel. Si une transaction existante est un fractionnement, la category_id transaction ne peut pas être modifiée. Les catégories de paiement par carte de crédit ne sont pas autorisées et seront ignorées si elles sont fournies.
Mémo
 memo string

Mémo.
Désactivé
 cleared string

État effacé de la transaction.
Approuvé
approved boolean

Indique si la transaction est approuvée ou non. Si elle n’est pas fournie, la transaction n’est pas approuvée par défaut.
Couleur de l’indicateur
 flag_color string

Indicateur de transaction.
ID d’importation
 import_id string

Si elle est spécifiée, la nouvelle transaction est affectée import_id et considérée comme « importée ». Nous tenterons également de faire correspondre cette transaction importée à une transaction « entrée par l’utilisateur » existante sur le même compte, avec le même montant et avec une date +/-10 jours à partir de la date de transaction importée.

Les transactions importées via l’importation basée sur des fichiers ou l’importation directe (pas via l’API) sont affectées à un import_id au format : « YNAB :[milliunit_amount] :[iso_date] :[occurrence] ». Par exemple, une transaction datant de 2015-12-30 au montant de -294,23 USD aurait un import_id de « YNAB :-294230:2015-12-30:1 ». Si une deuxième transaction sur le même compte a été importée et avait la même date et le même montant, son import_id serait « YNAB :-294230:2015-12-30:2 ». L’utilisation d’un format cohérent empêche les doublons via l’importation directe et l’importation basée sur des fichiers.

Si import_id est omis ou spécifié comme null, la transaction est traitée comme une transaction « entrée par l’utilisateur ». Par conséquent, il sera éligible pour être mis en correspondance par rapport aux transactions importées ultérieurement (via DI, FBI ou API).
Montant
 amount True integer

Quantité de sous-transaction au format milliunits.
ID du bénéficiaire
 payee_id uuid

Bénéficiaire de la sous-transaction.
Bénéficiaire
 payee_name string

Nom du bénéficiaire. Si une payee_name valeur est fournie et payee_id a une valeur Null, la payee_name valeur est utilisée pour résoudre le bénéficiaire par l’un ou l’autre (1) d’une règle de renommage de bénéficiaire correspondante (uniquement si import_id est également spécifié sur la transaction parente) ou (2) un bénéficiaire portant le même nom ou (3) création d’un nouveau bénéficiaire.
ID de catégorie
 category_id uuid

Catégorie de la sous-transaction. Les catégories de paiement par carte de crédit ne sont pas autorisées et seront ignorées si elles sont fournies.
Mémo
 memo string

Mémo.

Retours

Enregistrer la réponse aux transactions
SaveTransactionsResponse

Importer des transactions

ID d’opération :
ImportTransactions

Importe les transactions disponibles sur tous les comptes liés pour le budget donné. Les comptes liés permettent aux transactions d’être importées directement à partir d’une institution financière spécifiée et ce point de terminaison lance cette importation. L’envoi d’une demande à ce point de terminaison équivaut à cliquer sur « Importer » sur chaque compte de l’application web ou en appuyant sur la bannière « Nouvelles transactions » dans les applications mobiles. La réponse de ce point de terminaison contient les ID de transaction qui ont été importés.

Paramètres

Nom Clé Obligatoire Type Description
Budget ID
 budget_id True string

Identificateur du budget. « last-used » peut être utilisé pour spécifier le dernier budget utilisé et « default » peut être utilisé si la sélection du budget par défaut est activée (voir : https://api.youneedabudget.com/#oauth-default-budget).

Retours

Réponse à l’importation des transactions
TransactionsImportResponse

Mettre à jour la transaction

ID d’opération :
UpdateTransaction

Met à jour une transaction unique.

Paramètres

Nom Clé Obligatoire Type Description
Budget ID
 budget_id True string

Identificateur du budget. « last-used » peut être utilisé pour spécifier le dernier budget utilisé et « default » peut être utilisé si la sélection du budget par défaut est activée (voir : https://api.youneedabudget.com/#oauth-default-budget).
Transaction ID
 transaction_id True string

Identificateur de la transaction.
ID de compte
 account_id True string

Identificateur de compte.
Date
 date True date

Date de transaction au format ISO (par exemple, 2016-12-01). Les dates futures (transactions planifiées) ne sont pas autorisées. Les dates de transaction fractionnées ne peuvent pas être modifiées et si une date différente est fournie, elle sera ignorée.
Montant
 amount True integer

Quantité de transaction au format milliunits. Les montants des transactions fractionnées ne peuvent pas être modifiés et si un montant différent est fourni, il sera ignoré.
ID du bénéficiaire
 payee_id uuid

Bénéficiaire de la transaction. Pour créer un transfert entre deux comptes, utilisez le bénéficiaire de transfert de compte pointant vers le compte cible. Les payes de transfert de compte sont spécifiées comme transfer_payee_id sur la ressource de compte.
Bénéficiaire
 payee_name string

Nom du bénéficiaire. Si une payee_name valeur est fournie et payee_id a une valeur Null, la payee_name valeur est utilisée pour résoudre le bénéficiaire par l’un ou l’autre (1) d’une règle de renommage de bénéficiaire correspondante (uniquement si import_id elle est également spécifiée) ou (2) un bénéficiaire portant le même nom ou (3) création d’un nouveau bénéficiaire.
ID de catégorie
 category_id uuid

Catégorie de la transaction. Pour configurer une transaction fractionnée, vous pouvez spécifier null pour category_id et fournir un subtransactions tableau dans le cadre de l’objet transactionnel. Si une transaction existante est un fractionnement, la category_id transaction ne peut pas être modifiée. Les catégories de paiement par carte de crédit ne sont pas autorisées et seront ignorées si elles sont fournies.
Mémo
 memo string

Mémo.
Désactivé
 cleared string

État effacé de la transaction.
Approuvé
approved boolean

Indique si la transaction est approuvée ou non. Si elle n’est pas fournie, la transaction n’est pas approuvée par défaut.
Couleur de l’indicateur
 flag_color string

Indicateur de transaction.
ID d’importation
 import_id string

Si elle est spécifiée, la nouvelle transaction est affectée import_id et considérée comme « importée ». Nous tenterons également de faire correspondre cette transaction importée à une transaction « entrée par l’utilisateur » existante sur le même compte, avec le même montant et avec une date +/-10 jours à partir de la date de transaction importée.

Les transactions importées via l’importation basée sur des fichiers ou l’importation directe (pas via l’API) sont affectées à un import_id au format : « YNAB :[milliunit_amount] :[iso_date] :[occurrence] ». Par exemple, une transaction datant de 2015-12-30 au montant de -294,23 USD aurait un import_id de « YNAB :-294230:2015-12-30:1 ». Si une deuxième transaction sur le même compte a été importée et avait la même date et le même montant, son import_id serait « YNAB :-294230:2015-12-30:2 ». L’utilisation d’un format cohérent empêche les doublons via l’importation directe et l’importation basée sur des fichiers.

Si import_id est omis ou spécifié comme null, la transaction est traitée comme une transaction « entrée par l’utilisateur ». Par conséquent, il sera éligible pour être mis en correspondance par rapport aux transactions importées ultérieurement (via DI, FBI ou API).
Montant
 amount True integer

Quantité de sous-transaction au format milliunits.
ID du bénéficiaire
 payee_id uuid

Bénéficiaire de la sous-transaction.
Bénéficiaire
 payee_name string

Nom du bénéficiaire. Si une payee_name valeur est fournie et payee_id a une valeur Null, la payee_name valeur est utilisée pour résoudre le bénéficiaire par l’un ou l’autre (1) d’une règle de renommage de bénéficiaire correspondante (uniquement si import_id est également spécifié sur la transaction parente) ou (2) un bénéficiaire portant le même nom ou (3) création d’un nouveau bénéficiaire.
ID de catégorie
 category_id uuid

Catégorie de la sous-transaction. Les catégories de paiement par carte de crédit ne sont pas autorisées et seront ignorées si elles sont fournies.
Mémo
 memo string

Mémo.

Retours

Réponse de transaction
TransactionResponse

Mettre à jour les transactions

ID d’opération :
UpdateTransactions

Met à jour plusieurs transactions, par id ou import_id.

Paramètres

Nom Clé Obligatoire Type Description
Budget ID
 budget_id True string

Identificateur du budget. « last-used » peut être utilisé pour spécifier le dernier budget utilisé et « default » peut être utilisé si la sélection du budget par défaut est activée (voir : https://api.youneedabudget.com/#oauth-default-budget).
ID
 id True string

Identificateur.
ID de compte
 account_id True string

Identificateur de compte.
Date
 date True date

Date de transaction au format ISO (par exemple, 2016-12-01). Les dates futures (transactions planifiées) ne sont pas autorisées. Les dates de transaction fractionnées ne peuvent pas être modifiées et si une date différente est fournie, elle sera ignorée.
Montant
 amount True integer

Quantité de transaction au format milliunits. Les montants des transactions fractionnées ne peuvent pas être modifiés et si un montant différent est fourni, il sera ignoré.
ID du bénéficiaire
 payee_id uuid

Bénéficiaire de la transaction. Pour créer un transfert entre deux comptes, utilisez le bénéficiaire de transfert de compte pointant vers le compte cible. Les payes de transfert de compte sont spécifiées comme transfer_payee_id sur la ressource de compte.
Bénéficiaire
 payee_name string

Nom du bénéficiaire. Si une payee_name valeur est fournie et payee_id a une valeur Null, la payee_name valeur est utilisée pour résoudre le bénéficiaire par l’un ou l’autre (1) d’une règle de renommage de bénéficiaire correspondante (uniquement si import_id elle est également spécifiée) ou (2) un bénéficiaire portant le même nom ou (3) création d’un nouveau bénéficiaire.
ID de catégorie
 category_id uuid

Catégorie de la transaction. Pour configurer une transaction fractionnée, vous pouvez spécifier null pour category_id et fournir un subtransactions tableau dans le cadre de l’objet transactionnel. Si une transaction existante est un fractionnement, la category_id transaction ne peut pas être modifiée. Les catégories de paiement par carte de crédit ne sont pas autorisées et seront ignorées si elles sont fournies.
Mémo
 memo string

Mémo.
Désactivé
 cleared string

État effacé de la transaction.
Approuvé
approved boolean

Indique si la transaction est approuvée ou non. Si elle n’est pas fournie, la transaction n’est pas approuvée par défaut.
Couleur de l’indicateur
 flag_color string

Indicateur de transaction.
ID d’importation
 import_id string

Si elle est spécifiée, la nouvelle transaction est affectée import_id et considérée comme « importée ». Nous tenterons également de faire correspondre cette transaction importée à une transaction « entrée par l’utilisateur » existante sur le même compte, avec le même montant et avec une date +/-10 jours à partir de la date de transaction importée.

Les transactions importées via l’importation basée sur des fichiers ou l’importation directe (pas via l’API) sont affectées à un import_id au format : « YNAB :[milliunit_amount] :[iso_date] :[occurrence] ». Par exemple, une transaction datant de 2015-12-30 au montant de -294,23 USD aurait un import_id de « YNAB :-294230:2015-12-30:1 ». Si une deuxième transaction sur le même compte a été importée et avait la même date et le même montant, son import_id serait « YNAB :-294230:2015-12-30:2 ». L’utilisation d’un format cohérent empêche les doublons via l’importation directe et l’importation basée sur des fichiers.

Si import_id est omis ou spécifié comme null, la transaction est traitée comme une transaction « entrée par l’utilisateur ». Par conséquent, il sera éligible pour être mis en correspondance par rapport aux transactions importées ultérieurement (via DI, FBI ou API).
Montant
 amount True integer

Quantité de sous-transaction au format milliunits.
ID du bénéficiaire
 payee_id uuid

Bénéficiaire de la sous-transaction.
Bénéficiaire
 payee_name string

Nom du bénéficiaire. Si une payee_name valeur est fournie et payee_id a une valeur Null, la payee_name valeur est utilisée pour résoudre le bénéficiaire par l’un ou l’autre (1) d’une règle de renommage de bénéficiaire correspondante (uniquement si import_id est également spécifié sur la transaction parente) ou (2) un bénéficiaire portant le même nom ou (3) création d’un nouveau bénéficiaire.
ID de catégorie
 category_id uuid

Catégorie de la sous-transaction. Les catégories de paiement par carte de crédit ne sont pas autorisées et seront ignorées si elles sont fournies.
Mémo
 memo string

Mémo.

Retours

Enregistrer la réponse aux transactions
SaveTransactionsResponse

Obtenir des budgets

ID d’opération :
GetBudgets

Retourne la liste des budgets avec des informations récapitulatives.

Paramètres

Nom Clé Obligatoire Type Description
Inclure des comptes
 include_accounts boolean

Indique s’il faut inclure la liste des comptes budgétaires.

Retours

Réponse récapitulative du budget
BudgetSummaryResponse

Obtenir des catégories

ID d’opération :
GetCategories

Retourne toutes les catégories regroupées par groupe de catégories. Les montants (budgétaire, activité, solde, etc.) sont spécifiques au mois budgétaire actuel (UTC).

Paramètres

Nom Clé Obligatoire Type Description
Budget ID
 budget_id True string

Identificateur du budget. « last-used » peut être utilisé pour spécifier le dernier budget utilisé et « default » peut être utilisé si la sélection du budget par défaut est activée (voir : https://api.youneedabudget.com/#oauth-default-budget).
Dernière connaissance du serveur
 last_knowledge_of_server integer

Connaissances du serveur de démarrage. Si elle est fournie, seules les entités qui ont changé depuis last_knowledge_of_server seront incluses.

Retours

Réponse aux catégories
CategoriesResponse

Obtenir des comptes

ID d’opération :
GetAccounts

Retourne tous les comptes.

Paramètres

Nom Clé Obligatoire Type Description
Budget ID
 budget_id True string

Identificateur du budget. « last-used » peut être utilisé pour spécifier le dernier budget utilisé et « default » peut être utilisé si la sélection du budget par défaut est activée (voir : https://api.youneedabudget.com/#oauth-default-budget).
Dernière connaissance du serveur
 last_knowledge_of_server integer

Connaissances du serveur de démarrage. Si elle est fournie, seules les entités qui ont changé depuis last_knowledge_of_server seront incluses.

Retours

Réponse aux comptes
AccountsResponse

Obtenir des emplacements de bénéficiaire par bénéficiaire

ID d’opération :
GetPayeeLocationsByPayee

Retourne tous les emplacements du bénéficiaire pour un bénéficiaire spécifié.

Paramètres

Nom Clé Obligatoire Type Description
Budget ID
 budget_id True string

Identificateur du budget. « last-used » peut être utilisé pour spécifier le dernier budget utilisé et « default » peut être utilisé si la sélection du budget par défaut est activée (voir : https://api.youneedabudget.com/#oauth-default-budget).
ID du bénéficiaire
 payee_id True string

Identificateur du bénéficiaire.

Retours

Réponse aux emplacements payee
PayeeLocationsResponse

Obtenir des mois de budget

ID d’opération :
GetBudgetMonths

Retourne tous les mois de budget.

Paramètres

Nom Clé Obligatoire Type Description
Budget ID
 budget_id True string

Identificateur du budget. « last-used » peut être utilisé pour spécifier le dernier budget utilisé et « default » peut être utilisé si la sélection du budget par défaut est activée (voir : https://api.youneedabudget.com/#oauth-default-budget).
Dernière connaissance du serveur
 last_knowledge_of_server integer

Connaissances du serveur de démarrage. Si elle est fournie, seules les entités qui ont changé depuis last_knowledge_of_server seront incluses.

Retours

Réponse des résumés de mois
MonthSummariesResponse

Obtenir des salaires

ID d’opération :
GetPayees

Retourne tous les salaires.

Paramètres

Nom Clé Obligatoire Type Description
Budget ID
 budget_id True string

Identificateur du budget. « last-used » peut être utilisé pour spécifier le dernier budget utilisé et « default » peut être utilisé si la sélection du budget par défaut est activée (voir : https://api.youneedabudget.com/#oauth-default-budget).
Dernière connaissance du serveur
 last_knowledge_of_server integer

Connaissances du serveur de démarrage. Si elle est fournie, seules les entités qui ont changé depuis last_knowledge_of_server seront incluses.

Retours

Réponse de payees
PayeesResponse

Obtenir des transactions

ID d’opération :
GetTransactions

Retourne des transactions budgétaires.

Paramètres

Nom Clé Obligatoire Type Description
Budget ID
 budget_id True string

Identificateur du budget. « last-used » peut être utilisé pour spécifier le dernier budget utilisé et « default » peut être utilisé si la sélection du budget par défaut est activée (voir : https://api.youneedabudget.com/#oauth-default-budget).
Date depuis
 since_date date

Si elle est spécifiée, seules les transactions effectuées à cette date ou après cette date seront incluses. La date doit être mise en forme ISO (par exemple, 2016-12-30).
Type
 type string

Si elle est spécifiée, seules les transactions du type spécifié sont incluses. Les options « non classées » et « non approuvées » sont actuellement prises en charge.
Dernière connaissance du serveur
 last_knowledge_of_server integer

Connaissances du serveur de démarrage. Si elle est fournie, seules les entités qui ont changé depuis last_knowledge_of_server seront incluses.

Retours

Réponse aux transactions
TransactionsResponse

Obtenir des transactions par bénéficiaire

ID d’opération :
GetTransactionsByPayee

Retourne toutes les transactions pour un bénéficiaire spécifié.

Paramètres

Nom Clé Obligatoire Type Description
Budget ID
 budget_id True string

Identificateur du budget. « last-used » peut être utilisé pour spécifier le dernier budget utilisé et « default » peut être utilisé si la sélection du budget par défaut est activée (voir : https://api.youneedabudget.com/#oauth-default-budget).
ID du bénéficiaire
 payee_id True string

Identificateur du bénéficiaire.
Date depuis
 since_date date

Si elle est spécifiée, seules les transactions effectuées à cette date ou après cette date seront incluses. La date doit être mise en forme ISO (par exemple, 2016-12-30).
Type
 type string

Si elle est spécifiée, seules les transactions du type spécifié sont incluses. Les options « non classées » et « non approuvées » sont actuellement prises en charge.
Dernière connaissance du serveur
 last_knowledge_of_server integer

Connaissances du serveur de démarrage. Si elle est fournie, seules les entités qui ont changé depuis last_knowledge_of_server seront incluses.

Retours

Réponse aux transactions hybrides
HybridTransactionsResponse

Obtenir des transactions par catégorie

ID d’opération :
GetTransactionsByCategory

Retourne toutes les transactions pour une catégorie spécifiée.

Paramètres

Nom Clé Obligatoire Type Description
Budget ID
 budget_id True string

Identificateur du budget. « last-used » peut être utilisé pour spécifier le dernier budget utilisé et « default » peut être utilisé si la sélection du budget par défaut est activée (voir : https://api.youneedabudget.com/#oauth-default-budget).
ID de catégorie
 category_id True string

Identificateur de la catégorie.
Date depuis
 since_date date

Si elle est spécifiée, seules les transactions effectuées à cette date ou après cette date seront incluses. La date doit être mise en forme ISO (par exemple, 2016-12-30).
Type
 type string

Si elle est spécifiée, seules les transactions du type spécifié sont incluses. Les options « non classées » et « non approuvées » sont actuellement prises en charge.
Dernière connaissance du serveur
 last_knowledge_of_server integer

Connaissances du serveur de démarrage. Si elle est fournie, seules les entités qui ont changé depuis last_knowledge_of_server seront incluses.

Retours

Réponse aux transactions hybrides
HybridTransactionsResponse

Obtenir des transactions par compte

ID d’opération :
GetTransactionsByAccount

Retourne toutes les transactions pour un compte spécifié.

Paramètres

Nom Clé Obligatoire Type Description
Budget ID
 budget_id True string

Identificateur du budget. « last-used » peut être utilisé pour spécifier le dernier budget utilisé et « default » peut être utilisé si la sélection du budget par défaut est activée (voir : https://api.youneedabudget.com/#oauth-default-budget).
ID de compte
 account_id True string

Identificateur du compte.
Date depuis
 since_date date

Si elle est spécifiée, seules les transactions effectuées à cette date ou après cette date seront incluses. La date doit être mise en forme ISO (par exemple, 2016-12-30).
Type
 type string

Si elle est spécifiée, seules les transactions du type spécifié sont incluses. Les options « non classées » et « non approuvées » sont actuellement prises en charge.
Dernière connaissance du serveur
 last_knowledge_of_server integer

Connaissances du serveur de démarrage. Si elle est fournie, seules les entités qui ont changé depuis last_knowledge_of_server seront incluses.

Retours

Réponse aux transactions
TransactionsResponse

Obtenir des transactions planifiées

ID d’opération :
GetScheduledTransactions

Retourne toutes les transactions planifiées.

Paramètres

Nom Clé Obligatoire Type Description
Budget ID
 budget_id True string

Identificateur du budget. « last-used » peut être utilisé pour spécifier le dernier budget utilisé et « default » peut être utilisé si la sélection du budget par défaut est activée (voir : https://api.youneedabudget.com/#oauth-default-budget).
Dernière connaissance du serveur
 last_knowledge_of_server integer

Connaissances du serveur de démarrage. Si elle est fournie, seules les entités qui ont changé depuis last_knowledge_of_server seront incluses.

Retours

Réponse aux transactions planifiées
ScheduledTransactionsResponse

Obtenir la catégorie mois par ID

ID d’opération :
GetMonthCategoryById

Retourne une catégorie unique pour un mois budgétaire spécifique. Les montants (budgétaire, activité, solde, etc.) sont spécifiques au mois budgétaire actuel (UTC).

Paramètres

Nom Clé Obligatoire Type Description
Budget ID
 budget_id True string

Identificateur du budget. « last-used » peut être utilisé pour spécifier le dernier budget utilisé et « default » peut être utilisé si la sélection du budget par défaut est activée (voir : https://api.youneedabudget.com/#oauth-default-budget).
Mois
 month True date

Mois budgétaire au format ISO (par exemple, 2016-12-01). (« actuel » peut également être utilisé pour spécifier le mois calendrier actuel (UTC))
ID de catégorie
 category_id True string

Identificateur de la catégorie.

Retours

Réponse de catégorie
CategoryResponse

Obtenir la catégorie par ID

ID d’opération :
GetCategoryById

Retourne une seule catégorie. Les montants (budgétaire, activité, solde, etc.) sont spécifiques au mois budgétaire actuel (UTC).

Paramètres

Nom Clé Obligatoire Type Description
Budget ID
 budget_id True string

Identificateur du budget. « last-used » peut être utilisé pour spécifier le dernier budget utilisé et « default » peut être utilisé si la sélection du budget par défaut est activée (voir : https://api.youneedabudget.com/#oauth-default-budget).
ID de catégorie
 category_id True string

Identificateur de la catégorie.

Retours

Réponse de catégorie
CategoryResponse

Obtenir la transaction par ID

ID d’opération :
GetTransactionById

Retourne une transaction unique.

Paramètres

Nom Clé Obligatoire Type Description
Budget ID
 budget_id True string

Identificateur du budget. « last-used » peut être utilisé pour spécifier le dernier budget utilisé et « default » peut être utilisé si la sélection du budget par défaut est activée (voir : https://api.youneedabudget.com/#oauth-default-budget).
Transaction ID
 transaction_id True string

Identificateur de la transaction.

Retours

Réponse de transaction
TransactionResponse

Obtenir la transaction planifiée par ID

ID d’opération :
GetScheduledTransactionById

Retourne une transaction planifiée unique.

Paramètres

Nom Clé Obligatoire Type Description
Budget ID
 budget_id True string

Identificateur du budget. « last-used » peut être utilisé pour spécifier le dernier budget utilisé et « default » peut être utilisé si la sélection du budget par défaut est activée (voir : https://api.youneedabudget.com/#oauth-default-budget).
ID de transaction planifié
 scheduled_transaction_id True string

Identificateur de la transaction planifiée.

Retours

Réponse de transaction planifiée
ScheduledTransactionResponse

Obtenir le budget par ID

ID d’opération :
GetBudgetById

Retourne un budget unique avec toutes les entités associées. Cette ressource est effectivement une exportation budgétaire complète.

Paramètres

Nom Clé Obligatoire Type Description
Budget ID
 budget_id True string

Identificateur du budget.
Dernière connaissance du serveur
 last_knowledge_of_server integer

Connaissances du serveur de démarrage. Si elle est fournie, seules les entités qui ont changé depuis last_knowledge_of_server seront incluses.

Retours

Réponse détaillée du budget
BudgetDetailResponse

Obtenir le mois budgétaire

ID d’opération :
GetBudgetMonth

Retourne un mois budgétaire unique.

Paramètres

Nom Clé Obligatoire Type Description
Budget ID
 budget_id True string

Identificateur du budget. « last-used » peut être utilisé pour spécifier le dernier budget utilisé et « default » peut être utilisé si la sélection du budget par défaut est activée (voir : https://api.youneedabudget.com/#oauth-default-budget).
Mois
 month True date

Mois budgétaire au format ISO (par exemple, 2016-12-01). (« actuel » peut également être utilisé pour spécifier le mois calendrier actuel (UTC))

Retours

Réponse de détail du mois
MonthDetailResponse

Obtenir le paiement par ID

ID d’opération :
GetPayeeById

Retourne un seul bénéficiaire.

Paramètres

Nom Clé Obligatoire Type Description
Budget ID
 budget_id True string

Identificateur du budget. « last-used » peut être utilisé pour spécifier le dernier budget utilisé et « default » peut être utilisé si la sélection du budget par défaut est activée (voir : https://api.youneedabudget.com/#oauth-default-budget).
ID du bénéficiaire
 payee_id True string

Identificateur du bénéficiaire.

Retours

Réponse payee
PayeeResponse

Obtenir les emplacements du bénéficiaire

ID d’opération :
GetPayeeLocations

Retourne tous les emplacements du bénéficiaire.

Paramètres

Nom Clé Obligatoire Type Description
Budget ID
 budget_id True string

Identificateur du budget. « last-used » peut être utilisé pour spécifier le dernier budget utilisé et « default » peut être utilisé si la sélection du budget par défaut est activée (voir : https://api.youneedabudget.com/#oauth-default-budget).

Retours

Réponse aux emplacements payee
PayeeLocationsResponse

Obtenir les paramètres de budget par ID

ID d’opération :
GetBudgetSettingsById

Retourne les paramètres d’un budget

Paramètres

Nom Clé Obligatoire Type Description
Budget ID
 budget_id True string

Identificateur du budget. « last-used » peut être utilisé pour spécifier le dernier budget utilisé et « default » peut être utilisé si la sélection du budget par défaut est activée (voir : https://api.youneedabudget.com/#oauth-default-budget).

Retours

Réponse aux paramètres budgétaires
BudgetSettingsResponse

Obtenir l’emplacement du bénéficiaire par ID

ID d’opération :
GetPayeeLocationById

Retourne un emplacement de bénéficiaire unique.

Paramètres

Nom Clé Obligatoire Type Description
Budget ID
 budget_id True string

Identificateur du budget. « last-used » peut être utilisé pour spécifier le dernier budget utilisé et « default » peut être utilisé si la sélection du budget par défaut est activée (voir : https://api.youneedabudget.com/#oauth-default-budget).
ID d’emplacement du payee
 payee_location_id True string

Identificateur de l’emplacement du bénéficiaire.

Retours

Réponse à l’emplacement payee
PayeeLocationResponse

Obtenir un compte par ID

ID d’opération :
GetAccountById

Retourne un seul compte.

Paramètres

Nom Clé Obligatoire Type Description
Budget ID
 budget_id True string

Identificateur du budget. « last-used » peut être utilisé pour spécifier le dernier budget utilisé et « default » peut être utilisé si la sélection du budget par défaut est activée (voir : https://api.youneedabudget.com/#oauth-default-budget).
ID de compte
 account_id True uuid

Identificateur du compte.

Retours

Réponse du compte
AccountResponse

Obtenir un utilisateur

ID d’opération :
GetUser

Retourne des informations utilisateur authentifiées.

Retours

Réponse de l'utilisateur
UserResponse

Définitions

UserResponse

Nom Chemin d’accès Type Description
Data
 data Data

Utilisateur

Nom Chemin d’accès Type Description
ID
 id string

Identificateur.

DateFormat

Paramètre de format de date pour le budget. Dans certains cas, le format ne sera pas disponible et sera spécifié comme null.

Nom Chemin d’accès Type Description
Format
 format string

Format.

CurrencyFormat

Paramètre de format monétaire pour le budget. Dans certains cas, le format ne sera pas disponible et sera spécifié comme null.

Nom Chemin d’accès Type Description
ISO Code
 iso_code string

Code ISO.
Exemple de format
 example_format string

Exemple de format.
Chiffres Décimaux
 decimal_digits integer

Chiffres décimaux.
Séparateur décimal
 decimal_separator string

Séparateur décimal.
Symbole premier
 symbol_first boolean

Indique si le symbole est d’abord.
Séparateur de groupe
 group_separator string

Séparateur de groupe.
Symbole monétaire
 currency_symbol string

Symbole monétaire.
Symbole affiché
 display_symbol boolean

Indique si le symbole est affiché.

BudgetSummaryResponse

Nom Chemin d’accès Type Description
Data1
 data Data1

BudgetSummary

Nom Chemin d’accès Type Description
ID
 id string

Identificateur.
Nom
 name string

Nom.
Dernière modification sur
 last_modified_on date-time

La dernière fois que des modifications ont été apportées au budget à partir d’un client web ou mobile.
Premier mois
 first_month date

Le mois budgétaire le plus tôt.
Mois dernier
 last_month date

Le dernier mois budgétaire.
Date Format
 date_format DateFormat

Paramètre de format de date pour le budget. Dans certains cas, le format ne sera pas disponible et sera spécifié comme null.
Format monétaire
 currency_format CurrencyFormat

Paramètre de format monétaire pour le budget. Dans certains cas, le format ne sera pas disponible et sera spécifié comme null.
Accounts
 accounts array of Account

Les comptes de budget (inclus uniquement s’ils include_accounts=true sont spécifiés en tant que paramètre de requête).

BudgetDetailResponse

Nom Chemin d’accès Type Description
Data2
 data Data2

BudgetDetail

Nom Chemin d’accès Type Description
ID
 id string

Identificateur.
Nom
 name string

Nom.
Dernière modification sur
 last_modified_on date-time

La dernière fois que des modifications ont été apportées au budget à partir d’un client web ou mobile.
Premier mois
 first_month date

Le mois budgétaire le plus tôt.
Mois dernier
 last_month date

Le dernier mois budgétaire.
Date Format
 date_format DateFormat

Paramètre de format de date pour le budget. Dans certains cas, le format ne sera pas disponible et sera spécifié comme null.
Format monétaire
 currency_format CurrencyFormat

Paramètre de format monétaire pour le budget. Dans certains cas, le format ne sera pas disponible et sera spécifié comme null.
Accounts
 accounts array of Account

Les comptes de budget (inclus uniquement s’ils include_accounts=true sont spécifiés en tant que paramètre de requête).
Bénéficiaires
 payees array of Payee
Emplacements du bénéficiaire
 payee_locations array of PayeeLocation
Groupes de catégories
 category_groups array of CategoryGroup
Catégories
 categories array of Category
Mois
 months array of MonthDetail
Transactions
 transactions array of TransactionSummary
Sous-transactions
 subtransactions array of SubTransaction
Transactions planifiées
 scheduled_transactions array of ScheduledTransactionSummary
Sous-transactions planifiées
 scheduled_subtransactions array of ScheduledSubTransaction

BudgetSettingsResponse

Nom Chemin d’accès Type Description
Data3
 data Data3

BudgetSettings

Nom Chemin d’accès Type Description
Date Format
 date_format DateFormat

Paramètre de format de date pour le budget. Dans certains cas, le format ne sera pas disponible et sera spécifié comme null.
Format monétaire
 currency_format CurrencyFormat

Paramètre de format monétaire pour le budget. Dans certains cas, le format ne sera pas disponible et sera spécifié comme null.

AccountsResponse

Nom Chemin d’accès Type Description
Data4
 data Data4

AccountResponse

Nom Chemin d’accès Type Description
Data5
 data Data5

Compte

Nom Chemin d’accès Type Description
ID
 id string

Identificateur.
Nom
 name string

Nom.
Type
 type Type

Type de compte. Remarque : PayPal, merchantAccount, investmentAccount et les types d’hypothèques ont été déconseillés et seront supprimés à l’avenir.
Sur le budget
 on_budget boolean

Indique si ce compte est sur le budget ou non
Fermé
 closed boolean

Indique si ce compte est fermé ou non
Note
 note string

Remarque.
Solde
 balance integer

Solde actuel du compte au format milliunits.
Solde effacé
 cleared_balance integer

Solde actuel effacé du compte au format milliunits.
Solde non clair
 uncleared_balance integer

Solde actuel flou du compte au format milliunits.
ID du bénéficiaire de transfert
 transfer_payee_id string

Identificateur du bénéficiaire qui doit être utilisé lors du transfert vers ce compte.
Importation directe liée
 direct_import_linked boolean

Indique si le compte est lié à une institution financière pour l’importation automatique des transactions.
Importation directe en erreur
 direct_import_in_error boolean

Si un compte lié à une institution financière (direct_import_linked=true) et que la connexion liée n’est pas dans un état sain, cela sera vrai.
Supprimé
 deleted boolean

Indique si le compte a été supprimé ou non. Les comptes supprimés ne seront inclus que dans les requêtes delta.

CategoriesResponse

Nom Chemin d’accès Type Description
Data6
 data Data6

CategoryResponse

Nom Chemin d’accès Type Description
Data7
 data Data7

CategoryGroupWithCategories

Nom Chemin d’accès Type Description
ID
 id string

Identificateur.
Nom
 name string

Nom.
Caché
 hidden boolean

Indique si le groupe de catégories est masqué ou non.
Supprimé
 deleted boolean

Indique si le groupe de catégories a été supprimé ou non. Les groupes de catégories supprimés ne seront inclus que dans les requêtes delta.
Catégories
 categories array of Category

Catégories de groupes de catégories. Les montants (budgétaire, activité, solde, etc.) sont spécifiques au mois budgétaire actuel (UTC).

CategoryGroup

Nom Chemin d’accès Type Description
ID
 id string

Identificateur.
Nom
 name string

Nom.
Caché
 hidden boolean

Indique si le groupe de catégories est masqué ou non.
Supprimé
 deleted boolean

Indique si le groupe de catégories a été supprimé ou non. Les groupes de catégories supprimés ne seront inclus que dans les requêtes delta.

Catégorie

Nom Chemin d’accès Type Description
ID
 id string

Identificateur.
ID de groupe de catégories
 category_group_id string

Identificateur du groupe de catégories.
Nom
 name string

Nom.
Caché
 hidden boolean

Indique si la catégorie est masquée ou non.
ID de groupe de catégorie d’origine
 original_category_group_id uuid

Si la catégorie est masquée, il s’agit de l’identificateur du groupe de catégories auquel elle appartient à l’origine avant qu’elle ne soit masquée.
Note
 note string

Remarque.
Budgétisé
 budgeted integer

Montant budgété au format milliunits.
Activity
 activity integer

Quantité d’activité au format milliunits.
Solde
 balance integer

Équilibrez au format milliunits.
Type d’objectif
 goal_type GoalType

Type d’objectif, si la catégorie a un objectif (TB='Target Category Balance', TBD='Target Category Balance by Date', MF='Monthly Funding', NEED='Plan Your Dépense')
Mois de création d’objectifs
 goal_creation_month date

Le mois où un objectif a été créé.
Cible de l’objectif
 goal_target integer

Valeur cible de l’objectif en milliunits.
Mois cible de l’objectif
 goal_target_month date

Mois cible d’origine pour que l’objectif soit terminé. Seuls certains types d’objectifs spécifient cette date.
Pourcentage d’objectif terminé
 goal_percentage_complete integer

Pourcentage d’achèvement de l’objectif.
Mois d’objectif pour le budget
 goal_months_to_budget integer

Nombre de mois, y compris le mois en cours, laissé dans la période d’objectif actuelle.
Objectif en vertu du financement
 goal_under_funded integer

Le montant du financement restant nécessaire au cours du mois en cours pour suivre l’atteinte de l’objectif au cours de la période d’objectif actuelle. Ce montant correspond généralement au montant « Sous-financé » dans les clients web et mobiles, sauf lors de l’affichage d’une catégorie avec un objectif de dépense nécessaire pour un mois à venir. Les clients web et mobiles ignorent tout financement d’une période d’objectif antérieure lors de l’affichage d’une catégorie avec un objectif de dépense nécessaire au cours d’un mois à venir.
Objectif global financé
 goal_overall_funded integer

Montant total financé à l’égard de l’objectif au cours de la période d’objectif actuelle.
Objectif global gauche
 goal_overall_left integer

Le montant du financement restant nécessaire pour atteindre l’objectif au cours de la période d’objectif actuelle.
Supprimé
 deleted boolean

Indique si la catégorie a été supprimée ou non. Les catégories supprimées ne seront incluses que dans les requêtes delta.

SaveCategoryResponse

Nom Chemin d’accès Type Description
Data8
 data Data8

PayeesResponse

Nom Chemin d’accès Type Description
Data9
 data Data9

PayeeResponse

Nom Chemin d’accès Type Description
Data10
 data Data10

Bénéficiaire

Nom Chemin d’accès Type Description
ID
 id string

Identificateur.
Nom
 name string

Nom.
ID du compte de transfert
 transfer_account_id string

S’il s’agit d’un bénéficiaire de transfert, account_id auquel ce bénéficiaire transfère.
Supprimé
 deleted boolean

Indique si le bénéficiaire a été supprimé ou non. Les payes supprimées ne seront incluses que dans les requêtes delta.

PayeeLocationsResponse

Nom Chemin d’accès Type Description
Data11
 data Data11

PayeeLocationResponse

Nom Chemin d’accès Type Description
Data12
 data Data12

PayeeLocation

Nom Chemin d’accès Type Description
ID
 id string

Identificateur.
ID du bénéficiaire
 payee_id string

Identificateur du bénéficiaire.
Latitude
 latitude string

Latitude.
Longitude
 longitude string

Longitude.
Supprimé
 deleted boolean

Indique si l’emplacement du bénéficiaire a été supprimé ou non. Les emplacements de bénéficiaire supprimés ne seront inclus que dans les requêtes delta.

TransactionsResponse

Nom Chemin d’accès Type Description
Données13
 data Data13

HybridTransactionsResponse

Nom Chemin d’accès Type Description
Données14
 data Data14

SaveTransactionsResponse

Nom Chemin d’accès Type Description
Données15
 data Data15

TransactionResponse

Nom Chemin d’accès Type Description
Data16
 data Data16

TransactionSummary

Nom Chemin d’accès Type Description
ID
 id string

Identificateur.
Date
 date date

Date de transaction au format ISO (par exemple, 2016-12-01).
Montant
 amount integer

Quantité de transaction au format milliunits.
Mémo
 memo string

Mémo.
Désactivé
 cleared Cleared

État effacé de la transaction.
Approuvé
approved boolean

Indique si la transaction est approuvée ou non.
Couleur de l’indicateur
 flag_color FlagColor

Indicateur de transaction.
ID de compte
 account_id string

Identificateur de compte.
ID du bénéficiaire
 payee_id string

Identificateur du bénéficiaire.
ID de catégorie
 category_id string

Identificateur de catégorie.
ID du compte de transfert
 transfer_account_id uuid

S’il s’agit d’une transaction de transfert, le compte vers lequel il transfère.
ID de transaction de transfert
 transfer_transaction_id string

S’il s’agit d’une transaction de transfert, identificateur de transaction de l’autre côté du transfert.
ID de transaction correspondant
 matched_transaction_id string

Si la transaction est correspondante, l’identificateur de la transaction correspondante.
ID d’importation
 import_id string

Si la transaction a été importée, ce champ est un identificateur d’importation unique (par compte). Si cette transaction a été importée via l’importation basée sur les fichiers ou l’importation directe et non via l’API, le import_id aura le format « YNAB :[milliunit_amount] :[iso_date] :[occurrence] ». Par exemple, une transaction datant de 2015-12-30 au montant de -294,23 USD aurait un import_id de « YNAB :-294230:2015-12-30:1 ». Si une deuxième transaction sur le même compte a été importée et avait la même date et le même montant, son import_id serait « YNAB :-294230:2015-12-30:2 ».
Supprimé
 deleted boolean

Indique si la transaction a été supprimée ou non. Les transactions supprimées ne seront incluses que dans les requêtes delta.

TransactionDetail

Nom Chemin d’accès Type Description
ID
 id string

Identificateur.
Date
 date date

Date de transaction au format ISO (par exemple, 2016-12-01).
Montant
 amount integer

Quantité de transaction au format milliunits.
Mémo
 memo string

Mémo.
Désactivé
 cleared Cleared

État effacé de la transaction.
Approuvé
approved boolean

Indique si la transaction est approuvée ou non.
Couleur de l’indicateur
 flag_color FlagColor

Indicateur de transaction.
ID de compte
 account_id string

Identificateur de compte.
ID du bénéficiaire
 payee_id string

Identificateur du bénéficiaire.
ID de catégorie
 category_id string

Identificateur de catégorie.
ID du compte de transfert
 transfer_account_id uuid

S’il s’agit d’une transaction de transfert, le compte vers lequel il transfère.
ID de transaction de transfert
 transfer_transaction_id string

S’il s’agit d’une transaction de transfert, identificateur de transaction de l’autre côté du transfert.
ID de transaction correspondant
 matched_transaction_id string

Si la transaction est correspondante, l’identificateur de la transaction correspondante.
ID d’importation
 import_id string

Si la transaction a été importée, ce champ est un identificateur d’importation unique (par compte). Si cette transaction a été importée via l’importation basée sur les fichiers ou l’importation directe et non via l’API, le import_id aura le format « YNAB :[milliunit_amount] :[iso_date] :[occurrence] ». Par exemple, une transaction datant de 2015-12-30 au montant de -294,23 USD aurait un import_id de « YNAB :-294230:2015-12-30:1 ». Si une deuxième transaction sur le même compte a été importée et avait la même date et le même montant, son import_id serait « YNAB :-294230:2015-12-30:2 ».
Supprimé
 deleted boolean

Indique si la transaction a été supprimée ou non. Les transactions supprimées ne seront incluses que dans les requêtes delta.
Nom du compte
 account_name string

Nom du compte.
Bénéficiaire
 payee_name string

Nom du bénéficiaire.
Catégorie
 category_name string

Nom de la catégorie.
Sous-transactions
 subtransactions array of SubTransaction

Si une transaction fractionnée, les sous-transactions.

HybridTransaction

Nom Chemin d’accès Type Description
ID
 id string

Identificateur.
Date
 date date

Date de transaction au format ISO (par exemple, 2016-12-01).
Montant
 amount integer

Quantité de transaction au format milliunits.
Mémo
 memo string

Mémo.
Désactivé
 cleared Cleared

État effacé de la transaction.
Approuvé
approved boolean

Indique si la transaction est approuvée ou non.
Couleur de l’indicateur
 flag_color FlagColor

Indicateur de transaction.
ID de compte
 account_id string

Identificateur de compte.
ID du bénéficiaire
 payee_id string

Identificateur du bénéficiaire.
ID de catégorie
 category_id string

Identificateur de catégorie.
ID du compte de transfert
 transfer_account_id uuid

S’il s’agit d’une transaction de transfert, le compte vers lequel il transfère.
ID de transaction de transfert
 transfer_transaction_id string

S’il s’agit d’une transaction de transfert, identificateur de transaction de l’autre côté du transfert.
ID de transaction correspondant
 matched_transaction_id string

Si la transaction est correspondante, l’identificateur de la transaction correspondante.
ID d’importation
 import_id string

Si la transaction a été importée, ce champ est un identificateur d’importation unique (par compte). Si cette transaction a été importée via l’importation basée sur les fichiers ou l’importation directe et non via l’API, le import_id aura le format « YNAB :[milliunit_amount] :[iso_date] :[occurrence] ». Par exemple, une transaction datant de 2015-12-30 au montant de -294,23 USD aurait un import_id de « YNAB :-294230:2015-12-30:1 ». Si une deuxième transaction sur le même compte a été importée et avait la même date et le même montant, son import_id serait « YNAB :-294230:2015-12-30:2 ».
Supprimé
 deleted boolean

Indique si la transaction a été supprimée ou non. Les transactions supprimées ne seront incluses que dans les requêtes delta.
Type3
 type Type3

Indique si la transaction hybride représente une transaction régulière ou une sous-transaction
Parent Transaction ID
 parent_transaction_id string

Pour les types de sous-transactions, il s’agit de l’identificateur de la transaction parente. Pour les types de transactions, cet identificateur sera toujours null.
Nom du compte
 account_name string

Nom du compte.
Bénéficiaire
 payee_name string

Nom du bénéficiaire.
Catégorie
 category_name string

Nom de la catégorie.

TransactionsImportResponse

Nom Chemin d’accès Type Description
Données17
 data Data17

BulkResponse

Nom Chemin d’accès Type Description
Data18
 data Data18

Sous-transaction

Nom Chemin d’accès Type Description
ID
 id string

Identificateur.
Transaction ID
 transaction_id string

Transaction.
Montant
 amount integer

Quantité de sous-transaction au format milliunits.
Mémo
 memo string

Mémo.
ID du bénéficiaire
 payee_id string

Identificateur du bénéficiaire.
Bénéficiaire
 payee_name string

Nom du bénéficiaire.
ID de catégorie
 category_id string

Identificateur de catégorie.
Catégorie
 category_name string

Nom de la catégorie.
ID du compte de transfert
 transfer_account_id uuid

S’il s’agit d’un transfert, le account_id vers lequel la sous-transaction est transférée.
ID de transaction de transfert
 transfer_transaction_id string

S’il s’agit d’un transfert, identificateur de transaction de l’autre côté du transfert.
Supprimé
 deleted boolean

Indique si la sous-transaction a été supprimée ou non. Les sous-transactions supprimées ne seront incluses que dans les requêtes delta.

ScheduledTransactionsResponse

Nom Chemin d’accès Type Description
Données19
 data Data19

ScheduledTransactionResponse

Nom Chemin d’accès Type Description
Data20
 data Data20

ScheduledTransactionSummary

Nom Chemin d’accès Type Description
ID
 id string

Identificateur.
Première date
 date_first date

La première date pour laquelle la transaction planifiée a été planifiée.
Date suivante
 date_next date

Date suivante pour laquelle la transaction planifiée est planifiée.
Fréquence
 frequency Frequency

Fréquence.
Montant
 amount integer

Quantité de transaction planifiée au format milliunits.
Mémo
 memo string

Mémo.
FlagColor1
 flag_color FlagColor1

Indicateur de transaction planifié.
ID de compte
 account_id string

Identificateur de compte.
ID du bénéficiaire
 payee_id string

Identificateur du bénéficiaire.
ID de catégorie
 category_id string

Identificateur de catégorie.
ID du compte de transfert
 transfer_account_id uuid

S’il s’agit d’un transfert, le account_id vers lequel la transaction planifiée est transférée.
Supprimé
 deleted boolean

Indique si la transaction planifiée a été supprimée ou non. Les transactions planifiées supprimées ne seront incluses que dans les requêtes delta.

ScheduledTransactionDetail

Nom Chemin d’accès Type Description
ID
 id string

Identificateur.
Première date
 date_first date

La première date pour laquelle la transaction planifiée a été planifiée.
Date suivante
 date_next date

Date suivante pour laquelle la transaction planifiée est planifiée.
Fréquence
 frequency Frequency

Fréquence.
Montant
 amount integer

Quantité de transaction planifiée au format milliunits.
Mémo
 memo string

Mémo.
FlagColor1
 flag_color FlagColor1

Indicateur de transaction planifié.
ID de compte
 account_id string

Identificateur de compte.
ID du bénéficiaire
 payee_id string

Identificateur du bénéficiaire.
ID de catégorie
 category_id string

Identificateur de catégorie.
ID du compte de transfert
 transfer_account_id uuid

S’il s’agit d’un transfert, le account_id vers lequel la transaction planifiée est transférée.
Supprimé
 deleted boolean

Indique si la transaction planifiée a été supprimée ou non. Les transactions planifiées supprimées ne seront incluses que dans les requêtes delta.
Nom du compte
 account_name string

Nom du compte.
Bénéficiaire
 payee_name string

Nom du bénéficiaire.
Catégorie
 category_name string

Nom de la catégorie.
sous-transactions
 subtransactions array of ScheduledSubTransaction

Si une transaction planifiée fractionnée, les sous-transactions.

ScheduledSubTransaction

Nom Chemin d’accès Type Description
ID
 id string

Identificateur.
ID de transaction planifié
 scheduled_transaction_id string

Identificateur de transaction planifié.
Montant
 amount integer

Quantité de sous-transaction planifiée au format milliunits.
Mémo
 memo string

Mémo.
ID du bénéficiaire
 payee_id string

Identificateur du bénéficiaire.
ID de catégorie
 category_id string

Identificateur de catégorie.
ID du compte de transfert
 transfer_account_id uuid

S’il s’agit d’un transfert, le account_id vers lequel la sous-transaction planifiée est transférée.
Supprimé
 deleted boolean

Indique si la sous-transaction planifiée a été supprimée ou non. Les sous-transactions planifiées supprimées ne seront incluses que dans les requêtes delta.

MonthSummariesResponse

Nom Chemin d’accès Type Description
Data21
 data Data21

MonthDetailResponse

Nom Chemin d’accès Type Description
Data22
 data Data22

MonthSummary

Nom Chemin d’accès Type Description
Mois
 month date

Mois.
Note
 note string

Remarque.
Revenu
 income integer

Montant total des transactions classées en « Flux : Prêt à affecter » au cours du mois.
Budgétisé
 budgeted integer

Montant total budgété dans le mois.
Activity
 activity integer

Montant total des transactions au cours du mois, à l’exclusion de celles classées en « Flux : Prêt à affecter ».
Pour être budgété
 to_be_budgeted integer

Montant disponible pour « Prêt à affecter ».
Âge de l’argent
 age_of_money integer

L’âge de l’argent à partir du mois.
Supprimé
 deleted boolean

Indique si le mois a été supprimé ou non. Les mois supprimés ne seront inclus que dans les requêtes delta.

MonthDetail

Nom Chemin d’accès Type Description
Mois
 month date

Mois.
Note
 note string

Remarque.
Revenu
 income integer

Montant total des transactions classées en « Flux : Prêt à affecter » au cours du mois.
Budgétisé
 budgeted integer

Montant total budgété dans le mois.
Activity
 activity integer

Montant total des transactions au cours du mois, à l’exclusion de celles classées en « Flux : Prêt à affecter ».
Pour être budgété
 to_be_budgeted integer

Montant disponible pour « Prêt à affecter ».
Âge de l’argent
 age_of_money integer

L’âge de l’argent à partir du mois.
Supprimé
 deleted boolean

Indique si le mois a été supprimé ou non. Les mois supprimés ne seront inclus que dans les requêtes delta.
Catégories
 categories array of Category

Catégories du mois budgétaire. Les montants (budgétaire, activité, solde, etc.) sont spécifiques au paramètre {month} spécifié.

Courrier en nombre

Nom Chemin d’accès Type Description
ID de transaction
 transaction_ids array of string

Liste des ID de transaction qui ont été créés.
ID d’importation en double
 duplicate_import_ids array of string

Si des transactions n’ont pas été créées, car elles avaient déjà une import_id transaction correspondante sur le même compte, les import_id(s) spécifiées seront incluses dans cette liste.

Désactivé

État effacé de la transaction.

État effacé de la transaction.

Désactivé
string

Data

Nom Chemin d’accès Type Description
Utilisateur
 user User

Data1

Nom Chemin d’accès Type Description
Budgets
 budgets array of BudgetSummary
Résumé du budget
 default_budget BudgetSummary

Data2

Nom Chemin d’accès Type Description
Détail du budget
 budget BudgetDetail
Connaissances du serveur
 server_knowledge integer

Connaissance du serveur.

Data3

Nom Chemin d’accès Type Description
Paramètres budgétaires
 settings BudgetSettings

Data4

Nom Chemin d’accès Type Description
Accounts
 accounts array of Account
Connaissances du serveur
 server_knowledge integer

Connaissance du serveur.

Data5

Nom Chemin d’accès Type Description
Compte
 account Account

Data6

Nom Chemin d’accès Type Description
Groupes de catégories
 category_groups array of CategoryGroupWithCategories

Groupes de catégories.
Connaissances du serveur
 server_knowledge integer

Connaissance du serveur.

Data7

Nom Chemin d’accès Type Description
Catégorie
 category Category

Data8

Nom Chemin d’accès Type Description
Catégorie
 category Category
Connaissances du serveur
 server_knowledge integer

Connaissance du serveur.

Data9

Nom Chemin d’accès Type Description
Bénéficiaires
 payees array of Payee

Les payes.
Connaissances du serveur
 server_knowledge integer

Connaissance du serveur.

Data10

Nom Chemin d’accès Type Description
Bénéficiaire
 payee Payee

Data11

Nom Chemin d’accès Type Description
Emplacements du bénéficiaire
 payee_locations array of PayeeLocation

Emplacements du bénéficiaire.

Data12

Nom Chemin d’accès Type Description
Emplacement du bénéficiaire
 payee_location PayeeLocation

Données13

Nom Chemin d’accès Type Description
Transactions
 transactions array of TransactionDetail

Transactions.
Connaissances du serveur
 server_knowledge integer

Connaissance du serveur.

Données14

Nom Chemin d’accès Type Description
Transactions
 transactions array of HybridTransaction

Transactions.

Données15

Nom Chemin d’accès Type Description
ID de transaction
 transaction_ids array of string

ID de transaction enregistrés.
Détail de la transaction
 transaction TransactionDetail
transactions
 transactions array of TransactionDetail

Si plusieurs transactions ont été spécifiées, les transactions enregistrées.
ID d’importation en double
 duplicate_import_ids array of string

Si plusieurs transactions ont été spécifiées, une liste de import_ids qui n’ont pas été créées en raison d’un existant import_id trouvé sur le même compte.
Connaissances du serveur
 server_knowledge integer

Connaissance du serveur.

Data16

Nom Chemin d’accès Type Description
Détail de la transaction
 transaction TransactionDetail

Données17

Nom Chemin d’accès Type Description
ID de transaction
 transaction_ids array of string

Liste des ID de transaction importés.

Data18

Nom Chemin d’accès Type Description
Courrier en nombre
 bulk Bulk

Données19

Nom Chemin d’accès Type Description
scheduled_transactions
 scheduled_transactions array of ScheduledTransactionDetail
Connaissances du serveur
 server_knowledge integer

Connaissance du serveur.

Data20

Nom Chemin d’accès Type Description
Détail de la transaction planifiée
 scheduled_transaction ScheduledTransactionDetail

Data21

Nom Chemin d’accès Type Description
Mois
 months array of MonthSummary
Connaissances du serveur
 server_knowledge integer

Connaissance du serveur.

Data22

Nom Chemin d’accès Type Description
Détail du mois
 month MonthDetail

FlagColor

Indicateur de transaction.

Indicateur de transaction.

Couleur de l’indicateur
string

FlagColor1

Indicateur de transaction planifié.

Indicateur de transaction planifié.

FlagColor1
string

Fréquence

Fréquence.

Fréquence.

Fréquence
string

GoalType

Type d’objectif, si la catégorie a un objectif (TB='Target Category Balance', TBD='Target Category Balance by Date', MF='Monthly Funding', NEED='Plan Your Dépense')

Type d’objectif, si la catégorie a un objectif (TB='Target Category Balance', TBD='Target Category Balance by Date', MF='Monthly Funding', NEED='Plan Your Dépense')

Type d’objectif
string

Type

Type de compte. Remarque : PayPal, merchantAccount, investmentAccount et les types d’hypothèques ont été déconseillés et seront supprimés à l’avenir.

Type de compte. Remarque : PayPal, merchantAccount, investmentAccount et les types d’hypothèques ont été déconseillés et seront supprimés à l’avenir.

Type
string

Type3

Indique si la transaction hybride représente une transaction régulière ou une sous-transaction

Indique si la transaction hybride représente une transaction régulière ou une sous-transaction

Type3
string