Create Contact Organisation 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 Contact Organisation 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 Contact Organisation action
1. Connect your Offorte account
2. Configure Name
3. Configure Street
4. Configure Zipcode
5. Configure City
6. Configure State
7. Configure Country
8. Configure Phone
9. Optional- Configure Fax
10. Optional- Configure Email
11. Optional- Configure Internet
12. Optional- Configure LinkedIn
13. Optional- Configure Facebook
14. Optional- Configure Twitter
15. Optional- Configure Instagram
16. Optional- Configure COC Number
17. Optional- Configure VAT Number
18. 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 Contact Organisation on Offorte

Description:Create a new contact organisation in Offorte. [See the documentation](https://www.offorte.com/api-docs/api#tag/Contacts/operation/createContactOrganisation)

Version:0.0.1

Key:offorte-create-contact-organisation

View on GitHub

Action Code#

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

export default {
  key: "offorte-create-contact-organisation",
  name: "Create Contact Organisation",
  description: "Create a new contact organisation in Offorte. [See the documentation](https://www.offorte.com/api-docs/api#tag/Contacts/operation/createContactOrganisation)",
  version: "0.0.1",
  type: "action",
  props: {
    offorte,
    name: {
      propDefinition: [
        offorte,
        "name",
      ],
    },
    street: {
      propDefinition: [
        offorte,
        "street",
      ],
    },
    zipcode: {
      propDefinition: [
        offorte,
        "zipcode",
      ],
    },
    city: {
      propDefinition: [
        offorte,
        "city",
      ],
    },
    state: {
      propDefinition: [
        offorte,
        "state",
      ],
    },
    country: {
      propDefinition: [
        offorte,
        "country",
      ],
    },
    phone: {
      propDefinition: [
        offorte,
        "phone",
      ],
    },
    fax: {
      type: "string",
      label: "Fax",
      description: "The fax number of the contact",
      optional: true,
    },
    email: {
      propDefinition: [
        offorte,
        "email",
      ],
      optional: true,
    },
    internet: {
      propDefinition: [
        offorte,
        "internet",
      ],
      optional: true,
    },
    linkedin: {
      propDefinition: [
        offorte,
        "linkedin",
      ],
      optional: true,
    },
    facebook: {
      propDefinition: [
        offorte,
        "facebook",
      ],
      optional: true,
    },
    twitter: {
      propDefinition: [
        offorte,
        "twitter",
      ],
      optional: true,
    },
    instagram: {
      propDefinition: [
        offorte,
        "instagram",
      ],
      optional: true,
    },
    coc_number: {
      type: "string",
      label: "COC Number",
      description: "The COC number of the contact",
      optional: true,
    },
    vat_number: {
      type: "string",
      label: "VAT Number",
      description: "The VAT number of the contact",
      optional: true,
    },
    tags: {
      propDefinition: [
        offorte,
        "tags",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.offorte.createContactOrganisation({
      $,
      data: {
        name: this.name,
        type: "organisation",
        street: this.street,
        zipcode: this.zipcode,
        city: this.city,
        state: this.state,
        country: this.country,
        phone: this.phone,
        fax: this.fax,
        email: this.email,
        internet: this.internet,
        linkedin: this.linkedin,
        facebook: this.facebook,
        twitter: this.twitter,
        instagram: this.instagram,
        coc_number: this.coc_number,
        vat_number: this.vat_number,
        tags: parseObject(this.tags),
      },
    });

    $.export("$summary", "Contact organisation created successfully");
    return response.data;
  },
};

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.
Name	`name`	`string`	The name of the contact
Street	`street`	`string`	The street of the contact
Zipcode	`zipcode`	`string`	The zipcode of the contact
City	`city`	`string`	The city of the contact
State	`state`	`string`	The state of the contact
Country	`country`	`string`	The country of the contact
Phone	`phone`	`string`	The phone of the contact
Fax	`fax`	`string`	The fax number of the contact
Email	`email`	`string`	The email address of the contact
Internet	`internet`	`string`	The internet address of the contact
LinkedIn	`linkedin`	`string`	The LinkedIn address of the contact
Facebook	`facebook`	`string`	The Facebook address of the contact
Twitter	`twitter`	`string`	The Twitter address of the contact
Instagram	`instagram`	`string`	The Instagram address of the contact
COC Number	`coc_number`	`string`	The COC number of the contact
VAT Number	`vat_number`	`string`	The VAT number of the contact
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.