Get Sales Invoice Online URL with Xero Accounting API on New Deploy Created from LinearB API

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

Trigger workflow on

New Deploy Created from the LinearB API

Next, do this

Get Sales Invoice Online URL 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 LinearB 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 Deploy Created trigger
1. Connect your LinearB account
2. Configure Polling Schedule
3. Configure Repository ID
Configure the Get Sales Invoice Online URL action
1. Connect your Xero Accounting account
2. Configure tenant_id
3. Configure invoice_id
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 Deploy Created on LinearB

Description:Emit new event when a new deploy is created in LinearB. [See the documentation](https://docs.linearb.io/api-deployments/)

Version:0.0.1

Key:linearb-new-deploy-created

View on GitHub

LinearB Overview#

The LinearB API serves as a bridge between LinearB's project management insights and your preferred platforms, offering the ability to automate workflows, generate reports, and trigger actions based on project metrics. With Pipedream, these capabilities can be harnessed to create custom workflows that respond to events within LinearB, such as changes in project status or team performance metrics. The data can be pushed to various services, such as communication tools, databases, or other project management apps to enhance visibility and coordination across your team.

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import app from "../../linearb.app.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "linearb-new-deploy-created",
  name: "New Deploy Created",
  description: "Emit new event when a new deploy is created in LinearB. [See the documentation](https://docs.linearb.io/api-deployments/)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    app,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      label: "Polling Schedule",
      description: "How often to poll the API",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    repositoryId: {
      type: "integer",
      label: "Repository ID",
      description: "The git repository id. Eg. `1`",
    },
  },
  methods: {
    generateMeta(resource) {
      return {
        id: resource.id,
        summary: "New Deploy Created",
        ts: Date.now(),
      };
    },
    setLastCreatedAt(value) {
      this.db.set(constants.LAST_CREATED_AT, value);
    },
    getLastCreatedAt() {
      return this.db.get(constants.LAST_CREATED_AT);
    },
    getResourcesName() {
      return "items";
    },
    getResourcesFn() {
      return this.app.listDeployments;
    },
    getResourcesFnArgs() {
      return {
        params: {
          repository_id: this.repositoryId,
          limit: 50,
          sort_by: "published_at",
          sort_dir: "desc",
          after: this.getLastCreatedAt(),
        },
      };
    },
    processResource(resource) {
      const meta = this.generateMeta(resource);
      this.$emit(resource, meta);
    },
  },
  async run() {
    const {
      getResourcesFn,
      getResourcesFnArgs,
      getResourcesName,
      processResource,
    } = this;

    const resourcesFn = getResourcesFn();
    const { [getResourcesName()]: resources } =
      await resourcesFn(getResourcesFnArgs());

    const [
      lastResource,
    ] = resources;

    if (lastResource?.created_at) {
      this.setLastCreatedAt(lastResource.created_at);
    }

    Array.from(resources)
      .reverse()
      .forEach(processResource);
  },
};

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
LinearB	`app`	`app`	This component uses the LinearB app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling Schedule	`timer`	`$.interface.timer`	How often to poll the API
Repository ID	`repositoryId`	`integer`	The git repository id. Eg. `1`

Trigger Authentication#

LinearB uses API keys for authentication. When you connect your LinearB account, Pipedream securely stores the keys so you can easily authenticate to LinearB APIs in both code and no-code steps.

About LinearB#

The Software Delivery Management Platform for engineering leaders to streamline operations and align R&D investments to deliver business results

Action#

Get Sales Invoice Online URL on Xero Accounting

Description:Retrieves the online sales invoice URL.

Version:0.1.1

Key:xero_accounting_api-get-invoice-online-url

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_gniWnr
import { axios } from "@pipedream/platform";

export default {
  key: "xero_accounting_api-get-invoice-online-url",
  name: "Get Sales Invoice Online URL",
  description: "Retrieves the online sales invoice URL.",
  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.",
    },
    invoice_id: {
      type: "string",
      description: "Xero generated unique identifier for the invoice to retrieve its online url.",
    },
  },
  async run({ $ }) {
  //See the API docs: https://developer.xero.com/documentation/api/invoices#onlineinvoice

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

    return await axios($, {
      url: `https://api.xero.com/api.xro/2.0/Invoices/${this.invoice_id}/OnlineInvoice`,
      headers: {
        "Authorization": `Bearer ${this.xero_accounting_api.$auth.oauth_access_token}`,
        "xero-tenant-id": this.tenant_id,
      },
    });
  },
};

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.
invoice_id	`invoice_id`	`string`	Xero generated unique identifier for the invoice to retrieve its online url.

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