Create Invoice with Finmei API on New Document from MongoDB API

Pipedream makes it easy to connect APIs for Finmei, MongoDB and 2,400+ other apps remarkably fast.

Trigger workflow on

New Document from the MongoDB API

Next, do this

Create Invoice with the Finmei 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 MongoDB trigger and Finmei action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Document trigger
1. Connect your MongoDB account
2. Configure Polling Interval
3. Select a Database
4. Select a Collection
5. Configure Timestamp Field
Configure the Create Invoice action
1. Connect your Finmei account
2. Select a Type
3. Configure Date
4. Configure Series
5. Configure Currency
6. Configure Buyer
7. Configure Product(s)
8. Optional- Configure Use Default Seller Info
9. Optional- Configure Additional Options
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 Document on MongoDB

Description:Emit new an event when a new document is added to a collection

Version:0.0.9

Key:mongodb-new-document

View on GitHub

MongoDB Overview#

The MongoDB API provides powerful capabilities to interact with a MongoDB database, allowing you to perform CRUD (Create, Read, Update, Delete) operations, manage databases, and execute sophisticated queries. With Pipedream, you can harness these abilities to automate tasks, sync data across various apps, and react to events in real-time. It’s a combo that’s particularly potent for managing data workflows, syncing application states, or triggering actions based on changes to your data.

Trigger Code#

import common from "../common/base.mjs";
import { Timestamp } from "mongodb";

export default {
  ...common,
  key: "mongodb-new-document",
  name: "New Document",
  description: "Emit new an event when a new document is added to a collection",
  version: "0.0.9",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    database: {
      propDefinition: [
        common.props.mongodb,
        "database",
      ],
    },
    collection: {
      propDefinition: [
        common.props.mongodb,
        "collection",
        (c) => ({
          database: c.database,
        }),
      ],
    },
    timestampField: {
      type: "string",
      label: "Timestamp Field",
      description: "The key of a timestamp field, such as 'created_at' that is set to the current timestamp when a document is created. Must be of type Timestamp.",
    },
  },
  hooks: {
    async deploy() {
      const client = await this.mongodb.getClient();
      await this.processEvent(client, Date.now(), 25);
      await client.close();
    },
  },
  methods: {
    ...common.methods,
    _getLastTs() {
      return this.db.get("lastTs");
    },
    _setLastTs(lastTs) {
      this.db.set("lastTs", lastTs);
    },
    getTs(doc) {
      try {
        return JSON.parse(doc[this.timestampField]);
      } catch {
        return doc[this.timestampField];
      }
    },
    convertToTimestamp(timestampStr) {
      const bigIntValue = BigInt(timestampStr);
      const seconds = Number(bigIntValue >> 32n);
      const increment = Number(bigIntValue & 0xFFFFFFFFn);
      return new Timestamp({
        t: seconds,
        i: increment,
      });
    },
    async processEvent(client, eventTs, max) {
      const lastTs = this._getLastTs() || 0;
      let maxTs = lastTs;
      let count = 0;
      const collection = this.mongodb.getCollection(client, this.database, this.collection);
      const sort = {
        [this.timestampField]: -1,
      };
      const query = {
        [this.timestampField]: {
          $gt: this.convertToTimestamp(lastTs),
        },
      };
      const documents = await collection.find(query).sort(sort)
        .toArray();
      const docs = [];
      for (const doc of documents) {
        const ts = this.getTs(doc);
        if (!(ts > lastTs) || (max && count >= max)) {
          break;
        }
        if (ts > maxTs) {
          maxTs = ts;
        }
        docs.push(doc);
        count++;
      }
      docs.reverse().forEach((doc) => this.emitEvent(doc, eventTs));
      this._setLastTs(maxTs);
    },
    generateMeta({ _id: id }, ts) {
      return {
        id,
        summary: `New Document ID ${JSON.stringify(id)}`,
        ts,
      };
    },
  },
};

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
MongoDB	`mongodb`	`app`	This component uses the MongoDB app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling Interval	`timer`	`$.interface.timer`	Pipedream will poll the API on this schedule
Database	`database`	`string`	Select a value from the drop down menu.
Collection	`collection`	`string`	Select a value from the drop down menu.
Timestamp Field	`timestampField`	`string`	The key of a timestamp field, such as 'created_at' that is set to the current timestamp when a document is created. Must be of type Timestamp.

Trigger Authentication#

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

Before you connect to your Mongo database from Pipedream, please make sure your database is accessible from the public internet. You may need to add a firewall rule allowing connections from 0.0.0.0/0.

Then, enter the details of your Mongo host / database below.

About MongoDB#

MongoDB is an open source NoSQL database management program.

Action#

Create Invoice on Finmei

Description:Generates a new invoice within Finmei. [See the documentation](https://documenter.getpostman.com/view/835227/2s9YXh5NRs#01e4e494-2aaf-4d87-9b8d-e527b04af0a0)

Version:0.0.1

Key:finmei-create-invoice

View on GitHub

Finmei Overview#

The Finmei API offers access to a platform geared towards financial data management. With Pipedream, you can harness this API to craft serverless workflows that automate financial tasks, integrate with other services, and streamline data analysis. This includes tracking expenses, aggregating financial reports, or syncing data across different financial tools. Pipedream's no-code platform allows you to connect Finmei to hundreds of other apps, trigger actions based on various events, and manage data with built-in CRON scheduling.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import { INVOICE_TYPES } from "../../common/constants.mjs";
import finmei from "../../finmei.app.mjs";
import { parseAsJSON } from "../../common/utils.mjs";

export default {
  key: "finmei-create-invoice",
  name: "Create Invoice",
  description:
    "Generates a new invoice within Finmei. [See the documentation](https://documenter.getpostman.com/view/835227/2s9YXh5NRs#01e4e494-2aaf-4d87-9b8d-e527b04af0a0)",
  version: "0.0.1",
  type: "action",
  props: {
    finmei,
    type: {
      type: "string",
      label: "Type",
      description: "The type of invoice to create",
      options: INVOICE_TYPES,
    },
    date: {
      type: "string",
      label: "Date",
      description: "Date showed in the invoice. Format: `YYYY-MM-DD`",
    },
    series: {
      type: "string",
      label: "Series",
      description: "Invoice series in string format",
    },
    currency: {
      type: "string",
      label: "Currency",
      description: "Uppercase three letter currency code, e.g. `USD`",
    },
    buyer: {
      type: "object",
      label: "Buyer",
      description:
        "The buyer info, as an object. [See the documentation](https://documenter.getpostman.com/view/835227/2s9YXh5NRs#01e4e494-2aaf-4d87-9b8d-e527b04af0a0) for the properties. Example: `{ \"type\": \"company\", \"company_name\": \"My Company\" }`",
    },
    products: {
      type: "string[]",
      label: "Product(s)",
      description:
        "One or more products as JSON-stringified objects. [See the documentation](https://documenter.getpostman.com/view/835227/2s9YXh5NRs#01e4e494-2aaf-4d87-9b8d-e527b04af0a0) for the properties. Example: `{ \"name\": \"My Product\", \"units\": \"pcs\", \"quantity\": 2, \"price\": 10 }`",
    },
    useDefaultSellerInfo: {
      type: "boolean",
      label: "Use Default Seller Info",
      description:
        "If true, you do not need to provide seller info. Your business info and latest invoice information will be used.",
      optional: true,
      default: true,
    },
    additionalOptions: {
      type: "object",
      label: "Additional Options",
      description:
        "Additional parameters to send in the request. [See the documentation](https://documenter.getpostman.com/view/835227/2s9YXh5NRs#01e4e494-2aaf-4d87-9b8d-e527b04af0a0) for available parameters. Values will be parsed as JSON where applicable.",
      optional: true,
    },
  },
  async run({ $ }) {
    let products, buyer;
    try {
      const value = parseAsJSON(this.products);
      products = value.map(parseAsJSON);
    } catch (e) {
      throw new ConfigurationError(
        `Error parsing JSON value in \`Product(s)\` prop as JSON: \`${e}\``,
      );
    }
    try {
      buyer = parseAsJSON(this.buyer);
    } catch (e) {
      throw new ConfigurationError(
        `Error parsing JSON value in \`Product(s)\` prop as JSON: \`${e}\``,
      );
    }

    let additionalOptions = Object.fromEntries(
      Object.entries(this.additionalOptions ?? {}).map(([
        key,
        value,
      ]) => {
        // optional JSON parsing
        try {
          return [
            key,
            JSON.parse(value),
          ];
        } catch (e) {
          return [
            key,
            value,
          ];
        }
      }),
    );

    const response = await this.finmei.createInvoice({
      $,
      data: {
        type: this.type,
        invoice_date: this.date,
        series: this.series,
        currency: this.currency,
        use_default_seller_info: this.useDefaultSellerInfo,
        buyer,
        products,
        ...additionalOptions,
      },
    });
    $.export(
      "$summary",
      `Successfully created invoice (ID: ${response?.data?.id})`,
    );
    return response;
  },
};

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
Finmei	`finmei`	`app`	This component uses the Finmei app.
Type	`type`	`string`	Select a value from the drop down menu:`regular_invoicevat_invoicepreliminary_invoicepreliminary_vat_invoicecredit_invoicecredit_vat_invoice`
Date	`date`	`string`	Date showed in the invoice. Format: `YYYY-MM-DD`
Series	`series`	`string`	Invoice series in string format
Currency	`currency`	`string`	Uppercase three letter currency code, e.g. `USD`
Buyer	`buyer`	`object`	The buyer info, as an object. See the documentation for the properties. Example: `{ "type": "company", "company_name": "My Company" }`
Product(s)	`products`	`string[]`	One or more products as JSON-stringified objects. See the documentation for the properties. Example: `{ "name": "My Product", "units": "pcs", "quantity": 2, "price": 10 }`
Use Default Seller Info	`useDefaultSellerInfo`	`boolean`	If true, you do not need to provide seller info. Your business info and latest invoice information will be used.
Additional Options	`additionalOptions`	`object`	Additional parameters to send in the request. See the documentation for available parameters. Values will be parsed as JSON where applicable.