Export Report with Expensify API on New Monitor Run Completed from Postman API

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

Trigger workflow on

New Monitor Run Completed from the Postman 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 Postman 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 Monitor Run Completed trigger
1. Connect your Postman account
2. Configure timer
3. Select a Monitor ID
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 Monitor Run Completed on Postman

Description:Emit new event when a monitor run is completed. [See the documentation](https://learning.postman.com/docs/monitoring-your-api/intro-monitors/)

Version:0.0.1

Key:postman-monitor-run-completed

View on GitHub

Postman Overview#

The Postman API enables you to automate tasks within your Postman collections, such as running collections, fetching and updating environments, and integrating your API development workflow into your CI/CD pipeline. Using Pipedream, you can harness this functionality to create custom workflows that trigger on various events, process data, and connect with other apps, extending the capabilities of your API testing and development processes.

Trigger Code#

import postman from "../../postman.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "postman-monitor-run-completed",
  name: "New Monitor Run Completed",
  description: "Emit new event when a monitor run is completed. [See the documentation](https://learning.postman.com/docs/monitoring-your-api/intro-monitors/)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    postman,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: 60,
      },
    },
    monitorId: {
      propDefinition: [
        postman,
        "monitorId",
      ],
    },
  },
  methods: {
    _getLastDate() {
      return this.db.get("lastDate") || new Date("1970-01-01");
    },
    _setLastDate(lastDate) {
      this.db.set("lastDate", lastDate);
    },
    async startEvent() {
      const lastDate = this._getLastDate();

      const { monitor } = await this.postman.getMonitor({
        monitorId: this.monitorId,
      });

      if (monitor.lastRun?.status === "success" && new Date(monitor.lastRun.startedAt) > new Date(lastDate)) {
        this._setLastDate(monitor.lastRun.startedAt);
        this.emitEvent(monitor);
      }
    },
    emitEvent(monitor) {
      this.$emit(monitor, {
        id: monitor.id + monitor.lastRun.startedAt,
        summary: `Monitor Run Completed: ${monitor.name}`,
        ts: Date.parse(monitor.lastRun.finishedAt),
      });
    },
  },
  async run() {
    await this.startEvent();
  },
  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
Postman	`postman`	`app`	This component uses the Postman app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Monitor ID	`monitorId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

To retrieve your API key,

Navigate to your Postman account and sign in
Go to your Integration Dashboard
Click "Generate API Key", and copy and paste it below.

About Postman#

Postman is the world's leading API platform.

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

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.2",
    annotations: {
        destructiveHint: false,
        openWorldHint: true,
        readOnlyHint: false,
    },
    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`