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

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

Trigger workflow on

New Requests (Payload Only) from the HTTP / Webhook 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 HTTP / Webhook 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 Requests (Payload Only) trigger
1. Connect your HTTP / Webhook account
Configure the Create or Update Contact action
1. Connect your Xero Accounting account
2. Configure 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 puchases_default_account_code
25. Optional- Configure sales_tracking_categories
26. Optional- Configure puechases_tracking_categories
27. Optional- Configure tracking_category_name
28. Optional- Configure tracking_option_name
29. Optional- Select a payment_terms
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 Requests (Payload Only) on HTTP / Webhook

Description:Get a URL and emit the HTTP body as an event on every request

Version:0.1.1

Key:http-new-requests-payload-only

View on GitHub

HTTP / Webhook Overview#

Build, test, and send HTTP requests without code using your Pipedream workflows. The HTTP / Webhook action is a tool to build HTTP requests with a Postman-like graphical interface.

Point and click HTTP requests

Define the target URL, HTTP verb, headers, query parameters, and payload body without writing custom code.

$A screenshot of Pipedream's HTTP Request Configuration interface with a GET request type selected. The request URL is set to 'https://api.openai.com/v1/models'. The 'Auth' tab is highlighted, indicating that authentication is required for this request. In the headers section, there are two headers configured: 'User-Agent' is set to 'pipedream/1', and 'Authorization' is set to 'Bearer {{openai_api_key}}', showing how the OpenAI account's API key is dynamically inserted into the headers to handle authentication automatically.$

Here's an example workflow that uses the HTTP / Webhook action to send an authenticated API request to OpenAI.

Focus on integrating, not authenticating

This action can also use your connected accounts with third-party APIs. Selecting an integrated app will automatically update the request’s headers to authenticate with the app properly, and even inject your token dynamically.

Pipedream integrates with thousands of APIs, but if you can’t find a Pipedream integration simply use Environment Variables in your request headers to authenticate with.

Compatible with no code actions or Node.js and Python

The HTTP/Webhook action exports HTTP response data for use in subsequent workflow steps, enabling easy data transformation, further API calls, database storage, and more.

Response data is available for both coded (Node.js, Python) and no-code steps within your workflow.

Trigger Code#

import http from "../../http.app.mjs";

// Core HTTP component
// Returns a 200 OK response, emits the HTTP payload as an event
export default {
  key: "http-new-requests-payload-only",
  name: "New Requests (Payload Only)",
  // eslint-disable-next-line
  description: "Get a URL and emit the HTTP body as an event on every request",
  version: "0.1.1",
  type: "source",
  props: {
    // eslint-disable-next-line
    httpInterface: {
      type: "$.interface.http",
      customResponse: true,
    },
    http,
  },
  async run(event) {
    const { body } = event;
    this.httpInterface.respond({
      status: 200,
      body,
    });
    // Emit the HTTP payload
    this.$emit({
      body,
    });
  },
};

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
N/A	`httpInterface`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
HTTP / Webhook	`http`	`app`	This component uses the HTTP / Webhook app.

Trigger Authentication#

The HTTP / Webhook API does not require authentication.

About HTTP / Webhook#

Get a unique URL where you can send HTTP or webhook requests

Action#

Create or Update Contact on Xero Accounting

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

Version:0.1.1

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#

// legacy_hash_id: a_0Mi723
import { axios } from "@pipedream/platform";

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.1",
  type: "action",
  props: {
    xero_accounting_api: {
      type: "app",
      app: "xero_accounting_api",
    },
    tenant_id: {
      type: "string",
      description: "Id of the organization tenant to use on the Xero Accounting API. See [Get Tenant Connections](https://pipedream.com/@sergio/xero-accounting-api-get-tenant-connections-p_OKCzOgn/edit) for a workflow example on how to pull this data.",
    },
    name: {
      type: "string",
      description: "Full name of contact/organisation (max length = 255). The following is required to create a contact.",
      optional: true,
    },
    contact_id: {
      type: "string",
      description: "Xero identifier.",
      optional: true,
    },
    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,
    },
    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,
    },
    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",
      ],
    },
    first_name: {
      type: "string",
      description: "First name of contact person (max length = 255).",
      optional: true,
    },
    last_name: {
      type: "string",
      description: "Last name of contact person (max length = 255)",
      optional: true,
    },
    email_address: {
      type: "string",
      description: "Email address of contact person (umlauts not supported) (max length = 255)",
      optional: true,
    },
    skype_user_name: {
      type: "string",
      description: "Skype user name of contact.",
      optional: true,
    },
    contact_persons: {
      type: "any",
      description: "See [contact persons](https://developer.xero.com/documentation/api/contacts#contact-persons).",
      optional: true,
    },
    bank_account_details: {
      type: "string",
      description: "Bank account number of contact",
      optional: true,
    },
    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,
    },
    account_receivable_tax_type: {
      type: "string",
      description: "Default tax type used for contact on AP invoices",
      optional: true,
    },
    account_payable_type: {
      type: "string",
      description: "Store certain address types for a contact - see address types",
      optional: true,
    },
    addresses: {
      type: "any",
      description: "Store certain address types for a contact - see address types",
      optional: true,
    },
    phones: {
      type: "any",
      description: "Store certain phone types for a contact - see phone types.",
      optional: true,
    },
    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,
    },
    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,
    },
    default_currency: {
      type: "string",
      description: "Default currency for raising invoices against contact",
      optional: true,
    },
    xero_network_key: {
      type: "string",
      description: "Store XeroNetworkKey for contacts.",
      optional: true,
    },
    sales_default_account_code: {
      type: "string",
      description: "The default sales [account code](https://developer.xero.com/documentation/api/accounts) for contacts",
      optional: true,
    },
    puchases_default_account_code: {
      type: "string",
      description: "The default purchases [account code](https://developer.xero.com/documentation/api/accounts) for contacts",
      optional: true,
    },
    sales_tracking_categories: {
      type: "string",
      description: "The default sales [tracking categories](https://developer.xero.com/documentation/api/tracking-categories/) for contacts",
      optional: true,
    },
    puechases_tracking_categories: {
      type: "string",
      description: "The default purchases [tracking categories](https://developer.xero.com/documentation/api/tracking-categories/) for contacts",
      optional: true,
    },
    tracking_category_name: {
      type: "string",
      description: "The name of the Tracking Category assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories",
      optional: true,
    },
    tracking_option_name: {
      type: "string",
      description: "The name of the Tracking Option assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories",
      optional: true,
    },
    payment_terms: {
      type: "string",
      description: "The default payment terms for the contact - see Payment Terms",
      optional: true,
      options: [
        "DAYSAFTERBILLDATE",
        "DAYSAFTERBILLMONTH",
        "OFCURRENTMONTH",
        "OFFOLLOWINGMONTH",
      ],
    },
  },
  async run({ $ }) {
  //See the API docs: https://developer.xero.com/documentation/api/contacts
  //on section POST Contacts

    if (!this.tenant_id) {
      throw new Error("Must provide tenant_id parameter.");
    }

    return await axios($, {
      method: "post",
      url: "https://api.xero.com/api.xro/2.0/Contacts",
      headers: {
        "Authorization": `Bearer ${this.xero_accounting_api.$auth.oauth_access_token}`,
        "xero-tenant-id": this.tenant_id,
      },
      data: {
        Name: this.name,
        ContactID: this.contact_id,
        ContactNumber: this.contact_number,
        AccountNumber: this.account_number,
        ContactStatus: this.contact_status,
        FirstName: this.first_name,
        LastName: this.last_name,
        EmailAddress: this.email_address,
        SkypeUserName: this.skype_user_name,
        ContactPersons: this.contact_persons,
        BankAccountDetails: this.bank_account_details,
        TaxNumber: this.tax_number,
        AccountsReceivableTaxType: this.account_receivable_tax_type,
        AccountsPayableTaxType: this.account_payable_type,
        Addresses: this.addresses,
        Phones: this.phones,
        IsSupplier: this.is_supplier,
        IsCustomer: this.is_customer,
        DefaultCurrency: this.default_currency,
        XeroNetworkKey: this.xero_network_key,
        SalesDefaultAccountCode: this.sales_default_account_code,
        PurchasesDefaultAccountCode: this.puchases_default_account_code,
        SalesTrackingCategories: this.sales_tracking_categories,
        PurchasesTrackingCategories: this.puechases_tracking_categories,
        TrackingCategoryName: this.tracking_category_name,
        TrackingOptionName: this.tracking_option_name,
        PaymentTerms: this.payment_terms,
      },
    });
  },
};

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	`xero_accounting_api`	`app`	This component uses the Xero Accounting app.
tenant_id	`tenant_id`	`string`	Id of the organization tenant to use on the Xero Accounting API. See Get Tenant Connections for a workflow example on how to pull this data.
name	`name`	`string`	Full name of contact/organisation (max length = 255). The following is required to create a contact.
contact_id	`contact_id`	`string`	Xero identifier.
contact_number	`contact_number`	`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	`account_number`	`string`	A user defined account number. This can be updated via the API and the Xero UI (max length = 50).
contact_status	`contact_status`	`string`	Select a value from the drop down menu:`ACTIVEARCHIVEDGDPRREQUEST`
first_name	`first_name`	`string`	First name of contact person (max length = 255).
last_name	`last_name`	`string`	Last name of contact person (max length = 255)
email_address	`email_address`	`string`	Email address of contact person (umlauts not supported) (max length = 255)
skype_user_name	`skype_user_name`	`string`	Skype user name of contact.
contact_persons	`contact_persons`	`any`	See contact persons
bank_account_details	`bank_account_details`	`string`	Bank account number of contact
tax_number	`tax_number`	`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	`account_receivable_tax_type`	`string`	Default tax type used for contact on AP invoices
account_payable_type	`account_payable_type`	`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	`is_supplier`	`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	`is_customer`	`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	`default_currency`	`string`	Default currency for raising invoices against contact
xero_network_key	`xero_network_key`	`string`	Store XeroNetworkKey for contacts.
sales_default_account_code	`sales_default_account_code`	`string`	The default sales account code for contacts
puchases_default_account_code	`puchases_default_account_code`	`string`	The default purchases account code for contacts
sales_tracking_categories	`sales_tracking_categories`	`string`	The default sales tracking categories for contacts
puechases_tracking_categories	`puechases_tracking_categories`	`string`	The default purchases tracking categories for contacts
tracking_category_name	`tracking_category_name`	`string`	The name of the Tracking Category assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories
tracking_option_name	`tracking_option_name`	`string`	The name of the Tracking Option assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories
payment_terms	`payment_terms`	`string`	Select a value from the drop down menu:`DAYSAFTERBILLDATEDAYSAFTERBILLMONTHOFCURRENTMONTHOFFOLLOWINGMONTH`

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

About Xero Accounting#

Accounting Software

More Ways to Connect Xero Accounting + HTTP / Webhook#

Other Popular Integrations#

Send any HTTP Request with HTTP / Webhook API on New or updated contact from Xero Accounting API

Xero Accounting + HTTP / Webhook