Create Customer with Invoiced API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

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

Configure the Create Customer action
1. Connect your Invoiced account
2. Configure Name
3. Optional- Configure Number
4. Optional- Configure Email
5. Optional- Configure Autoplay
6. Optional- Configure Autoplay Delay Days
7. Optional- Configure Payment Terms
8. Optional- Configure Attention To
9. Optional- Configure Address Line 1
10. Optional- Configure Address Line 2
11. Optional- Configure City
12. Optional- Configure State
13. Optional- Configure Postal Code
14. Optional- Configure Country
15. Optional- Configure Language
16. Optional- Configure Currency
17. Optional- Configure Chase
18. Optional- Select a Chasing Cadence
19. Optional- Select a Next Chase Step
20. Optional- Configure Phone
21. Optional- Configure Credit Hold
22. Optional- Configure Credit Limit
23. Optional- Select a Member ID
24. Optional- Configure Taxable
25. Optional- Select one or more Taxes
26. Optional- Select a Tax ID
27. Optional- Configure Avalara Entity Use Code
28. Optional- Configure Avalara Exemption Number
29. Optional- Select a Type
30. Optional- Select a Parent Customer ID
31. Optional- Configure Notes
32. Optional- Configure Sign Up Page
33. Optional- Configure Metadata
34. Optional- Configure Disabled Payment Methods
35. Optional- Configure ACH Gateway
36. Optional- Configure CC Gateway
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 Customer on Invoiced

Description:Creates a new customer in Invoiced. [See the documentation](https://developer.invoiced.com/api/customers#create-a-customer)

Version:0.0.1

Key:invoiced-create-customer

View on GitHub

Code#

import {
  objectCamelToSnakeCase, parseObject,
} from "../../common/utils.mjs";
import invoiced from "../../invoiced.app.mjs";

export default {
  key: "invoiced-create-customer",
  name: "Create Customer",
  description: "Creates a new customer in Invoiced. [See the documentation](https://developer.invoiced.com/api/customers#create-a-customer)",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  props: {
    invoiced,
    name: {
      type: "string",
      label: "Name",
      description: "Customer name",
    },
    number: {
      type: "string",
      label: "Number",
      description: "A unique ID to help tie your customer to your external systems. Invoiced will generate one if not supplied",
      optional: true,
    },
    email: {
      type: "string",
      label: "Email",
      description: "Customer email address",
      optional: true,
    },
    autoplay: {
      type: "boolean",
      label: "Autoplay",
      description: "AutoPay enabled? Defaults to false",
      optional: true,
    },
    autoplayDelayDays: {
      type: "integer",
      label: "Autoplay Delay Days",
      description: "Number of days to delay AutoPay",
      optional: true,
    },
    paymentTerms: {
      type: "string",
      label: "Payment Terms",
      description: "Payment terms when AutoPay is off. (i.e., \"NET 30\")",
      optional: true,
    },
    attentionTo: {
      type: "string",
      label: "Attention To",
      description: "Used for ATTN: address line if `company`",
      optional: true,
    },
    address1: {
      type: "string",
      label: "Address Line 1",
      description: "Customer address line 1",
      optional: true,
    },
    address2: {
      type: "string",
      label: "Address Line 2",
      description: "Optional second address line",
      optional: true,
    },
    city: {
      type: "string",
      label: "City",
      description: "Customer city",
      optional: true,
    },
    state: {
      type: "string",
      label: "State",
      description: "State or province",
      optional: true,
    },
    postalCode: {
      type: "string",
      label: "Postal Code",
      description: "Zip or postal code",
      optional: true,
    },
    country: {
      type: "string",
      label: "Country",
      description: "Customer country [Two-letter ISO code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)",
      optional: true,
    },
    language: {
      type: "string",
      label: "Language",
      description: "Customer language [Two-letter ISO code](https://en.wikipedia.org/wiki/ISO_639-1)",
      optional: true,
    },
    currency: {
      type: "string",
      label: "Currency",
      description: "Customer currency [3-letter ISO code](https://en.wikipedia.org/wiki/ISO_4217)",
      optional: true,
    },
    chase: {
      type: "boolean",
      label: "Chase",
      description: "Chasing enabled? - defaults to true",
      optional: true,
    },
    chasingCadence: {
      propDefinition: [
        invoiced,
        "chasingCadenceId",
      ],
      optional: true,
    },
    nextChaseStep: {
      propDefinition: [
        invoiced,
        "nextChaseStep",
        ({ chasingCadence }) => ({
          chasingCadence,
        }),
      ],
      optional: true,
    },
    phone: {
      type: "string",
      label: "Phone",
      description: "Customer phone number",
      optional: true,
    },
    creditHold: {
      type: "boolean",
      label: "Credit Hold",
      description: "When true, customer is on credit hold",
      optional: true,
    },
    creditLimit: {
      type: "string",
      label: "Credit Limit",
      description: "Customer credit limit",
      optional: true,
    },
    ownerId: {
      propDefinition: [
        invoiced,
        "memberId",
      ],
      optional: true,
    },
    taxable: {
      type: "boolean",
      label: "Taxable",
      description: "Customer taxable?",
      optional: true,
    },
    taxes: {
      propDefinition: [
        invoiced,
        "taxId",
      ],
      type: "string[]",
      label: "Taxes",
      description: "Array of Tax Rate IDs",
      optional: true,
    },
    taxId: {
      propDefinition: [
        invoiced,
        "taxId",
      ],
      optional: true,
    },
    avalaraEntityUseCode: {
      type: "string",
      label: "Avalara Entity Use Code",
      description: "[Avalara-specific entity use code](https://help.avalara.com/Avalara_AvaTax_Update/Exemption_Reason_Matrix_for_US_and_Canada)",
      optional: true,
    },
    avalaraExemptionNumber: {
      type: "string",
      label: "Avalara Exemption Number",
      description: "Tax-exempt number to pass to [Avalara](https://docs.invoiced.com/integrations/avalara)",
      optional: true,
    },
    type: {
      type: "string",
      label: "Type",
      description: "Organization type",
      options: [
        {
          label: "Company",
          value: "company",
        },
        {
          label: "Person",
          value: "person",
        },
      ],
      optional: true,
    },
    parentCustomer: {
      propDefinition: [
        invoiced,
        "customerId",
      ],
      label: "Parent Customer ID",
      description: "The parent customer to which this customer belongs",
      optional: true,
    },
    notes: {
      type: "string",
      label: "Notes",
      description: "Private customer notes",
      optional: true,
    },
    signUpPage: {
      type: "string",
      label: "Sign Up Page",
      description: "[Sign up page ID](https://docs.invoiced.com/subscription-billing/sign-up-pages)",
      optional: true,
    },
    metadata: {
      propDefinition: [
        invoiced,
        "metadata",
      ],
    },
    disabledPaymentMethods: {
      propDefinition: [
        invoiced,
        "paymentMethodId",
      ],
    },
    achGateway: {
      type: "integer",
      label: "ACH Gateway",
      description: "Gateway configuration ID to process payments with",
      optional: true,
    },
    ccGateway: {
      type: "integer",
      label: "CC Gateway",
      description: "Gateway configuration ID to process payments with",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      invoiced,
      creditLimit,
      taxes,
      disabledPaymentMethods,
      ...data
    } = this;

    if (creditLimit) data.credit_limit = parseFloat(creditLimit);
    if (taxes) data.taxes = parseObject(taxes);
    if (disabledPaymentMethods) data.disabled_payment_methods = parseObject(disabledPaymentMethods);

    const response = await invoiced.createCustomer({
      $,
      data: objectCamelToSnakeCase(data),
    });

    $.export("$summary", `Successfully created customer with ID ${response.id}`);

    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
Invoiced	`invoiced`	`app`	This component uses the Invoiced app.
Name	`name`	`string`	Customer name
Number	`number`	`string`	A unique ID to help tie your customer to your external systems. Invoiced will generate one if not supplied
Email	`email`	`string`	Customer email address
Autoplay	`autoplay`	`boolean`	AutoPay enabled? Defaults to false
Autoplay Delay Days	`autoplayDelayDays`	`integer`	Number of days to delay AutoPay
Payment Terms	`paymentTerms`	`string`	Payment terms when AutoPay is off. (i.e., "NET 30")
Attention To	`attentionTo`	`string`	Used for ATTN: address line if `company`
Address Line 1	`address1`	`string`	Customer address line 1
Address Line 2	`address2`	`string`	Optional second address line
City	`city`	`string`	Customer city
State	`state`	`string`	State or province
Postal Code	`postalCode`	`string`	Zip or postal code
Country	`country`	`string`	Customer country Two-letter ISO code
Language	`language`	`string`	Customer language Two-letter ISO code
Currency	`currency`	`string`	Customer currency 3-letter ISO code
Chase	`chase`	`boolean`	Chasing enabled? - defaults to true
Chasing Cadence	`chasingCadence`	`integer`	Select a value from the drop down menu.
Next Chase Step	`nextChaseStep`	`integer`	Select a value from the drop down menu.
Phone	`phone`	`string`	Customer phone number
Credit Hold	`creditHold`	`boolean`	When true, customer is on credit hold
Credit Limit	`creditLimit`	`string`	Customer credit limit
Member ID	`ownerId`	`string`	Select a value from the drop down menu.
Taxable	`taxable`	`boolean`	Customer taxable?
Taxes	`taxes`	`string[]`	Select a value from the drop down menu.
Tax ID	`taxId`	`string`	Select a value from the drop down menu.
Avalara Entity Use Code	`avalaraEntityUseCode`	`string`	Avalara-specific entity use code
Avalara Exemption Number	`avalaraExemptionNumber`	`string`	Tax-exempt number to pass to Avalara
Type	`type`	`string`	Select a value from the drop down menu:`{ "label": "Company", "value": "company" }{ "label": "Person", "value": "person" }`
Parent Customer ID	`parentCustomer`	`string`	Select a value from the drop down menu.
Notes	`notes`	`string`	Private customer notes
Sign Up Page	`signUpPage`	`string`	Sign up page ID
Metadata	`metadata`	`object`	A hash of key/value pairs that can store additional information about this object.
Disabled Payment Methods	`disabledPaymentMethods`	`string[]`	Array of payment method IDs to disable for the customer. i.e., ["wire_transfer", "credit_card"]
ACH Gateway	`achGateway`	`integer`	Gateway configuration ID to process payments with
CC Gateway	`ccGateway`	`integer`	Gateway configuration ID to process payments with