Create or Update Contact with Xero Accounting API on New Labeled Email from Gmail API

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

Trigger workflow on

New Labeled Email from the Gmail API

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#

This integration creates a workflow with a Gmail trigger and Xero Accounting action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Labeled Email trigger
1. Connect your Gmail account
2. Configure timer
3. Select one or more Labels
4. Configure Return payload as plaintext
Configure the Create or Update Contact action
1. Connect your Xero Accounting account
2. Select a Tenant ID
3. Optional- Configure Name
4. Optional- Configure Contact ID
5. Optional- Configure Contact Number
6. Optional- Configure Account Number
7. Optional- Select a Contact Status
8. Optional- Configure First Name
9. Optional- Configure Last Name
10. Optional- Configure Email Address
11. Optional- Configure Skype User Name
12. Optional- Configure Contact Persons
13. Optional- Configure Bank Account Details
14. Optional- Configure Tax Number
15. Optional- Configure Account Receivable Tax Type
16. Optional- Configure Account Payable Type
17. Optional- Configure Addresses
18. Optional- Configure Phones
19. Optional- Configure Is Supplier
20. Optional- Configure Is Customer
21. Optional- Configure Default Currency
22. Optional- Configure Xero Network Key
23. Optional- Configure Sales Default Account Code
24. Optional- Configure Purchases Default Account Code
25. Optional- Configure Sales Tracking Categories
26. Optional- Configure Purchases Tracking Categories
27. Optional- Configure Tracking Category Name
28. Optional- Configure Tracking Option Name
29. Optional- Configure Payment Terms Bill Day
30. Optional- Select a Payment Terms Bill Type
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 Labeled Email on Gmail

Description:Emit new event when a new email is labeled.

Version:0.1.0

Key:gmail-new-labeled-email

View on GitHub

Gmail Overview#

By connecting your personal Gmail account to Pipedream, you'll be able to incorporate email into whatever you're building with any of the thousands of apps that are available on Pipedream.

Trigger Code#

import gmail from "../../gmail.app.mjs";
import common from "../common/polling-history.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "gmail-new-labeled-email",
  name: "New Labeled Email",
  description: "Emit new event when a new email is labeled.",
  type: "source",
  version: "0.1.0",
  dedupe: "unique",
  props: {
    gmail,
    ...common.props,
    labels: {
      propDefinition: [
        gmail,
        "label",
      ],
      type: "string[]",
      label: "Labels",
    },
    withTextPayload: {
      type: "boolean",
      label: "Return payload as plaintext",
      description: "Convert the payload response into a single text field. **This reduces the size of the payload and makes it easier for LLMs work with.**",
      default: false,
    },
  },
  methods: {
    ...common.methods,
    getHistoryTypes() {
      return [
        "labelAdded",
        "messageAdded",
      ];
    },
    generateMeta(message) {
      return {
        id: `${message.id}-${message.historyId}`,
        summary: `A new message with ID: ${message.id} was labeled"`,
        ts: +message.internalDate,
      };
    },
    filterHistory(history) {
      return history.filter((item) =>
        (item.labelsAdded && item.labelsAdded[0].labelIds.some((i) => this.labels.includes(i)))
        || (item.messagesAdded
          && item.messagesAdded[0].message.labelIds
          && item.messagesAdded[0].message.labelIds.some((i) => this.labels.includes(i))));
    },
  },
  sampleEmit,
};

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
Gmail	`gmail`	`app`	This component uses the Gmail app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Labels	`labels`	`string[]`	Select a value from the drop down menu.
Return payload as plaintext	`withTextPayload`	`boolean`	Convert the payload response into a single text field. This reduces the size of the payload and makes it easier for LLMs work with.

Trigger Authentication#

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

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

emailprofileopenidhttps://www.googleapis.com/auth/gmail.labelshttps://www.googleapis.com/auth/gmail.sendhttps://www.googleapis.com/auth/gmail.modifyhttps://www.googleapis.com/auth/gmail.composehttps://www.googleapis.com/auth/gmail.settings.basic

About Gmail#

Gmail offers private and secure email by Google at no cost, for business and consumer accounts.

Action#

Create or Update Contact on Xero Accounting

Description:Creates a new contact or updates if the contact exists.

Version:0.1.2

Key:xero_accounting_api-xero-accounting-create-or-update-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.

Action Code#

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

export default {
  key: "xero_accounting_api-xero-accounting-create-or-update-contact",
  name: "Create or Update Contact",
  description: "Creates a new contact or updates if the contact exists.",
  version: "0.1.2",
  type: "action",
  props: {
    xeroAccountingApi,
    tenantId: {
      propDefinition: [
        xeroAccountingApi,
        "tenantId",
      ],
    },
    name: {
      label: "Name",
      type: "string",
      description: "Full name of contact/organisation (max length = 255). The following is required to create a contact.",
      optional: true,
    },
    contactId: {
      label: "Contact ID",
      type: "string",
      description: "Xero identifier.",
      optional: true,
    },
    contactNumber: {
      label: "Contact Number",
      type: "string",
      description: "This can be updated via the API only i.e. This field is read only on the Xero contact screen, used to identify contacts in external systems (max length = 50). If the Contact Number is used, this is displayed as Contact Code in the Contacts UI in Xero.",
      optional: true,
    },
    accountNumber: {
      label: "Account Number",
      type: "string",
      description: "A user defined account number. This can be updated via the API and the [Xero UI](https://help.xero.com/ContactsAccountNumber) (max length = 50).",
      optional: true,
    },
    contactStatus: {
      label: "Contact Status",
      type: "string",
      description: "Current status of a contact - see contact status [types](https://developer.xero.com/documentation/api/types#ContactStatuses)",
      optional: true,
      options: [
        "ACTIVE",
        "ARCHIVED",
        "GDPRREQUEST",
      ],
    },
    firstName: {
      label: "First Name",
      type: "string",
      description: "First name of contact person (max length = 255).",
      optional: true,
    },
    lastName: {
      label: "Last Name",
      type: "string",
      description: "Last name of contact person (max length = 255)",
      optional: true,
    },
    emailAddress: {
      label: "Email Address",
      type: "string",
      description: "Email address of contact person (umlauts not supported) (max length = 255)",
      optional: true,
    },
    skypeUserName: {
      label: "Skype User Name",
      type: "string",
      description: "Skype user name of contact.",
      optional: true,
    },
    contactPersons: {
      label: "Contact Persons",
      type: "any",
      description: "See [contact persons](https://developer.xero.com/documentation/api/contacts#contact-persons).",
      optional: true,
    },
    bankAccountDetails: {
      label: "Bank Account Details",
      type: "string",
      description: "Bank account number of contact",
      optional: true,
    },
    taxNumber: {
      label: "Tax Number",
      type: "string",
      description: "Tax number of contact - this is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global) in the Xero UI depending on which regionalized version of Xero you are using (max length = 50)",
      optional: true,
    },
    accountReceivableTaxType: {
      label: "Account Receivable Tax Type",
      type: "string",
      description: "Default tax type used for contact on AP invoices",
      optional: true,
    },
    accountPayableType: {
      label: "Account Payable Type",
      type: "string",
      description: "Store certain address types for a contact - see address types",
      optional: true,
    },
    addresses: {
      label: "Addresses",
      type: "any",
      description: "Store certain address types for a contact - see address types",
      optional: true,
    },
    phones: {
      label: "Phones",
      type: "any",
      description: "Store certain phone types for a contact - see phone types.",
      optional: true,
    },
    isSupplier: {
      label: "Is Supplier",
      type: "boolean",
      description: "true or false  Boolean that describes if a contact that has any AP invoices entered against them. Cannot be set via PUT or POST - it is automatically set when an accounts payable invoice is generated against this contact.",
      optional: true,
    },
    isCustomer: {
      label: "Is Customer",
      type: "boolean",
      description: "true or false  Boolean that describes if a contact has any AR invoices entered against them. Cannot be set via PUT or POST - it is automatically set when an accounts receivable invoice is generated against this contact.",
      optional: true,
    },
    defaultCurrency: {
      label: "Default Currency",
      type: "string",
      description: "Default currency for raising invoices against contact",
      optional: true,
    },
    xeroNetworkKey: {
      label: "Xero Network Key",
      type: "string",
      description: "Store XeroNetworkKey for contacts.",
      optional: true,
    },
    salesDefaultAccountCode: {
      label: "Sales Default Account Code",
      type: "string",
      description: "The default sales [account code](https://developer.xero.com/documentation/api/accounts) for contacts",
      optional: true,
    },
    puchasesDefaultAccountCode: {
      label: "Purchases Default Account Code",
      type: "string",
      description: "The default purchases [account code](https://developer.xero.com/documentation/api/accounts) for contacts",
      optional: true,
    },
    salesTrackingCategories: {
      label: "Sales Tracking Categories",
      type: "string",
      description: "The default sales [tracking categories](https://developer.xero.com/documentation/api/tracking-categories/) for contacts",
      optional: true,
    },
    puechasesTrackingCategories: {
      label: "Purchases Tracking Categories",
      type: "string",
      description: "The default purchases [tracking categories](https://developer.xero.com/documentation/api/tracking-categories/) for contacts",
      optional: true,
    },
    trackingCategoryName: {
      label: "Tracking Category Name",
      type: "string",
      description: "The name of the Tracking Category assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories",
      optional: true,
    },
    trackingOptionName: {
      label: "Tracking Option Name",
      type: "string",
      description: "The name of the Tracking Option assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories",
      optional: true,
    },
    paymentTermsBillDay: {
      label: "Payment Terms Bill Day",
      type: "integer",
      description: "The default payment terms bill day",
      optional: true,
    },
    paymentTermsBillType: {
      type: "string",
      label: "Payment Terms Bill Type",
      description: "The default payment terms bill type",
      optional: true,
      options: [
        {
          "label": "day(s) after bill date",
          "value": "DAYSAFTERBILLDATE",
        },
        {
          "label": "day(s) after bill month",
          "value": "DAYSAFTERBILLMONTH",
        },
        {
          "label": "of the current month",
          "value": "OFCURRENTMONTH",
        },
        {
          "label": "of the following month",
          "value": "OFFOLLOWINGMONTH",
        },
      ],
    },
  },
  async run({ $ }) {
    const response = await this.xeroAccountingApi.createOrUpdateContact({
      $,
      tenantId: this.tenantId,
      data: {
        Name: this.name,
        ContactID: this.contactId,
        ContactNumber: this.contactNumber,
        AccountNumber: this.accountNumber,
        ContactStatus: this.contactStatus,
        FirstName: this.firstName,
        LastName: this.lastName,
        EmailAddress: this.emailAddress,
        SkypeUserName: this.skypeUserName,
        ContactPersons: parseObject(this.contactPersons),
        BankAccountDetails: this.bankAccountDetails,
        TaxNumber: this.taxNumber,
        AccountsReceivableTaxType: this.accountReceivableTaxType,
        AccountsPayableTaxType: this.accountPayableType,
        Addresses: parseObject(this.addresses),
        Phones: parseObject(this.phones),
        IsSupplier: this.isSupplier,
        IsCustomer: this.isCustomer,
        DefaultCurrency: this.defaultCurrency,
        XeroNetworkKey: this.xeroNetworkKey,
        SalesDefaultAccountCode: this.salesDefaultAccountCode,
        PurchasesDefaultAccountCode: this.puchasesDefaultAccountCode,
        SalesTrackingCategories: this.salesTrackingCategories,
        PurchasesTrackingCategories: this.puechasesTrackingCategories,
        TrackingCategoryName: this.trackingCategoryName,
        TrackingOptionName: this.trackingOptionName,
        PaymentTerms: {
          Bills: {
            Day: this.paymentTermsBillDay,
            Type: this.paymentTermsBillType,
          },
        },
      },
    });

    $.export("$summary", `Successfully created or updated contact with ID: ${this.contactId}`);
    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
Xero Accounting	`xeroAccountingApi`	`app`	This component uses the Xero Accounting app.
Tenant ID	`tenantId`	`string`	Select a value from the drop down menu.
Name	`name`	`string`	Full name of contact/organisation (max length = 255). The following is required to create a contact.
Contact ID	`contactId`	`string`	Xero identifier.
Contact Number	`contactNumber`	`string`	This can be updated via the API only i.e. This field is read only on the Xero contact screen, used to identify contacts in external systems (max length = 50). If the Contact Number is used, this is displayed as Contact Code in the Contacts UI in Xero.
Account Number	`accountNumber`	`string`	A user defined account number. This can be updated via the API and the Xero UI (max length = 50).
Contact Status	`contactStatus`	`string`	Select a value from the drop down menu:`ACTIVEARCHIVEDGDPRREQUEST`
First Name	`firstName`	`string`	First name of contact person (max length = 255).
Last Name	`lastName`	`string`	Last name of contact person (max length = 255)
Email Address	`emailAddress`	`string`	Email address of contact person (umlauts not supported) (max length = 255)
Skype User Name	`skypeUserName`	`string`	Skype user name of contact.
Contact Persons	`contactPersons`	`any`	See contact persons
Bank Account Details	`bankAccountDetails`	`string`	Bank account number of contact
Tax Number	`taxNumber`	`string`	Tax number of contact - this is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global) in the Xero UI depending on which regionalized version of Xero you are using (max length = 50)
Account Receivable Tax Type	`accountReceivableTaxType`	`string`	Default tax type used for contact on AP invoices
Account Payable Type	`accountPayableType`	`string`	Store certain address types for a contact - see address types
Addresses	`addresses`	`any`	Store certain address types for a contact - see address types
Phones	`phones`	`any`	Store certain phone types for a contact - see phone types.
Is Supplier	`isSupplier`	`boolean`	true or false Boolean that describes if a contact that has any AP invoices entered against them. Cannot be set via PUT or POST - it is automatically set when an accounts payable invoice is generated against this contact.
Is Customer	`isCustomer`	`boolean`	true or false Boolean that describes if a contact has any AR invoices entered against them. Cannot be set via PUT or POST - it is automatically set when an accounts receivable invoice is generated against this contact.
Default Currency	`defaultCurrency`	`string`	Default currency for raising invoices against contact
Xero Network Key	`xeroNetworkKey`	`string`	Store XeroNetworkKey for contacts.
Sales Default Account Code	`salesDefaultAccountCode`	`string`	The default sales account code for contacts
Purchases Default Account Code	`puchasesDefaultAccountCode`	`string`	The default purchases account code for contacts
Sales Tracking Categories	`salesTrackingCategories`	`string`	The default sales tracking categories for contacts
Purchases Tracking Categories	`puechasesTrackingCategories`	`string`	The default purchases tracking categories for contacts
Tracking Category Name	`trackingCategoryName`	`string`	The name of the Tracking Category assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories
Tracking Option Name	`trackingOptionName`	`string`	The name of the Tracking Option assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories
Payment Terms Bill Day	`paymentTermsBillDay`	`integer`	The default payment terms bill day
Payment Terms Bill Type	`paymentTermsBillType`	`string`	Select a value from the drop down menu:`{ "label": "day(s) after bill date", "value": "DAYSAFTERBILLDATE" }{ "label": "day(s) after bill month", "value": "DAYSAFTERBILLMONTH" }{ "label": "of the current month", "value": "OFCURRENTMONTH" }{ "label": "of the following month", "value": "OFFOLLOWINGMONTH" }`

Action 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

More Ways to Connect Xero Accounting + Gmail#

Other Popular Integrations#

Create Bank Transaction with Xero Accounting API on New Attachment Received from Gmail API

Gmail + Xero Accounting

Create or Update Contact with Xero Accounting API on New Labeled Email from Gmail API

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

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,800+apps by most popular

1
-
24
of
2,800+
apps by most popular