Create Credit Note with Xero Accounting API on New Worker Created from Rippling API

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

Trigger workflow on

New Worker Created from the Rippling API

Next, do this

Create Credit Note 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 Rippling 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 Worker Created trigger
1. Connect your Rippling account
2. Configure timer
3. Optional- Configure Filter
4. Optional- Select one or more Expand
Configure the Create Credit Note action
1. Connect your Xero Accounting account
2. Select a Tenant ID
3. Optional- Configure Contact ID
4. Optional- Configure Contact Name
5. Optional- Configure Contact Number
6. Select a Type
7. Optional- Configure Date
8. Optional- Select a Status
9. Optional- Select a Line amount types
10. Optional- Configure Line items
11. Optional- Configure Currency code
12. Optional- Configure Credit note number
13. Optional- Configure Reference
14. Optional- Configure Sent to contact
15. Optional- Configure Currency rate
16. Optional- Configure Branding theme 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 Worker Created on Rippling

Description:Emit new event when a new worker is created in Rippling. [See the documentation](https://developer.rippling.com/documentation/rest-api/reference/list-workers)

Version:0.0.1

Key:rippling-new-worker-created

View on GitHub

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import rippling from "../../rippling.app.mjs";

export default {
  key: "rippling-new-worker-created",
  name: "New Worker Created",
  description: "Emit new event when a new worker is created in Rippling. [See the documentation](https://developer.rippling.com/documentation/rest-api/reference/list-workers)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    rippling,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    filter: {
      propDefinition: [
        rippling,
        "filterWorkers",
      ],
    },
    expand: {
      propDefinition: [
        rippling,
        "expandWorkers",
      ],
    },
  },
  methods: {
    _getLastCreatedAt() {
      return this.db.get("lastCreatedAt") || 0;
    },
    _setLastCreatedAt(createdAt) {
      this.db.set("lastCreatedAt", createdAt);
    },
    generateMeta(worker) {
      return {
        id: worker.id,
        summary: `New Worker: ${worker?.user?.display_name || worker.id}`,
        ts: Date.parse(worker.created_at),
      };
    },
    async processEvents(max) {
      const lastCreatedAt = this._getLastCreatedAt();
      let maxCreatedAt = lastCreatedAt;
      const workers = await this.rippling.paginate({
        fn: this.rippling.listWorkers,
        args: {
          params: {
            order_by: "created_at desc",
            ...(this.filter && {
              filter: this.filter,
            }),
            ...(this.expand && {
              expand: this.expand.join(","),
            }),
          },
        },
        max,
      });
      for await (const worker of workers) {
        const ts = Date.parse(worker.created_at);
        if (ts > lastCreatedAt) {
          this.$emit(worker, this.generateMeta(worker));
          if (ts > maxCreatedAt) {
            maxCreatedAt = ts;
          }
        } else {
          break;
        }
      }
      this._setLastCreatedAt(maxCreatedAt);
    },
  },
  hooks: {
    async deploy() {
      await this.processEvents(25);
    },
  },
  async run() {
    await this.processEvents();
  },
};

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
Rippling	`rippling`	`app`	This component uses the Rippling app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Filter	`filter`	`string`	Filter workers by field. Filterable fields: `status`, `work_email`, `user_id`, `created_at`, `updated_at`. Example: `status+eq+'ACTIVE'` See the documentation for more information.
Expand	`expand`	`string[]`	Select a value from the drop down menu:`usermanagerlegal_entityemployment_typecompensationdepartmentteamslevelcustom_fieldsbusiness_partners`

Trigger Authentication#

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

About Rippling#

Employee Management Platform

Action#

Create Credit Note on Xero Accounting

Description:Creates a new credit note.

Version:0.1.3

Key:xero_accounting_api-create-credit-note

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 { ConfigurationError } from "@pipedream/platform";
import { formatLineItems } from "../../common/util.mjs";
import xeroAccountingApi from "../../xero_accounting_api.app.mjs";

export default {
  key: "xero_accounting_api-create-credit-note",
  name: "Create Credit Note",
  description: "Creates a new credit note.",
  version: "0.1.3",
  annotations: {
    destructiveHint: true,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    xeroAccountingApi,
    tenantId: {
      propDefinition: [
        xeroAccountingApi,
        "tenantId",
      ],
    },
    contactId: {
      label: "Contact ID",
      type: "string",
      description: "Id of the contact associated to the credit note.",
      optional: true,
    },
    contactName: {
      type: "string",
      label: "Contact Name",
      description: "Name of the contact associated to the credit note. If there is no contact matching this name, a new contact is created.",
      optional: true,
    },
    contactNumber: {
      type: "string",
      label: "Contact Number",
      description: "Number of the contact associated to the credit note. If there is no contact matching this name, a new contact is created.",
      optional: true,
    },
    type: {
      label: "Type",
      type: "string",
      description: "See [Credit Note Types](https://developer.xero.com/documentation/api/types#CreditNoteTypes)",
      options: [
        "ACCPAYCREDIT",
        "ACCRECCREDIT",
      ],
    },
    date: {
      type: "string",
      label: "Date",
      description: "The date the credit note is issued YYYY-MM-DD. If the Date element is not specified then it will default to the current date based on the timezone setting of the organisation",
      optional: true,
    },
    status: {
      type: "string",
      label: "Status",
      description: "See [Credit Note Status Codes](https://developer.xero.com/documentation/api/types#CreditNoteStatuses)",
      optional: true,
      options: [
        "DRAFT",
        "SUBMITTED",
        "DELETED",
        "AUTHORISED",
        "PAID",
        "VOIDED",
      ],
    },
    lineAmountTypes: {
      label: "Line amount types",
      type: "string",
      description: "See [Invoice Line Amount Types](https://developer.xero.com/documentation/api/Types#LineAmountTypes)",
      optional: true,
      options: [
        "Exclusive",
        "Inclusive",
        "NoTax",
      ],
    },
    lineItems: {
      label: "Line items",
      type: "object",
      description: "See [Invoice Line Items](https://developer.xero.com/documentation/api/Invoices#LineItems)",
      optional: true,
    },
    currencyCode: {
      label: "Currency code",
      type: "string",
      description: "Currency used for the Credit Note",
      optional: true,
    },
    creditNoteNumber: {
      label: "Credit note number",
      type: "string",
      description: "[ACCRECCREDIT](https://developer.xero.com/documentation/api/types#CreditNoteTypes) - Unique alpha numeric code identifying credit note ( *when missing will auto-generate from your Organisation Invoice Settings*)\n[ACCPAYCREDIT](https://developer.xero.com/documentation/api/types#CreditNoteTypes) - non-unique alpha numeric code identifying credit note. This value will also display as Reference in the UI.",
      optional: true,
    },
    reference: {
      label: "Reference",
      type: "string",
      description: "ACCRECCREDIT only - additional reference number",
      optional: true,
    },
    sentToContact: {
      label: "Sent to contact",
      type: "boolean",
      description: "Boolean to indicate if a credit note has been sent to a contact via the Xero app (currently read only)",
      optional: true,
    },
    currencyRate: {
      label: "Currency rate",
      type: "string",
      description: "The currency rate for a multicurrency invoice. If no rate is specified, the [XE.com day rate](http://help.xero.com/#CurrencySettings$Rates) is used",
      optional: true,
    },
    brandingThemeId: {
      label: "Branding theme ID",
      type: "string",
      description: "See [BrandingThemes](https://developer.xero.com/documentation/api/branding-themes)",
      optional: true,
    },
  },
  async run({ $ }) {
    if ((
      !this.contactId &&
      !this.contactName &&
      !this.contactNumber) ||
      !this.tenantId ||
      !this.type) {
      throw new ConfigurationError("Must provide one of **Contact ID** or **Contact Name** or **Contact Number**, **Tenant ID**, and **Type** parameters.");
    }

    const response = await this.xeroAccountingApi.createCreditNote({
      $,
      tenantId: this.tenantId,
      data: {
        Type: this.type,
        Contact: {
          ContactID: this.contactId,
          ContactNumber: this.contactNumber,
          Name: this.contactName,
        },
        Date: this.date,
        Status: this.status,
        LineAmountTypes: this.lineAmountTypes,
        LineItems: formatLineItems(this.lineItems),
        CurrencyCode: this.currencyCode,
        CreditNoteNumber: this.creditNoteNumber,
        Reference: this.reference,
        SentToContact: this.sentToContact,
        CurrencyRate: this.currencyRate,
        BrandingThemeID: this.brandingThemeId,
      },
    });

    $.export("$summary", `Successfully created credit note with ID: ${response.CreditNotes[0].CreditNoteID}`);
    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.
Contact ID	`contactId`	`string`	Id of the contact associated to the credit note.
Contact Name	`contactName`	`string`	Name of the contact associated to the credit note. If there is no contact matching this name, a new contact is created.
Contact Number	`contactNumber`	`string`	Number of the contact associated to the credit note. If there is no contact matching this name, a new contact is created.
Type	`type`	`string`	Select a value from the drop down menu:`ACCPAYCREDITACCRECCREDIT`
Date	`date`	`string`	The date the credit note is issued YYYY-MM-DD. If the Date element is not specified then it will default to the current date based on the timezone setting of the organisation
Status	`status`	`string`	Select a value from the drop down menu:`DRAFTSUBMITTEDDELETEDAUTHORISEDPAIDVOIDED`
Line amount types	`lineAmountTypes`	`string`	Select a value from the drop down menu:`ExclusiveInclusiveNoTax`
Line items	`lineItems`	`object`	See Invoice Line Items
Currency code	`currencyCode`	`string`	Currency used for the Credit Note
Credit note number	`creditNoteNumber`	`string`	ACCRECCREDIT - Unique alpha numeric code identifying credit note ( when missing will auto-generate from your Organisation Invoice Settings) ACCPAYCREDIT - non-unique alpha numeric code identifying credit note. This value will also display as Reference in the UI.
Reference	`reference`	`string`	ACCRECCREDIT only - additional reference number
Sent to contact	`sentToContact`	`boolean`	Boolean to indicate if a credit note has been sent to a contact via the Xero app (currently read only)
Currency rate	`currencyRate`	`string`	The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used
Branding theme ID	`brandingThemeId`	`string`	See BrandingThemes

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