Create Invoice with Square API on Custom Interval from Schedule API

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

Trigger workflow on

Custom Interval from the Schedule API

Next, do this

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

Select this integration
Configure the Custom Interval trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Create Invoice action
1. Connect your Square account
2. Select a Location
3. Select a Order
4. Select a Customer
5. Configure Due Date
6. Select one or more Accepted Payment Methods
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#

Custom Interval on Schedule

Description:Trigger your workflow every N hours, minutes or seconds.

Version:0.0.2

Key:schedule-custom-interval

View on GitHub

Schedule Overview#

The Schedule app in Pipedream is a powerful tool that allows you to trigger workflows at regular intervals, ranging from every minute to once a year. This enables the automation of repetitive tasks and the scheduling of actions to occur without manual intervention. By leveraging this API, you can execute code, run integrations, and process data on a reliable schedule, all within Pipedream's serverless environment.

Trigger Code#

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

export default {
  name: "Custom Interval",
  version: "0.0.2",
  key: "schedule-custom-interval",
  type: "source",
  description: "Trigger your workflow every N hours, minutes or seconds.",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
    },
  },
};

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
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

Action#

Create Invoice on Square

Description:Creates a draft invoice for an order. You must send (publish) the invoice before Square can process it. [See the documentation](https://developer.squareup.com/reference/square/invoices-api/create-invoice).

Version:0.0.4

Key:square-create-invoice

View on GitHub

Square Overview#

The Square API opens up a realm of possibilities for merchants to effortlessly manage their sales, inventory, customers, and payments. With Pipedream, you can automate actions based on events in Square, such as new transactions, updated orders, or customer profile changes. Craft custom workflows that react in real-time, sync data across platforms, or streamline reporting. Through Pipedream's serverless platform, you can connect Square with countless other apps without writing extensive code, turning manual tasks into automated, efficient processes.

Action Code#

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

export default {
  key: "square-create-invoice",
  name: "Create Invoice",
  description: "Creates a draft invoice for an order. You must send (publish) the invoice before Square can process it. [See the documentation](https://developer.squareup.com/reference/square/invoices-api/create-invoice).",
  type: "action",
  version: "0.0.4",
  props: {
    square,
    location: {
      propDefinition: [
        square,
        "location",
      ],
    },
    order: {
      propDefinition: [
        square,
        "order",
        (c) => ({
          location: c.location,
        }),
      ],
    },
    customer: {
      propDefinition: [
        square,
        "customer",
      ],
    },
    dueDate: {
      type: "string",
      label: "Due Date",
      description: "The due date for the payment request, in `YYYY-MM-DD` format",
    },
    acceptedPaymentMethods: {
      type: "string[]",
      label: "Accepted Payment Methods",
      description: "The payment methods that customers can use to pay the invoice on the Square-hosted invoice page. This setting is independent of any automatic payment requests for the invoice.",
      options: [
        "card",
        "square_gift_card",
        "bank_account",
        "buy_now_pay_later",
        "cash_app_pay",
      ],
    },
  },
  async run({ $ }) {
    const paymentRequests = [
      {
        request_type: "BALANCE",
        automatic_payment_source: "NONE",
        due_date: this.dueDate,
      },
    ];

    const acceptedPaymentMethods = {};
    this.acceptedPaymentMethods.forEach((method) => acceptedPaymentMethods[method] = true);

    const response = await this.square.createInvoice({
      $,
      generateIdempotencyKey: true,
      data: {
        invoice: {
          location_id: this.location,
          order_id: this.order,
          payment_requests: paymentRequests,
          delivery_method: "EMAIL",
          accepted_payment_methods: acceptedPaymentMethods,
          primary_recipient: {
            customer_id: this.customer,
          },
        },
      },
    });
    $.export("$summary", `Successfully created invoice with ID ${response.invoice.id}`);
    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
Square	`square`	`app`	This component uses the Square app.
Location	`location`	`string`	Select a value from the drop down menu.
Order	`order`	`string`	Select a value from the drop down menu.
Customer	`customer`	`string`	Select a value from the drop down menu.
Due Date	`dueDate`	`string`	The due date for the payment request, in `YYYY-MM-DD` format
Accepted Payment Methods	`acceptedPaymentMethods`	`string[]`	Select a value from the drop down menu:`cardsquare_gift_cardbank_accountbuy_now_pay_latercash_app_pay`

Action Authentication#

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

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

CUSTOMERS_READCUSTOMERS_WRITEPAYMENTS_READPAYMENTS_WRITEORDERS_READORDERS_WRITESUBSCRIPTIONS_READSUBSCRIPTIONS_WRITEITEMS_READITEMS_WRITEINVOICES_READINVOICES_WRITELOYALTY_READLOYALTY_WRITEEMPLOYEES_READEMPLOYEES_WRITEMERCHANT_PROFILE_READBANK_ACCOUNTS_READSETTLEMENTS_READDEVELOPER_APPLICATION_WEBHOOKS_WRITEAPPOINTMENTS_ALL_READAPPOINTMENTS_READ

About Square#

Solutions & Tools to Grow Your Business

More Ways to Connect Square + Schedule#

Other Popular Integrations#

Create Customer with Square API on Daily schedule from Schedule API

Schedule + Square

Try it

Create Customer with Square API on Weekly schedule from Schedule API

Schedule + Square

Try it

Create Customer with Square API on Custom Interval from Schedule API

Schedule + Square

Try it

Create Customer with Square API on Monthly Schedule from Schedule API

Schedule + Square

Try it

Create Invoice with Square API on Daily schedule from Schedule API

Schedule + Square

Try it

Popular Triggers#

Custom Interval from the Schedule API

Trigger your workflow every N hours, minutes or seconds.

Try it

Daily schedule from the Schedule API

Trigger your workflow every day.

Try it

Monthly Schedule from the Schedule API

Trigger your workflow on one or more days each month at a specific time (with timezone support).

Try it

Weekly schedule from the Schedule API

Trigger your workflow on one or more days each week at a specific time (with timezone support).

Try it

Catalog Item Updated from the Square API

Emit new event every time a catalog item is updated. See the docs

Try it

Popular Actions#

Create Customer with the Square API

Creates a new customer for a business. Must provide at least one of the following: Given Name, Family Name, Company Name, Email Address, or Phone Number. See the docs.

Try it

Create Invoice with the Square API

Creates a draft invoice for an order. You must send (publish) the invoice before Square can process it. See the documentation.

Try it

Create Order with the Square API

Creates a new order that can include information about products for purchase. See docs here.

Try it

Send Invoice with the Square API

Publishes the latest version of a specified invoice. See the docs.

Try it