Create Customer Invoice with Pennylane API on New DynamoDB Stream Event from AWS API

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

Trigger workflow on

New DynamoDB Stream Event from the AWS API

Next, do this

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

Select this integration
Configure the New DynamoDB Stream Event trigger
1. Connect your AWS account
2. Configure timer
3. Select a AWS Region
4. Select a Stream
Configure the Create Customer Invoice action
1. Connect your Pennylane account
2. Configure Date
3. Configure Deadline
4. Optional- Configure External Id
5. Optional- Configure PDF Invoice Free Text
6. Optional- Configure PDF Invoice Subject
7. Configure Draft
8. Optional- Configure Currency
9. Optional- Configure Special Mention
10. Optional- Configure Discount
11. Optional- Select a Language
12. Select a Banking Provider
13. Select a Provider Field Name
14. Configure Provider Field Value
15. Select a Customer Id
16. Optional- Configure Line Items Sections Attributes
17. Configure Line Items
18. Optional- Configure Categories
19. Configure Start Date
20. Configure End Date
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 DynamoDB Stream Event on AWS

Description:Emit new event when a DynamoDB stream receives new events. [See the docs here](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_streams_GetRecords.html)

Version:0.0.2

Key:aws-new-dynamodb-stream-event

View on GitHub

AWS Overview#

The AWS API unlocks endless possibilities for automation with Pipedream. With this powerful combo, you can manage your AWS services and resources, automate deployment workflows, process data, and react to events across your AWS infrastructure. Pipedream offers a serverless platform for creating workflows triggered by various events that can execute AWS SDK functions, making it an efficient tool to integrate, automate, and orchestrate tasks across AWS services and other apps.

Trigger Code#

import common from "../../common/common-dynamodb-streams.mjs";

export default {
  ...common,
  key: "aws-new-dynamodb-stream-event",
  name: "New DynamoDB Stream Event",
  description: "Emit new event when a DynamoDB stream receives new events. [See the docs here](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_streams_GetRecords.html)",
  type: "source",
  version: "0.0.2",
  dedupe: "unique",
  props: {
    ...common.props,
    stream: {
      type: "string",
      label: "Stream",
      description: "ARN of the Stream to watch for new events",
      async options({ prevContext }) {
        const {
          streams,
          lastEvaluatedStreamArn,
        } = await this.listEnabledStreams({
          ExclusiveStartStreamArn: prevContext.lastEvaluatedStreamArn,
        });
        const options = streams.map((stream) => ({
          label: `${stream.TableName} - Created ${stream.StreamLabel}`,
          value: stream.StreamArn,
        }));
        return {
          options,
          context: {
            lastEvaluatedStreamArn,
          },
        };
      },
    },
  },
  hooks: {
    async deploy() {
      const { StreamDescription: streamDescription } = await this.listShards({
        StreamArn: this.stream,
      });
      const shardId = streamDescription.Shards[streamDescription.Shards.length - 1].ShardId;
      const { ShardIterator: shardIterator } = await this.getShardIterator({
        ShardId: shardId,
        StreamArn: this.stream,
        ShardIteratorType: "LATEST",
      });
      this._setShardIterator(shardIterator);
    },
  },
  methods: {
    ...common.methods,
    _getShardIterator() {
      return this.db.get("shardIterator");
    },
    _setShardIterator(shardIterator) {
      this.db.set("shardIterator", shardIterator);
    },
    generateMeta({
      eventID, eventName, dynamodb,
    }) {
      return {
        id: eventID,
        summary: `New ${eventName} event`,
        ts: Date.parse(dynamodb.ApproximateCreationDateTime),
      };
    },
  },
  async run() {
    if (!(await this.isStreamEnabled(this.stream))) {
      throw new Error("Stream is no longer enabled.");
    }

    const shardIterator = this._getShardIterator();

    const {
      Records: records, NextShardIterator: nextShardIterator,
    } = await this.getRecords({
      ShardIterator: shardIterator,
    });

    for (const record of records) {
      const meta = this.generateMeta(record);
      this.$emit(record, meta);
    }

    this._setShardIterator(nextShardIterator);
  },
};

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
AWS	`aws`	`app`	This component uses the AWS app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
AWS Region	`region`	`string`	Select a value from the drop down menu.
Stream	`stream`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

Follow the AWS Instructions for creating an IAM user with an associated access and secret key.

As a best practice, attach the minimum set of IAM permissions necessary to perform the specific task in Pipedream. If your workflow only needs to perform a single API call, you should create a user and associate an IAM group / policy with permission to do only that task. You can create as many linked AWS accounts in Pipedream as you'd like.

Enter your access and secret key below.

About AWS#

Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.

Action#

Create Customer Invoice on Pennylane

Description:Generates a new invoice for a customer using Pennylane. [See the documentation](https://pennylane.readme.io/reference/customer_invoices-post-1)

Version:0.0.1

Key:pennylane-create-customer-invoice

View on GitHub

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import {
  BANKING_PROVIDER_OPTIONS,
  LANGUAGE_OPTIONS,
  PROVIDER_FIELD_NAMES_OPTIONS,
} from "../../common/constants.mjs";
import { parseObject } from "../../common/utils.mjs";
import pennylane from "../../pennylane.app.mjs";

export default {
  key: "pennylane-create-customer-invoice",
  name: "Create Customer Invoice",
  description: "Generates a new invoice for a customer using Pennylane. [See the documentation](https://pennylane.readme.io/reference/customer_invoices-post-1)",
  version: "0.0.1",
  type: "action",
  props: {
    pennylane,
    date: {
      type: "string",
      label: "Date",
      description: "Invoice date (ISO 8601)",
    },
    deadline: {
      type: "string",
      label: "Deadline",
      description: "Invoice payment deadline (ISO 8601)",
    },
    externalId: {
      type: "string",
      label: "External Id",
      description: "An id you can use to refer to the invoice from outside of Pennylane",
      optional: true,
    },
    pdfInvoiceFreeText: {
      type: "string",
      label: "PDF Invoice Free Text",
      description: "For example, the contact details of the person to contact",
      optional: true,
    },
    pdfInvoiceSubject: {
      type: "string",
      label: "PDF Invoice Subject",
      description: "Invoice title",
      optional: true,
    },
    draft: {
      type: "boolean",
      label: "Draft",
      description: "Do you wish to create a draft invoice (otherwise it is a finalized invoice)? Reminder, once created, a finalized invoice cannot be edited!",
    },
    currency: {
      type: "string",
      label: "Currency",
      description: "Invoice Currency (ISO 4217). Default is EUR.",
      optional: true,
    },
    specialMention: {
      type: "string",
      label: "Special Mention",
      description: "Additional details",
      optional: true,
    },
    discount: {
      type: "integer",
      label: "Discount",
      description: "Invoice discount (in percent)",
      optional: true,
    },
    language: {
      type: "string",
      label: "Language",
      description: "invoice pdf language",
      options: LANGUAGE_OPTIONS,
      optional: true,
    },
    bankingProvider: {
      type: "string",
      label: "Banking Provider",
      description: "The banking provider for the transaction",
      options: BANKING_PROVIDER_OPTIONS,
      reloadProps: true,
    },
    providerFieldName: {
      type: "string",
      label: "Provider Field Name",
      description: "Name of the field that you want to match",
      options: PROVIDER_FIELD_NAMES_OPTIONS,
      hidden: true,
    },
    providerFieldValue: {
      type: "string",
      label: "Provider Field Value",
      description: "Value that you want to match",
    },
    customerId: {
      propDefinition: [
        pennylane,
        "customerId",
      ],
    },
    lineItemsSectionsAttributes: {
      propDefinition: [
        pennylane,
        "lineItemsSectionsAttributes",
      ],
      optional: true,
    },
    lineItems: {
      propDefinition: [
        pennylane,
        "lineItems",
      ],
    },
    categories: {
      type: "string[]",
      label: "Categories",
      description: "A list of objects of categories",
      optional: true,
    },
    startDate: {
      type: "string",
      label: "Start Date",
      description: "Start date of the imputation period (ISO 8601)",
    },
    endDate: {
      type: "string",
      label: "End Date",
      description: "End date of the imputation period (ISO 8601)",
    },
  },
  async additionalProps(props) {
    if (this.bankingProvider === "stripe") {
      props.providerFieldName.hidden = false;
    }
    return {};
  },
  async run({ $ }) {
    try {
      const invoice = await this.pennylane.createInvoice({
        $,
        data: {
          create_customer: false,
          create_products: false,
          invoice: {
            date: this.date,
            deadline: this.deadline,
            external_id: this.externalId,
            pdf_invoice_free_text: this.pdfInvoiceFreeText,
            pdf_invoice_subject: this.pdfInvoiceSubject,
            draft: this.draft,
            currency: this.currency,
            special_mention: this.specialMention,
            discount: this.discount,
            language: this.language,
            transactions_reference: {
              banking_provider: this.bankingProvider,
              provider_field_name: (this.bankingProvider === "gocardless")
                ? "payment_id"
                : this.providerFieldName,
              provider_field_value: this.providerFieldValue,
            },
            customer: {
              source_id: this.customerId,
            },
            line_items_sections_attributes: parseObject(this.lineItemsSectionsAttributes),
            line_items: parseObject(this.lineItems),
            categories: parseObject(this.categories),
            imputation_dates: {
              start_date: this.startDate,
              end_date: this.endDate,
            },
          },
        },
      });

      $.export("$summary", `Created invoice with ID ${invoice.invoice.id}`);
      return invoice;
    } catch ({ response }) {
      throw new ConfigurationError(response?.data?.message || response?.data?.error);
    }
  },
};

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
Pennylane	`pennylane`	`app`	This component uses the Pennylane app.
Date	`date`	`string`	Invoice date (ISO 8601)
Deadline	`deadline`	`string`	Invoice payment deadline (ISO 8601)
External Id	`externalId`	`string`	An id you can use to refer to the invoice from outside of Pennylane
PDF Invoice Free Text	`pdfInvoiceFreeText`	`string`	For example, the contact details of the person to contact
PDF Invoice Subject	`pdfInvoiceSubject`	`string`	Invoice title
Draft	`draft`	`boolean`	Do you wish to create a draft invoice (otherwise it is a finalized invoice)? Reminder, once created, a finalized invoice cannot be edited!
Currency	`currency`	`string`	Invoice Currency (ISO 4217). Default is EUR.
Special Mention	`specialMention`	`string`	Additional details
Discount	`discount`	`integer`	Invoice discount (in percent)
Language	`language`	`string`	Select a value from the drop down menu:`en_GBfr_FR`
Banking Provider	`bankingProvider`	`string`	Select a value from the drop down menu:`gocardlessstripe`
Provider Field Value	`providerFieldValue`	`string`	Value that you want to match
Customer Id	`customerId`	`string`	Select a value from the drop down menu.
Line Items Sections Attributes	`lineItemsSectionsAttributes`	`string[]`	A list of objects of items sections to be listed on the invoice. Example: [{"title": "Title","description": "description","rank": 1}] See the documentation from further information.
Line Items	`lineItems`	`string[]`	A list of objects of items to be listed on the invoice. Example: [{"product": {"source_id": "0e67fc3c-c632-4feb-ad34-e18ed5fbf66a","unit": "20","price": "10.00","label": "Product label","vat_rate": "FR_09","currency": "EUR"},"quantity": 2,"label": "Line Item Label"}] See the documentation from further information.
Categories	`categories`	`string[]`	A list of objects of categories
Start Date	`startDate`	`string`	Start date of the imputation period (ISO 8601)
End Date	`endDate`	`string`	End date of the imputation period (ISO 8601)

Action Authentication#

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

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

customer_invoices

About Pennylane#

Pennylane brings together your finances, your accounting, and your Business Account!

More Ways to Connect Pennylane + AWS#

Other Popular Integrations#

Create Customer with Pennylane API on New DynamoDB Stream Event from AWS API

AWS + Pennylane

Create Customer Invoice with Pennylane API on New DynamoDB Stream Event from AWS API

Pipedream makes it easy to connect APIs for Pennylane, AWS 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