Create Invoice with Xendit API on New Download Counts from npm API

Pipedream makes it easy to connect APIs for Xendit, npm and 2,500+ other apps remarkably fast.

Trigger workflow on

New Download Counts from the npm API

Next, do this

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

Select this integration
Configure the New Download Counts trigger
1. Connect your npm account
2. Configure timer
3. Select a Period
4. Optional- Configure Package
Configure the Create Invoice action
1. Connect your Xendit account
2. Configure External ID
3. Configure Amount
4. Optional- Configure Description
5. Optional- Configure Given Names
6. Optional- Configure Surname
7. Optional- Configure Email
8. Optional- Configure Mobile Number
9. Optional- Configure City
10. Optional- Configure Country
11. Optional- Configure Postal Code
12. Optional- Configure State
13. Optional- Configure Address Line 1
14. Optional- Configure Address Line 2
15. Optional- Select one or more Invoice Created Notification
16. Optional- Select one or more Invoice Reminder Notification
17. Optional- Select one or more Invoice Paid Notification
18. Optional- Configure Invoice Duration
19. Optional- Configure Success Redirect URL
20. Optional- Configure Failure Redirect URL
21. Optional- Select one or more Payment Methods
22. Optional- Configure Currency
23. Optional- Select a Locale
24. Optional- Configure Items
25. Optional- Configure Fees
26. Optional- Configure Metadata
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 Download Counts on npm

Description:Emit new event with the latest count of downloads for an npm package. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md).

Version:0.1.0

Key:npm-download-counts

View on GitHub

Trigger Code#

import app from "../../npm.app.mjs";

export default {
  key: "npm-download-counts",
  name: "New Download Counts",
  description: "Emit new event with the latest count of downloads for an npm package. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md).",
  version: "0.1.0",
  type: "source",
  props: {
    app,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      description: "One day interval time is recommended because NPM only update metrics once a day. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md#data-source).",
      default: {
        intervalSeconds: 60 * 60 * 24,
      },
    },
    period: {
      type: "string",
      label: "Period",
      description: "Select last-day, last-week or last-month.",
      optional: false,
      default: "last-day",
      options: [
        "last-day",
        "last-week",
        "last-month",
      ],
    },
    packageName: {
      type: "string",
      label: "Package",
      description: "Enter an npm package name. Leave blank for all",
      optional: true,
    },
  },
  methods: {
    getDownloadCounts({
      period, packageName, ...args
    } = {}) {
      const basePath = `/downloads/point/${encodeURIComponent(period)}`;
      return this.app.makeRequest({
        path: packageName
          ? `${basePath}/${encodeURIComponent(packageName)}`
          : basePath,
        ...args,
      });
    },
  },
  async run({ timestamp: ts }) {
    const {
      getDownloadCounts,
      period,
      packageName,
    } = this;

    const response = await getDownloadCounts({
      period,
      packageName,
    });

    this.$emit(response, {
      id: ts,
      summary: `New Download Count ${response.downloads}`,
      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
npm	`app`	`app`	This component uses the npm app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`	One day interval time is recommended because NPM only update metrics once a day. See the documentation
Period	`period`	`string`	Select a value from the drop down menu:`last-daylast-weeklast-month`
Package	`packageName`	`string`	Enter an npm package name. Leave blank for all

Trigger Authentication#

The npm API does not require authentication.

About npm#

Node package manager

Action#

Create Invoice on Xendit

Description:Create a new invoice on Xendit platform [See the documentation](https://developers.xendit.co/api-reference/#create-invoice)

Version:0.0.1

Key:xendit-create-invoice

View on GitHub

Xendit Overview#

Leveraging the Xendit API on Pipedream, you can automate an array of financial tasks related to payments, disbursements, and accounting. Xendit simplifies handling transactions in Southeast Asia, offering services such as direct debit, credit card processing, and real-time payment tracking. By connecting it with Pipedream, you can create powerful workflows that trigger actions based on payment events, sync transaction data with other business systems, and streamline notification processes for financial operations.

Action Code#

import {
  INVOICE_NOTIFICATION_OPTIONS,
  LOCALE_OPTIONS,
  PAYMENT_METHODS_OPTIONS,
} from "../../common/constants.mjs";
import { parseObject } from "../../common/utils.mjs";
import xendit from "../../xendit.app.mjs";

export default {
  key: "xendit-create-invoice",
  name: "Create Invoice",
  version: "0.0.1",
  description: "Create a new invoice on Xendit platform [See the documentation](https://developers.xendit.co/api-reference/#create-invoice)",
  type: "action",
  props: {
    xendit,
    externalId: {
      type: "string",
      label: "External ID",
      description: "ID of your choice (typically the unique identifier of an invoice in your system).",
    },
    amount: {
      type: "string",
      label: "Amount",
      description: "Amount on the invoice. Min and max amounts are stated [here](https://docs.xendit.co/xeninvoice/payment-channels). The amount should be inclusive of any fees and or items that you may choose to include. If there is a difference between this amount and the sum of the price in the `items` parameters and or `fees` parameter, Xendit will refer to this amount parameter to create invoice. Do take note: if the currency or default currency is IDR and the amount includes decimals (e.g IDR 4550.50), the amount will be truncated to IDR 4550.",
    },
    description: {
      type: "string",
      label: "Description",
      description: "Description of invoice - you can use this field to list what items are being paid for, or anything else of your choice that describes the function of the invoice.",
      optional: true,
    },
    givenNames: {
      type: "string",
      label: "Given Names",
      description: "Given name of the customer",
      optional: true,
    },
    surname: {
      type: "string",
      label: "Surname",
      description: "Surname of the customer",
      optional: true,
    },
    email: {
      type: "string",
      label: "Email",
      description: "Email address of the customer",
      optional: true,
    },
    mobileNumber: {
      type: "string",
      label: "Mobile Number",
      description: "Mobile phone number of the customer in E164 format",
      optional: true,
    },
    addressCity: {
      type: "string",
      label: "City",
      description: "The city of the customer",
      optional: true,
    },
    addressCountry: {
      type: "string",
      label: "Country",
      description: "The country of the customer",
      optional: true,
    },
    addressPostalCode: {
      type: "string",
      label: "Postal Code",
      description: "The postal code of the customer",
      optional: true,
    },
    addressstate: {
      type: "string",
      label: "State",
      description: "The state of the customer",
      optional: true,
    },
    addressLine1: {
      type: "string",
      label: "Address Line 1",
      description: "The address line 1 of the customer",
      optional: true,
    },
    addressLine2: {
      type: "string",
      label: "Address Line 2",
      description: "The address line 2 of the customer",
      optional: true,
    },
    invoiceCreatedNotification: {
      type: "string[]",
      label: "Invoice Created Notification",
      description: "Specify which channel you want to notify your end customer through when you create a payment/invoice. If you do not specify values for this object, your end user will not be notified for this notification type.",
      options: INVOICE_NOTIFICATION_OPTIONS,
      optional: true,
    },
    invoiceReminderNotification: {
      type: "string[]",
      label: "Invoice Reminder Notification",
      description: "Specify which channel you want to notify your end customer through when you want to remind your customer to complete their payment. If you do not specify values for this object, your end user will not be notified for this notification type.",
      options: INVOICE_NOTIFICATION_OPTIONS,
      optional: true,
    },
    invoicePaidNotification: {
      type: "string[]",
      label: "Invoice Paid Notification",
      description: "Specify which channel you want to notify your end customer through when they have successfully completed payment. If you do not specify values for this object, your end user will not be notified for this notification type.",
      options: INVOICE_NOTIFICATION_OPTIONS,
      optional: true,
    },
    invoiceDuration: {
      type: "integer",
      label: "Invoice Duration",
      description: "Duration of time that the end customer is given to pay the invoice before expiration (in seconds, since creation). Default is 24 hours (86,400 seconds).",
      optional: true,
    },
    successRedirectUrl: {
      type: "string",
      label: "Success Redirect URL",
      description: "URL to redirect the customer to after successful payment.",
      optional: true,
    },
    failureRedirectUrl: {
      type: "string",
      label: "Failure Redirect URL",
      description: "URL to redirect the customer to after failed payment.",
      optional: true,
    },
    paymentMethods: {
      type: "string[]",
      label: "Payment Methods",
      description: "Specify the payment channels that you wish to be available on your Invoice.",
      options: PAYMENT_METHODS_OPTIONS,
      optional: true,
    },
    currency: {
      type: "string",
      label: "Currency",
      description: "Currency of the amount that you created.",
      optional: true,
    },
    locale: {
      type: "string",
      label: "Locale",
      description: "The default language to display",
      options: LOCALE_OPTIONS,
      optional: true,
    },
    items: {
      type: "string[]",
      label: "Items",
      description: "Array of items JSON objects describing the item(s) purchased. Max array size: 75. Mandatory for PayLater payment method. [See the documentation](https://developers.xendit.co/api-reference/#create-invoice) for further details.",
      optional: true,
    },
    fees: {
      type: "string[]",
      label: "Fees",
      description: "Array of items JSON objects describing the fee(s) that you charge to your end customer. This can be an admin fee, logistics fee, etc. This amount will be included in the total invoice amount and will be transferred to your balance when the transaction settles. Max array size: 10. [See the documentation](https://developers.xendit.co/api-reference/#create-invoice) for further details.",
      optional: true,
    },
    metadata: {
      type: "object",
      label: "Metadata",
      description: "An object containing any additional information you want to include with the invoice. This will be returned in the response and can be used for tracking or reporting purposes.",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.xendit.createInvoice({
      $,
      data: {
        external_id: this.externalId,
        amount: this.amount,
        description: this.description,
        customer: {
          given_names: this.givenNames,
          surname: this.surname,
          email: this.email,
          mobile_number: this.mobileNumber,
          addresses: [
            {
              city: this.addressCity,
              country: this.addressCountry,
              postal_code: this.addressPostalCode,
              state: this.addressstate,
              street_line1: this.addressLine1,
              street_line2: this.addressLine2,
            },
          ],
        },
        customer_notification_preference: {
          invoice_created: parseObject(this.invoiceCreatedNotification),
          invoice_reminder: parseObject(this.invoiceReminderNotification),
          invoice_paid: parseObject(this.invoicePaidNotification),
        },
        invoice_duration: this.invoiceDuration,
        success_redirect_url: this.successRedirectUrl,
        failure_redirect_url: this.failureRedirectUrl,
        payment_methods: parseObject(this.paymentMethods),
        locale: this.locale,
        items: parseObject(this.items),
        fees: parseObject(this.fees),
        currency: this.currency,
        metadata: this.metadata,
      },
    });

    $.export("$summary", `A new invoice with ID: ${response.id} was successfully created!`);
    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
Xendit	`xendit`	`app`	This component uses the Xendit app.
External ID	`externalId`	`string`	ID of your choice (typically the unique identifier of an invoice in your system).
Amount	`amount`	`string`	Amount on the invoice. Min and max amounts are stated here. The amount should be inclusive of any fees and or items that you may choose to include. If there is a difference between this amount and the sum of the price in the `items` parameters and or `fees` parameter, Xendit will refer to this amount parameter to create invoice. Do take note: if the currency or default currency is IDR and the amount includes decimals (e.g IDR 4550.50), the amount will be truncated to IDR 4550.
Description	`description`	`string`	Description of invoice - you can use this field to list what items are being paid for, or anything else of your choice that describes the function of the invoice.
Given Names	`givenNames`	`string`	Given name of the customer
Surname	`surname`	`string`	Surname of the customer
Email	`email`	`string`	Email address of the customer
Mobile Number	`mobileNumber`	`string`	Mobile phone number of the customer in E164 format
City	`addressCity`	`string`	The city of the customer
Country	`addressCountry`	`string`	The country of the customer
Postal Code	`addressPostalCode`	`string`	The postal code of the customer
State	`addressstate`	`string`	The state of the customer
Address Line 1	`addressLine1`	`string`	The address line 1 of the customer
Address Line 2	`addressLine2`	`string`	The address line 2 of the customer
Invoice Created Notification	`invoiceCreatedNotification`	`string[]`	Select a value from the drop down menu:`whatsappemailviber`
Invoice Reminder Notification	`invoiceReminderNotification`	`string[]`	Select a value from the drop down menu:`whatsappemailviber`
Invoice Paid Notification	`invoicePaidNotification`	`string[]`	Select a value from the drop down menu:`whatsappemailviber`
Invoice Duration	`invoiceDuration`	`integer`	Duration of time that the end customer is given to pay the invoice before expiration (in seconds, since creation). Default is 24 hours (86,400 seconds).
Success Redirect URL	`successRedirectUrl`	`string`	URL to redirect the customer to after successful payment.
Failure Redirect URL	`failureRedirectUrl`	`string`	URL to redirect the customer to after failed payment.
Payment Methods	`paymentMethods`	`string[]`	Select a value from the drop down menu:`CREDIT_CARDBCABNIBSIBRIMANDIRIPERMATASAHABAT_SAMPOERNABNCALFAMARTINDOMARETOVODANASHOPEEPAYLINKAJAJENIUSPAYDD_BRIDD_BCA_KLIKPAYKREDIVOAKULAKUATOMEQRISCREDIT_CARD7ELEVENCEBUANADD_BPIDD_UBPDD_RCBCDD_BDO_EPAYDP_MLHUILLIERDP_PALAWANDP_ECPAY_LOANPAYMAYAGRABPAYGCASHSHOPEEPAYBILLEASECASHALOBDO_ONLINE_BANKINGBPI_ONLINE_BANKINGUNIONBANK_ONILNE_BANKINGBOC_ONLINE_BANKINGCHINABANK_ONLINE_BANKINGINSTAPAY_ONLINE_BANKINGLANDBANK_ONLINE_BANKINGMAYBANK_ONLINE_BANKINGMETROBANK_ONLINE_BANKINGPNB_ONLINE_BANKINGPSBANK_ONLINE_BANKINGPESONET_ONLINE_BANKINGRCBC_ONLINE_BANKINGROBINSONS_BANK_ONLINE_BANKINGSECURITY_BANK_ONLINE_BANKINGQRPHCREDIT_CARDPROMPTPAYLINEPAYWECHATPAYTRUEMONEYSHOPEEPAYDD_SCB_MBDD_BBL_MBDD_KTB_MBDD_BAY_MBDD_KBANK_MBCREDIT_CARDAPPOTAZALOPAYVNPTWALLETVIETTELPAYSHOPEEPAYWOORIVIETCAPITALVPBBIDVCREDIT_CARDTOUCHNGOWECHATPAYDD_UOB_FPXDD_PUBLIC_FPXDD_AFFIN_FPXDD_AGRO_FPXDD_ALLIANCE_FPXDD_AMBANK_FPXDD_ISLAM_FPXDD_MUAMALAT_FPXDD_BOC_FPXDD_RAKYAT_FPXDD_BSN_FPXDD_CIMB_FPXDD_HLB_FPXDD_HSBC_FPXDD_KFH_FPXDD_MAYB2U_FPXDD_OCBC_FPXDD_RHB_FPXDD_SCH_FPXDD_AFFIN_FPX_BUSINESSDD_AGRO_FPX_BUSINESSDD_ALLIANCE_FPX_BUSINESSDD_AMBANK_FPX_BUSINESSDD_ISLAM_FPX_BUSINESSDD_MUAMALAT_FPX_BUSINESSDD_BNP_FPX_BUSINESSDD_CIMB_FPX_BUSINESSDD_CITIBANK_FPX_BUSINESSDD_DEUTSCHE_FPX_BUSINESSDD_HLB_FPX_BUSINESSDD_HSBC_FPX_BUSINESSDD_RAKYAT_FPX_BUSINESSDD_KFH_FPX_BUSINESSDD_MAYB2E_FPX_BUSINESSDD_OCBC_FPX_BUSINESSDD_PUBLIC_FPX_BUSINESSDD_RHB_FPX_BUSINESSDD_SCH_FPX_BUSINESSDD_UOB_FPX_BUSINESS`
Currency	`currency`	`string`	Currency of the amount that you created.
Locale	`locale`	`string`	Select a value from the drop down menu:`enid`
Items	`items`	`string[]`	Array of items JSON objects describing the item(s) purchased. Max array size: 75. Mandatory for PayLater payment method. See the documentation for further details.
Fees	`fees`	`string[]`	Array of items JSON objects describing the fee(s) that you charge to your end customer. This can be an admin fee, logistics fee, etc. This amount will be included in the total invoice amount and will be transferred to your balance when the transaction settles. Max array size: 10. See the documentation for further details.
Metadata	`metadata`	`object`	An object containing any additional information you want to include with the invoice. This will be returned in the response and can be used for tracking or reporting purposes.