Compartilhar via

Você precisa de um orçamento (Editor Independente)

Você precisa de um orçamento (YNAB) permite que você crie um aplicativo pessoal para interagir com seu próprio orçamento ou criar um aplicativo que qualquer outro YNABer possa autorizar e usar.

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

Service Class Regions
Copilot Studio Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos Standard Todas as regiões dos Aplicativos Lógicos , exceto as seguintes:
     – Regiões do Azure Governamental
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Premium Todas as regiões do Power Apps , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Power Automate Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Troy Taylor
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Metadados do conector
Publicador Troy Taylor
Site https://www.youneedabudget.com/
Política de privacidade https://www.youneedabudget.com/privacy-policy/
Categorias Finanças

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:
Default 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.

Essa não é uma conexão compartilhável. Se o aplicativo de energia 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

Limitações

Nome Chamadas Período de renovação
Chamadas à API por conexão 100 60 segundos

Ações

Atualizar categoria de mês

Atualize uma categoria para um mês específico. Somente budgeted a quantidade pode ser atualizada.
Atualizar transação

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

Atualiza várias transações por id ou import_id.
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. Transações agendadas não podem ser criadas neste ponto de extremidade.
Criar transações em massa

Cria várias transações. Embora esse ponto de extremidade ainda tenha suporte, é recomendável usar 'POST /budgets/{budget_id}/transactions' para criar várias transações.
Importar transações

Importa transações disponíveis em todas as contas vinculadas 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 esse ponto de extremidade é o equivalente a clicar em "Importar" em cada conta no aplicativo Web ou tocar na faixa "Novas Transações" nos aplicativos móveis. A resposta para esse ponto de extremidade contém as IDs de transação que foram importadas.
Obter categoria de mês por ID

Retorna uma única categoria para um mês de orçamento específico. Os valores (orçado, atividade, saldo etc.) são específicos para o UTC (mês de orçamento atual).
Obter categoria por ID

Retorna uma única categoria. Os valores (orçado, atividade, saldo etc.) são específicos para o UTC (mês de orçamento atual).
Obter categorias

Retorna todas as categorias agrupadas por grupo de categorias. Os valores (orçado, atividade, saldo etc.) são específicos para o UTC (mês de orçamento atual).
Obter configurações de orçamento por ID

Retorna as configurações de um orçamento
Obter conta por ID

Retorna uma única conta.
Obter contas

Retorna todas as contas.
Obter locais do destinatário

Retorna todos os locais do destinatário.
Obter locais do destinatário pelo destinatário

Retorna todos os locais do destinatário para um destinatário especificado.
Obter meses de orçamento

Retorna todos os meses de orçamento.
Obter o destinatário por ID

Retorna um único destinatário.
Obter o local do destinatário por ID

Retorna um único local de pagamento.
Obter o mês do orçamento

Retorna um único mês de orçamento.
Obter orçamento por ID

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

Retorna a lista de orçamentos com informações resumidas.
Obter pagamentos

Retorna todos os pagantes.
Obter transação agendada por ID

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

Retorna 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 categoria

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

Retorna todas as transações de uma conta especificada.
Obter transações por destinatário

Retorna todas as transações para um destinatário especificado.
Obter usuário

Retorna informações do usuário autenticado.

Atualizar categoria de mês

ID da operação:
UpdateMonthCategory

Atualize uma categoria para um mês específico. Somente budgeted a quantidade pode ser atualizada.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do orçamento
 budget_id True string

O identificador do orçamento. "usado pela última vez" 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 (consulte: https://api.youneedabudget.com/#oauth-default-budget).
Mês
 month True date

O mês de orçamento no formato ISO (por exemplo, 2016-12-01). ("atual" 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 no formato milliunits.

Retornos

Salvar resposta de categoria
SaveCategoryResponse

Atualizar transação

ID da operação:
UpdateTransaction

Atualiza uma única transação.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do orçamento
 budget_id True string

O identificador do orçamento. "usado pela última vez" 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 (consulte: https://api.youneedabudget.com/#oauth-default-budget).
ID da transação
 transaction_id True string

O identificador da transação.
AccountID
 account_id True string

O identificador da conta.
Date
 date True date

A data da transação no 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.
Quantidade
 amount True integer

O valor da transação no formato milliunits. Os valores de transação dividida não podem ser alterados e, se um valor diferente for fornecido, eles serão ignorados.
ID do destinatário
 payee_id uuid

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

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

A categoria da transação. Para configurar uma transação dividida, você pode especificar nulo e category_id fornecer uma subtransactions matriz como parte do objeto de transação. Se uma transação existente for uma divisão, ela category_id não poderá ser alterada. Categorias de pagamento de cartão de crédito não são permitidas e serão ignoradas se fornecidas.
Memorando
 memo string

O memorando.
Desmarcada
 cleared string

O status desmarcado da transação.
Aprovada
 approved boolean

Se a transação foi aprovada ou não. Se não for fornecida, a transação não será aprovada por padrão.
Cor do Sinalizador
 flag_color string

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

Se especificada, a nova transação será atribuída a ela import_id e considerada "importada". Também tentaremos corresponder essa 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.

As transações importadas por meio da Importação Baseada em Arquivo ou importação direta (não por meio da API) recebem uma import_id no 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 valor, sua import_id seria 'YNAB:-294230:2015-12-30:2'. O uso de um formato consistente impedirá duplicatas 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". Dessa forma, ele será qualificado para ser correspondido às transações que serão importadas posteriormente (via DI, FBI ou API).
Quantidade
 amount True integer

A quantidade de subtransação no formato milliunits.
ID do destinatário
 payee_id uuid

O destinatário da subtransação.
Beneficiário
 payee_name string

O nome do destinatário. Se um payee_name valor for fornecido e payee_id tiver um valor nulo, o payee_name valor será usado para resolver o destinatário por (1) uma regra de renomeação de destinatário correspondente (somente se import_id também for especificado na transação pai) ou (2) um destinatário com o mesmo nome ou (3) criação de um novo destinatário.
ID da categoria
 category_id uuid

A categoria da subtransação. Categorias de pagamento de cartão de crédito não são permitidas e serão ignoradas se fornecidas.
Memorando
 memo string

O memorando.

Retornos

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

Nome Chave Obrigatório Tipo Description
ID do orçamento
 budget_id True string

O identificador do orçamento. "usado pela última vez" 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 (consulte: https://api.youneedabudget.com/#oauth-default-budget).
ID
 id True string

O identificador.
AccountID
 account_id True string

O identificador da conta.
Date
 date True date

A data da transação no 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.
Quantidade
 amount True integer

O valor da transação no formato milliunits. Os valores de transação dividida não podem ser alterados e, se um valor diferente for fornecido, eles serão ignorados.
ID do destinatário
 payee_id uuid

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

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

A categoria da transação. Para configurar uma transação dividida, você pode especificar nulo e category_id fornecer uma subtransactions matriz como parte do objeto de transação. Se uma transação existente for uma divisão, ela category_id não poderá ser alterada. Categorias de pagamento de cartão de crédito não são permitidas e serão ignoradas se fornecidas.
Memorando
 memo string

O memorando.
Desmarcada
 cleared string

O status desmarcado da transação.
Aprovada
 approved boolean

Se a transação foi aprovada ou não. Se não for fornecida, a transação não será aprovada por padrão.
Cor do Sinalizador
 flag_color string

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

Se especificada, a nova transação será atribuída a ela import_id e considerada "importada". Também tentaremos corresponder essa 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.

As transações importadas por meio da Importação Baseada em Arquivo ou importação direta (não por meio da API) recebem uma import_id no 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 valor, sua import_id seria 'YNAB:-294230:2015-12-30:2'. O uso de um formato consistente impedirá duplicatas 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". Dessa forma, ele será qualificado para ser correspondido às transações que serão importadas posteriormente (via DI, FBI ou API).
Quantidade
 amount True integer

A quantidade de subtransação no formato milliunits.
ID do destinatário
 payee_id uuid

O destinatário da subtransação.
Beneficiário
 payee_name string

O nome do destinatário. Se um payee_name valor for fornecido e payee_id tiver um valor nulo, o payee_name valor será usado para resolver o destinatário por (1) uma regra de renomeação de destinatário correspondente (somente se import_id também for especificado na transação pai) ou (2) um destinatário com o mesmo nome ou (3) criação de um novo destinatário.
ID da categoria
 category_id uuid

A categoria da subtransação. Categorias de pagamento de cartão de crédito não são permitidas e serão ignoradas se fornecidas.
Memorando
 memo string

O memorando.

Retornos

Salvar resposta de transações
SaveTransactionsResponse

Criar conta

ID da operação:
CreateAccount

Cria uma nova conta.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do orçamento
 budget_id True string

O identificador do orçamento ("usado pela última vez" 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 (consulte: https://api.youneedabudget.com/#oauth-default-budget)
Nome
 name True string

O nome da conta.
Tipo2
 type True string

O tipo de conta
Saldo
 balance True integer

O saldo atual da conta no formato milliunits.

Retornos

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. Transações agendadas não podem ser criadas neste ponto de extremidade.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do orçamento
 budget_id True string

O identificador do orçamento. "usado pela última vez" 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 (consulte: https://api.youneedabudget.com/#oauth-default-budget).
AccountID
 account_id True string

O identificador da conta.
Date
 date True date

A data da transação no 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.
Quantidade
 amount True integer

O valor da transação no formato milliunits. Os valores de transação dividida não podem ser alterados e, se um valor diferente for fornecido, eles serão ignorados.
ID do destinatário
 payee_id uuid

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

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

A categoria da transação. Para configurar uma transação dividida, você pode especificar nulo e category_id fornecer uma subtransactions matriz como parte do objeto de transação. Se uma transação existente for uma divisão, ela category_id não poderá ser alterada. Categorias de pagamento de cartão de crédito não são permitidas e serão ignoradas se fornecidas.
Memorando
 memo string

O memorando.
Desmarcada
 cleared string

O status desmarcado da transação.
Aprovada
 approved boolean

Se a transação foi aprovada ou não. Se não for fornecida, a transação não será aprovada por padrão.
Cor do Sinalizador
 flag_color string

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

Se especificada, a nova transação será atribuída a ela import_id e considerada "importada". Também tentaremos corresponder essa 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.

As transações importadas por meio da Importação Baseada em Arquivo ou importação direta (não por meio da API) recebem uma import_id no 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 valor, sua import_id seria 'YNAB:-294230:2015-12-30:2'. O uso de um formato consistente impedirá duplicatas 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". Dessa forma, ele será qualificado para ser correspondido às transações que serão importadas posteriormente (via DI, FBI ou API).
Quantidade
 amount True integer

A quantidade de subtransação no formato milliunits.
ID do destinatário
 payee_id uuid

O destinatário da subtransação.
Beneficiário
 payee_name string

O nome do destinatário. Se um payee_name valor for fornecido e payee_id tiver um valor nulo, o payee_name valor será usado para resolver o destinatário por (1) uma regra de renomeação de destinatário correspondente (somente se import_id também for especificado na transação pai) ou (2) um destinatário com o mesmo nome ou (3) criação de um novo destinatário.
ID da categoria
 category_id uuid

A categoria da subtransação. Categorias de pagamento de cartão de crédito não são permitidas e serão ignoradas se fornecidas.
Memorando
 memo string

O memorando.
AccountID
 account_id True string

O identificador da conta.
Date
 date True date

A data da transação no 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.
Quantidade
 amount True integer

O valor da transação no formato milliunits. Os valores de transação dividida não podem ser alterados e, se um valor diferente for fornecido, eles serão ignorados.
ID do destinatário
 payee_id uuid

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

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

A categoria da transação. Para configurar uma transação dividida, você pode especificar nulo e category_id fornecer uma subtransactions matriz como parte do objeto de transação. Se uma transação existente for uma divisão, ela category_id não poderá ser alterada. Categorias de pagamento de cartão de crédito não são permitidas e serão ignoradas se fornecidas.
Memorando
 memo string

O memorando.
Desmarcada
 cleared string

O status desmarcado da transação.
Aprovada
 approved boolean

Se a transação foi aprovada ou não. Se não for fornecida, a transação não será aprovada por padrão.
Cor do Sinalizador
 flag_color string

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

Se especificada, a nova transação será atribuída a ela import_id e considerada "importada". Também tentaremos corresponder essa 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.

As transações importadas por meio da Importação Baseada em Arquivo ou importação direta (não por meio da API) recebem uma import_id no 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 valor, sua import_id seria 'YNAB:-294230:2015-12-30:2'. O uso de um formato consistente impedirá duplicatas 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". Dessa forma, ele será qualificado para ser correspondido às transações que serão importadas posteriormente (via DI, FBI ou API).
Quantidade
 amount True integer

A quantidade de subtransação no formato milliunits.
ID do destinatário
 payee_id uuid

O destinatário da subtransação.
Beneficiário
 payee_name string

O nome do destinatário. Se um payee_name valor for fornecido e payee_id tiver um valor nulo, o payee_name valor será usado para resolver o destinatário por (1) uma regra de renomeação de destinatário correspondente (somente se import_id também for especificado na transação pai) ou (2) um destinatário com o mesmo nome ou (3) criação de um novo destinatário.
ID da categoria
 category_id uuid

A categoria da subtransação. Categorias de pagamento de cartão de crédito não são permitidas e serão ignoradas se fornecidas.
Memorando
 memo string

O memorando.

Retornos

Salvar resposta de transações
SaveTransactionsResponse

Criar transações em massa

ID da operação:
BulkCreateTransactions

Cria várias transações. Embora esse ponto de extremidade ainda tenha suporte, é recomendável usar 'POST /budgets/{budget_id}/transactions' para criar várias transações.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do orçamento
 budget_id True string

O identificador do orçamento. "usado pela última vez" 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 (consulte: https://api.youneedabudget.com/#oauth-default-budget).
AccountID
 account_id True string

O identificador da conta.
Date
 date True date

A data da transação no 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.
Quantidade
 amount True integer

O valor da transação no formato milliunits. Os valores de transação dividida não podem ser alterados e, se um valor diferente for fornecido, eles serão ignorados.
ID do destinatário
 payee_id uuid

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

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

A categoria da transação. Para configurar uma transação dividida, você pode especificar nulo e category_id fornecer uma subtransactions matriz como parte do objeto de transação. Se uma transação existente for uma divisão, ela category_id não poderá ser alterada. Categorias de pagamento de cartão de crédito não são permitidas e serão ignoradas se fornecidas.
Memorando
 memo string

O memorando.
Desmarcada
 cleared string

O status desmarcado da transação.
Aprovada
 approved boolean

Se a transação foi aprovada ou não. Se não for fornecida, a transação não será aprovada por padrão.
Cor do Sinalizador
 flag_color string

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

Se especificada, a nova transação será atribuída a ela import_id e considerada "importada". Também tentaremos corresponder essa 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.

As transações importadas por meio da Importação Baseada em Arquivo ou importação direta (não por meio da API) recebem uma import_id no 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 valor, sua import_id seria 'YNAB:-294230:2015-12-30:2'. O uso de um formato consistente impedirá duplicatas 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". Dessa forma, ele será qualificado para ser correspondido às transações que serão importadas posteriormente (via DI, FBI ou API).
Quantidade
 amount True integer

A quantidade de subtransação no formato milliunits.
ID do destinatário
 payee_id uuid

O destinatário da subtransação.
Beneficiário
 payee_name string

O nome do destinatário. Se um payee_name valor for fornecido e payee_id tiver um valor nulo, o payee_name valor será usado para resolver o destinatário por (1) uma regra de renomeação de destinatário correspondente (somente se import_id também for especificado na transação pai) ou (2) um destinatário com o mesmo nome ou (3) criação de um novo destinatário.
ID da categoria
 category_id uuid

A categoria da subtransação. Categorias de pagamento de cartão de crédito não são permitidas e serão ignoradas se fornecidas.
Memorando
 memo string

O memorando.

Retornos

Resposta em massa
BulkResponse

Importar transações

ID da operação:
ImportTransactions

Importa transações disponíveis em todas as contas vinculadas 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 esse ponto de extremidade é o equivalente a clicar em "Importar" em cada conta no aplicativo Web ou tocar na faixa "Novas Transações" nos aplicativos móveis. A resposta para esse ponto de extremidade contém as IDs de transação que foram importadas.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do orçamento
 budget_id True string

O identificador do orçamento. "usado pela última vez" 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 (consulte: https://api.youneedabudget.com/#oauth-default-budget).

Retornos

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

Obter categoria de mês por ID

ID da operação:
GetMonthCategoryById

Retorna uma única categoria para um mês de orçamento específico. Os valores (orçado, atividade, saldo etc.) são específicos para o UTC (mês de orçamento atual).

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do orçamento
 budget_id True string

O identificador do orçamento. "usado pela última vez" 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 (consulte: https://api.youneedabudget.com/#oauth-default-budget).
Mês
 month True date

O mês de orçamento no formato ISO (por exemplo, 2016-12-01). ("atual" 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.

Retornos

Resposta de categoria
CategoryResponse

Obter categoria por ID

ID da operação:
GetCategoryById

Retorna uma única categoria. Os valores (orçado, atividade, saldo etc.) são específicos para o UTC (mês de orçamento atual).

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do orçamento
 budget_id True string

O identificador do orçamento. "usado pela última vez" 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 (consulte: https://api.youneedabudget.com/#oauth-default-budget).
ID da categoria
 category_id True string

O identificador da categoria.

Retornos

Resposta de categoria
CategoryResponse

Obter categorias

ID da operação:
GetCategories

Retorna todas as categorias agrupadas por grupo de categorias. Os valores (orçado, atividade, saldo etc.) são específicos para o UTC (mês de orçamento atual).

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do orçamento
 budget_id True string

O identificador do orçamento. "usado pela última vez" 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 (consulte: https://api.youneedabudget.com/#oauth-default-budget).
Último conhecimento do servidor
 last_knowledge_of_server integer

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

Retornos

Resposta de categorias
CategoriesResponse

Obter configurações de orçamento por ID

ID da operação:
GetBudgetSettingsById

Retorna as configurações de um orçamento

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do orçamento
 budget_id True string

O identificador do orçamento. "usado pela última vez" 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 (consulte: https://api.youneedabudget.com/#oauth-default-budget).

Retornos

Resposta de configurações de orçamento
BudgetSettingsResponse

Obter conta por ID

ID da operação:
GetAccountById

Retorna uma única conta.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do orçamento
 budget_id True string

O identificador do orçamento. "usado pela última vez" 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 (consulte: https://api.youneedabudget.com/#oauth-default-budget).
AccountID
 account_id True uuid

O identificador da conta.

Retornos

Resposta da conta
AccountResponse

Obter contas

ID da operação:
GetAccounts

Retorna todas as contas.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do orçamento
 budget_id True string

O identificador do orçamento. "usado pela última vez" 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 (consulte: https://api.youneedabudget.com/#oauth-default-budget).
Último conhecimento do servidor
 last_knowledge_of_server integer

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

Retornos

Resposta de contas
AccountsResponse

Obter locais do destinatário

ID da operação:
GetPayeeLocations

Retorna todos os locais do destinatário.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do orçamento
 budget_id True string

O identificador do orçamento. "usado pela última vez" 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 (consulte: https://api.youneedabudget.com/#oauth-default-budget).

Retornos

Resposta de locais do payee
PayeeLocationsResponse

Obter locais do destinatário pelo destinatário

ID da operação:
GetPayeeLocationsByPayee

Retorna todos os locais do destinatário para um destinatário especificado.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do orçamento
 budget_id True string

O identificador do orçamento. "usado pela última vez" 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 (consulte: https://api.youneedabudget.com/#oauth-default-budget).
ID do destinatário
 payee_id True string

O identificador do destinatário.

Retornos

Resposta de locais do payee
PayeeLocationsResponse

Obter meses de orçamento

ID da operação:
GetBudgetMonths

Retorna todos os meses de orçamento.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do orçamento
 budget_id True string

O identificador do orçamento. "usado pela última vez" 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 (consulte: https://api.youneedabudget.com/#oauth-default-budget).
Último conhecimento do servidor
 last_knowledge_of_server integer

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

Retornos

Resposta de resumos de mês
MonthSummariesResponse

Obter o destinatário por ID

ID da operação:
GetPayeeById

Retorna um único destinatário.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do orçamento
 budget_id True string

O identificador do orçamento. "usado pela última vez" 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 (consulte: https://api.youneedabudget.com/#oauth-default-budget).
ID do destinatário
 payee_id True string

O identificador do destinatário.

Retornos

Resposta do destinatário
PayeeResponse

Obter o local do destinatário por ID

ID da operação:
GetPayeeLocationById

Retorna um único local de pagamento.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do orçamento
 budget_id True string

O identificador do orçamento. "usado pela última vez" 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 (consulte: https://api.youneedabudget.com/#oauth-default-budget).
ID do local do destinatário
 payee_location_id True string

Identificador do local do destinatário.

Retornos

Resposta de local do destinatário
PayeeLocationResponse

Obter o mês do orçamento

ID da operação:
GetBudgetMonth

Retorna um único mês de orçamento.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do orçamento
 budget_id True string

O identificador do orçamento. "usado pela última vez" 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 (consulte: https://api.youneedabudget.com/#oauth-default-budget).
Mês
 month True date

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

Retornos

Resposta de detalhes do mês
MonthDetailResponse

Obter orçamento por ID

ID da operação:
GetBudgetById

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

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do orçamento
 budget_id True string

O identificador do orçamento.
Último conhecimento do servidor
 last_knowledge_of_server integer

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

Retornos

Resposta de detalhes do orçamento
BudgetDetailResponse

Obter orçamentos

ID da operação:
GetBudgets

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Incluir contas
 include_accounts boolean

Se deve incluir a lista de contas de orçamento.

Retornos

Resposta de resumo do orçamento
BudgetSummaryResponse

Obter pagamentos

ID da operação:
GetPayees

Retorna todos os pagantes.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do orçamento
 budget_id True string

O identificador do orçamento. "usado pela última vez" 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 (consulte: https://api.youneedabudget.com/#oauth-default-budget).
Último conhecimento do servidor
 last_knowledge_of_server integer

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

Retornos

Resposta do Payees
PayeesResponse

Obter transação agendada por ID

ID da operação:
GetScheduledTransactionById

Retorna uma única transação agendada.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do orçamento
 budget_id True string

O identificador do orçamento. "usado pela última vez" 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 (consulte: https://api.youneedabudget.com/#oauth-default-budget).
ID da transação agendada
 scheduled_transaction_id True string

O identificador da transação agendada.

Retornos

Resposta de transação agendada
ScheduledTransactionResponse

Obter transação por ID

ID da operação:
GetTransactionById

Retorna uma única transação.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do orçamento
 budget_id True string

O identificador do orçamento. "usado pela última vez" 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 (consulte: https://api.youneedabudget.com/#oauth-default-budget).
ID da transação
 transaction_id True string

O identificador da transação.

Retornos

Resposta da transação
TransactionResponse

Obter transações

ID da operação:
GetTransactions

Retorna transações de orçamento.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do orçamento
 budget_id True string

O identificador do orçamento. "usado pela última vez" 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 (consulte: https://api.youneedabudget.com/#oauth-default-budget).
Desde a Data
 since_date date

Se especificado, somente as transações em ou após essa data serão incluídas. A data deve ser formatada em ISO (por exemplo, 2016-12-30).
Tipo
 type string

Se especificado, somente as transações do tipo especificado serão incluídas. Atualmente, há suporte para "não categorizado" e "não aprovado".
Último conhecimento do servidor
 last_knowledge_of_server integer

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

Retornos

Resposta de transações
TransactionsResponse

Obter transações agendadas

ID da operação:
GetScheduledTransactions

Retorna todas as transações agendadas.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do orçamento
 budget_id True string

O identificador do orçamento. "usado pela última vez" 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 (consulte: https://api.youneedabudget.com/#oauth-default-budget).
Último conhecimento do servidor
 last_knowledge_of_server integer

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

Retornos

Resposta de transações agendadas
ScheduledTransactionsResponse

Obter transações por categoria

ID da operação:
GetTransactionsByCategory

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

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do orçamento
 budget_id True string

O identificador do orçamento. "usado pela última vez" 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 (consulte: 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, somente as transações em ou após essa data serão incluídas. A data deve ser formatada em ISO (por exemplo, 2016-12-30).
Tipo
 type string

Se especificado, somente as transações do tipo especificado serão incluídas. Atualmente, há suporte para "não categorizado" e "não aprovado".
Último conhecimento do servidor
 last_knowledge_of_server integer

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

Retornos

Resposta de transações híbridas
HybridTransactionsResponse

Obter transações por conta

ID da operação:
GetTransactionsByAccount

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

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do orçamento
 budget_id True string

O identificador do orçamento. "usado pela última vez" 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 (consulte: https://api.youneedabudget.com/#oauth-default-budget).
AccountID
 account_id True string

O identificador da conta.
Desde a Data
 since_date date

Se especificado, somente as transações em ou após essa data serão incluídas. A data deve ser formatada em ISO (por exemplo, 2016-12-30).
Tipo
 type string

Se especificado, somente as transações do tipo especificado serão incluídas. Atualmente, há suporte para "não categorizado" e "não aprovado".
Último conhecimento do servidor
 last_knowledge_of_server integer

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

Retornos

Resposta de transações
TransactionsResponse

Obter transações por destinatário

ID da operação:
GetTransactionsByPayee

Retorna todas as transações para um destinatário especificado.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do orçamento
 budget_id True string

O identificador do orçamento. "usado pela última vez" 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 (consulte: https://api.youneedabudget.com/#oauth-default-budget).
ID do destinatário
 payee_id True string

O identificador do destinatário.
Desde a Data
 since_date date

Se especificado, somente as transações em ou após essa data serão incluídas. A data deve ser formatada em ISO (por exemplo, 2016-12-30).
Tipo
 type string

Se especificado, somente as transações do tipo especificado serão incluídas. Atualmente, há suporte para "não categorizado" e "não aprovado".
Último conhecimento do servidor
 last_knowledge_of_server integer

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

Retornos

Resposta de transações híbridas
HybridTransactionsResponse

Obter usuário

ID da operação:
GetUser

Retorna informações do usuário autenticado.

Retornos

Resposta do usuário
UserResponse

Definições

UserResponse

Nome Caminho Tipo Description
Dados
 data Data

Utilizador

Nome Caminho Tipo Description
ID
 id string

O identificador.

DateFormat

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

Nome Caminho Tipo Description
Formato
 format string

O formato.

CurrencyFormat

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

Nome 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 de moeda
 currency_symbol string

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

Se o símbolo é exibido.

BudgetSummaryResponse

Nome Caminho Tipo Description
Data1
 data Data1

BudgetSummary

Nome Caminho Tipo Description
ID
 id string

O identificador.
Nome
 name string

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

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

O mês do orçamento mais antigo.
Último Mês
 last_month date

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

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

A configuração de 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 somente se include_accounts=true especificadas como parâmetro de consulta).

BudgetDetailResponse

Nome Caminho Tipo Description
Data2
 data Data2

BudgetDetail

Nome Caminho Tipo Description
ID
 id string

O identificador.
Nome
 name string

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

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

O mês do orçamento mais antigo.
Último Mês
 last_month date

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

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

A configuração de 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 somente se include_accounts=true especificadas como parâmetro de consulta).
Beneficiários
 payees array of Payee
Locais do Payee
 payee_locations array of PayeeLocation
Grupos de categorias
 category_groups array of CategoryGroup
Categorias
 categories array of Category
Meses
 months array of MonthDetail
Transactions
 transactions array of TransactionSummary
Subtransações
 subtransactions array of SubTransaction
Transações agendadas
 scheduled_transactions array of ScheduledTransactionSummary
Subtransações agendadas
 scheduled_subtransactions array of ScheduledSubTransaction

BudgetSettingsResponse

Nome Caminho Tipo Description
Data3
 data Data3

BudgetSettings

Nome Caminho Tipo Description
Formato de data
 date_format DateFormat

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

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

AccountsResponse

Nome Caminho Tipo Description
Data4
 data Data4

AccountResponse

Nome Caminho Tipo Description
Dados5
 data Data5

Conta

Nome Caminho Tipo Description
ID
 id string

O identificador.
Nome
 name string

O nome.
Tipo
 type Type

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

Se essa conta está no orçamento ou não
Fechado
 closed boolean

Se essa conta está fechada ou não
Observação
 note string

A anotação.
Saldo
 balance integer

O saldo atual da conta no formato milliunits.
Saldo Desmarcado
 cleared_balance integer

O saldo desmarcado atual da conta no formato milliunits.
Saldo Não Claro
 uncleared_balance integer

O saldo não claro atual da conta no formato milliunits.
Transferir ID do Destinatário
 transfer_payee_id string

O identificador do destinatário que deve ser usado ao transferir para essa 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.
Importação direta em erro
 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.
Excluído
 deleted boolean

Se a conta foi excluída ou não. As contas excluídas serão incluídas apenas em solicitações delta.

CategoriesResponse

Nome Caminho Tipo Description
Data6
 data Data6

CategoryResponse

Nome Caminho Tipo Description
Data7
 data Data7

CategoryGroupWithCategories

Nome Caminho Tipo Description
ID
 id string

O identificador.
Nome
 name string

O nome.
Oculto
 hidden boolean

Se o grupo de categorias está oculto ou não.
Excluído
 deleted boolean

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

Categorias de grupo de categorias. Os valores (orçado, atividade, saldo etc.) são específicos para o UTC (mês de orçamento atual).

CategoryGroup

Nome Caminho Tipo Description
ID
 id string

O identificador.
Nome
 name string

O nome.
Oculto
 hidden boolean

Se o grupo de categorias está oculto ou não.
Excluído
 deleted boolean

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

Categoria

Nome Caminho Tipo Description
ID
 id string

O identificador.
ID do Grupo de Categorias
 category_group_id string

O identificador do grupo de categorias.
Nome
 name string

O nome.
Oculto
 hidden boolean

Se a categoria está oculta ou não.
ID original do grupo de categorias
 original_category_group_id uuid

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

A anotação.
Orçado
 budgeted integer

Valor orçado no formato milliunits.
Activity
 activity integer

Quantidade de atividade no formato milliunits.
Saldo
 balance integer

Balancear no formato milliunits.
Tipo de meta
 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 de Criação de Meta
 goal_creation_month date

No mês em que uma meta foi criada.
Destino de meta
 goal_target integer

A quantidade de destino de meta em mililitros.
Mês de Destino da Meta
 goal_target_month date

O mês de destino original para a meta a ser concluída. Apenas alguns tipos de meta especificam essa data.
Porcentagem de metas concluída
 goal_percentage_complete integer

O percentual de conclusão da meta.
Meta meses para o orçamento
 goal_months_to_budget integer

O número de meses, incluindo o mês atual, deixado no período de meta atual.
Meta em Financiado
 goal_under_funded integer

A quantidade de financiamento ainda necessária no mês atual 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 exibir uma categoria com uma meta necessária para gastos em um mês futuro. Os clientes web e móveis ignorarão qualquer financiamento de um período de meta anterior ao exibir a categoria com uma Meta necessária para gastos em um mês futuro.
Meta Geral Financiada
 goal_overall_funded integer

O valor total financiado para a meta dentro do período de meta atual.
Meta geral à esquerda
 goal_overall_left integer

A quantidade de financiamento ainda precisava para completar a meta dentro do período de meta atual.
Excluído
 deleted boolean

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

SaveCategoryResponse

Nome Caminho Tipo Description
Data8
 data Data8

PayeesResponse

Nome Caminho Tipo Description
Data9
 data Data9

PayeeResponse

Nome Caminho Tipo Description
Data10
 data Data10

Beneficiário

Nome Caminho Tipo Description
ID
 id string

O identificador.
Nome
 name string

O nome.
Transferir ID da conta
 transfer_account_id string

Se um destinatário de transferência, para o account_id qual esse destinatário é transferido.
Excluído
 deleted boolean

Se o destinatário foi excluído ou não. Os payees excluídos serão incluídos apenas em solicitações delta.

PayeeLocationsResponse

Nome Caminho Tipo Description
Data11
 data Data11

PayeeLocationResponse

Nome Caminho Tipo Description
Data12
 data Data12

PayeeLocation

Nome Caminho Tipo Description
ID
 id string

O identificador.
ID do destinatário
 payee_id string

O identificador do destinatário.
Latitude
 latitude string

A latitude.
Longitude
 longitude string

A longitude.
Excluído
 deleted boolean

Se o local do destinatário foi excluído ou não. Os locais de destinatário excluídos serão incluídos apenas em solicitações delta.

TransactionsResponse

Nome Caminho Tipo Description
Data13
 data Data13

HybridTransactionsResponse

Nome Caminho Tipo Description
Data14
 data Data14

SaveTransactionsResponse

Nome Caminho Tipo Description
Data15
 data Data15

TransactionResponse

Nome Caminho Tipo Description
Data16
 data Data16

TransactionSummary

Nome Caminho Tipo Description
ID
 id string

O identificador.
Date
 date date

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

O valor da transação no formato milliunits.
Memorando
 memo string

O memorando.
Desmarcada
 cleared Cleared

O status desmarcado da transação.
Aprovada
 approved boolean

Se a transação foi aprovada ou não.
Cor do Sinalizador
 flag_color FlagColor

O sinalizador de transação.
AccountID
 account_id string

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

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

O identificador de categoria.
Transferir ID da conta
 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 uma transação de transferência, o identificador da transação do outro lado da transferência.
ID da 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, esse campo será um identificador de importação exclusivo (por conta). Se essa transação tiver sido importada por meio de Importação Baseada em Arquivo ou Importação Direta e não por meio 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 valor, sua import_id seria 'YNAB:-294230:2015-12-30:2'.
Excluído
 deleted boolean

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

TransactionDetail

Nome Caminho Tipo Description
ID
 id string

O identificador.
Date
 date date

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

O valor da transação no formato milliunits.
Memorando
 memo string

O memorando.
Desmarcada
 cleared Cleared

O status desmarcado da transação.
Aprovada
 approved boolean

Se a transação foi aprovada ou não.
Cor do Sinalizador
 flag_color FlagColor

O sinalizador de transação.
AccountID
 account_id string

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

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

O identificador de categoria.
Transferir ID da conta
 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 uma transação de transferência, o identificador da transação do outro lado da transferência.
ID da 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, esse campo será um identificador de importação exclusivo (por conta). Se essa transação tiver sido importada por meio de Importação Baseada em Arquivo ou Importação Direta e não por meio 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 valor, sua import_id seria 'YNAB:-294230:2015-12-30:2'.
Excluído
 deleted boolean

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

O nome da conta.
Beneficiário
 payee_name string

O nome do destinatário.
Categoria
 category_name string

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

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

HybridTransaction

Nome Caminho Tipo Description
ID
 id string

O identificador.
Date
 date date

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

O valor da transação no formato milliunits.
Memorando
 memo string

O memorando.
Desmarcada
 cleared Cleared

O status desmarcado da transação.
Aprovada
 approved boolean

Se a transação foi aprovada ou não.
Cor do Sinalizador
 flag_color FlagColor

O sinalizador de transação.
AccountID
 account_id string

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

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

O identificador de categoria.
Transferir ID da conta
 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 uma transação de transferência, o identificador da transação do outro lado da transferência.
ID da 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, esse campo será um identificador de importação exclusivo (por conta). Se essa transação tiver sido importada por meio de Importação Baseada em Arquivo ou Importação Direta e não por meio 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 valor, sua import_id seria 'YNAB:-294230:2015-12-30:2'.
Excluído
 deleted boolean

Se a transação foi excluída ou não. As transações excluídas serão incluídas apenas 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, esse é o identificador da transação pai. Para tipos de transação, esse identificador sempre será nulo.
Nome da Conta
 account_name string

O nome da conta.
Beneficiário
 payee_name string

O nome do destinatário.
Categoria
 category_name string

O nome da categoria.

TransactionsImportResponse

Nome Caminho Tipo Description
Data17
 data Data17

BulkResponse

Nome Caminho Tipo Description
Data18
 data Data18

SubTransação

Nome Caminho Tipo Description
ID
 id string

O identificador.
ID da transação
 transaction_id string

A transação.
Quantidade
 amount integer

A quantidade de subtransação no formato milliunits.
Memorando
 memo string

O memorando.
ID do destinatário
 payee_id string

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

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

O identificador de categoria.
Categoria
 category_name string

O nome da categoria.
Transferir ID da conta
 transfer_account_id uuid

Se uma transferência, a account_id para a 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.
Excluído
 deleted boolean

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

ScheduledTransactionsResponse

Nome Caminho Tipo Description
Data19
 data Data19

ScheduledTransactionResponse

Nome Caminho Tipo Description
Data20
 data Data20

ScheduledTransactionSummary

Nome Caminho Tipo Description
ID
 id string

O identificador.
Primeira data
 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.
Quantidade
 amount integer

O valor da transação agendada no formato milliunits.
Memorando
 memo string

O memorando.
FlagColor1
 flag_color FlagColor1

O sinalizador de transação agendado.
AccountID
 account_id string

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

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

O identificador de categoria.
Transferir ID da conta
 transfer_account_id uuid

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

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

ScheduledTransactionDetail

Nome Caminho Tipo Description
ID
 id string

O identificador.
Primeira data
 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.
Quantidade
 amount integer

O valor da transação agendada no formato milliunits.
Memorando
 memo string

O memorando.
FlagColor1
 flag_color FlagColor1

O sinalizador de transação agendado.
AccountID
 account_id string

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

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

O identificador de categoria.
Transferir ID da conta
 transfer_account_id uuid

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

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

O nome da conta.
Beneficiário
 payee_name string

O nome do destinatário.
Categoria
 category_name string

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

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

ScheduledSubTransaction

Nome Caminho Tipo Description
ID
 id string

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

O identificador de transação agendado.
Quantidade
 amount integer

A quantidade de subtransação agendada no formato milliunits.
Memorando
 memo string

O memorando.
ID do destinatário
 payee_id string

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

O identificador de categoria.
Transferir ID da conta
 transfer_account_id uuid

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

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

MonthSummariesResponse

Nome Caminho Tipo Description
Data21
 data Data21

MonthDetailResponse

Nome Caminho Tipo Description
Data22
 data Data22

MonthSummary

Nome Caminho Tipo Description
Mês
 month date

O mês.
Observação
 note string

A anotação.
Rendimento
 income integer

A quantidade total de transações categorizadas como 'Inflow: Ready to Assign' no mês.
Orçado
 budgeted integer

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

A quantidade total de transações no mês, excluindo aquelas categorizadas como 'Inflow: Ready to Assign'.
Para ser orçado
 to_be_budgeted integer

O valor disponível para 'Pronto para Atribuir'.
Era do Dinheiro
 age_of_money integer

A Era do Dinheiro a partir do mês.
Excluído
 deleted boolean

Se o mês foi excluído ou não. Os meses excluídos serão incluídos apenas em solicitações delta.

MonthDetail

Nome Caminho Tipo Description
Mês
 month date

O mês.
Observação
 note string

A anotação.
Rendimento
 income integer

A quantidade total de transações categorizadas como 'Inflow: Ready to Assign' no mês.
Orçado
 budgeted integer

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

A quantidade total de transações no mês, excluindo aquelas categorizadas como 'Inflow: Ready to Assign'.
Para ser orçado
 to_be_budgeted integer

O valor disponível para 'Pronto para Atribuir'.
Era do Dinheiro
 age_of_money integer

A Era do Dinheiro a partir do mês.
Excluído
 deleted boolean

Se o mês foi excluído ou não. Os meses excluídos serão incluídos apenas em solicitações delta.
Categorias
 categories array of Category

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

Em massa

Nome 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 quaisquer Transações não tiverem sido criadas porque elas tinham uma import_id transação correspondente já na mesma conta, os import_id especificados serão incluídos nesta lista.

Desmarcada

O status desmarcado da transação.

O status desmarcado da transação.

Desmarcada
string

Dados

Nome Caminho Tipo Description
Utilizador
 user User

Data1

Nome Caminho Tipo Description
Budgets
 budgets array of BudgetSummary
Resumo do Orçamento
 default_budget BudgetSummary

Data2

Nome Caminho Tipo Description
Detalhes do orçamento
 budget BudgetDetail
Conhecimento do servidor
 server_knowledge integer

O conhecimento do servidor.

Data3

Nome Caminho Tipo Description
Configurações de Orçamento
 settings BudgetSettings

Data4

Nome Caminho Tipo Description
Accounts
 accounts array of Account
Conhecimento do servidor
 server_knowledge integer

O conhecimento do servidor.

Dados5

Nome Caminho Tipo Description
Conta
 account Account

Data6

Nome 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.

Data7

Nome Caminho Tipo Description
Categoria
 category Category

Data8

Nome Caminho Tipo Description
Categoria
 category Category
Conhecimento do servidor
 server_knowledge integer

O conhecimento do servidor.

Data9

Nome Caminho Tipo Description
Beneficiários
 payees array of Payee

Os pagantes.
Conhecimento do servidor
 server_knowledge integer

O conhecimento do servidor.

Data10

Nome Caminho Tipo Description
Beneficiário
 payee Payee

Data11

Nome Caminho Tipo Description
Locais do Payee
 payee_locations array of PayeeLocation

Os locais do destinatário.

Data12

Nome Caminho Tipo Description
Local do destinatário
 payee_location PayeeLocation

Data13

Nome Caminho Tipo Description
Transactions
 transactions array of TransactionDetail

As transações.
Conhecimento do servidor
 server_knowledge integer

O conhecimento do servidor.

Data14

Nome Caminho Tipo Description
Transactions
 transactions array of HybridTransaction

As transações.

Data15

Nome 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.

Data16

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

Data17

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

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

Data18

Nome Caminho Tipo Description
Em massa
 bulk Bulk

Data19

Nome Caminho Tipo Description
scheduled_transactions
 scheduled_transactions array of ScheduledTransactionDetail
Conhecimento do servidor
 server_knowledge integer

O conhecimento do servidor.

Data20

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

Data21

Nome Caminho Tipo Description
meses
 months array of MonthSummary
Conhecimento do servidor
 server_knowledge integer

O conhecimento do servidor.

Data22

Nome Caminho Tipo Description
Detalhes do mês
 month MonthDetail

FlagColor

O sinalizador de transação.

O sinalizador de transação.

Cor do Sinalizador
string

FlagColor1

O sinalizador de transação agendado.

O sinalizador de transação agendado.

FlagColor1
string

Frequência

A frequência.

A frequência.

Frequência
string

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')

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 meta
string

Tipo

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

O tipo de conta. Observação: 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