Export Report with Expensify API on New Scheduled Tasks from Pipedream API

Pipedream makes it easy to connect APIs for Expensify, Pipedream and 2,800+ other apps remarkably fast.

Trigger workflow on

New Scheduled Tasks from the Pipedream API

Next, do this

Export Report with the Expensify 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#

This integration creates a workflow with a Pipedream trigger and Expensify action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Scheduled Tasks trigger
1. Connect your Pipedream account
2. Optional- Configure Secret
Configure the Export Report action
1. Connect your Expensify account
2. Optional- Configure Report IDs
3. Optional- Configure Start Date
4. Optional- Configure End Date
5. Optional- Configure Approved After
6. Select a File Extension
7. Optional- Configure Marked as Exported Label (Filter)
8. Optional- Select one or more Report States
9. Optional- Configure Employee Email
10. Optional- Select one or more Policy IDs
11. Optional- Configure File Base Name
12. Optional- Configure Include Full Page Receipts PDF
13. Optional- Configure Email Recipients
14. Optional- Configure Mark as Exported
15. Optional- Configure Template Path
16. Optional- Configure Limit
17. Optional- Configure Test Mode
18. Configure syncDir
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

New Scheduled Tasks on Pipedream

Description:Exposes an HTTP API for scheduling messages to be emitted at a future time

Version:0.3.1

Key:pipedream-new-scheduled-tasks

View on GitHub

Pipedream Overview#

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

An application that can extract data from a database, transform it, and then
load it into another database.
An application that can monitor a data source for changes, and then trigger a
workflow in response to those changes.
An application that can poll an API for new data, and then process that data
in real-time.

Trigger Code#

import pipedream from "../../pipedream.app.mjs";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";

export default {
  key: "pipedream-new-scheduled-tasks",
  name: "New Scheduled Tasks",
  type: "source",
  description:
    "Exposes an HTTP API for scheduling messages to be emitted at a future time",
  version: "0.3.1",
  dedupe: "unique", // Dedupe on a UUID generated for every scheduled task
  props: {
    pipedream,
    secret: {
      type: "string",
      secret: true,
      label: "Secret",
      optional: true,
      description:
        "**Optional but recommended**: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests",
    },
    http: {
      label: "Endpoint",
      description: "The endpoint where you'll send task scheduler requests",
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
  },
  methods: {
    // To schedule future emits, we emit to the selfChannel of the component
    selfChannel() {
      return "self";
    },
    // Queue for future emits that haven't yet been delivered
    queuedEventsChannel() {
      return "$in";
    },
    httpRespond({
      status, body,
    }) {
      this.http.respond({
        headers: {
          "content-type": "application/json",
        },
        status,
        body,
      });
    },
    async selfSubscribe() {
      // Subscribe the component to itself. We do this here because even in
      // the activate hook, the component isn't available to take subscriptions.
      // Scheduled tasks are sent to the self channel, which emits the message at
      // the specified delivery_ts to this component.
      const isSubscribedToSelf = this.db.get("isSubscribedToSelf");
      if (!isSubscribedToSelf) {
        const componentId = process.env.PD_COMPONENT;
        const selfChannel = this.selfChannel();
        console.log(`Subscribing to ${selfChannel} channel for event source`);
        console.log(
          await this.pipedream.subscribe(componentId, componentId, selfChannel),
        );
        this.db.set("isSubscribedToSelf", true);
      }
    },
    validateEventBody(event, operation) {
      const errors = [];

      // Secrets are optional, so we first check if the user configured
      // a secret, then check its value against the prop (validation below)
      if (this.secret && event.headers["x-pd-secret"] !== this.secret) {
        errors.push(
          "Secret on incoming request doesn't match the configured secret",
        );
      }

      if (operation === "schedule") {
        const {
          timestamp,
          message,
        } = event.body;
        // timestamp should be an ISO 8601 string. Parse and check for validity below.
        const epoch = Date.parse(timestamp);

        if (!timestamp) {
          errors.push(
            "No timestamp included in payload. Please provide an ISO8601 timestamp in the 'timestamp' field",
          );
        }
        if (timestamp && !epoch) {
          errors.push("Timestamp isn't a valid ISO 8601 string");
        }
        if (!message) {
          errors.push("No message passed in payload");
        }
      }

      return errors;
    },
    scheduleTask(event) {
      const errors = this.validateEventBody(event, "schedule");
      let status, body;

      if (errors.length) {
        console.log(errors);
        status = 400;
        body = {
          errors,
        };
      } else {
        const id = this.emitScheduleEvent(event.body, event.body.timestamp);
        status = 200;
        body = {
          msg: "Successfully scheduled task",
          id,
        };
      }

      this.httpRespond({
        status,
        body,
      });
    },
    emitScheduleEvent(event, timestamp) {
      const selfChannel = this.selfChannel();
      const epoch = Date.parse(timestamp);
      const $id = uuid();

      console.log(`Scheduled event to emit on: ${new Date(epoch)}`);

      this.$emit(
        {
          ...event,
          $channel: selfChannel,
          $id,
        },
        {
          name: selfChannel,
          id: $id,
          delivery_ts: epoch,
        },
      );

      return $id;
    },
    async cancelTask(event) {
      const errors = this.validateEventBody(event, "cancel");
      let status, msg;

      if (errors.length) {
        console.log(errors);
        status = 400;
        msg = "Secret on incoming request doesn't match the configured secret";
      } else {
        try {
          const id = event.body.id;
          const isCanceled = await this.deleteEvent(event);
          if (isCanceled) {
            status = 200;
            msg = `Cancelled scheduled task for event ${id}`;
          } else {
            status = 404;
            msg = `No event with ${id} found`;
          }
        } catch (error) {
          console.log(error);
          status = 500;
          msg = "Failed to schedule task. Please see the logs";
        }
      }

      this.httpRespond({
        status,
        body: {
          msg,
        },
      });
    },
    async deleteEvent(event) {
      const componentId = process.env.PD_COMPONENT;
      const inChannel = this.queuedEventsChannel();

      // The user must pass a scheduled event UUID they'd like to cancel
      // We lookup the event by ID and delete it
      const { id } = event.body;

      // List events in the $in channel - the queue of scheduled events, to be emitted in the future
      const events = await this.pipedream.listEvents(
        componentId,
        inChannel,
      );
      console.log("Events: ", events);

      // Find the event in the list by id
      const eventToCancel = events.data.find((e) => {
        const { metadata } = e;
        return metadata.id === id;
      });

      console.log("Event to cancel: ", eventToCancel);

      if (!eventToCancel) {
        console.log(`No event with ${id} found`);
        return false;
      }

      // Delete the event
      await this.pipedream.deleteEvent(
        componentId,
        eventToCancel.id,
        inChannel,
      );
      return true;
    },
    emitEvent(event, summary) {
      // Delete the channel name and id from the incoming event, which were used only as metadata
      const id = event.$id;
      delete event.$channel;
      delete event.$id;

      this.$emit(event, {
        summary: summary ?? JSON.stringify(event),
        id,
        ts: +new Date(),
      });
    },
  },
  async run(event) {
    await this.selfSubscribe();

    const { path } = event;
    if (path === "/schedule") {
      this.scheduleTask(event);
    } else if (path === "/cancel") {
      await this.cancelTask(event);
    } else if (event.$channel === this.selfChannel()) {
      this.emitEvent(event);
    }
  },
  sampleEmit,
};

Trigger 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
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.
Secret	`secret`	`string`	Optional but recommended: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

Pipedream uses API keys for authentication. When you connect your Pipedream account, Pipedream securely stores the keys so you can easily authenticate to Pipedream APIs in both code and no-code steps.

About Pipedream#

Integration platform for developers

Action#

Export Report on Expensify

Description:Export Expensify reports to a file (csv, xls, xlsx, txt, pdf, json, xml). [See the documentation](https://integrations.expensify.com/Integration-Server/doc/#report-exporter)

Version:0.0.1

Key:expensify-export-report

View on GitHub

Expensify Overview#

The Expensify API enables the automation of expense reporting and management tasks. By harnessing this API within Pipedream, you can craft workflows that streamline the expense submission process, synchronize financial data across platforms, and trigger actions based on expense report statuses. With Pipedream’s serverless platform, these automations can run in the background, allowing for real-time data processing and interaction between Expensify and a myriad of other apps and services.

Action Code#

import { defineAction } from "@pipedream/types";
import expensify from "../../app/expensify.app.mjs";
import fs from "fs";
import { axios, ConfigurationError, } from "@pipedream/platform";
import qs from "qs";
export default defineAction({
    key: "expensify-export-report",
    name: "Export Report",
    description: "Export Expensify reports to a file (csv, xls, xlsx, txt, pdf, json, xml). [See the documentation](https://integrations.expensify.com/Integration-Server/doc/#report-exporter)",
    version: "0.0.1",
    type: "action",
    props: {
        expensify,
        reportIds: {
            type: "string[]",
            label: "Report IDs",
            description: "The IDs of the reports to be exported. Required if `startDate` or `approvedAfter` are not specified.",
            optional: true,
        },
        startDate: {
            type: "string",
            label: "Start Date",
            description: "The start date of the report. Format: YYYY-MM-DD. Required if `reportIds` or `approvedAfter ` are not specified.",
            optional: true,
        },
        endDate: {
            type: "string",
            label: "End Date",
            description: "The end date of the report. Format: YYYY-MM-DD. Conditionally required, if either `startDate` or `approvedAfter` is more than one year ago.",
            optional: true,
        },
        approvedAfter: {
            type: "string",
            label: "Approved After",
            description: "Filters out all reports approved before the given date, whichever occurred last (inclusive). Required if `reportIds` or `startDate` are not specified",
            optional: true,
        },
        fileExtension: {
            type: "string",
            label: "File Extension",
            description: "Specifies the format of the generated report",
            options: [
                "csv",
                "xls",
                "xlsx",
                "txt",
                "pdf",
                "json",
                "xml",
            ],
        },
        markedAsExported: {
            type: "string",
            label: "Marked as Exported Label (Filter)",
            description: "Filters out reports that have already been exported with that label",
            optional: true,
        },
        reportStates: {
            type: "string[]",
            label: "Report States",
            description: "Only the reports matching the specified status(es) will be exported",
            options: [
                "OPEN",
                "SUBMITTED",
                "APPROVED",
                "REIMBURSED",
                "ARCHIVED",
            ],
            optional: true,
        },
        employeeEmail: {
            type: "string",
            label: "Employee Email",
            description: "Export reports for the specified employee email",
            optional: true,
        },
        policyIds: {
            propDefinition: [
                expensify,
                "policyExportIds",
            ],
        },
        fileBaseName: {
            type: "string",
            label: "File Base Name",
            description: "The base name of the file to be exported",
            optional: true,
        },
        includeFullPageReceiptsPdf: {
            type: "boolean",
            label: "Include Full Page Receipts PDF",
            description: "Specifies whether generated PDFs should include full page receipts. This parameter is used only if fileExtension contains pdf.",
            optional: true,
        },
        emailRecipients: {
            type: "string[]",
            label: "Email Recipients",
            description: "People to email at the end of the export",
            optional: true,
        },
        markAsExported: {
            type: "string",
            label: "Mark as Exported",
            description: "Mark the reports as exported with the given label",
            optional: true,
        },
        templatePath: {
            type: "string",
            label: "Template Path",
            description: "The path in the /tmp directory to the template to use for the export. Required if `fileExtension` is `csv`, `txt`, `json`, or `xml`.",
            optional: true,
        },
        limit: {
            type: "string",
            label: "Limit",
            description: "Maximum number of reports to export",
            optional: true,
        },
        test: {
            type: "boolean",
            label: "Test Mode",
            description: "If set to true, actions defined in `onFinish` (i.e. email, markAsExported) will not be executed",
            optional: true,
        },
        syncDir: {
            type: "dir",
            accessMode: "write",
            sync: true,
        },
    },
    async run({ $ }) {
        if (!this.reportIds && !this.startDate && !this.approvedAfter) {
            throw new ConfigurationError("At least one of `reportIds`, `startDate`, or `approvedAfter` must be specified");
        }
        if ([
            "csv",
            "txt",
            "json",
            "xml",
        ].includes(this.fileExtension) && !this.templatePath) {
            throw new ConfigurationError(`Template path is required for file extension: ${this.fileExtension}`);
        }
        const onFinish = [];
        if (this.emailRecipients) {
            onFinish.push({
                actionName: "email",
                recipients: this.emailRecipients.join(","),
            });
        }
        if (this.markAsExported) {
            onFinish.push({
                actionName: "markAsExported",
                label: this.markAsExported,
            });
        }
        const data = {
            type: "file",
            credentials: {
                partnerUserID: this.expensify._partnerUserId(),
                partnerUserSecret: this.expensify._partnerUserSecret(),
            },
            onReceive: {
                immediateResponse: [
                    "returnRandomFileName",
                ],
            },
            inputSettings: {
                type: "combinedReportData",
                filters: {
                    reportIDList: this.reportIds
                        ? this.reportIds.join(",")
                        : undefined,
                    startDate: this.startDate,
                    endDate: this.endDate,
                    approvedAfter: this.approvedAfter,
                    markedAsExported: this.markedAsExported,
                    policyIDList: this.policyIds
                        ? this.policyIds.join(",")
                        : undefined,
                },
                reportState: this.reportStates
                    ? this.reportStates.join(",")
                    : undefined,
                employeeEmail: this.employeeEmail,
                limit: this.limit,
            },
            outputSettings: {
                fileExtension: this.fileExtension,
                fileBasename: this.fileBaseName,
                includeFullPageReceiptsPdf: this.includeFullPageReceiptsPdf,
            },
            onFinish,
            test: this.test,
        };
        let fileName;
        const args = {
            method: "post",
            url: `${this.expensify._apiUrl()}`,
        };
        if (!this.templatePath) {
            fileName = await axios($, {
                ...args,
                data: qs.stringify({
                    requestJobDescription: JSON.stringify(data),
                    template: "default",
                }),
            });
        }
        else {
            fileName = await axios($, {
                ...args,
                data: qs.stringify({
                    requestJobDescription: JSON.stringify(data),
                    template: fs.readFileSync(this.templatePath.includes("tmp/")
                        ? this.templatePath
                        : `/tmp/${this.templatePath}`, "utf8"),
                }),
                headers: {
                    "Content-Type": "application/x-www-form-urlencoded",
                },
            });
        }
        const fileBuffer = await this.expensify.downloadFile({
            $,
            fileName,
        });
        const path = `/tmp/${fileName}`;
        await fs.writeFileSync(path, fileBuffer);
        if (fileBuffer) {
            $.export("$summary", `Successfully exported report in ${path}`);
        }
        return path;
    },
});

Action Configuration#

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

Label	Prop	Type	Description
Expensify	`expensify`	`app`	This component uses the Expensify app.
Report IDs	`reportIds`	`string[]`	The IDs of the reports to be exported. Required if `startDate` or `approvedAfter` are not specified.
Start Date	`startDate`	`string`	The start date of the report. Format: YYYY-MM-DD. Required if `reportIds` or `approvedAfter` are not specified.
End Date	`endDate`	`string`	The end date of the report. Format: YYYY-MM-DD. Conditionally required, if either `startDate` or `approvedAfter` is more than one year ago.
Approved After	`approvedAfter`	`string`	Filters out all reports approved before the given date, whichever occurred last (inclusive). Required if `reportIds` or `startDate` are not specified
File Extension	`fileExtension`	`string`	Select a value from the drop down menu:`csvxlsxlsxtxtpdfjsonxml`
Marked as Exported Label (Filter)	`markedAsExported`	`string`	Filters out reports that have already been exported with that label
Report States	`reportStates`	`string[]`	Select a value from the drop down menu:`OPENSUBMITTEDAPPROVEDREIMBURSEDARCHIVED`
Employee Email	`employeeEmail`	`string`	Export reports for the specified employee email
Policy IDs	`policyIds`	`string[]`	Select a value from the drop down menu.
File Base Name	`fileBaseName`	`string`	The base name of the file to be exported
Include Full Page Receipts PDF	`includeFullPageReceiptsPdf`	`boolean`	Specifies whether generated PDFs should include full page receipts. This parameter is used only if fileExtension contains pdf.
Email Recipients	`emailRecipients`	`string[]`	People to email at the end of the export
Mark as Exported	`markAsExported`	`string`	Mark the reports as exported with the given label
Template Path	`templatePath`	`string`	The path in the /tmp directory to the template to use for the export. Required if `fileExtension` is `csv`, `txt`, `json`, or `xml`.
Limit	`limit`	`string`	Maximum number of reports to export
Test Mode	`test`	`boolean`	If set to true, actions defined in `onFinish` (i.e. email, markAsExported) will not be executed
syncDir	`syncDir`	`dir`

Action Authentication#

Expensify uses API keys for authentication. When you connect your Expensify account, Pipedream securely stores the keys so you can easily authenticate to Expensify APIs in both code and no-code steps.

About Expensify#

From unlimited receipt scanning and mileage tracking to next-day reimbursement, automate your preaccounting system with an easy to use expense tracking app.

More Ways to Connect Expensify + Pipedream#

Other Popular Integrations#

Create Expense with Expensify API on New Scheduled Tasks from Pipedream API

Pipedream + Expensify

Try it

Export Report To PDF with Expensify API on New Scheduled Tasks from Pipedream API

Pipedream + Expensify

Try it

Create Report with Expensify API on New Scheduled Tasks from Pipedream API

Pipedream + Expensify

Try it

Create Report with Expensify API on Card Due Date Reminder from Pipedream API

Pipedream + Expensify

Try it

Export Report with Expensify API on Card Due Date Reminder from Pipedream API

Pipedream + Expensify

Try it

Popular Triggers#

New Scheduled Tasks from the Pipedream API

Exposes an HTTP API for scheduling messages to be emitted at a future time

Try it

New Upcoming Event Alert from the Pipedream API

Emit new event based on a time interval before an upcoming event in the calendar. This source uses Pipedream's Task Scheduler. See the documentation for more information and instructions for connecting your Pipedream account.

Try it

Card Due Date Reminder from the Pipedream API

Emit new event at a specified time before a card is due.

Try it

New Upcoming Calendar Event from the Pipedream API

Emit new event when a Calendar event is upcoming, this source is using reminderMinutesBeforeStart property of the event to determine the time it should emit.

Try it