Create Invoice with Square API on New Finished Task Run (Instant) from Apify API

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

Trigger workflow on

New Finished Task Run (Instant) from the Apify 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 Apify 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 New Finished Task Run (Instant) trigger
1. Connect your Apify account
2. Select a Task ID
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#

New Finished Task Run (Instant) on Apify

Description:Emit new event when a selected task is run and finishes.

Version:0.0.3

Key:apify-new-finished-task-run-instant

View on GitHub

Apify Overview#

The Apify API unleashes the power to automate web scraping, process data, and orchestrate web automation workflows. By utilizing Apify on Pipedream, you can create dynamic serverless workflows to manage tasks like extracting data from websites, running browser automation, and scheduling these jobs to run autonomously. It integrates smoothly with Pipedream's capabilities to trigger actions on various other apps, store the results, and manage complex data flow with minimal setup.

Trigger Code#

import common from "../common/base.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "apify-new-finished-task-run-instant",
  name: "New Finished Task Run (Instant)",
  description: "Emit new event when a selected task is run and finishes.",
  version: "0.0.3",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    db: "$.service.db",
    taskId: {
      propDefinition: [
        common.props.apify,
        "taskId",
      ],
    },
  },
  methods: {
    ...common.methods,
    getCondition() {
      return {
        actorTaskId: this.taskId,
      };
    },
    getSummary(body) {
      return `A new task run ${body.eventData.actorRunId} has finished`;
    },
  },
  sampleEmit,
};

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
Apify	`apify`	`app`	This component uses the Apify app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Task ID	`taskId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

About Apify#

Apify is the place to find, develop, buy and run cloud programs called actors. Use actors to turn any website into an API.

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

Create Invoice with Square API on New Finished Task Run (Instant) from Apify API

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

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,700+apps by most popular

1
-
24
of
2,700+
apps by most popular