Create Invoice with Agiled API on New Column from MySQL API

Pipedream makes it easy to connect APIs for Agiled, MySQL and 2,900+ other apps remarkably fast.

Trigger workflow on

New Column from the MySQL API

Next, do this

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

Select this integration
Configure the New Column trigger
1. Connect your MySQL account
2. Configure timer
3. Select a Table
Configure the Create Invoice action
1. Connect your Agiled account
2. Configure Invoice Number
3. Select a Client ID
4. Configure Issue Date
5. Configure Due Date
6. Select a Currency ID
7. Configure Recurring Payment
8. Select a Discount Type
9. Configure Discount
10. Configure Sub Total
11. Configure Total
12. Select a Billing Frequency
13. Configure Billing Interval
14. Configure Billing Cycle
15. Optional- Configure Note
16. Configure Number Of Items
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 Column on MySQL

Description:Emit new event when you add a new column to a table. [See the docs here](https://dev.mysql.com/doc/refman/8.0/en/show-columns.html)

Version:2.0.6

Key:mysql-new-column

View on GitHub

MySQL Overview#

The MySQL application on Pipedream enables direct interaction with your MySQL databases, allowing you to perform CRUD operations—create, read, update, delete—on your data with ease. You can leverage these capabilities to automate data synchronization, report generation, and event-based triggers that kick off workflows in other apps. With Pipedream's serverless platform, you can connect MySQL to hundreds of other services without managing infrastructure, crafting complex code, or handling authentication.

Trigger Code#

import common from "../common/table.mjs";

export default {
  ...common,
  key: "mysql-new-column",
  name: "New Column",
  description:
    "Emit new event when you add a new column to a table. [See the docs here](https://dev.mysql.com/doc/refman/8.0/en/show-columns.html)",
  type: "source",
  version: "2.0.6",
  dedupe: "unique",
  props: {
    ...common.props,
    db: "$.service.db",
  },
  methods: {
    ...common.methods,
    _getPreviousColumns() {
      return this.db.get("previousColumns");
    },
    _setPreviousColumns(previousColumns) {
      this.db.set("previousColumns", previousColumns);
    },
    async listResults() {
      const { table } = this;
      let previousColumns = this._getPreviousColumns() || [];
      const columns = await this.mysql.listNewColumns({
        table,
        previousColumns,
      });
      this.iterateAndEmitEvents(columns);

      const newColumnNames = columns
        .map((column) => column.Field)
        .filter((c) => !previousColumns.includes(c));

      previousColumns = previousColumns.concat(newColumnNames);
      this._setPreviousColumns(previousColumns);
    },
    generateMeta(column) {
      const columnName = column.Field;
      return {
        id: `${columnName}${this.table}`,
        summary: columnName,
        ts: Date.now(),
      };
    },
  },
};

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

Trigger Authentication#

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

Connecting to Restricted Databases

Either enable the shared static IP for this account below, or configure a VPC to deploy any workflow in your workspace to a private network with a dedicated static IP. Learn more in our docs

SSL Setup

Configure SSL on your MySQL database by providing the CA (Certificate Authority), and choosing between Full Verification, Verify Certificate Authority (CA), or Skip Verification. Skipping verification is not recommended as this has serious security implications

About MySQL#

MySQL is an open-source relational database management system.

Action#

Create Invoice on Agiled

Description:Creates a new invoice in Agiled. [See the documentation](https://my.agiled.app/developers)

Version:0.0.2

Key:agiled-create-invoice

View on GitHub

Agiled Overview#

Agiled is a business management platform designed to streamline operations like CRM, project management, finances, and more. Through its API, you can automate various aspects of business management by creating, updating, and retrieving data on leads, customers, projects, tasks, invoices, and payments. Leveraging the Agiled API on Pipedream allows you to connect and automate these operations with hundreds of other apps and services to create custom workflows, facilitating data synchronization, event-driven actions, and time-saving automations.

Action Code#

import app from "../../agiled.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "agiled-create-invoice",
  name: "Create Invoice",
  description: "Creates a new invoice in Agiled. [See the documentation](https://my.agiled.app/developers)",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    app,
    invoiceNumber: {
      type: "integer",
      label: "Invoice Number",
      description: "Invoice Number in integer form. Don't include prefix. It must be `10` for example and never `INV#10`",
    },
    clientId: {
      label: "Client ID",
      description: "The ID of a client.",
      propDefinition: [
        app,
        "userId",
      ],
    },
    issueDate: {
      type: "string",
      label: "Issue Date",
      description: "Issue Date (Use same date format as in your company settings). Eg. `2021-01-01`",
    },
    dueDate: {
      type: "string",
      label: "Due Date",
      description: "Due Date (Use same date format as in your company settings). Eg. `2021-01-01`",
    },
    currencyId: {
      propDefinition: [
        app,
        "currencyId",
      ],
    },
    recurringPayment: {
      type: "boolean",
      label: "Recurring Payment",
      description: "If its a recurring profile or not",
    },
    discountType: {
      type: "string",
      label: "Discount Type",
      description: "Discount Type",
      options: [
        "percent",
        "fixed",
      ],
    },
    discount: {
      type: "integer",
      label: "Discount",
      description: "Discount. Eg. `10`",
      default: 0,
    },
    subTotal: {
      type: "integer",
      label: "Sub Total",
      description: "Sub Total. Eg. `100`",
    },
    total: {
      type: "integer",
      label: "Total",
      description: "Total. Eg. `120`",
    },
    billingFrequency: {
      type: "string",
      label: "Billing Frequency",
      description: "Specifies billing frequency. Either `day`, `week`, `month` or `year`.",
      options: [
        "day",
        "week",
        "month",
        "year",
      ],
    },
    billingInterval: {
      type: "integer",
      label: "Billing Interval",
      description: "The number of intervals between subscription billings.",
    },
    billingCycle: {
      type: "string",
      label: "Billing Cycle",
      description: "How many times you want to bill? Eg. `1`",
    },
    note: {
      type: "string",
      label: "Note",
      description: "Notes in Invoice",
      optional: true,
    },
    numberOfItems: {
      type: "integer",
      label: "Number Of Items",
      description: "The number of items to generate. Defaults to 1.",
      default: 1,
      reloadProps: true,
    },
  },
  methods: {
    boolToString(value) {
      return value
        ? "yes"
        : "no";
    },
    createInvoice(args = {}) {
      return this.app.post({
        path: "/invoices",
        ...args,
      });
    },
    itemsPropsMapper(prefix) {
      const {
        [`${prefix}name`]: name,
        [`${prefix}summary`]: summary,
        [`${prefix}quantity`]: quantity,
        [`${prefix}unitPrice`]: unitPrice,
        [`${prefix}amount`]: amount,
      } = this;

      return {
        item_name: name,
        item_summary: summary,
        item_type: "item",
        quantity,
        unit_price: unitPrice,
        amount,
      };
    },
    getItemsPropDefinitions({
      prefix, label,
    } = {}) {
      return {
        [`${prefix}name`]: {
          type: "string",
          label: `${label} - Name`,
          description: "Name of the item",
        },
        [`${prefix}summary`]: {
          type: "string",
          label: `${label} - Summary`,
          description: "Summary of the item",
        },
        [`${prefix}quantity`]: {
          type: "integer",
          label: `${label} - Quantity`,
          description: "Quantity of the item. Eg. `1`",
        },
        [`${prefix}unitPrice`]: {
          type: "integer",
          label: `${label} - Unit Price`,
          description: "Unit Price of the item. Eg. `10`",
        },
        [`${prefix}amount`]: {
          type: "integer",
          label: `${label} - Amount`,
          description: "Amount of the item. **Unit Price** x **Quantity**",
        },
      };
    },
  },
  async additionalProps() {
    const {
      numberOfItems,
      getItemsPropDefinitions,
    } = this;

    return utils.getAdditionalProps({
      numberOfFields: numberOfItems,
      fieldName: "item",
      getPropDefinitions: getItemsPropDefinitions,
    });
  },
  async run({ $ }) {
    const {
      boolToString,
      numberOfItems,
      itemsPropsMapper,
      createInvoice,
      invoiceNumber,
      clientId,
      issueDate,
      dueDate,
      discountType,
      discount,
      currencyId,
      recurringPayment,
      note,
      total,
      subTotal,
      billingFrequency,
      billingInterval,
      billingCycle,
    } = this;

    const response = await createInvoice({
      $,
      data: {
        invoice_number: invoiceNumber,
        client_id: clientId,
        issue_date: issueDate,
        due_date: dueDate,
        discount_type: discountType,
        discount,
        currency_id: currencyId,
        recurring_payment: boolToString(recurringPayment),
        billing_frequency: billingFrequency,
        billing_interval: billingInterval,
        billing_cycle: billingCycle,
        note,
        total,
        sub_total: subTotal,
        items: utils.getFieldsProps({
          numberOfFields: numberOfItems,
          fieldName: "item",
          propsMapper: itemsPropsMapper,
        }),
      },
    });

    $.export("$summary", `Successfully created invoice with ID \`${response.data.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
Agiled	`app`	`app`	This component uses the Agiled app.
Invoice Number	`invoiceNumber`	`integer`	Invoice Number in integer form. Don't include prefix. It must be `10` for example and never `INV#10`
Client ID	`clientId`	`integer`	Select a value from the drop down menu.
Issue Date	`issueDate`	`string`	Issue Date (Use same date format as in your company settings). Eg. `2021-01-01`
Due Date	`dueDate`	`string`	Due Date (Use same date format as in your company settings). Eg. `2021-01-01`
Currency ID	`currencyId`	`integer`	Select a value from the drop down menu.
Recurring Payment	`recurringPayment`	`boolean`	If its a recurring profile or not
Discount Type	`discountType`	`string`	Select a value from the drop down menu:`percentfixed`
Discount	`discount`	`integer`	Discount. Eg. `10`
Sub Total	`subTotal`	`integer`	Sub Total. Eg. `100`
Total	`total`	`integer`	Total. Eg. `120`
Billing Frequency	`billingFrequency`	`string`	Select a value from the drop down menu:`dayweekmonthyear`
Billing Interval	`billingInterval`	`integer`	The number of intervals between subscription billings.
Billing Cycle	`billingCycle`	`string`	How many times you want to bill? Eg. `1`
Note	`note`	`string`	Notes in Invoice
Number Of Items	`numberOfItems`	`integer`	The number of items to generate. Defaults to 1.

Action Authentication#

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

To retrieve your API key,

Navigate to your Agiled account and sign in
Go to “Profile” > “API Settings”