Find Invoice with Lightspeed eCom (C-Series) API

Pipedream makes it easy to connect APIs for Lightspeed eCom (C-Series) and 2,800+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Find Invoice with the Lightspeed eCom (C-Series) 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 Find Invoice with the Lightspeed eCom (C-Series) API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Find Invoice action
1. Connect your Lightspeed eCom (C-Series) account
2. Optional- Select a Customer ID
3. Optional- Select a Order Number
4. Optional- Select a Invoice Number
5. Optional- Configure Since ID
6. Optional- Configure Created At Min
7. Optional- Configure Created At Max
8. Optional- Configure Updated At Min
9. Optional- Configure Updated At Max
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

Integrations#

Find Invoice with Lightspeed eCom (C-Series) API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Lightspeed eCom (C-Series)

Try it

Find Invoice with Lightspeed eCom (C-Series) API on New Submission from Typeform API

Typeform + Lightspeed eCom (C-Series)

Try it

Find Invoice with Lightspeed eCom (C-Series) API on New Submission (Instant) from Jotform API

Jotform + Lightspeed eCom (C-Series)

Try it

Find Invoice with Lightspeed eCom (C-Series) API on New Scheduled Tasks from Pipedream API

Pipedream + Lightspeed eCom (C-Series)

Try it

Find Invoice with Lightspeed eCom (C-Series) API on New Download Counts from npm API

npm + Lightspeed eCom (C-Series)

Try it

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.

Find Invoice on Lightspeed eCom (C-Series)

Description:Find an invoice by ID. [See the documentation](https://developers.lightspeedhq.com/ecom/endpoints/invoice/#get-all-invoices)

Version:0.0.1

Key:lightspeed_ecom_c_series-find-invoice

View on GitHub

Code#

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

export default {
  key: "lightspeed_ecom_c_series-find-invoice",
  name: "Find Invoice",
  description: "Find an invoice by ID. [See the documentation](https://developers.lightspeedhq.com/ecom/endpoints/invoice/#get-all-invoices)",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  props: {
    app,
    customerId: {
      propDefinition: [
        app,
        "customerId",
      ],
      description: "Retrieve all invoices from a specific customer based on the customerid",
      optional: true,
    },
    orderNumber: {
      propDefinition: [
        app,
        "orderNumber",
      ],
      description: "Retrieve an order based on the order number",
      optional: true,
    },
    invoiceNumber: {
      propDefinition: [
        app,
        "invoiceNumber",
      ],
      description: "Retrieve an invoice based on the invoice number",
      optional: true,
    },
    sinceId: {
      type: "string",
      label: "Since ID",
      description: "Restrict results to after the specified ID",
      optional: true,
    },
    createdAtMin: {
      propDefinition: [
        app,
        "createdAtMin",
      ],
      description: "Show invoices created after date. **Format: `YYYY-MM-DD HH:MM:SS`**",
    },
    createdAtMax: {
      propDefinition: [
        app,
        "createdAtMax",
      ],
      description: "Show invoices created before date. **Format: `YYYY-MM-DD HH:MM:SS`**",
    },
    updatedAtMin: {
      propDefinition: [
        app,
        "updatedAtMin",
      ],
      description: "Show invoices last updated after date. **Format: `YYYY-MM-DD HH:MM:SS`**",
    },
    updatedAtMax: {
      propDefinition: [
        app,
        "updatedAtMax",
      ],
      description: "Show invoices last updated before date. **Format: `YYYY-MM-DD HH:MM:SS`**",
    },
  },
  async run({ $ }) {
    const response = this.app.paginate({
      fn: this.app.listInvoice,
      $,
      params: {
        customer: this.customerId,
        number: this.invoiceNumber,
        order: this.orderNumber,
        since_id: this.sinceId,
        created_at_min: this.createdAtMin,
        created_at_max: this.createdAtMax,
        updated_at_min: this.updatedAtMin,
        updated_at_max: this.updatedAtMax,
      },
      dataField: "invoices",
    });

    const invoices = [];
    for await (const invoice of response) {
      invoices.push(invoice);
    }

    $.export("$summary", `Successfully found ${invoices.length} invoice${invoices.length === 1
      ? ""
      : "s"}`);
    return invoices;
  },
};

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
Lightspeed eCom (C-Series)	`app`	`app`	This component uses the Lightspeed eCom (C-Series) app.
Customer ID	`customerId`	`string`	Select a value from the drop down menu.
Order Number	`orderNumber`	`string`	Select a value from the drop down menu.
Invoice Number	`invoiceNumber`	`string`	Select a value from the drop down menu.
Since ID	`sinceId`	`string`	Restrict results to after the specified ID
Created At Min	`createdAtMin`	`string`	Show invoices created after date. Format: `YYYY-MM-DD HH:MM:SS`
Created At Max	`createdAtMax`	`string`	Show invoices created before date. Format: `YYYY-MM-DD HH:MM:SS`
Updated At Min	`updatedAtMin`	`string`	Show invoices last updated after date. Format: `YYYY-MM-DD HH:MM:SS`
Updated At Max	`updatedAtMax`	`string`	Show invoices last updated before date. Format: `YYYY-MM-DD HH:MM:SS`

Authentication#

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