Create Proposal with Offorte API on New or updated contact from Xero Accounting API

Pipedream makes it easy to connect APIs for Offorte, Xero Accounting and 2,700+ other apps remarkably fast.

Trigger workflow on

New or updated contact from the Xero Accounting API

Next, do this

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

Select this integration
Configure the New or updated contact trigger
1. Connect your Xero Accounting account
2. Select a Tenant ID
3. Configure Polling interval
Configure the Create Proposal action
1. Connect your Offorte account
2. Optional- Select a Account User ID
3. Optional- Select one or more Contact People IDs
4. Select a Contact ID
5. Select a Proposal Template ID
6. Select a Design Template ID
7. Optional- Configure Name
8. Optional- Configure Price Total
9. Select a Status
10. Select a Text Template ID
11. Optional- Configure Content
12. Optional- Select one or more Tags
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 or updated contact on Xero Accounting

Description:Emit new notifications when you create a new or update existing contact

Version:0.0.3

Key:xero_accounting_api-new-updated-contact

View on GitHub

Xero Accounting Overview#

The Xero Accounting API offers a powerful gateway to access and manipulate financial data within Xero. Leveraging Pipedream's capabilities, developers can build custom workflows that streamline accounting processes, sync financial data with external systems, and trigger actions based on financial events. This API allows for the automation of tasks such as invoicing, bank reconciliation, bill payments, and reporting, which can lead to significant time savings and enhanced data accuracy.

Trigger Code#

import { formatJsonDate } from "../../common/util.mjs";
import xeroAccountingApi from "../../xero_accounting_api.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

export default {
  key: "xero_accounting_api-new-updated-contact",
  name: "New or updated contact",
  description: "Emit new notifications when you create a new or update existing contact",
  version: "0.0.3",
  type: "source",
  props: {
    xeroAccountingApi,
    tenantId: {
      propDefinition: [
        xeroAccountingApi,
        "tenantId",
      ],
    },
    timer: {
      label: "Polling interval",
      description: "Pipedream will poll Xero accounting API on this schedule",
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    db: "$.service.db",
  },
  dedupe: "unique",
  async run() {
    let lastDateChecked = this.xeroAccountingApi.getLastDateChecked(this.db);

    if (!lastDateChecked) {
      lastDateChecked = new Date().toISOString();
      this.xeroAccountingApi.setLastDateChecked(this.db, lastDateChecked);
    }
    const contacts = (
      await this.xeroAccountingApi.getContact(
        null,
        this.tenantId,
        null,
        lastDateChecked,
      )
    )?.Contacts;
    contacts && contacts.reverse().forEach((contact) => {
      const formattedDate = formatJsonDate(contact.UpdatedDateUTC);
      this.xeroAccountingApi.setLastDateChecked(this.db, formattedDate);
      this.$emit(contact,
        {
          id: `${contact.ContactID}D${formattedDate || ""}`,
          summary: contact.Name,
        });
    });
  },
};

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
Xero Accounting	`xeroAccountingApi`	`app`	This component uses the Xero Accounting app.
Tenant ID	`tenantId`	`string`	Select a value from the drop down menu.
Polling interval	`timer`	`$.interface.timer`	Pipedream will poll Xero accounting API on this schedule
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

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

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

offline_accessopenidprofileemailaccounting.transactionsaccounting.transactions.readaccounting.reports.readaccounting.settingsaccounting.settings.readaccounting.contactsaccounting.attachmentsaccounting.journals.read

About Xero Accounting#

Accounting Software

Action#

Create Proposal on Offorte

Description:Create a new proposal in Offorte. [See the documentation](https://www.offorte.com/api-docs/api#tag/Proposals/operation/createProposal)

Version:0.0.1

Key:offorte-create-proposal

View on GitHub

Action Code#

import { STATUS_OPTIONS } from "../../common/constants.mjs";
import {
  clearObject, parseObject,
} from "../../common/utils.mjs";
import offorte from "../../offorte.app.mjs";

export default {
  key: "offorte-create-proposal",
  name: "Create Proposal",
  description: "Create a new proposal in Offorte. [See the documentation](https://www.offorte.com/api-docs/api#tag/Proposals/operation/createProposal)",
  version: "0.0.1",
  type: "action",
  props: {
    offorte,
    accountUserId: {
      propDefinition: [
        offorte,
        "userId",
      ],
      label: "Account User ID",
      optional: true,
    },
    contactPeople: {
      propDefinition: [
        offorte,
        "contactId",
      ],
      optional: true,
      type: "string[]",
      label: "Contact People IDs",
      description: "List with people who are going to receive the proposal. These are the contacts belonging to an organisation who are going to receive the proposal. Make sure they got an email filled in.",
    },
    contactId: {
      propDefinition: [
        offorte,
        "contactId",
        () => ({
          fieldId: "contact_id",
        }),
      ],
      description: "The proposal is assigned to this main contact id",
    },
    proposalTemplateId: {
      propDefinition: [
        offorte,
        "proposalTemplateId",
      ],
    },
    designTemplateId: {
      propDefinition: [
        offorte,
        "designTemplateId",
      ],
    },
    name: {
      type: "string",
      label: "Name",
      description: "The name of the proposal",
      optional: true,
    },
    priceTotal: {
      type: "string",
      label: "Price Total",
      description: "Proposal value as calculated by pricetables",
      optional: true,
    },
    status: {
      type: "string",
      label: "Status",
      description: "The status of the proposal",
      options: STATUS_OPTIONS,
    },
    textTemplateId: {
      propDefinition: [
        offorte,
        "textTemplateId",
      ],
    },
    content: {
      type: "string[]",
      label: "Content",
      description: "A list of content items of the proposal. [See the documentation](https://www.offorte.com/api-docs/api#tag/Proposals/operation/createProposal)",
      optional: true,
    },
    tags: {
      propDefinition: [
        offorte,
        "tags",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.offorte.createProposal({
      $,
      data: clearObject({
        account_user_id: this.accountUserId,
        contact_people: parseObject(this.contactPeople),
        contact_id: this.contactId,
        proposal_template_id: this.proposalTemplateId,
        design_template_id: this.designTemplateId,
        name: this.name,
        price_total: this.priceTotal && parseFloat(this.priceTotal),
        status: this.status,
        text_template_id: this.textTemplateId,
        content: parseObject(this.content),
        tags: parseObject(this.tags),
      }),
    });

    $.export("$summary", `Created proposal with ID: ${response.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
Offorte	`offorte`	`app`	This component uses the Offorte app.
Account User ID	`accountUserId`	`string`	Select a value from the drop down menu.
Contact People IDs	`contactPeople`	`string[]`	Select a value from the drop down menu.
Contact ID	`contactId`	`string`	Select a value from the drop down menu.
Proposal Template ID	`proposalTemplateId`	`string`	Select a value from the drop down menu.
Design Template ID	`designTemplateId`	`string`	Select a value from the drop down menu.
Name	`name`	`string`	The name of the proposal
Price Total	`priceTotal`	`string`	Proposal value as calculated by pricetables
Status	`status`	`string`	Select a value from the drop down menu:`{ "label": "Edit", "value": "edit" }{ "label": "Open", "value": "open" }{ "label": "Won", "value": "won" }{ "label": "Lost", "value": "lost" }{ "label": "Closed", "value": "closed" }`
Text Template ID	`textTemplateId`	`string`	Select a value from the drop down menu.
Content	`content`	`string[]`	A list of content items of the proposal. See the documentation
Tags	`tags`	`string[]`	Select a value from the drop down menu.

Action Authentication#

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