Create Invoice with ChargeKeep API

Pipedream makes it easy to connect APIs for ChargeKeep and 3,000+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create Invoice with the ChargeKeep 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#

Create a workflow to Create Invoice with the ChargeKeep API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Create Invoice action
1. Connect your ChargeKeep account
2. Select a Contact ID
3. Select a Status
4. Configure Date
5. Select a Currency ID
6. Select one or more Product Codes
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

Create Invoice on ChargeKeep

Description:Create a new invoice in Chargekeep. [See the documentation](https://crm.chargekeep.com/app/api/swagger)

Version:0.0.1

Key:chargekeep-create-invoice

View on GitHub

Code#

import chargekeep from "../../chargekeep.app.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "chargekeep-create-invoice",
  name: "Create Invoice",
  description: "Create a new invoice in Chargekeep. [See the documentation](https://crm.chargekeep.com/app/api/swagger)",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  props: {
    chargekeep,
    contactId: {
      propDefinition: [
        chargekeep,
        "contactId",
      ],
    },
    status: {
      type: "string",
      label: "Status",
      description: "The status of the invoice",
      options: constants.INVOICE_STATUS_OPTIONS,
    },
    date: {
      type: "string",
      label: "Date",
      description: "The date of the invoice in the format YYYY-MM-DD",
    },
    currencyId: {
      propDefinition: [
        chargekeep,
        "currencyId",
      ],
    },
    productCodes: {
      propDefinition: [
        chargekeep,
        "productCodes",
        (c) => ({
          currencyId: c.currencyId,
        }),
      ],
      reloadProps: true,
    },
  },
  additionalProps() {
    const props = {};
    if (!this.productCodes?.length) {
      return props;
    }
    for (const productCode of this.productCodes) {
      props[`${productCode}_quantity`] = {
        type: "string",
        label: `Quantity for Product ${productCode}`,
        description: `The quantity of the product ${productCode} to add to the invoice`,
      };
      props[`${productCode}_rate`] = {
        type: "string",
        label: `Rate for Product ${productCode}`,
        description: `The rate of the product ${productCode} to add to the invoice`,
      };
      props[`${productCode}_unit`] = {
        type: "string",
        label: `Unit for Product ${productCode}`,
        description: `The unit of the product ${productCode} to add to the invoice`,
        options: constants.UNIT_OPTIONS,
      };
      props[`${productCode}_sortOrder`] = {
        type: "integer",
        label: `Sort Order for Product ${productCode}`,
        description: `The sort order of the product ${productCode} to add to the invoice`,
      };
    }
    return props;
  },
  async run({ $ }) {
    const lines = [];
    let grandTotal = 0;
    for (const productCode of this.productCodes) {
      const total = parseFloat(this[`${productCode}_quantity`]) * parseFloat(this[`${productCode}_rate`]);
      lines.push({
        productCode,
        quantity: parseFloat(this[`${productCode}_quantity`]),
        rate: parseFloat(this[`${productCode}_rate`]),
        total,
        unit: this[`${productCode}_unit`],
        sortOrder: this[`${productCode}_sortOrder`],
      });
      grandTotal += total;
    }
    const response = await this.chargekeep.createInvoice({
      $,
      data: {
        contactId: this.contactId,
        status: this.status,
        date: this.date,
        currencyId: this.currencyId,
        lines,
        grandTotal,
      },
    });

    $.export("$summary", `Successfully created invoice with ID ${response.result}.`);
    return response;
  },
};

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
ChargeKeep	`chargekeep`	`app`	This component uses the ChargeKeep app.
Contact ID	`contactId`	`integer`	Select a value from the drop down menu.
Status	`status`	`string`	Select a value from the drop down menu:`DraftFinalSentPaidCanceledPartiallyPaidRefundedPartiallyRefunded`
Date	`date`	`string`	The date of the invoice in the format YYYY-MM-DD
Currency ID	`currencyId`	`string`	Select a value from the drop down menu.
Product Codes	`productCodes`	`string[]`	Select a value from the drop down menu.