Create Payment with Invoiced API

Pipedream makes it easy to connect APIs for Invoiced and 3,000+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create Payment with the Invoiced 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 Create Payment with the Invoiced API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Create Payment action
1. Connect your Invoiced account
2. Optional- Select a Customer ID
3. Optional- Configure Date
4. Optional- Configure Payment Method
5. Optional- Configure Currency
6. Configure Amount
7. Optional- Configure Reference
8. Optional- Configure ACH Sender ID
9. Optional- Configure Source
10. Optional- Configure Notes
11. Optional- Configure Applied To
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

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.

Create Payment on Invoiced

Description:Creates a new payment in Invoiced. [See the documentation](https://developer.invoiced.com/api/payments#create-a-payment)

Version:0.0.1

Key:invoiced-create-payment

View on GitHub

Code#

import { parseObject } from "../../common/utils.mjs";
import invoiced from "../../invoiced.app.mjs";

export default {
  key: "invoiced-create-payment",
  name: "Create Payment",
  description: "Creates a new payment in Invoiced. [See the documentation](https://developer.invoiced.com/api/payments#create-a-payment)",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  props: {
    invoiced,
    customerId: {
      propDefinition: [
        invoiced,
        "customerId",
      ],
      optional: true,
    },
    date: {
      type: "string",
      label: "Date",
      description: "Payment datetime, defaults to current timestamp. Format YYYY-MM-DDTHH:MM:SSZ.",
      optional: true,
    },
    method: {
      type: "string",
      label: "Payment Method",
      description: "Payment instrument used, defaults to **other**",
      optional: true,
    },
    currency: {
      type: "string",
      label: "Currency",
      description: "[3-letter ISO code](https://en.wikipedia.org/wiki/ISO_4217)",
      optional: true,
    },
    amount: {
      type: "string",
      label: "Amount",
      description: "Payment amount. Example: 100.00",
    },
    reference: {
      type: "string",
      label: "Reference",
      description: "Reference number, i.e. check #",
      optional: true,
    },
    achSenderId: {
      type: "string",
      label: "ACH Sender ID",
      description: "Originator ID (ACH payments)",
      optional: true,
    },
    source: {
      type: "string",
      label: "Source",
      description: "Source of the payment, defaults to **keyed**",
      optional: true,
    },
    notes: {
      type: "string",
      label: "Notes",
      description: "Internal notes",
      optional: true,
    },
    appliedTo: {
      type: "string[]",
      label: "Applied To",
      description: "JSON array of payment applications. Each application should have: type (invoice, credit_note, etc.), invoice (or credit_note ID), amount. Example: [{\"type\":\"invoice\",\"invoice\":\"44648\",\"amount\":800}] [See the documentation](https://developer.invoiced.com/api/payments#payment-object) for more details.",
      optional: true,
    },

  },
  async run({ $ }) {
    const response = await this.invoiced.createPayment({
      $,
      data: {
        customer: this.customerId,
        date: this.date && Date.parse(this.date),
        method: this.method,
        currency: this.currency,
        amount: this.amount && parseFloat(this.amount),
        reference: this.reference,
        ach_sender_id: this.achSenderId,
        source: this.source,
        notes: this.notes,
        applied_to: parseObject(this.appliedTo),
      },
    });

    $.export("$summary", `Successfully created payment with ID ${response.id} for amount $${response.amount}`);
    return response;
  },
};

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
Invoiced	`invoiced`	`app`	This component uses the Invoiced app.
Customer ID	`customerId`	`string`	Select a value from the drop down menu.
Date	`date`	`string`	Payment datetime, defaults to current timestamp. Format YYYY-MM-DDTHH:MM:SSZ.
Payment Method	`method`	`string`	Payment instrument used, defaults to other
Currency	`currency`	`string`	3-letter ISO code
Amount	`amount`	`string`	Payment amount. Example: 100.00
Reference	`reference`	`string`	Reference number, i.e. check #
ACH Sender ID	`achSenderId`	`string`	Originator ID (ACH payments)
Source	`source`	`string`	Source of the payment, defaults to keyed
Notes	`notes`	`string`	Internal notes
Applied To	`appliedTo`	`string[]`	JSON array of payment applications. Each application should have: type (invoice, credit_note, etc.), invoice (or credit_note ID), amount. Example: [{"type":"invoice","invoice":"44648","amount":800}] See the documentation for more details.