Partilhar via

Você precisa de um orçamento (Editora independente)

You Need A Budget (YNAB) permite que você crie um aplicativo pessoal para interagir com seu próprio orçamento ou construir um aplicativo que qualquer outro YNABer pode autorizar e usar.

Este conector está disponível nos seguintes produtos e regiões:

Serviço Class Regiões
Estúdio Copiloto Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas Standard Todas as regiões do Logic Apps , exceto as seguintes:
     - Regiões do Azure Government
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Aplicações Power Premium Todas as regiões do Power Apps , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Automatize o poder Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Troia Taylor
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Metadados do conector
Editora Troia Taylor
Sítio Web https://www.youneedabudget.com/
Política de privacidade https://www.youneedabudget.com/privacy-policy/
Categorias Finance

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:
Predefinição Parâmetros para criar conexão. Todas as regiões Não compartilhável

Padrão

Aplicável: Todas as regiões

Parâmetros para criar conexão.

Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome Tipo Description Obrigatório
Token de acesso (no formato 'Bearer AccessToken) securestring O Token de Acesso (no formato 'Bearer AccessToken) para esta api Verdade

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de API por conexão 100 60 segundos

Ações

Atualizar transação

Atualiza uma única transação.
Atualizar transações

Atualiza várias transações, por id ou import_id.
Categoria do mês de atualização

Atualizar uma categoria para um mês específico. Apenas budgeted o valor pode ser atualizado.
Criar conta

Cria uma nova conta.
Criar transação

Cria uma única transação ou várias transações. Se você fornecer um corpo contendo um transaction objeto, uma única transação será criada e, se você fornecer um corpo contendo uma transactions matriz, várias transações serão criadas. As transações agendadas não podem ser criadas neste ponto de extremidade.
Criar transações em massa

Cria várias transações. Embora este ponto de extremidade ainda seja suportado, recomenda-se usar 'POST /budgets/{budget_id}/transactions' para criar várias transações.
Obter a localização do beneficiário por ID

Devolve uma única localização do beneficiário.
Obter beneficiário por ID

Devolve um único beneficiário.
Obter beneficiários

Devolve todos os beneficiários.
Obter categoria de mês por ID

Devolve uma única categoria para um mês orçamental específico. Os montantes (orçamentados, atividade, saldo, etc.) são específicos do mês orçamental corrente (UTC).
Obter categoria por ID

Devolve uma única categoria. Os montantes (orçamentados, atividade, saldo, etc.) são específicos do mês orçamental corrente (UTC).
Obter categorias

Retorna todas as categorias agrupadas por grupo de categorias. Os montantes (orçamentados, atividade, saldo, etc.) são específicos do mês orçamental corrente (UTC).
Obter configurações de orçamento por ID

Devolve definições para um orçamento
Obter conta por ID

Devolve uma única conta.
Obter contas

Devolve todas as contas.
Obter localizações de beneficiários

Devolve todas as localizações dos beneficiários.
Obter localizações de beneficiários por beneficiário

Devolve todas as localizações do beneficiário para um beneficiário especificado.
Obter meses de orçamento

Devolve todos os meses orçamentados.
Obter orçamento do mês

Devolve um único mês orçamental.
Obter orçamento por ID

Devolve um único orçamento com todas as entidades relacionadas. Este recurso é efetivamente uma exportação de orçamento completo.
Obter orçamentos

Devolve a lista de orçamentos com informações resumidas.
Obter transação agendada por ID

Retorna uma única transação agendada.
Obter transação por ID

Devolve uma única transação.
Obter transações

Retorna transações de orçamento.
Obter transações agendadas

Retorna todas as transações agendadas.
Obter transações por beneficiário

Devolve todas as transações de um beneficiário especificado.
Obter transações por categoria

Retorna todas as transações de uma categoria especificada.
Obter transações por conta

Devolve todas as transações de uma conta especificada.
Obter utilizador

Retorna informações autenticadas do usuário.
Operações de importação

Importa operações disponíveis em todas as contas ligadas para o orçamento determinado. As contas vinculadas permitem que as transações sejam importadas diretamente de uma instituição financeira especificada e esse ponto de extremidade inicia essa importação. Enviar uma solicitação para este endpoint é o equivalente a clicar em "Importar" em cada conta no aplicativo web ou tocar no banner "Novas transações" nos aplicativos móveis. A resposta para este ponto de extremidade contém as ids de transação que foram importadas.

Atualizar transação

ID da Operação:
UpdateTransaction

Atualiza uma única transação.

Parâmetros

Name Chave Necessário Tipo Description
ID de orçamento
 budget_id True string

O identificador do orçamento. "Última utilização" pode ser usado para especificar o último orçamento usado e "padrão" pode ser usado se a seleção de orçamento padrão estiver habilitada (ver: https://api.youneedabudget.com/#oauth-default-budget).
ID da transação
 transaction_id True string

O identificador da transação.
ID da conta
 account_id True string

O identificador da conta.
Date
 date True date

A data da transação em formato ISO (por exemplo, 2016-12-01). Datas futuras (transações agendadas) não são permitidas. As datas de transação divididas não podem ser alteradas e, se uma data diferente for fornecida, ela será ignorada.
Montante
 amount True integer

O valor da transação em formato miliunidades. Os valores de transação divididos não podem ser alterados e, se um valor diferente for fornecido, ele será ignorado.
ID do beneficiário
 payee_id uuid

O beneficiário da transação. Para criar uma transferência entre duas contas, use o beneficiário da transferência de conta apontando para a conta de destino. Os beneficiários da transferência de conta são especificados como transfer_payee_id no recurso da conta.
Beneficiário
 payee_name string

O nome do beneficiário. Se um payee_name valor for fornecido e payee_id tiver um valor nulo, o payee_name valor será utilizado para resolver o beneficiário através de (1) uma regra de mudança de nome do beneficiário correspondente (apenas se import_id também for especificado) ou (2) um beneficiário com o mesmo nome ou (3) a criação de um novo beneficiário.
ID da categoria
 category_id uuid

A categoria para a transação. Para configurar uma transação dividida, você pode especificar null para category_id e fornecer uma subtransactions matriz como parte do objeto de transação. Se uma transação existente for uma divisão, a category_id não pode ser alterada. As categorias de pagamento com cartão de crédito não são permitidas e serão ignoradas se fornecidas.
Nota
 memo string

O memorando.
Desmarcado
 cleared string

O status de compensação da transação.
Aprovado
 approved boolean

Se a transação é aprovada ou não. Se não for fornecida, a transação não será aprovada por padrão.
Cor da bandeira
 flag_color string

O sinalizador de transação.
ID de importação
 import_id string

Se especificado, a nova transação será atribuída a este import_id e considerada "importada". Também tentaremos fazer corresponder esta transação importada a uma transação "inserida pelo usuário" existente na mesma conta, com o mesmo valor e com uma data +/-10 dias a partir da data da transação importada.

Às transações importadas através da Importação Baseada em Ficheiros ou da Importação Direta (não através da API) é atribuída uma import_id no formato: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. Por exemplo, uma transação datada de 2015-12-30 no valor de -$294.23 USD teria um import_id de 'YNAB:-294230:2015-12-30:1'. Se uma segunda transação na mesma conta fosse importada e tivesse a mesma data e o mesmo montante, o seu import_id seria «YNAB:-294230:2015-12-30:2». O uso de um formato consistente evitará duplicações por meio da Importação Direta e da Importação Baseada em Arquivo.

Se import_id for omitido ou especificado como nulo, a transação será tratada como uma transação "inserida pelo usuário". Como tal, será elegível para ser comparado com transações posteriormente importadas (via DI, FBI ou API).
Montante
 amount True integer

O valor da subtransação em formato miliunidades.
ID do beneficiário
 payee_id uuid

O beneficiário da suboperação.
Beneficiário
 payee_name string

O nome do beneficiário. Se for fornecido um payee_name valor nulo payee_id , o payee_name valor será utilizado para resolver o beneficiário através de (1) uma regra de mudança de nome correspondente do beneficiário (apenas se import_id também for especificado na transação-mãe) ou (2) um beneficiário com o mesmo nome ou (3) a criação de um novo beneficiário.
ID da categoria
 category_id uuid

A categoria para a subtransação. As categorias de pagamento com cartão de crédito não são permitidas e serão ignoradas se fornecidas.
Nota
 memo string

O memorando.

Devoluções

Resposta da transação
TransactionResponse

Atualizar transações

ID da Operação:
UpdateTransactions

Atualiza várias transações, por id ou import_id.

Parâmetros

Name Chave Necessário Tipo Description
ID de orçamento
 budget_id True string

O identificador do orçamento. "Última utilização" pode ser usado para especificar o último orçamento usado e "padrão" pode ser usado se a seleção de orçamento padrão estiver habilitada (ver: https://api.youneedabudget.com/#oauth-default-budget).
ID
 id True string

O identificador.
ID da conta
 account_id True string

O identificador da conta.
Date
 date True date

A data da transação em formato ISO (por exemplo, 2016-12-01). Datas futuras (transações agendadas) não são permitidas. As datas de transação divididas não podem ser alteradas e, se uma data diferente for fornecida, ela será ignorada.
Montante
 amount True integer

O valor da transação em formato miliunidades. Os valores de transação divididos não podem ser alterados e, se um valor diferente for fornecido, ele será ignorado.
ID do beneficiário
 payee_id uuid

O beneficiário da transação. Para criar uma transferência entre duas contas, use o beneficiário da transferência de conta apontando para a conta de destino. Os beneficiários da transferência de conta são especificados como transfer_payee_id no recurso da conta.
Beneficiário
 payee_name string

O nome do beneficiário. Se um payee_name valor for fornecido e payee_id tiver um valor nulo, o payee_name valor será utilizado para resolver o beneficiário através de (1) uma regra de mudança de nome do beneficiário correspondente (apenas se import_id também for especificado) ou (2) um beneficiário com o mesmo nome ou (3) a criação de um novo beneficiário.
ID da categoria
 category_id uuid

A categoria para a transação. Para configurar uma transação dividida, você pode especificar null para category_id e fornecer uma subtransactions matriz como parte do objeto de transação. Se uma transação existente for uma divisão, a category_id não pode ser alterada. As categorias de pagamento com cartão de crédito não são permitidas e serão ignoradas se fornecidas.
Nota
 memo string

O memorando.
Desmarcado
 cleared string

O status de compensação da transação.
Aprovado
 approved boolean

Se a transação é aprovada ou não. Se não for fornecida, a transação não será aprovada por padrão.
Cor da bandeira
 flag_color string

O sinalizador de transação.
ID de importação
 import_id string

Se especificado, a nova transação será atribuída a este import_id e considerada "importada". Também tentaremos fazer corresponder esta transação importada a uma transação "inserida pelo usuário" existente na mesma conta, com o mesmo valor e com uma data +/-10 dias a partir da data da transação importada.

Às transações importadas através da Importação Baseada em Ficheiros ou da Importação Direta (não através da API) é atribuída uma import_id no formato: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. Por exemplo, uma transação datada de 2015-12-30 no valor de -$294.23 USD teria um import_id de 'YNAB:-294230:2015-12-30:1'. Se uma segunda transação na mesma conta fosse importada e tivesse a mesma data e o mesmo montante, o seu import_id seria «YNAB:-294230:2015-12-30:2». O uso de um formato consistente evitará duplicações por meio da Importação Direta e da Importação Baseada em Arquivo.

Se import_id for omitido ou especificado como nulo, a transação será tratada como uma transação "inserida pelo usuário". Como tal, será elegível para ser comparado com transações posteriormente importadas (via DI, FBI ou API).
Montante
 amount True integer

O valor da subtransação em formato miliunidades.
ID do beneficiário
 payee_id uuid

O beneficiário da suboperação.
Beneficiário
 payee_name string

O nome do beneficiário. Se for fornecido um payee_name valor nulo payee_id , o payee_name valor será utilizado para resolver o beneficiário através de (1) uma regra de mudança de nome correspondente do beneficiário (apenas se import_id também for especificado na transação-mãe) ou (2) um beneficiário com o mesmo nome ou (3) a criação de um novo beneficiário.
ID da categoria
 category_id uuid

A categoria para a subtransação. As categorias de pagamento com cartão de crédito não são permitidas e serão ignoradas se fornecidas.
Nota
 memo string

O memorando.

Devoluções

Salvar resposta de transações
SaveTransactionsResponse

Categoria do mês de atualização

ID da Operação:
UpdateMonthCategory

Atualizar uma categoria para um mês específico. Apenas budgeted o valor pode ser atualizado.

Parâmetros

Name Chave Necessário Tipo Description
ID de orçamento
 budget_id True string

O identificador do orçamento. "Última utilização" pode ser usado para especificar o último orçamento usado e "padrão" pode ser usado se a seleção de orçamento padrão estiver habilitada (ver: https://api.youneedabudget.com/#oauth-default-budget).
Mês
 month True date

O mês orçamental em formato ISO (por exemplo, 2016-12-01). ("current" também pode ser usado para especificar o mês do calendário atual (UTC))
ID da categoria
 category_id True string

O identificador da categoria.
Orçado
 budgeted True integer

Valor orçado em formato miliunidades.

Devoluções

Salvar resposta de categoria
SaveCategoryResponse

Criar conta

ID da Operação:
CreateAccount

Cria uma nova conta.

Parâmetros

Name Chave Necessário Tipo Description
ID de orçamento
 budget_id True string

O identificador do orçamento ("último uso" pode ser usado para especificar o último orçamento usado e "padrão" pode ser usado se a seleção de orçamento padrão estiver habilitada (ver: https://api.youneedabudget.com/#oauth-default-budget)
Nome
 name True string

O nome da conta.
Tipo2
 type True string

O tipo de conta
Equilíbrio
 balance True integer

O saldo atual da conta em formato miliunidades.

Devoluções

Resposta da conta
AccountResponse

Criar transação

ID da Operação:
CreateTransaction

Cria uma única transação ou várias transações. Se você fornecer um corpo contendo um transaction objeto, uma única transação será criada e, se você fornecer um corpo contendo uma transactions matriz, várias transações serão criadas. As transações agendadas não podem ser criadas neste ponto de extremidade.

Parâmetros

Name Chave Necessário Tipo Description
ID de orçamento
 budget_id True string

O identificador do orçamento. "Última utilização" pode ser usado para especificar o último orçamento usado e "padrão" pode ser usado se a seleção de orçamento padrão estiver habilitada (ver: https://api.youneedabudget.com/#oauth-default-budget).
ID da conta
 account_id True string

O identificador da conta.
Date
 date True date

A data da transação em formato ISO (por exemplo, 2016-12-01). Datas futuras (transações agendadas) não são permitidas. As datas de transação divididas não podem ser alteradas e, se uma data diferente for fornecida, ela será ignorada.
Montante
 amount True integer

O valor da transação em formato miliunidades. Os valores de transação divididos não podem ser alterados e, se um valor diferente for fornecido, ele será ignorado.
ID do beneficiário
 payee_id uuid

O beneficiário da transação. Para criar uma transferência entre duas contas, use o beneficiário da transferência de conta apontando para a conta de destino. Os beneficiários da transferência de conta são especificados como transfer_payee_id no recurso da conta.
Beneficiário
 payee_name string

O nome do beneficiário. Se um payee_name valor for fornecido e payee_id tiver um valor nulo, o payee_name valor será utilizado para resolver o beneficiário através de (1) uma regra de mudança de nome do beneficiário correspondente (apenas se import_id também for especificado) ou (2) um beneficiário com o mesmo nome ou (3) a criação de um novo beneficiário.
ID da categoria
 category_id uuid

A categoria para a transação. Para configurar uma transação dividida, você pode especificar null para category_id e fornecer uma subtransactions matriz como parte do objeto de transação. Se uma transação existente for uma divisão, a category_id não pode ser alterada. As categorias de pagamento com cartão de crédito não são permitidas e serão ignoradas se fornecidas.
Nota
 memo string

O memorando.
Desmarcado
 cleared string

O status de compensação da transação.
Aprovado
 approved boolean

Se a transação é aprovada ou não. Se não for fornecida, a transação não será aprovada por padrão.
Cor da bandeira
 flag_color string

O sinalizador de transação.
ID de importação
 import_id string

Se especificado, a nova transação será atribuída a este import_id e considerada "importada". Também tentaremos fazer corresponder esta transação importada a uma transação "inserida pelo usuário" existente na mesma conta, com o mesmo valor e com uma data +/-10 dias a partir da data da transação importada.

Às transações importadas através da Importação Baseada em Ficheiros ou da Importação Direta (não através da API) é atribuída uma import_id no formato: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. Por exemplo, uma transação datada de 2015-12-30 no valor de -$294.23 USD teria um import_id de 'YNAB:-294230:2015-12-30:1'. Se uma segunda transação na mesma conta fosse importada e tivesse a mesma data e o mesmo montante, o seu import_id seria «YNAB:-294230:2015-12-30:2». O uso de um formato consistente evitará duplicações por meio da Importação Direta e da Importação Baseada em Arquivo.

Se import_id for omitido ou especificado como nulo, a transação será tratada como uma transação "inserida pelo usuário". Como tal, será elegível para ser comparado com transações posteriormente importadas (via DI, FBI ou API).
Montante
 amount True integer

O valor da subtransação em formato miliunidades.
ID do beneficiário
 payee_id uuid

O beneficiário da suboperação.
Beneficiário
 payee_name string

O nome do beneficiário. Se for fornecido um payee_name valor nulo payee_id , o payee_name valor será utilizado para resolver o beneficiário através de (1) uma regra de mudança de nome correspondente do beneficiário (apenas se import_id também for especificado na transação-mãe) ou (2) um beneficiário com o mesmo nome ou (3) a criação de um novo beneficiário.
ID da categoria
 category_id uuid

A categoria para a subtransação. As categorias de pagamento com cartão de crédito não são permitidas e serão ignoradas se fornecidas.
Nota
 memo string

O memorando.
ID da conta
 account_id True string

O identificador da conta.
Date
 date True date

A data da transação em formato ISO (por exemplo, 2016-12-01). Datas futuras (transações agendadas) não são permitidas. As datas de transação divididas não podem ser alteradas e, se uma data diferente for fornecida, ela será ignorada.
Montante
 amount True integer

O valor da transação em formato miliunidades. Os valores de transação divididos não podem ser alterados e, se um valor diferente for fornecido, ele será ignorado.
ID do beneficiário
 payee_id uuid

O beneficiário da transação. Para criar uma transferência entre duas contas, use o beneficiário da transferência de conta apontando para a conta de destino. Os beneficiários da transferência de conta são especificados como transfer_payee_id no recurso da conta.
Beneficiário
 payee_name string

O nome do beneficiário. Se um payee_name valor for fornecido e payee_id tiver um valor nulo, o payee_name valor será utilizado para resolver o beneficiário através de (1) uma regra de mudança de nome do beneficiário correspondente (apenas se import_id também for especificado) ou (2) um beneficiário com o mesmo nome ou (3) a criação de um novo beneficiário.
ID da categoria
 category_id uuid

A categoria para a transação. Para configurar uma transação dividida, você pode especificar null para category_id e fornecer uma subtransactions matriz como parte do objeto de transação. Se uma transação existente for uma divisão, a category_id não pode ser alterada. As categorias de pagamento com cartão de crédito não são permitidas e serão ignoradas se fornecidas.
Nota
 memo string

O memorando.
Desmarcado
 cleared string

O status de compensação da transação.
Aprovado
 approved boolean

Se a transação é aprovada ou não. Se não for fornecida, a transação não será aprovada por padrão.
Cor da bandeira
 flag_color string

O sinalizador de transação.
ID de importação
 import_id string

Se especificado, a nova transação será atribuída a este import_id e considerada "importada". Também tentaremos fazer corresponder esta transação importada a uma transação "inserida pelo usuário" existente na mesma conta, com o mesmo valor e com uma data +/-10 dias a partir da data da transação importada.

Às transações importadas através da Importação Baseada em Ficheiros ou da Importação Direta (não através da API) é atribuída uma import_id no formato: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. Por exemplo, uma transação datada de 2015-12-30 no valor de -$294.23 USD teria um import_id de 'YNAB:-294230:2015-12-30:1'. Se uma segunda transação na mesma conta fosse importada e tivesse a mesma data e o mesmo montante, o seu import_id seria «YNAB:-294230:2015-12-30:2». O uso de um formato consistente evitará duplicações por meio da Importação Direta e da Importação Baseada em Arquivo.

Se import_id for omitido ou especificado como nulo, a transação será tratada como uma transação "inserida pelo usuário". Como tal, será elegível para ser comparado com transações posteriormente importadas (via DI, FBI ou API).
Montante
 amount True integer

O valor da subtransação em formato miliunidades.
ID do beneficiário
 payee_id uuid

O beneficiário da suboperação.
Beneficiário
 payee_name string

O nome do beneficiário. Se for fornecido um payee_name valor nulo payee_id , o payee_name valor será utilizado para resolver o beneficiário através de (1) uma regra de mudança de nome correspondente do beneficiário (apenas se import_id também for especificado na transação-mãe) ou (2) um beneficiário com o mesmo nome ou (3) a criação de um novo beneficiário.
ID da categoria
 category_id uuid

A categoria para a subtransação. As categorias de pagamento com cartão de crédito não são permitidas e serão ignoradas se fornecidas.
Nota
 memo string

O memorando.

Devoluções

Salvar resposta de transações
SaveTransactionsResponse

Criar transações em massa

ID da Operação:
BulkCreateTransactions

Cria várias transações. Embora este ponto de extremidade ainda seja suportado, recomenda-se usar 'POST /budgets/{budget_id}/transactions' para criar várias transações.

Parâmetros

Name Chave Necessário Tipo Description
ID de orçamento
 budget_id True string

O identificador do orçamento. "Última utilização" pode ser usado para especificar o último orçamento usado e "padrão" pode ser usado se a seleção de orçamento padrão estiver habilitada (ver: https://api.youneedabudget.com/#oauth-default-budget).
ID da conta
 account_id True string

O identificador da conta.
Date
 date True date

A data da transação em formato ISO (por exemplo, 2016-12-01). Datas futuras (transações agendadas) não são permitidas. As datas de transação divididas não podem ser alteradas e, se uma data diferente for fornecida, ela será ignorada.
Montante
 amount True integer

O valor da transação em formato miliunidades. Os valores de transação divididos não podem ser alterados e, se um valor diferente for fornecido, ele será ignorado.
ID do beneficiário
 payee_id uuid

O beneficiário da transação. Para criar uma transferência entre duas contas, use o beneficiário da transferência de conta apontando para a conta de destino. Os beneficiários da transferência de conta são especificados como transfer_payee_id no recurso da conta.
Beneficiário
 payee_name string

O nome do beneficiário. Se um payee_name valor for fornecido e payee_id tiver um valor nulo, o payee_name valor será utilizado para resolver o beneficiário através de (1) uma regra de mudança de nome do beneficiário correspondente (apenas se import_id também for especificado) ou (2) um beneficiário com o mesmo nome ou (3) a criação de um novo beneficiário.
ID da categoria
 category_id uuid

A categoria para a transação. Para configurar uma transação dividida, você pode especificar null para category_id e fornecer uma subtransactions matriz como parte do objeto de transação. Se uma transação existente for uma divisão, a category_id não pode ser alterada. As categorias de pagamento com cartão de crédito não são permitidas e serão ignoradas se fornecidas.
Nota
 memo string

O memorando.
Desmarcado
 cleared string

O status de compensação da transação.
Aprovado
 approved boolean

Se a transação é aprovada ou não. Se não for fornecida, a transação não será aprovada por padrão.
Cor da bandeira
 flag_color string

O sinalizador de transação.
ID de importação
 import_id string

Se especificado, a nova transação será atribuída a este import_id e considerada "importada". Também tentaremos fazer corresponder esta transação importada a uma transação "inserida pelo usuário" existente na mesma conta, com o mesmo valor e com uma data +/-10 dias a partir da data da transação importada.

Às transações importadas através da Importação Baseada em Ficheiros ou da Importação Direta (não através da API) é atribuída uma import_id no formato: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. Por exemplo, uma transação datada de 2015-12-30 no valor de -$294.23 USD teria um import_id de 'YNAB:-294230:2015-12-30:1'. Se uma segunda transação na mesma conta fosse importada e tivesse a mesma data e o mesmo montante, o seu import_id seria «YNAB:-294230:2015-12-30:2». O uso de um formato consistente evitará duplicações por meio da Importação Direta e da Importação Baseada em Arquivo.

Se import_id for omitido ou especificado como nulo, a transação será tratada como uma transação "inserida pelo usuário". Como tal, será elegível para ser comparado com transações posteriormente importadas (via DI, FBI ou API).
Montante
 amount True integer

O valor da subtransação em formato miliunidades.
ID do beneficiário
 payee_id uuid

O beneficiário da suboperação.
Beneficiário
 payee_name string

O nome do beneficiário. Se for fornecido um payee_name valor nulo payee_id , o payee_name valor será utilizado para resolver o beneficiário através de (1) uma regra de mudança de nome correspondente do beneficiário (apenas se import_id também for especificado na transação-mãe) ou (2) um beneficiário com o mesmo nome ou (3) a criação de um novo beneficiário.
ID da categoria
 category_id uuid

A categoria para a subtransação. As categorias de pagamento com cartão de crédito não são permitidas e serão ignoradas se fornecidas.
Nota
 memo string

O memorando.

Devoluções

Resposta em massa
BulkResponse

Obter a localização do beneficiário por ID

ID da Operação:
GetPayeeLocationById

Devolve uma única localização do beneficiário.

Parâmetros

Name Chave Necessário Tipo Description
ID de orçamento
 budget_id True string

O identificador do orçamento. "Última utilização" pode ser usado para especificar o último orçamento usado e "padrão" pode ser usado se a seleção de orçamento padrão estiver habilitada (ver: https://api.youneedabudget.com/#oauth-default-budget).
ID de Localização do Beneficiário
 payee_location_id True string

Identificador da localização do beneficiário.

Devoluções

Resposta de localização do beneficiário
PayeeLocationResponse

Obter beneficiário por ID

ID da Operação:
GetPayeeById

Devolve um único beneficiário.

Parâmetros

Name Chave Necessário Tipo Description
ID de orçamento
 budget_id True string

O identificador do orçamento. "Última utilização" pode ser usado para especificar o último orçamento usado e "padrão" pode ser usado se a seleção de orçamento padrão estiver habilitada (ver: https://api.youneedabudget.com/#oauth-default-budget).
ID do beneficiário
 payee_id True string

O identificador do beneficiário.

Devoluções

Resposta do beneficiário
PayeeResponse

Obter beneficiários

ID da Operação:
GetPayees

Devolve todos os beneficiários.

Parâmetros

Name Chave Necessário Tipo Description
ID de orçamento
 budget_id True string

O identificador do orçamento. "Última utilização" pode ser usado para especificar o último orçamento usado e "padrão" pode ser usado se a seleção de orçamento padrão estiver habilitada (ver: https://api.youneedabudget.com/#oauth-default-budget).
Último Conhecimento do Servidor
 last_knowledge_of_server integer

O conhecimento do servidor inicial. Se fornecido, apenas as entidades que mudaram desde então last_knowledge_of_server serão incluídas.

Devoluções

Resposta dos beneficiários
PayeesResponse

Obter categoria de mês por ID

ID da Operação:
GetMonthCategoryById

Devolve uma única categoria para um mês orçamental específico. Os montantes (orçamentados, atividade, saldo, etc.) são específicos do mês orçamental corrente (UTC).

Parâmetros

Name Chave Necessário Tipo Description
ID de orçamento
 budget_id True string

O identificador do orçamento. "Última utilização" pode ser usado para especificar o último orçamento usado e "padrão" pode ser usado se a seleção de orçamento padrão estiver habilitada (ver: https://api.youneedabudget.com/#oauth-default-budget).
Mês
 month True date

O mês orçamental em formato ISO (por exemplo, 2016-12-01). ("current" também pode ser usado para especificar o mês do calendário atual (UTC))
ID da categoria
 category_id True string

O identificador da categoria.

Devoluções

Resposta da categoria
CategoryResponse

Obter categoria por ID

ID da Operação:
GetCategoryById

Devolve uma única categoria. Os montantes (orçamentados, atividade, saldo, etc.) são específicos do mês orçamental corrente (UTC).

Parâmetros

Name Chave Necessário Tipo Description
ID de orçamento
 budget_id True string

O identificador do orçamento. "Última utilização" pode ser usado para especificar o último orçamento usado e "padrão" pode ser usado se a seleção de orçamento padrão estiver habilitada (ver: https://api.youneedabudget.com/#oauth-default-budget).
ID da categoria
 category_id True string

O identificador da categoria.

Devoluções

Resposta da categoria
CategoryResponse

Obter categorias

ID da Operação:
GetCategories

Retorna todas as categorias agrupadas por grupo de categorias. Os montantes (orçamentados, atividade, saldo, etc.) são específicos do mês orçamental corrente (UTC).

Parâmetros

Name Chave Necessário Tipo Description
ID de orçamento
 budget_id True string

O identificador do orçamento. "Última utilização" pode ser usado para especificar o último orçamento usado e "padrão" pode ser usado se a seleção de orçamento padrão estiver habilitada (ver: https://api.youneedabudget.com/#oauth-default-budget).
Último Conhecimento do Servidor
 last_knowledge_of_server integer

O conhecimento do servidor inicial. Se fornecido, apenas as entidades que mudaram desde então last_knowledge_of_server serão incluídas.

Devoluções

Categorias Resposta
CategoriesResponse

Obter configurações de orçamento por ID

ID da Operação:
GetBudgetSettingsById

Devolve definições para um orçamento

Parâmetros

Name Chave Necessário Tipo Description
ID de orçamento
 budget_id True string

O identificador do orçamento. "Última utilização" pode ser usado para especificar o último orçamento usado e "padrão" pode ser usado se a seleção de orçamento padrão estiver habilitada (ver: https://api.youneedabudget.com/#oauth-default-budget).

Devoluções

Resposta de configurações de orçamento
BudgetSettingsResponse

Obter conta por ID

ID da Operação:
GetAccountById

Devolve uma única conta.

Parâmetros

Name Chave Necessário Tipo Description
ID de orçamento
 budget_id True string

O identificador do orçamento. "Última utilização" pode ser usado para especificar o último orçamento usado e "padrão" pode ser usado se a seleção de orçamento padrão estiver habilitada (ver: https://api.youneedabudget.com/#oauth-default-budget).
ID da conta
 account_id True uuid

O identificador da conta.

Devoluções

Resposta da conta
AccountResponse

Obter contas

ID da Operação:
GetAccounts

Devolve todas as contas.

Parâmetros

Name Chave Necessário Tipo Description
ID de orçamento
 budget_id True string

O identificador do orçamento. "Última utilização" pode ser usado para especificar o último orçamento usado e "padrão" pode ser usado se a seleção de orçamento padrão estiver habilitada (ver: https://api.youneedabudget.com/#oauth-default-budget).
Último Conhecimento do Servidor
 last_knowledge_of_server integer

O conhecimento do servidor inicial. Se fornecido, apenas as entidades que mudaram desde então last_knowledge_of_server serão incluídas.

Devoluções

Resposta das contas
AccountsResponse

Obter localizações de beneficiários

ID da Operação:
GetPayeeLocations

Devolve todas as localizações dos beneficiários.

Parâmetros

Name Chave Necessário Tipo Description
ID de orçamento
 budget_id True string

O identificador do orçamento. "Última utilização" pode ser usado para especificar o último orçamento usado e "padrão" pode ser usado se a seleção de orçamento padrão estiver habilitada (ver: https://api.youneedabudget.com/#oauth-default-budget).

Devoluções

Resposta dos Locais do Beneficiário
PayeeLocationsResponse

Obter localizações de beneficiários por beneficiário

ID da Operação:
GetPayeeLocationsByPayee

Devolve todas as localizações do beneficiário para um beneficiário especificado.

Parâmetros

Name Chave Necessário Tipo Description
ID de orçamento
 budget_id True string

O identificador do orçamento. "Última utilização" pode ser usado para especificar o último orçamento usado e "padrão" pode ser usado se a seleção de orçamento padrão estiver habilitada (ver: https://api.youneedabudget.com/#oauth-default-budget).
ID do beneficiário
 payee_id True string

O identificador do beneficiário.

Devoluções

Resposta dos Locais do Beneficiário
PayeeLocationsResponse

Obter meses de orçamento

ID da Operação:
GetBudgetMonths

Devolve todos os meses orçamentados.

Parâmetros

Name Chave Necessário Tipo Description
ID de orçamento
 budget_id True string

O identificador do orçamento. "Última utilização" pode ser usado para especificar o último orçamento usado e "padrão" pode ser usado se a seleção de orçamento padrão estiver habilitada (ver: https://api.youneedabudget.com/#oauth-default-budget).
Último Conhecimento do Servidor
 last_knowledge_of_server integer

O conhecimento do servidor inicial. Se fornecido, apenas as entidades que mudaram desde então last_knowledge_of_server serão incluídas.

Devoluções

Resposta aos resumos mensais
MonthSummariesResponse

Obter orçamento do mês

ID da Operação:
GetBudgetMonth

Devolve um único mês orçamental.

Parâmetros

Name Chave Necessário Tipo Description
ID de orçamento
 budget_id True string

O identificador do orçamento. "Última utilização" pode ser usado para especificar o último orçamento usado e "padrão" pode ser usado se a seleção de orçamento padrão estiver habilitada (ver: https://api.youneedabudget.com/#oauth-default-budget).
Mês
 month True date

O mês orçamental em formato ISO (por exemplo, 2016-12-01). ("current" também pode ser usado para especificar o mês do calendário atual (UTC))

Devoluções

Resposta detalhada do mês
MonthDetailResponse

Obter orçamento por ID

ID da Operação:
GetBudgetById

Devolve um único orçamento com todas as entidades relacionadas. Este recurso é efetivamente uma exportação de orçamento completo.

Parâmetros

Name Chave Necessário Tipo Description
ID de orçamento
 budget_id True string

O identificador do orçamento.
Último Conhecimento do Servidor
 last_knowledge_of_server integer

O conhecimento do servidor inicial. Se fornecido, apenas as entidades que mudaram desde então last_knowledge_of_server serão incluídas.

Devoluções

Resposta detalhada do orçamento
BudgetDetailResponse

Obter orçamentos

ID da Operação:
GetBudgets

Devolve a lista de orçamentos com informações resumidas.

Parâmetros

Name Chave Necessário Tipo Description
Incluir Contas
 include_accounts boolean

Inclusão ou não da lista de contas orçamentais.

Devoluções

Resposta do resumo do orçamento
BudgetSummaryResponse

Obter transação agendada por ID

ID da Operação:
GetScheduledTransactionById

Retorna uma única transação agendada.

Parâmetros

Name Chave Necessário Tipo Description
ID de orçamento
 budget_id True string

O identificador do orçamento. "Última utilização" pode ser usado para especificar o último orçamento usado e "padrão" pode ser usado se a seleção de orçamento padrão estiver habilitada (ver: https://api.youneedabudget.com/#oauth-default-budget).
ID de transação agendada
 scheduled_transaction_id True string

O identificador da transação agendada.

Devoluções

Resposta de transação agendada
ScheduledTransactionResponse

Obter transação por ID

ID da Operação:
GetTransactionById

Devolve uma única transação.

Parâmetros

Name Chave Necessário Tipo Description
ID de orçamento
 budget_id True string

O identificador do orçamento. "Última utilização" pode ser usado para especificar o último orçamento usado e "padrão" pode ser usado se a seleção de orçamento padrão estiver habilitada (ver: https://api.youneedabudget.com/#oauth-default-budget).
ID da transação
 transaction_id True string

O identificador da transação.

Devoluções

Resposta da transação
TransactionResponse

Obter transações

ID da Operação:
GetTransactions

Retorna transações de orçamento.

Parâmetros

Name Chave Necessário Tipo Description
ID de orçamento
 budget_id True string

O identificador do orçamento. "Última utilização" pode ser usado para especificar o último orçamento usado e "padrão" pode ser usado se a seleção de orçamento padrão estiver habilitada (ver: https://api.youneedabudget.com/#oauth-default-budget).
Desde a data
 since_date date

Se especificado, apenas as transações a partir desta data serão incluídas. A data deve ser formatada ISO (por exemplo, 2016-12-30).
Tipo
 type string

Se especificado, apenas as transações do tipo especificado serão incluídas. "não categorizado" e "não aprovado" são atualmente suportados.
Último Conhecimento do Servidor
 last_knowledge_of_server integer

O conhecimento do servidor inicial. Se fornecido, apenas as entidades que mudaram desde então last_knowledge_of_server serão incluídas.

Devoluções

Resposta às transações
TransactionsResponse

Obter transações agendadas

ID da Operação:
GetScheduledTransactions

Retorna todas as transações agendadas.

Parâmetros

Name Chave Necessário Tipo Description
ID de orçamento
 budget_id True string

O identificador do orçamento. "Última utilização" pode ser usado para especificar o último orçamento usado e "padrão" pode ser usado se a seleção de orçamento padrão estiver habilitada (ver: https://api.youneedabudget.com/#oauth-default-budget).
Último Conhecimento do Servidor
 last_knowledge_of_server integer

O conhecimento do servidor inicial. Se fornecido, apenas as entidades que mudaram desde então last_knowledge_of_server serão incluídas.

Devoluções

Resposta de transações agendadas
ScheduledTransactionsResponse

Obter transações por beneficiário

ID da Operação:
GetTransactionsByPayee

Devolve todas as transações de um beneficiário especificado.

Parâmetros

Name Chave Necessário Tipo Description
ID de orçamento
 budget_id True string

O identificador do orçamento. "Última utilização" pode ser usado para especificar o último orçamento usado e "padrão" pode ser usado se a seleção de orçamento padrão estiver habilitada (ver: https://api.youneedabudget.com/#oauth-default-budget).
ID do beneficiário
 payee_id True string

O identificador do beneficiário.
Desde a data
 since_date date

Se especificado, apenas as transações a partir desta data serão incluídas. A data deve ser formatada ISO (por exemplo, 2016-12-30).
Tipo
 type string

Se especificado, apenas as transações do tipo especificado serão incluídas. "não categorizado" e "não aprovado" são atualmente suportados.
Último Conhecimento do Servidor
 last_knowledge_of_server integer

O conhecimento do servidor inicial. Se fornecido, apenas as entidades que mudaram desde então last_knowledge_of_server serão incluídas.

Devoluções

Resposta de transações híbridas
HybridTransactionsResponse

Obter transações por categoria

ID da Operação:
GetTransactionsByCategory

Retorna todas as transações de uma categoria especificada.

Parâmetros

Name Chave Necessário Tipo Description
ID de orçamento
 budget_id True string

O identificador do orçamento. "Última utilização" pode ser usado para especificar o último orçamento usado e "padrão" pode ser usado se a seleção de orçamento padrão estiver habilitada (ver: https://api.youneedabudget.com/#oauth-default-budget).
ID da categoria
 category_id True string

O identificador da categoria.
Desde a data
 since_date date

Se especificado, apenas as transações a partir desta data serão incluídas. A data deve ser formatada ISO (por exemplo, 2016-12-30).
Tipo
 type string

Se especificado, apenas as transações do tipo especificado serão incluídas. "não categorizado" e "não aprovado" são atualmente suportados.
Último Conhecimento do Servidor
 last_knowledge_of_server integer

O conhecimento do servidor inicial. Se fornecido, apenas as entidades que mudaram desde então last_knowledge_of_server serão incluídas.

Devoluções

Resposta de transações híbridas
HybridTransactionsResponse

Obter transações por conta

ID da Operação:
GetTransactionsByAccount

Devolve todas as transações de uma conta especificada.

Parâmetros

Name Chave Necessário Tipo Description
ID de orçamento
 budget_id True string

O identificador do orçamento. "Última utilização" pode ser usado para especificar o último orçamento usado e "padrão" pode ser usado se a seleção de orçamento padrão estiver habilitada (ver: https://api.youneedabudget.com/#oauth-default-budget).
ID da conta
 account_id True string

O identificador da conta.
Desde a data
 since_date date

Se especificado, apenas as transações a partir desta data serão incluídas. A data deve ser formatada ISO (por exemplo, 2016-12-30).
Tipo
 type string

Se especificado, apenas as transações do tipo especificado serão incluídas. "não categorizado" e "não aprovado" são atualmente suportados.
Último Conhecimento do Servidor
 last_knowledge_of_server integer

O conhecimento do servidor inicial. Se fornecido, apenas as entidades que mudaram desde então last_knowledge_of_server serão incluídas.

Devoluções

Resposta às transações
TransactionsResponse

Obter utilizador

ID da Operação:
GetUser

Retorna informações autenticadas do usuário.

Devoluções

Resposta do usuário
UserResponse

Operações de importação

ID da Operação:
ImportTransactions

Importa operações disponíveis em todas as contas ligadas para o orçamento determinado. As contas vinculadas permitem que as transações sejam importadas diretamente de uma instituição financeira especificada e esse ponto de extremidade inicia essa importação. Enviar uma solicitação para este endpoint é o equivalente a clicar em "Importar" em cada conta no aplicativo web ou tocar no banner "Novas transações" nos aplicativos móveis. A resposta para este ponto de extremidade contém as ids de transação que foram importadas.

Parâmetros

Name Chave Necessário Tipo Description
ID de orçamento
 budget_id True string

O identificador do orçamento. "Última utilização" pode ser usado para especificar o último orçamento usado e "padrão" pode ser usado se a seleção de orçamento padrão estiver habilitada (ver: https://api.youneedabudget.com/#oauth-default-budget).

Devoluções

Resposta de importação de transações
TransactionsImportResponse

Definições

Resposta do usuário

Name Caminho Tipo Description
Data
 data Data

User

Name Caminho Tipo Description
ID
 id string

O identificador.

DateFormat

A definição do formato de data para o orçamento. Em alguns casos, o formato não estará disponível e será especificado como nulo.

Name Caminho Tipo Description
Formato
 format string

O formato.

Formato da moeda

A configuração do formato de moeda para o orçamento. Em alguns casos, o formato não estará disponível e será especificado como nulo.

Name Caminho Tipo Description
Código ISO
 iso_code string

O código ISO.
Formato de exemplo
 example_format string

O formato de exemplo.
Dígitos decimais
 decimal_digits integer

Os dígitos decimais.
Separador decimal
 decimal_separator string

O separador decimal.
Símbolo primeiro
 symbol_first boolean

Se o símbolo é o primeiro.
Separador de Grupo
 group_separator string

O separador de grupo.
Símbolo da moeda
 currency_symbol string

O símbolo da moeda.
Símbolo exibido
 display_symbol boolean

Se o símbolo é exibido.

OrçamentoResumoResposta

Name Caminho Tipo Description
Dados1
 data Data1

OrçamentoResumo

Name Caminho Tipo Description
ID
 id string

O identificador.
Nome
 name string

O nome.
Última modificação em
 last_modified_on date-time

A última vez que foram feitas alterações no orçamento de um cliente web ou móvel.
Primeiro Mês
 first_month date

O primeiro mês orçamental.
Mês passado
 last_month date

O último mês orçamental.
Formato de data
 date_format DateFormat

A definição do formato de data para o orçamento. Em alguns casos, o formato não estará disponível e será especificado como nulo.
Formato da moeda
 currency_format CurrencyFormat

A configuração do formato de moeda para o orçamento. Em alguns casos, o formato não estará disponível e será especificado como nulo.
Accounts
 accounts array of Account

As contas de orçamento (incluídas apenas se include_accounts=true especificadas como parâmetro de consulta).

BudgetDetailResponse

Name Caminho Tipo Description
Dados2
 data Data2

OrçamentoDetalhe

Name Caminho Tipo Description
ID
 id string

O identificador.
Nome
 name string

O nome.
Última modificação em
 last_modified_on date-time

A última vez que foram feitas alterações no orçamento de um cliente web ou móvel.
Primeiro Mês
 first_month date

O primeiro mês orçamental.
Mês passado
 last_month date

O último mês orçamental.
Formato de data
 date_format DateFormat

A definição do formato de data para o orçamento. Em alguns casos, o formato não estará disponível e será especificado como nulo.
Formato da moeda
 currency_format CurrencyFormat

A configuração do formato de moeda para o orçamento. Em alguns casos, o formato não estará disponível e será especificado como nulo.
Accounts
 accounts array of Account

As contas de orçamento (incluídas apenas se include_accounts=true especificadas como parâmetro de consulta).
Beneficiários
 payees array of Payee
Localizações dos beneficiários
 payee_locations array of PayeeLocation
Grupos de Categorias
 category_groups array of CategoryGroup
Categorias
 categories array of Category
Meses
 months array of MonthDetail
Transações
 transactions array of TransactionSummary
Suboperações
 subtransactions array of SubTransaction
Transações agendadas
 scheduled_transactions array of ScheduledTransactionSummary
Subtransações agendadas
 scheduled_subtransactions array of ScheduledSubTransaction

BudgetSettingsResponse

Name Caminho Tipo Description
Dados3
 data Data3

BudgetSettings

Name Caminho Tipo Description
Formato de data
 date_format DateFormat

A definição do formato de data para o orçamento. Em alguns casos, o formato não estará disponível e será especificado como nulo.
Formato da moeda
 currency_format CurrencyFormat

A configuração do formato de moeda para o orçamento. Em alguns casos, o formato não estará disponível e será especificado como nulo.

ContasResposta

Name Caminho Tipo Description
Dados4
 data Data4

AccountResponse

Name Caminho Tipo Description
Dados5
 data Data5

Account

Name Caminho Tipo Description
ID
 id string

O identificador.
Nome
 name string

O nome.
Tipo
 type Type

O tipo de conta. Nota: PayPal, merchantAccount, investmentAccount e tipos de hipoteca foram preteridos e serão removidos no futuro.
Orçamento
 on_budget boolean

Se esta conta está no orçamento ou não
Closed
 closed boolean

Se esta conta está encerrada ou não
Observação
 note string

A nota.
Equilíbrio
 balance integer

O saldo atual da conta em formato miliunidades.
Saldo Apurado
 cleared_balance integer

O saldo atual apurado da conta em formato miliunidades.
Saldo não apurado
 uncleared_balance integer

O saldo atual não apurado da conta em formato miliunidades.
Transferir ID do beneficiário
 transfer_payee_id string

O identificador do beneficiário que deve ser utilizado aquando da transferência para esta conta.
Importação direta vinculada
 direct_import_linked boolean

Se a conta está ou não vinculada a uma instituição financeira para importação automática de transações.
Erro de importação direta
 direct_import_in_error boolean

Se uma conta vinculada a uma instituição financeira (direct_import_linked=true) e a conexão vinculada não estiver em um estado íntegro, isso será verdade.
Suprimido
 deleted boolean

Se a conta foi ou não excluída. Contas excluídas só serão incluídas em solicitações delta.

CategoriasResposta

Name Caminho Tipo Description
Dados6
 data Data6

CategoriaResposta

Name Caminho Tipo Description
Dados7
 data Data7

CategoriaGrupoComCategorias

Name Caminho Tipo Description
ID
 id string

O identificador.
Nome
 name string

O nome.
Escondido
 hidden boolean

Se o grupo de categorias está oculto ou não.
Suprimido
 deleted boolean

Se o grupo de categorias foi ou não excluído. Os grupos de categorias excluídas só serão incluídos em solicitações delta.
Catagorias
 categories array of Category

Categorias de grupos de categorias. Os montantes (orçamentados, atividade, saldo, etc.) são específicos do mês orçamental corrente (UTC).

CategoriaGrupo

Name Caminho Tipo Description
ID
 id string

O identificador.
Nome
 name string

O nome.
Escondido
 hidden boolean

Se o grupo de categorias está oculto ou não.
Suprimido
 deleted boolean

Se o grupo de categorias foi ou não excluído. Os grupos de categorias excluídas só serão incluídos em solicitações delta.

Categoria

Name Caminho Tipo Description
ID
 id string

O identificador.
ID do Grupo de Categoria
 category_group_id string

O identificador de grupo de categorias.
Nome
 name string

O nome.
Escondido
 hidden boolean

Se a categoria está ou não oculta.
ID do Grupo da Categoria Original
 original_category_group_id uuid

Se a categoria estiver oculta, este é o identificador do grupo de categorias ao qual pertencia originalmente antes de ser ocultada.
Observação
 note string

A nota.
Orçado
 budgeted integer

Valor orçado em formato miliunidades.
Activity
 activity integer

Quantidade de atividade em formato miliunidades.
Equilíbrio
 balance integer

Equilíbrio em formato miliunidades.
Tipo de Objetivo
 goal_type GoalType

O tipo de meta, se a categoria tiver uma meta (TB='Target Category Balance', TBD='Target Category Balance by Date', MF='Monthly Funding', NEED='Plan Your Spending')
Mês da Criação de Metas
 goal_creation_month date

No mês em que foi criada uma meta.
Meta Alvo
 goal_target integer

O valor alvo da meta em miliunidades.
Meta Mês
 goal_target_month date

O mês alvo original para a meta a ser concluída. Apenas alguns tipos de meta especificam essa data.
Percentagem de Objetivos Concluída
 goal_percentage_complete integer

A porcentagem de conclusão da meta.
Meta Meses para Orçamento
 goal_months_to_budget integer

O número de meses, incluindo o mês atual, restantes no período da meta atual.
Objetivo subfinanciado
 goal_under_funded integer

O montante de financiamento ainda necessário no mês em curso para se manter no caminho certo para completar a meta dentro do período de meta atual. Esse valor geralmente corresponderá ao valor "Subfinanciado" nos clientes web e móveis, exceto ao visualizar uma categoria com uma Meta de Gastos Necessários em um mês futuro. Os clientes web e móveis ignorarão qualquer financiamento de um período de meta anterior ao visualizar a categoria com uma meta necessária para gastos em um mês futuro.
Objetivo Global Financiado
 goal_overall_funded integer

O montante total financiado para o objetivo dentro do período atual do objetivo.
Gol geral à esquerda
 goal_overall_left integer

O montante de financiamento ainda necessário para completar a meta dentro do período de meta atual.
Suprimido
 deleted boolean

Se a categoria foi ou não eliminada. As categorias excluídas só serão incluídas em solicitações delta.

SaveCategoryResponse

Name Caminho Tipo Description
Dados8
 data Data8

BeneficiáriosResposta

Name Caminho Tipo Description
Dados9
 data Data9

PayeeResponse

Name Caminho Tipo Description
Dados10
 data Data10

Beneficiário

Name Caminho Tipo Description
ID
 id string

O identificador.
Nome
 name string

O nome.
ID da conta de transferência
 transfer_account_id string

Se for um beneficiário da transferência, para o account_id qual esse beneficiário é transferido.
Suprimido
 deleted boolean

Se o beneficiário foi ou não excluído. Os beneficiários excluídos só serão incluídos nas solicitações delta.

PayeeLocationsResponse

Name Caminho Tipo Description
Dados11
 data Data11

PayeeLocationResponse

Name Caminho Tipo Description
Dados12
 data Data12

BeneficiárioLocalização

Name Caminho Tipo Description
ID
 id string

O identificador.
ID do beneficiário
 payee_id string

O identificador do beneficiário.
Latitude
 latitude string

A latitude.
Longitude
 longitude string

A longitude.
Suprimido
 deleted boolean

Se a localização do beneficiário foi ou não eliminada. Os locais de beneficiários excluídos só serão incluídos em solicitações delta.

TransaçõesResposta

Name Caminho Tipo Description
Dados13
 data Data13

HybridTransactionsResponse

Name Caminho Tipo Description
Dados14
 data Data14

SaveTransactionsResponse

Name Caminho Tipo Description
Dados15
 data Data15

TransactionResponse

Name Caminho Tipo Description
Dados16
 data Data16

Resumo da transação

Name Caminho Tipo Description
ID
 id string

O identificador.
Date
 date date

A data da transação em formato ISO (por exemplo, 2016-12-01).
Montante
 amount integer

O valor da transação em formato miliunidades.
Nota
 memo string

O memorando.
Desmarcado
 cleared Cleared

O status de compensação da transação.
Aprovado
 approved boolean

Se a transação é aprovada ou não.
Cor da bandeira
 flag_color FlagColor

O sinalizador de transação.
ID da conta
 account_id string

O identificador da conta.
ID do beneficiário
 payee_id string

O identificador do beneficiário.
ID da categoria
 category_id string

O identificador de categoria.
ID da conta de transferência
 transfer_account_id uuid

Se uma transação de transferência, a conta para a qual ela é transferida.
ID da transação de transferência
 transfer_transaction_id string

Se se tratar de uma operação de transferência, o identificador da transação do outro lado da transferência.
ID de transação correspondente
 matched_transaction_id string

Se a transação for correspondida, o identificador da transação correspondente.
ID de importação
 import_id string

Se a Transação tiver sido importada, este campo será um identificador de importação exclusivo (por conta). Se esta transação foi importada através de Importação Baseada em Arquivo ou Importação Direta e não através da API, o import_id terá o formato: 'YNAB:[milliunit_amount]:[iso_date]:[ocorrência]'. Por exemplo, uma transação datada de 2015-12-30 no valor de -$294.23 USD teria um import_id de 'YNAB:-294230:2015-12-30:1'. Se uma segunda transação na mesma conta fosse importada e tivesse a mesma data e o mesmo montante, o seu import_id seria «YNAB:-294230:2015-12-30:2».
Suprimido
 deleted boolean

Se a transação foi excluída ou não. As transações excluídas só serão incluídas em solicitações delta.

TransactionDetail

Name Caminho Tipo Description
ID
 id string

O identificador.
Date
 date date

A data da transação em formato ISO (por exemplo, 2016-12-01).
Montante
 amount integer

O valor da transação em formato miliunidades.
Nota
 memo string

O memorando.
Desmarcado
 cleared Cleared

O status de compensação da transação.
Aprovado
 approved boolean

Se a transação é aprovada ou não.
Cor da bandeira
 flag_color FlagColor

O sinalizador de transação.
ID da conta
 account_id string

O identificador da conta.
ID do beneficiário
 payee_id string

O identificador do beneficiário.
ID da categoria
 category_id string

O identificador de categoria.
ID da conta de transferência
 transfer_account_id uuid

Se uma transação de transferência, a conta para a qual ela é transferida.
ID da transação de transferência
 transfer_transaction_id string

Se se tratar de uma operação de transferência, o identificador da transação do outro lado da transferência.
ID de transação correspondente
 matched_transaction_id string

Se a transação for correspondida, o identificador da transação correspondente.
ID de importação
 import_id string

Se a Transação tiver sido importada, este campo será um identificador de importação exclusivo (por conta). Se esta transação foi importada através de Importação Baseada em Arquivo ou Importação Direta e não através da API, o import_id terá o formato: 'YNAB:[milliunit_amount]:[iso_date]:[ocorrência]'. Por exemplo, uma transação datada de 2015-12-30 no valor de -$294.23 USD teria um import_id de 'YNAB:-294230:2015-12-30:1'. Se uma segunda transação na mesma conta fosse importada e tivesse a mesma data e o mesmo montante, o seu import_id seria «YNAB:-294230:2015-12-30:2».
Suprimido
 deleted boolean

Se a transação foi excluída ou não. As transações excluídas só serão incluídas em solicitações delta.
Nome da Conta
 account_name string

O nome da conta.
Beneficiário
 payee_name string

O nome do beneficiário.
Categoria
 category_name string

O nome da categoria.
Suboperações
 subtransactions array of SubTransaction

Se uma transação fracionada, as subtransações.

HybridTransaction

Name Caminho Tipo Description
ID
 id string

O identificador.
Date
 date date

A data da transação em formato ISO (por exemplo, 2016-12-01).
Montante
 amount integer

O valor da transação em formato miliunidades.
Nota
 memo string

O memorando.
Desmarcado
 cleared Cleared

O status de compensação da transação.
Aprovado
 approved boolean

Se a transação é aprovada ou não.
Cor da bandeira
 flag_color FlagColor

O sinalizador de transação.
ID da conta
 account_id string

O identificador da conta.
ID do beneficiário
 payee_id string

O identificador do beneficiário.
ID da categoria
 category_id string

O identificador de categoria.
ID da conta de transferência
 transfer_account_id uuid

Se uma transação de transferência, a conta para a qual ela é transferida.
ID da transação de transferência
 transfer_transaction_id string

Se se tratar de uma operação de transferência, o identificador da transação do outro lado da transferência.
ID de transação correspondente
 matched_transaction_id string

Se a transação for correspondida, o identificador da transação correspondente.
ID de importação
 import_id string

Se a Transação tiver sido importada, este campo será um identificador de importação exclusivo (por conta). Se esta transação foi importada através de Importação Baseada em Arquivo ou Importação Direta e não através da API, o import_id terá o formato: 'YNAB:[milliunit_amount]:[iso_date]:[ocorrência]'. Por exemplo, uma transação datada de 2015-12-30 no valor de -$294.23 USD teria um import_id de 'YNAB:-294230:2015-12-30:1'. Se uma segunda transação na mesma conta fosse importada e tivesse a mesma data e o mesmo montante, o seu import_id seria «YNAB:-294230:2015-12-30:2».
Suprimido
 deleted boolean

Se a transação foi excluída ou não. As transações excluídas só serão incluídas em solicitações delta.
Tipo3
 type Type3

Se a transação híbrida representa uma transação regular ou uma subtransação
ID da transação pai
 parent_transaction_id string

Para tipos de subtransação, este é o identificador da transação pai. Para tipos de transação, esse identificador será sempre nulo.
Nome da Conta
 account_name string

O nome da conta.
Beneficiário
 payee_name string

O nome do beneficiário.
Categoria
 category_name string

O nome da categoria.

TransaçõesImportResponse

Name Caminho Tipo Description
Dados17
 data Data17

BulkResponse

Name Caminho Tipo Description
Dados18
 data Data18

Subtransação

Name Caminho Tipo Description
ID
 id string

O identificador.
ID da transação
 transaction_id string

A transação.
Montante
 amount integer

O valor da subtransação em formato miliunidades.
Nota
 memo string

O memorando.
ID do beneficiário
 payee_id string

O identificador do beneficiário.
Beneficiário
 payee_name string

O nome do beneficiário.
ID da categoria
 category_id string

O identificador de categoria.
Categoria
 category_name string

O nome da categoria.
ID da conta de transferência
 transfer_account_id uuid

Se for uma transferência, o account_id para o qual a subtransação é transferida.
ID da transação de transferência
 transfer_transaction_id string

Se for uma transferência, o identificador da transação do outro lado da transferência.
Suprimido
 deleted boolean

Se a subtransação foi excluída ou não. Subtransações excluídas só serão incluídas em solicitações delta.

ScheduledTransactionsResponse

Name Caminho Tipo Description
Dados19
 data Data19

ScheduledTransactionResponse

Name Caminho Tipo Description
Dados20
 data Data20

ScheduledTransactionSummary

Name Caminho Tipo Description
ID
 id string

O identificador.
Primeiro Encontro
 date_first date

A primeira data para a qual a Transação Agendada foi agendada.
Próxima Data
 date_next date

A próxima data para a qual a Transação Agendada está agendada.
Frequência
 frequency Frequency

A frequência.
Montante
 amount integer

O valor da transação agendada em formato de miliunidades.
Nota
 memo string

O memorando.
Cor da bandeira1
 flag_color FlagColor1

O sinalizador de transação agendada.
ID da conta
 account_id string

O identificador da conta.
ID do beneficiário
 payee_id string

O identificador do beneficiário.
ID da categoria
 category_id string

O identificador de categoria.
ID da conta de transferência
 transfer_account_id uuid

Se for uma transferência, o account_id para o qual a transação agendada é transferida.
Suprimido
 deleted boolean

Se a transação agendada foi excluída ou não. As transações agendadas excluídas só serão incluídas em solicitações delta.

ScheduledTransactionDetail

Name Caminho Tipo Description
ID
 id string

O identificador.
Primeiro Encontro
 date_first date

A primeira data para a qual a Transação Agendada foi agendada.
Próxima Data
 date_next date

A próxima data para a qual a Transação Agendada está agendada.
Frequência
 frequency Frequency

A frequência.
Montante
 amount integer

O valor da transação agendada em formato de miliunidades.
Nota
 memo string

O memorando.
Cor da bandeira1
 flag_color FlagColor1

O sinalizador de transação agendada.
ID da conta
 account_id string

O identificador da conta.
ID do beneficiário
 payee_id string

O identificador do beneficiário.
ID da categoria
 category_id string

O identificador de categoria.
ID da conta de transferência
 transfer_account_id uuid

Se for uma transferência, o account_id para o qual a transação agendada é transferida.
Suprimido
 deleted boolean

Se a transação agendada foi excluída ou não. As transações agendadas excluídas só serão incluídas em solicitações delta.
Nome da Conta
 account_name string

O nome da conta.
Beneficiário
 payee_name string

O nome do beneficiário.
Categoria
 category_name string

O nome da categoria.
suboperações
 subtransactions array of ScheduledSubTransaction

Se uma transação agendada dividida, as subtransações.

Subtransação programada

Name Caminho Tipo Description
ID
 id string

O identificador.
ID de transação agendada
 scheduled_transaction_id string

O identificador de transação agendada.
Montante
 amount integer

O valor da subtransação agendada no formato miliunidades.
Nota
 memo string

O memorando.
ID do beneficiário
 payee_id string

O identificador do beneficiário.
ID da categoria
 category_id string

O identificador de categoria.
ID da conta de transferência
 transfer_account_id uuid

Se for uma transferência, o account_id para o qual a subtransação agendada é transferida.
Suprimido
 deleted boolean

Se a subtransação agendada foi excluída ou não. Subtransações agendadas excluídas só serão incluídas em solicitações delta.

MêsResumosResposta

Name Caminho Tipo Description
Dados21
 data Data21

MonthDetailResponse

Name Caminho Tipo Description
Dados22
 data Data22

MêsResumo

Name Caminho Tipo Description
Mês
 month date

O mês.
Observação
 note string

A nota.
Rendimentos
 income integer

A quantidade total de transações categorizadas como 'Entrada: Pronto para Atribuir' no mês.
Orçado
 budgeted integer

O valor total orçado no mês.
Activity
 activity integer

O valor total de transações no mês, excluindo aquelas categorizadas como 'Entrada: Pronto para Atribuir'.
A orçamentar
 to_be_budgeted integer

O montante disponível para 'Pronto a atribuir'.
A Era do Dinheiro
 age_of_money integer

A Idade do Dinheiro a partir do mês.
Suprimido
 deleted boolean

Se o mês foi ou não excluído. Os meses eliminados só serão incluídos nos pedidos delta.

MêsDetalhe

Name Caminho Tipo Description
Mês
 month date

O mês.
Observação
 note string

A nota.
Rendimentos
 income integer

A quantidade total de transações categorizadas como 'Entrada: Pronto para Atribuir' no mês.
Orçado
 budgeted integer

O valor total orçado no mês.
Activity
 activity integer

O valor total de transações no mês, excluindo aquelas categorizadas como 'Entrada: Pronto para Atribuir'.
A orçamentar
 to_be_budgeted integer

O montante disponível para 'Pronto a atribuir'.
A Era do Dinheiro
 age_of_money integer

A Idade do Dinheiro a partir do mês.
Suprimido
 deleted boolean

Se o mês foi ou não excluído. Os meses eliminados só serão incluídos nos pedidos delta.
Categorias
 categories array of Category

As categorias do mês do orçamento. Os montantes (orçamentados, atividade, saldo, etc.) são específicos para o parâmetro {month} especificado.

Bulk

Name Caminho Tipo Description
IDs de transação
 transaction_ids array of string

A lista de ids de transação que foram criadas.
IDs de importação duplicadas
 duplicate_import_ids array of string

Se alguma Transação não tiver sido criada porque já tinha uma import_id transação correspondente na mesma conta, o(s) import_id(s) especificado(s) será(ão) incluído(s) nesta lista.

Desmarcado

O status de compensação da transação.

O status de compensação da transação.

Desmarcado
string

Data

Name Caminho Tipo Description
User
 user User

Dados1

Name Caminho Tipo Description
Orçamentos
 budgets array of BudgetSummary
Resumo do orçamento
 default_budget BudgetSummary

Dados2

Name Caminho Tipo Description
Detalhe do orçamento
 budget BudgetDetail
Conhecimento do Servidor
 server_knowledge integer

O conhecimento do servidor.

Dados3

Name Caminho Tipo Description
Configurações de orçamento
 settings BudgetSettings

Dados4

Name Caminho Tipo Description
Accounts
 accounts array of Account
Conhecimento do Servidor
 server_knowledge integer

O conhecimento do servidor.

Dados5

Name Caminho Tipo Description
Account
 account Account

Dados6

Name Caminho Tipo Description
Grupos de Categorias
 category_groups array of CategoryGroupWithCategories

Os grupos de categorias.
Conhecimento do Servidor
 server_knowledge integer

O conhecimento do servidor.

Dados7

Name Caminho Tipo Description
Categoria
 category Category

Dados8

Name Caminho Tipo Description
Categoria
 category Category
Conhecimento do Servidor
 server_knowledge integer

O conhecimento do servidor.

Dados9

Name Caminho Tipo Description
Beneficiários
 payees array of Payee

Os beneficiários.
Conhecimento do Servidor
 server_knowledge integer

O conhecimento do servidor.

Dados10

Name Caminho Tipo Description
Beneficiário
 payee Payee

Dados11

Name Caminho Tipo Description
Localizações dos beneficiários
 payee_locations array of PayeeLocation

Os locais do beneficiário.

Dados12

Name Caminho Tipo Description
Localização do beneficiário
 payee_location PayeeLocation

Dados13

Name Caminho Tipo Description
Transações
 transactions array of TransactionDetail

As transações.
Conhecimento do Servidor
 server_knowledge integer

O conhecimento do servidor.

Dados14

Name Caminho Tipo Description
Transações
 transactions array of HybridTransaction

As transações.

Dados15

Name Caminho Tipo Description
IDs de transação
 transaction_ids array of string

As ids de transação que foram salvas.
Detalhes da transação
 transaction TransactionDetail
transações
 transactions array of TransactionDetail

Se várias transações foram especificadas, as transações que foram salvas.
IDs de importação duplicadas
 duplicate_import_ids array of string

Se várias transações foram especificadas, uma lista de import_ids que não foram criadas devido a um existente import_id encontrado na mesma conta.
Conhecimento do Servidor
 server_knowledge integer

O conhecimento do servidor.

Dados16

Name Caminho Tipo Description
Detalhes da transação
 transaction TransactionDetail

Dados17

Name Caminho Tipo Description
IDs de transação
 transaction_ids array of string

A lista de ids de transação que foram importadas.

Dados18

Name Caminho Tipo Description
Bulk
 bulk Bulk

Dados19

Name Caminho Tipo Description
scheduled_transactions
 scheduled_transactions array of ScheduledTransactionDetail
Conhecimento do Servidor
 server_knowledge integer

O conhecimento do servidor.

Dados20

Name Caminho Tipo Description
Detalhes da transação agendada
 scheduled_transaction ScheduledTransactionDetail

Dados21

Name Caminho Tipo Description
Meses
 months array of MonthSummary
Conhecimento do Servidor
 server_knowledge integer

O conhecimento do servidor.

Dados22

Name Caminho Tipo Description
Detalhe do mês
 month MonthDetail

Cor da bandeira

O sinalizador de transação.

O sinalizador de transação.

Cor da bandeira
string

Cor da bandeira1

O sinalizador de transação agendada.

O sinalizador de transação agendada.

Cor da bandeira1
string

Frequência

A frequência.

A frequência.

Frequência
string

Tipo de Golo

O tipo de meta, se a categoria tiver uma meta (TB='Target Category Balance', TBD='Target Category Balance by Date', MF='Monthly Funding', NEED='Plan Your Spending')

O tipo de meta, se a categoria tiver uma meta (TB='Target Category Balance', TBD='Target Category Balance by Date', MF='Monthly Funding', NEED='Plan Your Spending')

Tipo de Objetivo
string

Tipo

O tipo de conta. Nota: PayPal, merchantAccount, investmentAccount e tipos de hipoteca foram preteridos e serão removidos no futuro.

O tipo de conta. Nota: PayPal, merchantAccount, investmentAccount e tipos de hipoteca foram preteridos e serão removidos no futuro.

Tipo
string

Tipo3

Se a transação híbrida representa uma transação regular ou uma subtransação

Se a transação híbrida representa uma transação regular ou uma subtransação

Tipo3
string