Create Invoice with Finmei API on New Event Emitted (Instant) from Shopify API

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

Trigger workflow on

New Event Emitted (Instant) from the Shopify 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 Shopify 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 Event Emitted (Instant) trigger
1. Connect your Shopify account
2. Optional- Configure Metafield Namespaces
3. Optional- Configure Private Metafield Namespaces
4. Select a Event Topic
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 Event Emitted (Instant) on Shopify

Description:Emit new event for each new Shopify event.

Version:0.0.5

Key:shopify_developer_app-new-event-emitted

View on GitHub

Shopify Overview#

The Shopify Admin REST & GraphQL API unleashes a myriad of possibilities to automate and enhance online store operations. It provides programmatic access to Shopify functionalities, allowing users to manage products, customers, orders, and more. Leveraging the Shopify Admin API within Pipedream, developers can create custom workflows that automate repetitive tasks, sync data across platforms, and respond dynamically to events in Shopify.

This integration can be used as a custom app on your store, or for automating actions on behalf of merchants through your Shopify app.

Looking for integrating into the Shopify Partner API for your apps, themes or referrals? Check out our Shopify Partner API integration.

Trigger Code#

import constants from "../common/constants.mjs";
import common from "../common/webhook-metafields.mjs";

export default {
  ...common,
  key: "shopify_developer_app-new-event-emitted",
  name: "New Event Emitted (Instant)",
  type: "source",
  description: "Emit new event for each new Shopify event.",
  version: "0.0.5",
  dedupe: "unique",
  props: {
    ...common.props,
    topic: {
      type: "string",
      label: "Event Topic",
      description: "Event topic that triggers the webhook.",
      options: constants.EVENT_TOPICS,
    },
  },
  methods: {
    ...common.methods,
    getTopic() {
      return this.topic;
    },
    generateMeta() {
      const ts = Date.now();
      return {
        id: ts,
        summary: `New Event Emitted at ${new Date(ts)}.`,
        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
Shopify	`app`	`app`	This component uses the Shopify app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
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.
Metafield Namespaces	`metafieldNamespaces`	`string[]`	Array of namespaces for any metafields that should be included with each webhook. Metafield definitions can be found in your store's Settings -> Custom Data. Select a metafield to view its namespace under "Namespace and key". For example, if the value is `custom.test_metafield`, the namespace is `custom`.
Private Metafield Namespaces	`privateMetafieldNamespaces`	`string[]`	Array of namespaces for any private metafields that should be included with each webhook. Metafield definitions can be found in your store's Settings -> Custom Data. Select a metafield to view its namespace under "Namespace and key". For example, if the value is `custom.test_metafield`, the namespace is `custom`.
Event Topic	`topic`	`string`	Select a value from the drop down menu:`app/uninstalledbulk_operations/finishcarts/createcarts/updatecheckouts/createcheckouts/deletecheckouts/updatecollection_listings/addcollection_listings/removecollection_listings/updatecollections/createcollections/deletecollections/updatecustomer_groups/createcustomer_groups/deletecustomer_groups/updatecustomer_payment_methods/createcustomer_payment_methods/revokecustomer_payment_methods/updatecustomers_marketing_consent/updatecustomers/createcustomers/deletecustomers/disablecustomers/enablecustomers/updatedisputes/createdisputes/updatedomains/createdomains/destroydomains/updatedraft_orders/createdraft_orders/deletedraft_orders/updatefulfillment_events/createfulfillment_events/deletefulfillments/createfulfillments/updateinventory_items/createinventory_items/deleteinventory_items/updateinventory_levels/connectinventory_levels/disconnectinventory_levels/updatelocales/createlocales/updatelocations/createlocations/deletelocations/updatemarkets/createmarkets/deletemarkets/updateorder_transactions/createorders/cancelledorders/createorders/deleteorders/editedorders/fulfilledorders/paidorders/partially_fulfilledorders/updatedproduct_listings/addproduct_listings/removeproduct_listings/updateproducts/createproducts/deleteproducts/updateprofiles/createprofiles/deleteprofiles/updaterefunds/createscheduled_product_listings/addscheduled_product_listings/removescheduled_product_listings/updateselling_plan_groups/createselling_plan_groups/deleteselling_plan_groups/updateshop/updatesubscription_billing_attempts/challengedsubscription_billing_attempts/failuresubscription_billing_attempts/successsubscription_contracts/createsubscription_contracts/updatetender_transactions/createthemes/createthemes/deletethemes/publishevent-topics-themes-updatethemes/update`

Trigger Authentication#

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

Get your Access Token

Create a custom app in Shopify to obtain your Admin API access token. See our detailed instructions here.

Enter your Admin API access token below, and save it in a secure location (we recommend using a password manager such as 1Password)

About Shopify#

Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.

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.

Create Invoice with Finmei API on New Event Emitted (Instant) from Shopify API

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

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

Developers ♥ Pipedream

Get your Access Token

1-24of2,400+apps by most popular

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