Update Transaction with You Need a Budget API

Pipedream makes it easy to connect APIs for You Need a Budget and 2,400+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Update Transaction with the You Need a Budget API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Update Transaction with the You Need a Budget API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Update Transaction action
1. Connect your You Need a Budget account
2. Select a Budget ID
3. Select a Account ID
4. Select a Transaction ID
5. Configure Date
6. Optional- Select a Payee ID
7. Optional- Select a Category ID
8. Configure Amount
9. Optional- Configure Memo
10. Optional- Select one or more Cleared
11. Optional- Configure Approved
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Update Transaction with You Need a Budget API on New Requests from HTTP / Webhook API

HTTP / Webhook + You Need a Budget

Try it

Update Transaction with You Need a Budget API on New Submission from Typeform API

Typeform + You Need a Budget

Try it

Update Transaction with You Need a Budget API on New Submission (Instant) from Jotform API

Jotform + You Need a Budget

Try it

Update Transaction with You Need a Budget API on New Scheduled Tasks from Pipedream API

Pipedream + You Need a Budget

Try it

Update Transaction with You Need a Budget API on npm Download Counts from npm API

npm + You Need a Budget

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Update Transaction on You Need a Budget

Description:Update an existing transaction. [See the docs](https://api.youneedabudget.com/v1#/Transactions/updateTransaction)

Version:0.0.2

Key:you_need_a_budget-update-transaction

View on GitHub

Code#

import constants from "../../common/constants.mjs";
import app from "../../you_need_a_budget.app.mjs";

export default {
  key: "you_need_a_budget-update-transaction",
  name: "Update Transaction",
  description: "Update an existing transaction. [See the docs](https://api.youneedabudget.com/v1#/Transactions/updateTransaction)",
  version: "0.0.2",
  type: "action",
  props: {
    app,
    budgetId: {
      propDefinition: [
        app,
        "budgetId",
      ],
    },
    accountId: {
      propDefinition: [
        app,
        "accountId",
        ({ budgetId }) => ({
          budgetId,
        }),
      ],
    },
    transactionId: {
      propDefinition: [
        app,
        "transactionId",
        ({ budgetId }) => ({
          budgetId,
        }),
      ],
    },
    date: {
      description: "The transaction date in ISO format `YYYY-MM-DD` (e.g. `2016-12-01`). Future dates (scheduled transactions) are not permitted. Split transaction dates cannot be changed and if a different date is supplied it will be ignored.",
      propDefinition: [
        app,
        "date",
      ],
    },
    payeeId: {
      label: "Payee ID",
      description: "The id of the payee.",
      optional: true,
      propDefinition: [
        app,
        "payee",
        ({ budgetId }) => ({
          budgetId,
        }),
      ],
    },
    categoryId: {
      propDefinition: [
        app,
        "categoryId",
        ({ budgetId }) => ({
          budgetId,
        }),
      ],
      optional: true,
    },
    amount: {
      propDefinition: [
        app,
        "amount",
      ],
    },
    memo: {
      type: "string",
      label: "Memo",
      description: "A short description.",
      optional: true,
    },
    cleared: {
      type: "string[]",
      label: "Cleared",
      description: "The cleared status of the transaction.",
      options: Object.values(constants.CLEARED_STATUS),
      optional: true,
    },
    approved: {
      type: "boolean",
      label: "Approved",
      description: "Approve the transaction directly?",
      optional: true,
    },
  },
  methods: {
    updateTransaction({
      budgetId, transactionId, data = {},
    }) {
      return this.app._client().transactions.updateTransaction(
        budgetId,
        transactionId,
        data,
      );
    },
  },
  async run({ $: step }) {
    const {
      budgetId,
      transactionId,
      accountId,
      date,
      payeeId,
      categoryId,
      amount,
      memo,
      cleared,
      approved,
    } = this;

    try {
      const response = await this.updateTransaction({
        budgetId,
        transactionId,
        data: {
          transaction: {
            account_id: accountId,
            date,
            amount: this.app._convertToMilliunit(amount),
            payee_id: payeeId,
            category_id: categoryId?.value ?? categoryId,
            memo,
            cleared,
            approved,
          },
        },
      });

      step.export("$summary", `Transaction ${this.response.data.transaction.id} updated.`);

      return response;

    } catch (error) {
      const msg = "Error updating transaction";
      const strError = JSON.stringify(error, null, 2);

      if (!error?.error) {
        console.log("Error in API response, please check your transactions to make sure the changes were applied.");
        step.export("$summary", `Transaction ${this.transactionId} updated.`);
        return {
          success: true,
          transactionId,
        };
      }

      console.log(msg, error);
      throw new Error(`${msg}: ${strError}`);
    }
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
You Need a Budget	`app`	`app`	This component uses the You Need a Budget app.
Budget ID	`budgetId`	`string`	Select a value from the drop down menu.
Account ID	`accountId`	`string`	Select a value from the drop down menu.
Transaction ID	`transactionId`	`string`	Select a value from the drop down menu.
Date	`date`	`string`	The transaction date in ISO format `YYYY-MM-DD` (e.g. `2016-12-01`). Future dates (scheduled transactions) are not permitted. Split transaction dates cannot be changed and if a different date is supplied it will be ignored.
Payee ID	`payeeId`	`string`	Select a value from the drop down menu.
Category ID	`categoryId`	`string`	Select a value from the drop down menu.
Amount	`amount`	`string`	E.g. `-290.99`
Memo	`memo`	`string`	A short description.
Cleared	`cleared`	`string[]`	Select a value from the drop down menu:`clearedunclearedreconciled`
Approved	`approved`	`boolean`	Approve the transaction directly?

Authentication#

You Need a Budget uses OAuth authentication. When you connect your You Need a Budget account, Pipedream will open a popup window where you can sign into You Need a Budget and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any You Need a Budget API.

Pipedream requests the following authorization scopes when you connect your account: