Pay or Remove Payment for Invoice with Fakturoid API

Pipedream makes it easy to connect APIs for Fakturoid and 2,200+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

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

Configure the Pay or Remove Payment for Invoice action
1. Connect your Fakturoid account
2. Select a Account
3. Select a Invoice ID
4. Select a Action Type
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

Integrations#

Pay or Remove Payment for Invoice with Fakturoid API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Fakturoid

Try it

Pay or Remove Payment for Invoice with Fakturoid API on New Submission from Typeform API

Typeform + Fakturoid

Try it

Pay or Remove Payment for Invoice with Fakturoid API on New Submission (Instant) from Jotform API

Jotform + Fakturoid

Try it

Pay or Remove Payment for Invoice with Fakturoid API on New Scheduled Tasks from Pipedream API

Pipedream + Fakturoid

Try it

Pay or Remove Payment for Invoice with Fakturoid API on New Download Counts from npm API

npm + Fakturoid

Try it

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.

Pay or Remove Payment for Invoice on Fakturoid

Description:Executes payment for an invoice or removes an already applied payment. [See the documentation](https://www.fakturoid.cz/api/v3/invoice-payments)

Version:0.0.1

Key:fakturoid-pay-remove-payment-invoice

View on GitHub

Code#

import constants from "../../common/constants.mjs";
import fakturoid from "../../fakturoid.app.mjs";

export default {
  key: "fakturoid-pay-remove-payment-invoice",
  name: "Pay or Remove Payment for Invoice",
  description: "Executes payment for an invoice or removes an already applied payment. [See the documentation](https://www.fakturoid.cz/api/v3/invoice-payments)",
  version: "0.0.1",
  type: "action",
  props: {
    fakturoid,
    accountSlug: {
      propDefinition: [
        fakturoid,
        "accountSlug",
      ],
    },
    invoiceId: {
      propDefinition: [
        fakturoid,
        "invoiceId",
        ({ accountSlug }) => ({
          accountSlug,
        }),
      ],
    },
    actionType: {
      type: "string",
      label: "Action Type",
      description: "Specify if you want to execute or remove a payment",
      options: constants.ACTION_TYPE_OPTIONS,
      reloadProps: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (this.actionType === "execute") {
      props.paidOn = {
        type: "string",
        label: "Paid On",
        description: "Payment date. **Format: YYYY-MM-DD** Default: Today",
        optional: true,
      };
      props.currency = {
        type: "string",
        label: "Currency",
        description: "Currency [ISO Code](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) (same as invoice currency)",
        optional: true,
      };
      props.amount = {
        type: "string",
        label: "Amount",
        description: "Paid amount in document currency. Default: Remaining amount to pay",
        optional: true,
      };
      props.markDocumentAsPaid = {
        type: "boolean",
        label: "Mark Document As Paid",
        description: "Mark document as paid? Default: true if the total paid amount becomes greater or equal to remaining amount to pay",
        optional: true,
      };
    } else if (this.actionType === "remove") {
      props.paymentId =  {
        type: "string",
        label: "Payment ID",
        description: "ID of the payment to be removed.",
        options: async () => {
          const { payments } = await this.fakturoid.getInvoice({
            accountSlug: this.accountSlug,
            invoiceId: this.invoiceId,
          });

          return payments.map(({
            id: value, paid_on: pOn, currency, amount,
          }) => ({
            label: `${currency} ${amount} (${pOn})`,
            value,
          }));
        },
      };
    }
    return props;
  },
  async run({ $ }) {
    if (this.actionType === "execute") {
      const response = await this.fakturoid.payInvoice({
        accountSlug: this.accountSlug,
        invoiceId: this.invoiceId,
        data: {
          paid_on: this.paidOn,
          currency: this.currency,
          amount: this.amount && parseFloat(this.amount),
          mark_document_as_paid: this.markDocumentAsPaid,
        },
      });
      $.export("$summary", `Successfully executed payment for invoice ID ${this.invoiceId}`);
      return response;
    } else if (this.actionType === "remove") {
      const response = await this.fakturoid.removePayment({
        $,
        accountSlug: this.accountSlug,
        invoiceId: this.invoiceId,
        paymentId: this.paymentId,
      });
      $.export("$summary", `Successfully removed payment ID ${this.paymentId} from invoice ID ${this.invoiceId}`);
      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
Fakturoid	`fakturoid`	`app`	This component uses the Fakturoid app.
Account	`accountSlug`	`string`	Select a value from the drop down menu.
Invoice ID	`invoiceId`	`string`	Select a value from the drop down menu.
Action Type	`actionType`	`string`	Select a value from the drop down menu:`{ "label": "Execute Payment", "value": "execute" }{ "label": "Remove Payment", "value": "remove" }`

Authentication#

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

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