Create Employee with Xero Accounting API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create Employee 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 Employee 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 Employee action
1. Connect your Xero Accounting account
2. Configure tenant_id
3. Configure first_name
4. Configure last_name
5. Optional- Select a status
6. Optional- Configure external_link
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 Employee with Xero Accounting API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Xero Accounting

Try it

Create Employee with Xero Accounting API on New Item in Feed from RSS API

RSS + Xero Accounting

Try it

Create Employee with Xero Accounting API on New Message from Discord API

Discord + Xero Accounting

Try it

Create Employee with Xero Accounting API on New Message In Channels from Slack API

Slack + Xero Accounting

Try it

Create Employee with Xero Accounting API on New Message in Channel from Discord Bot API

Discord Bot + 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 Employee on Xero Accounting

Description:Creates a new employee.

Version:0.3.1

Key:xero_accounting_api-xero-accounting-create-employee

View on GitHub

Code#

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

export default {
  key: "xero_accounting_api-xero-accounting-create-employee",
  name: "Create Employee",
  description: "Creates a new employee.",
  version: "0.3.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.",
    },
    first_name: {
      type: "string",
      description: "First name of an employee (max length = 255). If an existing employee matches your `FirstName` and `LastName` then you will receive an error.",
    },
    last_name: {
      type: "string",
      description: "Last name of an employee (max length = 255). If an existing employee matches your `FirstName` and `LastName` then you will receive an error.",
    },
    status: {
      type: "string",
      description: "Current status of an employee - see contact status [types](https://developer.xero.com/documentation/api/types#ContactStatuses)",
      optional: true,
      options: [
        "ACTIVE",
        "ARCHIVED",
        "GDPRREQUEST",
      ],
    },
    external_link: {
      type: "object",
      description: "Link to an external resource, for example, an employee record in an external system. You can specify the URL element.\nThe description of the link is auto-generated in the form \"Go to <App name>\". <App name> refers to the [Xero application](https://api.xero.com/Application) name that is making the API call.",
      optional: true,
    },
  },
  async run({ $ }) {
  //See the API docs: https://developer.xero.com/documentation/api/employees
  //on section PUT Employees

    if (!this.tenant_id || !this.first_name || !this.last_name) {
      throw new Error("Must provide tenant_id, first_name, and last_name parameters.");
    }

    return await axios($, {
      method: "put",
      url: "https://api.xero.com/api.xro/2.0/Employees",
      headers: {
        "Authorization": `Bearer ${this.xero_accounting_api.$auth.oauth_access_token}`,
        "xero-tenant-id": this.tenant_id,
      },
      data: {
        Status: this.status,
        FirstName: this.first_name,
        LastName: this.last_name,
        ExternalLink: this.external_link,
      },
    });
  },
};

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	`xero_accounting_api`	`app`	This component uses the Xero Accounting app.
	`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.
	`first_name`	`string`	First name of an employee (max length = 255). If an existing employee matches your `FirstName` and `LastName` then you will receive an error.
	`last_name`	`string`	Last name of an employee (max length = 255). If an existing employee matches your `FirstName` and `LastName` then you will receive an error.
	`status`	`string`	Select a value from the drop down menu:`ACTIVEARCHIVEDGDPRREQUEST`
	`external_link`	`object`	Link to an external resource, for example, an employee record in an external system. You can specify the URL element. The description of the link is auto-generated in the form "Go to <App name>". <App name> refers to the Xero application name that is making the API call.

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