Find contact. Optionally, create one if none are found with Xero Accounting API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Find contact. Optionally, create one if none are found with the Xero Accounting 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 Find contact. Optionally, create one if none are found with the Xero Accounting API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Find contact. Optionally, create one if none are found action
1. Connect your Xero Accounting account
2. Select a Tenant ID
3. Optional- Configure Contact name
4. Optional- Configure Account number
5. Select a Create a new contact if not found
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#

Find contact. Optionally, create one if none are found with Xero Accounting API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Xero Accounting

Try it

Find contact. Optionally, create one if none are found with Xero Accounting API on New Message from Discord API

Discord + Xero Accounting

Try it

Find contact. Optionally, create one if none are found with Xero Accounting API on New Message In Channels from Slack API

Slack + Xero Accounting

Try it

Find contact. Optionally, create one if none are found with Xero Accounting API on New Message in Channel from Discord Bot API

Discord Bot + Xero Accounting

Try it

Find contact. Optionally, create one if none are found with Xero Accounting API on New Submission from Typeform API

Typeform + Xero Accounting

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.

Find contact. Optionally, create one if none are found on Xero Accounting

Description:Finds a contact by name or account number. Optionally, create one if none are found. [See the docs here](https://developer.xero.com/documentation/api/accounting/contacts/#get-contacts)

Version:0.0.2

Key:xero_accounting_api-find-contact

View on GitHub

Code#

import { ConfigurationError } from "@pipedream/platform";
import {
  removeNullEntries, formatQueryString,
} from "../../common/util.mjs";
import xeroAccountingApi from "../../xero_accounting_api.app.mjs";

export default {
  key: "xero_accounting_api-find-contact",
  name: "Find contact.  Optionally, create one if none are found",
  description: "Finds a contact by name or account number. Optionally, create one if none are found. [See the docs here](https://developer.xero.com/documentation/api/accounting/contacts/#get-contacts)",
  version: "0.0.2",
  type: "action",
  props: {
    xeroAccountingApi,
    tenantId: {
      propDefinition: [
        xeroAccountingApi,
        "tenantId",
      ],
    },
    name: {
      type: "string",
      label: "Contact name",
      description: "Full name of contact/organization ",
      optional: true,
    },
    accountNumber: {
      type: "string",
      label: "Account number",
      description: "Account number of Contact.",
      optional: true,
    },
    createContactIfNotFound: {
      description: "Create a new contact if not found?.",
      label: "Create a new contact if not found",
      type: "string",
      options: [
        "Yes",
        "No",
      ],
      reloadProps: true,
    },
  },
  additionalProps() {
    const props = {};
    if (this.createContactIfNotFound === "Yes") {
      props.name = {
        type: "string",
        label: "Contact name",
        description: "Full name of contact/organization.",
      };
      props.firstName = {
        type: "string",
        label: "First name",
        description: "First name of contact person .",
        optional: true,
      };
      props.lastName = {
        type: "string",
        label: "Last name",
        description: "Last name of contact person.",
        optional: true,
      };
      props.emailAddress = {
        type: "string",
        label: "Email address",
        description: "Email address of contact person.",
        optional: true,
      };
      props.contactStatus = {
        type: "string",
        label: "Contact status",
        description:
          "See [contact status reference](https://developer.xero.com/documentation/api/accounting/types#contacts)",
        options: [
          "ACTIVE",
          "ARCHIVED",
          "GDPRREQUEST",
        ],
        optional: true,
        default: "ACTIVE",
      };
    }
    return props;
  },
  async run({ $ }) {
    let contactDetail;
    const {
      tenantId,
      name,
      firstName,
      lastName,
      emailAddress,
      accountNumber,
      contactStatus,
      createContactIfNotFound,
    } = this;
    if (createContactIfNotFound === "No" && accountNumber && name) {
      throw new ConfigurationError(
        "Choose exclusively between Account Number or Name to find a contact.",
      );
    }
    const findPayload = removeNullEntries({
      Name: name,
      AccountNumber: accountNumber,
    });
    const createPayload = removeNullEntries({
      Name: name,
      FirstName: firstName,
      LastName: lastName,
      EmailAddress: emailAddress,
      AccountNumber: accountNumber,
      ContactStatus: contactStatus,
    });
    const queryString = formatQueryString(findPayload, true);
    try {
      contactDetail = await this.xeroAccountingApi.getContact(
        $,
        tenantId,
        queryString,
      );
    } catch (error) {
      if (createContactIfNotFound === "Yes") {
        $.export("$summary", "Contact not found. Creating new contact");
      } else {
        throw new ConfigurationError("Contact not found");
      }
    }

    if (
      (!contactDetail || !contactDetail?.Contacts?.length) &&
      createContactIfNotFound === "Yes"
    ) {
      return await this.xeroAccountingApi.createContact(
        $,
        tenantId,
        createPayload,
      );
    }
    return contactDetail;
  },
};

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.
Contact name	`name`	`string`	Full name of contact/organization
Account number	`accountNumber`	`string`	Account number of Contact.
Create a new contact if not found	`createContactIfNotFound`	`string`	Select a value from the drop down menu:`YesNo`

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.reports.readaccounting.settingsaccounting.settings.readaccounting.contactsaccounting.attachmentsaccounting.journals.read