Create Credit Note with Xero Accounting API on New or Updated Row from Baserow API

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

Trigger workflow on

New or Updated Row from the Baserow 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 Baserow 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 or Updated Row trigger
1. Connect your Baserow account
2. Configure Table ID
3. Configure timer
4. Optional- Select one or more Event Types
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 or Updated Row on Baserow

Description:Emit new event when a table row is created, updated or deleted, according to the selected event types

Version:0.0.1

Key:baserow-new-or-updated-row

View on GitHub

Baserow Overview#

The Baserow API allows you to interact programmatically with Baserow, an open-source no-code database tool. With its API, you can automate database operations such as creating, reading, updating, and deleting records. Moreover, it's possible to manage databases, tables, fields, and rows, or integrate with external services to enrich or move data in real-time. Leveraging Pipedream’s capabilities, you can trigger workflows from a variety of events and connect Baserow to numerous apps for seamless data processes.

Trigger Code#

import { defineSource } from "@pipedream/types";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import common from "../../actions/common.mjs";
import { EventType } from "../../common/constants.mjs";
export default defineSource({
    ...common,
    key: "baserow-new-or-updated-row",
    name: "New or Updated Row",
    description: "Emit new event when a table row is created, updated or deleted, according to the selected event types",
    version: "0.0.1",
    type: "source",
    props: {
        ...common.props,
        db: "$.service.db",
        timer: {
            type: "$.interface.timer",
            default: {
                intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
            },
        },
        eventTypes: {
            type: "string[]",
            label: "Event Types",
            description: "Which events to emit. If not specified, all events will be emitted.",
            optional: true,
            options: [
                EventType.Create,
                EventType.Update,
                EventType.Delete,
            ],
        },
    },
    hooks: {
        async deploy() {
            await this.getAndProcessData();
        },
    },
    methods: {
        _getTableId() {
            return this.db.get("tableId");
        },
        _setTableId(value) {
            this.db.set("tableId", value);
        },
        _getSavedData() {
            return JSON.parse(this.db.get("savedData") ?? "{}");
        },
        _setSavedData(data) {
            this.db.set("savedData", JSON.stringify(data));
        },
        async getAndProcessData() {
            const { baserow, tableId, eventTypes, } = this;
            const savedTableId = this._getTableId();
            const data = await baserow.listRows({
                tableId,
            });
            if (!data) {
                console.log("No data received: ", data);
                return;
            }
            const firstRun = savedTableId !== tableId;
            if (firstRun) {
                this._setTableId(tableId);
            }
            else {
                const events = eventTypes?.length
                    ? eventTypes
                    : Object.values(EventType);
                const savedData = this._getSavedData();
                const emitCreate = events.includes(EventType.Create);
                const emitUpdate = events.includes(EventType.Update);
                const emitDelete = events.includes(EventType.Delete);
                if (emitCreate || emitUpdate) {
                    data.forEach((row) => {
                        const savedRow = savedData[row.id];
                        if (emitCreate && !savedRow) {
                            this.emitEvent(EventType.Create, row);
                        }
                        else if (emitUpdate &&
                            JSON.stringify(savedRow) !== JSON.stringify(row)) {
                            this.emitEvent(EventType.Update, row);
                        }
                    });
                }
                if (emitDelete) {
                    Object.entries(savedData)
                        .filter(([id,]) => {
                        const numId = Number(id);
                        return !data.some((row) => row.id === numId);
                    })
                        .forEach(([, savedRow,]) => {
                        this.emitEvent(EventType.Delete, savedRow);
                    });
                }
            }
            this._setSavedData(data.reduce((acc, row) => {
                acc[row.id] = row;
                return acc;
            }, {}));
        },
        emitEvent(eventType, rowData) {
            const ts = Date.now();
            const { id } = rowData;
            this.$emit({
                eventType,
                rowData,
            }, {
                id,
                summary: `${eventType}: ${id}`,
                ts,
            });
        },
    },
    async run() {
        await this.getAndProcessData();
    },
});

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
Baserow	`baserow`	`app`	This component uses the Baserow app.
Table ID	`tableId`	`integer`	The ID of the table to use. You can find your tables and their IDs on the Baserow API Docs
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Event Types	`eventTypes`	`string[]`	Select a value from the drop down menu:`New Row CreatedRow UpdatedRow Deleted`

Trigger Authentication#

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

Baserow uses a simple token based authentication. You need to generate at least one API token in your settings.

About Baserow#

Open source online database tool

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