Run Python Code with Python API on New Invoice Created from Square API

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

Trigger workflow on

New Invoice Created from the Square API

Next, do this

Run Python Code with the Python API

No credit card required

▶

Watch us build a workflow

4 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Square trigger and Python action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Invoice Created trigger
1. Connect your Square account
2. Configure timer
3. Select a Location
Configure the Run Python Code action
1. Connect your Python account
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 Invoice Created on Square

Description:Emit new event for every new invoice created. [See the docs](https://developer.squareup.com/reference/square/invoices-api/search-invoices)

Version:0.0.3

Key:square-new-invoice-created

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.

Trigger Code#

import base from "../common/base-polling.mjs";
import constants from "../common/constants.mjs";

export default {
  ...base,
  key: "square-new-invoice-created",
  name: "New Invoice Created",
  description: "Emit new event for every new invoice created. [See the docs](https://developer.squareup.com/reference/square/invoices-api/search-invoices)",
  type: "source",
  version: "0.0.3",
  dedupe: "unique",
  props: {
    ...base.props,
    location: {
      propDefinition: [
        base.props.square,
        "location",
      ],
    },
  },
  hooks: {
    ...base.hooks,
    async deploy() {
      console.log(`Retrieving at most last ${constants.MAX_HISTORICAL_EVENTS} objects...`);
      const { invoices } = await this.square.searchInvoices({
        data: {
          ...this.getBaseParams(),
        },
      });
      if (!(invoices?.length > 0)) {
        return;
      }
      this._setLastTs(Date.parse(invoices[0].created_at));
      invoices?.slice(0, constants.MAX_HISTORICAL_EVENTS)
        .reverse()
        .forEach((invoice) => this.$emit(invoice, this.generateMeta(invoice)));
    },
  },
  methods: {
    ...base.methods,
    getBaseParams() {
      return {
        limit: constants.MAX_LIMIT,
        query: {
          sort: {
            field: "INVOICE_SORT_DATE",
            order: "DESC",
          },
          filter: {
            location_ids: [
              this.location,
            ],
          },
        },
      };
    },
    generateMeta(invoice) {
      return {
        id: invoice.id,
        summary: `Invoice created: ${invoice.id}`,
        ts: Date.parse(invoice.created_at),
      };
    },
  },
  async run() {
    const lastTs = this._getLastTs();
    let newLastTs;
    let cursor;
    let done = false;

    do {
      const response = await this.square.searchInvoices({
        data: {
          ...this.getBaseParams(),
          cursor,
        },
      });
      const { invoices } = response;
      if (!(invoices?.length > 0)) {
        break;
      }
      if (!newLastTs) {
        newLastTs = Date.parse(invoices[0].created_at);
      }
      for (const invoice of invoices) {
        if (Date.parse(invoice.created_at) <= lastTs) {
          done = true;
          break;
        }
        this.emitEvent(invoice);
      }
      cursor = response?.cursor;
    } while (cursor && !done);

    this._setLastTs(newLastTs);
  },
};

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
Square	`square`	`app`	This component uses the Square app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Location	`location`	`string`	Select a value from the drop down menu.

Trigger 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

Action#

Run Python Code on Python

Description:Write Python and use any of the 350k+ PyPi packages available. Refer to the [Pipedream Python docs](https://pipedream.com/docs/code/python) to learn more.

Version:0.0.2

Key:python-run-python-code

View on GitHub

Python Overview#

Develop, run and deploy your Python code in Pipedream workflows. Integrate seamlessly between no-code steps, with connected accounts, or integrate Data Stores and manipulate files within a workflow.

This includes installing PyPI packages, within your code without having to manage a requirements.txt file or running pip.

Below is an example of using Python to access data from the trigger of the workflow, and sharing it with subsequent workflow steps:

Action Code#

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

export default {
  name: "Run Python Code",
  version: "0.0.2",
  key: "python-run-python-code",
  description: "Write Python and use any of the 350k+ PyPi packages available. Refer to the [Pipedream Python docs](https://pipedream.com/docs/code/python) to learn more.",
  props: {
    python,
  },
  type: "action",
  methods: {},
  async run({
    steps, $,
  }) {
    // Placeholder action for Python code app
  },
};

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
Python	`python`	`app`	This component uses the Python app.

Action Authentication#

The Python API does not require authentication.

About Python#

Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.

More Ways to Connect Python + Square#

Other Popular Integrations#

Run Python Code with Python API on Catalog Item Updated from Square API

Square + Python

Run Python Code with Python API on New Invoice Created from Square API

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

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

Developers ♥ Pipedream

1-24of2,000+apps by most popular

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