Create Invoice with Fakturoid API on New Invoice Created (Instant) from Chargebee API

Pipedream makes it easy to connect APIs for Fakturoid, Chargebee and 2,700+ other apps remarkably fast.

Trigger workflow on

New Invoice Created (Instant) from the Chargebee API

Next, do this

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

Select this integration
Configure the New Invoice Created (Instant) trigger
1. Connect your Chargebee account
Configure the Create Invoice action
1. Connect your Fakturoid account
2. Select a Account
3. Optional- Configure Custom Id
4. Optional- Select a Document Type
5. Select a Subject Id
6. Optional- Configure Order Number
7. Optional- Configure Note
8. Optional- Configure Due
9. Optional- Configure Issued On
10. Optional- Configure Taxable Fulfillment Due
11. Optional- Configure Tags
12. Optional- Configure Round Total
13. Optional- Configure Subtotal
14. Optional- Configure Total
15. Configure Lines
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 Invoice Created (Instant) on Chargebee

Description:Emit new event when a new invoice is created. [See the Documentation](https://apidocs.chargebee.com/docs/api/events#invoice_generated). Please make sure once you deploy this source, you copy/paste the webhook URL to create it in your [Chargebee Webhook settings](https://www.chargebee.com/docs/2.0/webhook_settings.html#configure-webhooks).

Version:0.0.3

Key:chargebee-new-invoice-created-instant

View on GitHub

Chargebee Overview#

The Chargebee API provides a suite of powerful endpoints that facilitate automation around subscription billing, invoicing, and customer management. By leveraging this API on Pipedream, you can build complex, event-driven workflows that react to subscription changes, automate billing operations, sync customer data across platforms, and trigger personalized communication, all without managing servers.

Trigger Code#

import common from "../common/webhook.mjs";
import events from "../common/events.mjs";
import constants from "../../common/constants.mjs";

export default {
  ...common,
  key: "chargebee-new-invoice-created-instant",
  name: "New Invoice Created (Instant)",
  description: "Emit new event when a new invoice is created. [See the Documentation](https://apidocs.chargebee.com/docs/api/events#invoice_generated). Please make sure once you deploy this source, you copy/paste the webhook URL to create it in your [Chargebee Webhook settings](https://www.chargebee.com/docs/2.0/webhook_settings.html#configure-webhooks).",
  type: "source",
  version: "0.0.3",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getEventTypes() {
      return [
        events.INVOICE_GENERATED,
      ];
    },
    async getResources() {
      const { list } = await this.app.getInvoices({
        "limit": constants.MAX_LIMIT,
        "sort_by[desc]": "date",
      });
      return list;
    },
    generateMeta(event) {
      const { invoice } = event.content ?? event;
      return {
        id: invoice.id,
        summary: `New Invoice: ${invoice.id}`,
        ts: invoice.date,
      };
    },
  },
};

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
Chargebee	`app`	`app`	This component uses the Chargebee 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.

Trigger Authentication#

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

About Chargebee#

Automated Subscription Billing Software

Action#

Create Invoice on Fakturoid

Description:Creates a new invoice. [See the documentation](https://www.fakturoid.cz/api/v3/invoices)

Version:0.0.1

Key:fakturoid-create-invoice

View on GitHub

Action Code#

import constants, { parseObject } from "../../common/constants.mjs";
import fakturoid from "../../fakturoid.app.mjs";

export default {
  key: "fakturoid-create-invoice",
  name: "Create Invoice",
  description: "Creates a new invoice. [See the documentation](https://www.fakturoid.cz/api/v3/invoices)",
  version: "0.0.1",
  type: "action",
  props: {
    fakturoid,
    accountSlug: {
      propDefinition: [
        fakturoid,
        "accountSlug",
      ],
    },
    customId: {
      type: "string",
      label: "Custom Id",
      description: "Identifier in your application",
      optional: true,
    },
    documentType: {
      type: "string",
      label: "Document Type",
      description: "Type of document",
      options: constants.DOCUMENT_TYPE_OPTIONS,
      reloadProps: true,
      optional: true,
    },
    subjectId: {
      propDefinition: [
        fakturoid,
        "subjectId",
        ({ accountSlug }) => ({
          accountSlug,
        }),
      ],
    },
    orderNumber: {
      type: "string",
      label: "Order Number",
      description: "Order number in your application",
      optional: true,
    },
    note: {
      type: "string",
      label: "Note",
      description: "Additional notes for the invoice",
      optional: true,
    },
    due: {
      type: "string",
      label: "Due",
      description: "Invoice due date in number of days from today",
      optional: true,
    },
    issuedOn: {
      type: "string",
      label: "Issued On",
      description: "Date of issue. **Format: YYYY-MM-DD**",
      optional: true,
    },
    taxableFulfillmentDue: {
      type: "string",
      label: "Taxable Fulfillment Due",
      description: "Chargeable event date.",
      optional: true,
    },
    tags: {
      type: "string[]",
      label: "Tags",
      description: "List of tags",
      optional: true,
    },
    roundTotal: {
      type: "boolean",
      label: "Round Total",
      description: "Round total amount (VAT included)",
      optional: true,
    },
    subtotal: {
      type: "string",
      label: "Subtotal",
      description: "Total without VAT",
      optional: true,
    },
    total: {
      type: "string",
      label: "Total",
      description: "Total with VAT",
      optional: true,
    },
    lines: {
      type: "string[]",
      label: "Lines",
      description: "List of object lines to invoice. [See the documentation](https://www.fakturoid.cz/api/v3/invoices#attributes). **Example: {\"name\": \"Hard work\",\"quantity\": \"1.0\",\"unit_name\": \"h\",\"unit_price\": \"40000\",\"vat_rate\": \"21\"}**",
    },
  },
  async additionalProps() {
    const props = {};
    if (this.documentType === "proforma") {
      props.proformaFollowupDocument = {
        type: "string",
        label: "Proforma Followup Document",
        description: "What to issue after a proforma is paid.",
        options: constants.PROFORMA_OPTIONS,
        optional: true,
      };
    }
    return props;
  },
  async run({ $ }) {
    const response = await this.fakturoid.createInvoice({
      $,
      accountSlug: this.accountSlug,
      data: {
        custom_id: this.customId,
        document_type: this.documentType,
        proforma_followup_document: this.proformaFollowupDocument,
        subject_id: this.subjectId,
        order_number: this.orderNumber,
        note: this.note,
        due: this.due,
        issued_on: this.issuedOn,
        taxable_fulfillment_due: this.taxableFulfillmentDue,
        tags: parseObject(this.tags),
        round_total: this.roundTotal,
        subtotal: this.subtotal && parseFloat(this.subtotal),
        total: this.total && parseFloat(this.total),
        lines: parseObject(this.lines),
      },
    });

    $.export("$summary", `Successfully created invoice with ID ${response.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
Fakturoid	`fakturoid`	`app`	This component uses the Fakturoid app.
Account	`accountSlug`	`string`	Select a value from the drop down menu.
Custom Id	`customId`	`string`	Identifier in your application
Document Type	`documentType`	`string`	Select a value from the drop down menu:`{ "label": "Invoice", "value": "invoice" }{ "label": "Proforma", "value": "proforma" }{ "label": "Legacy partial proforma (cannot be set for new documents)", "value": "partial_proforma" }{ "label": "Correction document for an invoice", "value": "correction" }{ "label": "Tax document for a received payment", "value": "tax_document" }{ "label": "Final invoice for tax documents", "value": "final_invoice" }`
Subject Id	`subjectId`	`string`	Select a value from the drop down menu.
Order Number	`orderNumber`	`string`	Order number in your application
Note	`note`	`string`	Additional notes for the invoice
Due	`due`	`string`	Invoice due date in number of days from today
Issued On	`issuedOn`	`string`	Date of issue. Format: YYYY-MM-DD
Taxable Fulfillment Due	`taxableFulfillmentDue`	`string`	Chargeable event date.
Tags	`tags`	`string[]`	List of tags
Round Total	`roundTotal`	`boolean`	Round total amount (VAT included)
Subtotal	`subtotal`	`string`	Total without VAT
Total	`total`	`string`	Total with VAT
Lines	`lines`	`string[]`	List of object lines to invoice. See the documentation. Example: {"name": "Hard work","quantity": "1.0","unit_name": "h","unit_price": "40000","vat_rate": "21"}

Action Authentication#

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

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

Create Invoice with Fakturoid API on New Invoice Created (Instant) from Chargebee API

Pipedream makes it easy to connect APIs for Fakturoid, Chargebee and 2,700+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,700+apps by most popular

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