Create Invoice with faktoora API on New Coupon Event (Instant) from WooCommerce API

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

Trigger workflow on

New Coupon Event (Instant) from the WooCommerce API

Next, do this

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

Select this integration
Configure the New Coupon Event (Instant) trigger
1. Connect your WooCommerce account
2. Select one or more Event topics
Configure the Create Invoice action
1. Connect your faktoora account
2. Select a Format
3. Configure Invoice Number
4. Configure Issue Date
5. Configure Currency
6. Configure Buyer Name
7. Configure Buyer Postcode
8. Configure Buyer Street
9. Configure Buyer City
10. Configure Buyer Country
11. Configure Invoice Items
12. Optional- Configure Additional Data
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 Coupon Event (Instant) on WooCommerce

Description:Emit new event each time the specified coupon event(s) occur

Version:0.0.3

Key:woocommerce-new-coupon-event

View on GitHub

WooCommerce Overview#

WooCommerce is a customizable, open-source eCommerce platform built on WordPress. With the WooCommerce API, you can tap into the heart of your eCommerce store to read, create, update, and delete products, orders, and customers. On Pipedream, you can harness this API to automate routine tasks, sync data across platforms, and enhance customer experiences. By connecting WooCommerce to a wide array of apps and services, you can streamline operations, trigger personalized marketing, and analyze your sales data with greater ease.

Trigger Code#

import common from "../common/base.mjs";

export default {
  ...common,
  key: "woocommerce-new-coupon-event",
  name: "New Coupon Event (Instant)",
  description: "Emit new event each time the specified coupon event(s) occur",
  version: "0.0.3",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    async getSampleEvents({ perPage }) {
      return this.woocommerce.listCoupons({
        per_page: perPage,
        orderby: "date",
      });
    },
    getTopic(topicType) {
      return `coupon.${topicType}`;
    },
    generateMeta(eventType, {
      id, date_modified: dateModified,
    }) {
      const ts = Date.parse(dateModified);
      return {
        id: `${id}${ts}`,
        summary: `Coupon ID: ${id} ${eventType}`,
        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
WooCommerce	`woocommerce`	`app`	This component uses the WooCommerce 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.
Event topics	`topics`	`string[]`	Select a value from the drop down menu:`createdupdateddeleted`

Trigger Authentication#

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

Find your API key at WooCommerce > Settings > Advanced > REST API. See the WooCommerce docs for more info. Enter the Key and Secret below.

About WooCommerce#

WooCommerce is the open-source ecommerce platform for WordPress.

Action#

Create Invoice on faktoora

Description:Create a new ZUGFeRD/xrechnung invoice. [See the documentation](https://api.faktoora.com/api/v1/api-docs/static/index.html)

Version:0.0.1

Key:faktoora-create-invoice

View on GitHub

faktoora Overview#

The faktoora API offers a suite of tools for managing invoices and financial documents within applications. By integrating this API with Pipedream, you can automate tasks related to invoice creation, retrieval, and management, streamlining your financial operations. Pipedream's serverless execution model allows the API's capabilities to be woven into custom workflows that trigger on various events, process data, and connect to countless other apps to create powerful automations.

Action Code#

import { parseObject } from "../../common/utils.mjs";
import faktoora from "../../faktoora.app.mjs";

export default {
  key: "faktoora-create-invoice",
  name: "Create Invoice",
  description: "Create a new ZUGFeRD/xrechnung invoice. [See the documentation](https://api.faktoora.com/api/v1/api-docs/static/index.html)",
  version: "0.0.1",
  type: "action",
  props: {
    faktoora,
    format: {
      type: "string",
      label: "Format",
      description: "The format of the invoice (ZUGFeRD/xrechnung).",
      options: [
        "zf:1",
        "zf:2",
        "xrechnung",
      ],
    },
    invoiceNumber: {
      propDefinition: [
        faktoora,
        "invoiceNumber",
      ],
    },
    issueDate: {
      type: "string",
      label: "Issue Date",
      description: "The issue date of the invoice (YYYYMMDD).",
    },
    currency: {
      type: "string",
      label: "Currency",
      description: "The currency of the invoice.",
    },
    buyerName: {
      type: "string",
      label: "Buyer Name",
      description: "The name of the buyer.",
    },
    buyerPostcode: {
      type: "string",
      label: "Buyer Postcode",
      description: "Buyer location postcode.",
    },
    buyerStreet: {
      type: "string",
      label: "Buyer Street",
      description: "Buyer location street.",
    },
    buyerCity: {
      type: "string",
      label: "Buyer City",
      description: "Buyer location city.",
    },
    buyerCountry: {
      type: "string",
      label: "Buyer Country",
      description: "Buyer location country.",
    },
    invoiceItems: {
      type: "string[]",
      label: "Invoice Items",
      description: "A list of product objects. E.g. **{\"productId\": \"39887\", \"name\": \"Freezer Z7749\", \"quantity\": \"1\", \"unitCode\": \"C62\", \"price\": 100, \"taxes\": [{\"typeCode\": \"VAT\", \"categoryCode\": \"S\", \"rate\": 16}] }**. For further information about init code [click here](https://www.unece.org/fileadmin/DAM/cefact/recommendations/rec20/rec20_rev3_Annex1e.pdf). For further information about Category Code [click here](https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL5305/)",
    },
    additionalData: {
      type: "object",
      label: "Additional Data",
      description: "An object to manual input other fields. Please check the fields from [the API doc > POST /invoice > Request Body](https://api.faktoora.com/api/v1/api-docs/static/index.html)",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.faktoora.createInvoice({
      $,
      data: {
        invoices: [
          {
            format: this.format,
            invoiceNumber: this.invoiceNumber,
            issueDate: this.issueDate,
            currency: this.currency,
            buyer: {
              name: this.buyerName,
              postcode: this.buyerPostcode,
              street: this.buyerStreet,
              city: this.buyerCity,
              country: this.buyerCountry,
            },
            invoiceItems: this.invoiceItems && parseObject(this.invoiceItems)
              .map((item, index) => ({
                id: `${index + 1}`,
                product: item,
              })),
            ...(parseObject(this.additionalData) || {}),
          },
        ],
      },
    });

    $.export("$summary", `Successfully created invoice with number ${this.invoiceNumber}`);
    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
faktoora	`faktoora`	`app`	This component uses the faktoora app.
Format	`format`	`string`	Select a value from the drop down menu:`zf:1zf:2xrechnung`
Invoice Number	`invoiceNumber`	`string`	The invoice number.
Issue Date	`issueDate`	`string`	The issue date of the invoice (YYYYMMDD).
Currency	`currency`	`string`	The currency of the invoice.
Buyer Name	`buyerName`	`string`	The name of the buyer.
Buyer Postcode	`buyerPostcode`	`string`	Buyer location postcode.
Buyer Street	`buyerStreet`	`string`	Buyer location street.
Buyer City	`buyerCity`	`string`	Buyer location city.
Buyer Country	`buyerCountry`	`string`	Buyer location country.
Invoice Items	`invoiceItems`	`string[]`	A list of product objects. E.g. {"productId": "39887", "name": "Freezer Z7749", "quantity": "1", "unitCode": "C62", "price": 100, "taxes": [{"typeCode": "VAT", "categoryCode": "S", "rate": 16}] }. For further information about init code click here. For further information about Category Code click here
Additional Data	`additionalData`	`object`	An object to manual input other fields. Please check the fields from the API doc > POST /invoice > Request Body