Create or update contact 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

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

Configure the Create or update contact action
1. Connect your Xero Accounting account
2. Select a Tenant ID
3. Select a Type of action
4. Optional- Configure Contact name
5. Optional- Configure First name
6. Optional- Configure Last name
7. Optional- Configure Email address
8. Optional- Configure Account number
9. Select a Contact status
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#

Create or update contact with Xero Accounting API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Xero Accounting

Try it

Create or update contact with Xero Accounting API on New Message from Discord API

Discord + Xero Accounting

Try it

Create or update contact with Xero Accounting API on New Message In Channels from Slack API

Slack + Xero Accounting

Try it

Create or update contact with Xero Accounting API on New Message in Channel from Discord Bot API

Discord Bot + Xero Accounting

Try it

Create or update contact 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.

Create or update contact on Xero Accounting

Description:Creates a new contact or updates a contact if a contact already exists. [See the docs here](https://developer.xero.com/documentation/api/accounting/contacts)

Version:0.0.2

Key:xero_accounting_api-create-update-contact

View on GitHub

Code#

import { removeNullEntries } from "../../common/util.mjs";
import xeroAccountingApi from "../../xero_accounting_api.app.mjs";

export default {
  key: "xero_accounting_api-create-update-contact",
  name: "Create or update contact ",
  description: "Creates a new contact or updates a contact if a contact already exists. [See the docs here](https://developer.xero.com/documentation/api/accounting/contacts)",
  version: "0.0.2",
  type: "action",
  props: {
    xeroAccountingApi,
    tenantId: {
      propDefinition: [
        xeroAccountingApi,
        "tenantId",
      ],
    },
    actionType: {
      label: "Type of action",
      description: "This triggers an update if UPDATE is selected",
      type: "string",
      options: [
        "NEW",
        "UPDATE",
      ],
      reloadProps: true,
    },
    name: {
      type: "string",
      label: "Contact name",
      description: "Full name of contact/organization.",
      optional: true,
    },
    firstName: {
      type: "string",
      label: "First name",
      description: "First name of contact person .",
      optional: true,
    },
    lastName: {
      type: "string",
      label: "Last name",
      description: "Last name of contact person.",
      optional: true,
    },
    emailAddress: {
      type: "string",
      label: "Email address",
      description: "Email address of contact person.",
      optional: true,
    },
    accountNumber: {
      type: "string",
      label: "Account number",
      description: "User defined account number..",
      optional: true,
    },
    contactStatus: {
      type: "string",
      label: "Contact status",
      description:
        "See https://developer.xero.com/documentation/api/accounting/types#contacts",
      options: [
        "ACTIVE",
        "ARCHIVED",
        "GDPRREQUEST",
      ],
      default: "ACTIVE",
    },
  },
  async additionalProps() {
    const props = {};
    if (this.actionType === "UPDATE") {
      props.contactID = {
        type: "string",
        label: "Contact ID",
        description: "ID of the contact that requires update.",
      };
    }
    return props;
  },
  async run({ $ }) {
    const {
      contactID,
      tenantId,
      name,
      firstName,
      lastName,
      emailAddress,
      accountNumber,
      contactStatus,
    } = this;
    const data = removeNullEntries({
      Name: name,
      FirstName: firstName,
      LastName: lastName,
      EmailAddress: emailAddress,
      AccountNumber: accountNumber,
      ContactStatus: contactStatus,
    });
    contactID && (data.ContactID = contactID);
    const response = await this.xeroAccountingApi.createContact($, tenantId, data);
    response && $.export("$summary", "Contact created successfully");
    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
Xero Accounting	`xeroAccountingApi`	`app`	This component uses the Xero Accounting app.
Tenant ID	`tenantId`	`string`	Select a value from the drop down menu.
Type of action	`actionType`	`string`	Select a value from the drop down menu:`NEWUPDATE`
Contact name	`name`	`string`	Full name of contact/organization.
First name	`firstName`	`string`	First name of contact person .
Last name	`lastName`	`string`	Last name of contact person.
Email address	`emailAddress`	`string`	Email address of contact person.
Account number	`accountNumber`	`string`	User defined account number..
Contact status	`contactStatus`	`string`	Select a value from the drop down menu:`ACTIVEARCHIVEDGDPRREQUEST`

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