Create Receipt with Loyverse API on New Field in Document from MongoDB API

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

Trigger workflow on

New Field in Document from the MongoDB API

Next, do this

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

Select this integration
Configure the New Field in Document trigger
1. Connect your MongoDB account
2. Configure Polling Interval
3. Select a Database
4. Select a Collection
5. Select a Document
Configure the Create Receipt action
1. Connect your Loyverse account
2. Select a Store ID
3. Configure Line Items
4. Select a Payment Type ID
5. Optional- Select a Employee ID
6. Optional- Configure Order
7. Optional- Select a Customer ID
8. Optional- Configure Source
9. Optional- Configure Receipt Date
10. Optional- Configure Total Discounts
11. Optional- Configure Note
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 Field in Document on MongoDB

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

Version:0.0.7

Key:mongodb-new-field-in-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";

export default {
  ...common,
  key: "mongodb-new-field-in-document",
  name: "New Field in Document",
  description: "Emit new an event when a new field is added to a document",
  version: "0.0.7",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    database: {
      propDefinition: [
        common.props.mongodb,
        "database",
      ],
    },
    collection: {
      propDefinition: [
        common.props.mongodb,
        "collection",
        (c) => ({
          database: c.database,
        }),
      ],
    },
    document: {
      propDefinition: [
        common.props.mongodb,
        "document",
        (c) => ({
          database: c.database,
          collection: c.collection,
        }),
      ],
    },
  },
  methods: {
    ...common.methods,
    _getFields() {
      return this.db.get("fields");
    },
    _setFields(fields) {
      this.db.set("fields", fields);
    },
    isRelevant(key, fields) {
      return !fields.includes(key);
    },
    async processEvent(client, ts) {
      const fields = this._getFields() || [];
      const collection = this.mongodb.getCollection(client, this.database, this.collection);
      const documents = await this.mongodb.listDocuments(collection);
      const doc = documents.find((obj) => {
        return obj._id == this.document;
      });
      const keys = Object.keys(doc);
      for (const key of keys) {
        if (!this.isRelevant(key, fields)) {
          continue;
        }
        fields.push(key);
        this.emitEvent(key, ts);
      }
      this._setFields(fields);
    },
    generateMeta(key, ts) {
      return {
        id: key,
        summary: `New Field ${key}`,
        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.
Document	`document`	`string`	Select a value from the drop down menu.

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 Receipt on Loyverse

Description:Creates a new receipt for a specific store. [See the documentation](https://developer.loyverse.com/docs/#tag/Receipts/paths/~1receipts/post)

Version:0.0.1

Key:loyverse-create-receipt

View on GitHub

Loyverse Overview#

The Loyverse API provides a suite of functions to access and manage the data for businesses using the Loyverse platform, which includes point of sale, inventory management, employee management, and analytics. With Pipedream, you can create automated workflows that trigger on new events from Loyverse, like a new sale, or that perform operations in Loyverse, like creating a new item in your inventory. By connecting Loyverse to other apps via Pipedream, you can sync data across platforms, get real-time notifications, and streamline operations.

Action Code#

import loyverse from "../../loyverse.app.mjs";
import { parseAsJSON } from "../../common/utils.mjs";

export default {
  key: "loyverse-create-receipt",
  name: "Create Receipt",
  description: "Creates a new receipt for a specific store. [See the documentation](https://developer.loyverse.com/docs/#tag/Receipts/paths/~1receipts/post)",
  version: "0.0.1",
  type: "action",
  props: {
    loyverse,
    storeId: {
      propDefinition: [
        loyverse,
        "storeId",
      ],
    },
    lineItems: {
      type: "string[]",
      label: "Line Items",
      description: "[An array of JSON-stringified objects](https://developer.loyverse.com/docs/#tag/Receipts/paths/~1receipts/post). You can use the **Generate Receipt Items** action to generate these items.",
    },
    paymentTypeId: {
      propDefinition: [
        loyverse,
        "paymentTypeId",
      ],
    },
    employeeId: {
      propDefinition: [
        loyverse,
        "employeeId",
      ],
    },
    order: {
      type: "string",
      label: "Order",
      description: "The order name or number associated with the receipt",
      optional: true,
    },
    customerId: {
      propDefinition: [
        loyverse,
        "customerId",
      ],
      description: "Select a customer or provide a customer ID.",
    },
    source: {
      type: "string",
      label: "Source",
      description: "The name of the source this receipt comes from. By default it is the name of the application that created the receipt.",
      optional: true,
    },
    receiptDate: {
      type: "string",
      label: "Receipt Date",
      description: "A date/time string such as `2022-03-15T18:30:00Z`. By default, this is the date/time the receipt was created.",
      optional: true,
    },
    totalDiscounts: {
      type: "string[]",
      label: "Total Discounts",
      description: "The list of all discounts applied in the receipt, as JSON-stringified objects. [See the documentation](https://developer.loyverse.com/docs/#tag/Receipts/paths/~1receipts/post) for the expected properties.",
      optional: true,
    },
    note: {
      type: "string",
      label: "Note",
      description: "The receipt's note",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      lineItems, totalDiscounts,
    } = this;
    const discounts = totalDiscounts?.map?.(parseAsJSON);
    const response = await this.loyverse.createReceipt({
      $,
      data: {
        store_id: this.storeId,
        line_items: lineItems.map?.(parseAsJSON) ?? JSON.parse(lineItems),
        payments: [
          {
            payment_type_id: this.paymentTypeId,
          },
        ],
        employee_id: this.employeeId,
        order: this.order,
        customer_id: this.customerId,
        source: this.source,
        receipt_date: this.receiptDate,
        total_discounts: discounts ?? (totalDiscounts && JSON.parse(totalDiscounts)),
        note: this.note,
      },
    });
    $.export("$summary", `Successfully created receipt with number ${response.receipt_number}`);
    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
Loyverse	`loyverse`	`app`	This component uses the Loyverse app.
Store ID	`storeId`	`string`	Select a value from the drop down menu.
Line Items	`lineItems`	`string[]`	An array of JSON-stringified objects. You can use the Generate Receipt Items action to generate these items.
Payment Type ID	`paymentTypeId`	`string`	Select a value from the drop down menu.
Employee ID	`employeeId`	`string`	Select a value from the drop down menu.
Order	`order`	`string`	The order name or number associated with the receipt
Customer ID	`customerId`	`string`	Select a value from the drop down menu.
Source	`source`	`string`	The name of the source this receipt comes from. By default it is the name of the application that created the receipt.
Receipt Date	`receiptDate`	`string`	A date/time string such as `2022-03-15T18:30:00Z`. By default, this is the date/time the receipt was created.
Total Discounts	`totalDiscounts`	`string[]`	The list of all discounts applied in the receipt, as JSON-stringified objects. See the documentation for the expected properties.
Note	`note`	`string`	The receipt's note

Action Authentication#

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

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

CUSTOMERS_READCUSTOMERS_WRITEEMPLOYEES_READITEMS_READINVENTORY_WRITEPAYMENT_TYPES_READRECEIPTS_READRECEIPTS_WRITESTORES_READMERCHANT_READ

Create Receipt with Loyverse API on New Field in Document from MongoDB API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

1
-
24
of
2,400+
apps by most popular