Create Credit Note with Xero Accounting API on New Document Status Changed from Docsumo API

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

Trigger workflow on

New Document Status Changed from the Docsumo 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 Docsumo 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 Document Status Changed trigger
1. Connect your Docsumo account
2. Configure timer
Configure the Create Credit Note action
1. Connect your Xero Accounting account
2. Optional- Configure contact_id
3. Optional- Configure contact_name
4. Optional- Configure contact_number
5. Configure tenant_id
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 Document Status Changed on Docsumo

Description:Emit new event when document status is changed

Version:0.0.1

Key:docsumo-document-status-changed

View on GitHub

Docsumo Overview#

The Docsumo API offers robust capabilities for extracting and processing data from various types of documents, like invoices, receipts, and bank statements. It applies intelligent OCR (Optical Character Recognition) to transform unstructured documents into structured data. With Pipedream, you can harness this power to automate workflows, such as digitizing financial records, validating document data, or integrating extracted information into databases or other apps, all with minimal code.

Trigger Code#

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

export default {
  name: "New Document Status Changed",
  description: "Emit new event when document status is changed",
  key: "docsumo-document-status-changed",
  version: "0.0.1",
  type: "source",
  props: {
    app,
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    db: "$.service.db",
  },
  hooks: {
    async deploy() {
      const documents = await this.listAllDocuments();
      this.setDocuments(this.getDocumentsStatusMap(documents));
    },
  },
  methods: {
    setDocuments(documents) {
      this.db.set("documents", documents);
    },
    getDocuments() {
      return this.db.get("documents") || {};
    },
    getDocumentsStatusMap(documents) {
      const documentsStatusMap = {};
      for (const document of documents) {
        documentsStatusMap[document.doc_id] = document.status;
      }
      return documentsStatusMap;
    },
    getDocumentsMappedByDocId(documents) {
      const documentsMap = {};
      for (const document of documents) {
        documentsMap[document.doc_id] = document;
      }
      return documentsMap;
    },
    async listAllDocuments(params) {
      const PAGE_SIZE = 200;
      let page = 0;
      const documents = [];

      while (true) {
        const res = await this.app.listDocuments({
          ...params,
          limit: PAGE_SIZE,
          offset: (page * PAGE_SIZE),
        });
        if (res.data.documents.length === 0) {
          break;
        }
        documents.push(...res.data.documents);
        page++;
      }

      return documents;
    },
    emitEvent(doc, isNew) {
      this.$emit(doc, {
        id: `${doc.doc_id}-${doc.status}`,
        summary: `${isNew
          ? "New"
          : "Changed"
        } - ${doc.doc_id}`,
        ts: Date.now(),
      });
    },
  },
  async run() {
    const documents = await this.listAllDocuments();
    const changedDocuments = [];
    const newDocuments = [];
    const documentsMappedByDocId = this.getDocumentsMappedByDocId(documents);
    const prevDocumentsStatusMap = this.getDocuments();

    // Iterate over documentsStatusMap map
    for (const [
      docId,
      doc,
    ] of Object.entries(documentsMappedByDocId)) {
      // If document is new
      if (!prevDocumentsStatusMap[docId]) {
        newDocuments.push(doc);
      }

      // If document status has changed
      else if (prevDocumentsStatusMap[docId] !== doc.status) {
        changedDocuments.push(doc);
      }
    }

    this.setDocuments(this.getDocumentsStatusMap(documents));
    for (const doc of changedDocuments) {
      this.emitEvent(doc, false);
    }
    for (const doc of newDocuments) {
      this.emitEvent(doc, true);
    }
  },
};

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
Docsumo	`app`	`app`	This component uses the Docsumo app.
	`timer`	`$.interface.timer`
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

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

About Docsumo#

Make fast & accurate decisions from unstructured documents. Document AI software that converts unstructured documents to actionable data.

Action#

Create Credit Note on Xero Accounting

Description:Creates a new credit note.

Version:0.1.1

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#

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

export default {
  key: "xero_accounting_api-create-credit-note",
  name: "Create Credit Note",
  description: "Creates a new credit note.",
  version: "0.1.1",
  type: "action",
  props: {
    xero_accounting_api: {
      type: "app",
      app: "xero_accounting_api",
    },
    contact_id: {
      type: "string",
      description: "Id of the contact associated to the credit note.",
      optional: true,
    },
    contact_name: {
      type: "string",
      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,
    },
    contact_number: {
      type: "string",
      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,
    },
    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.",
    },
    type: {
      type: "string",
      description: "See [Credit Note Types](https://developer.xero.com/documentation/api/types#CreditNoteTypes)",
      options: [
        "ACCPAYCREDIT",
        "ACCRECCREDIT",
      ],
    },
    date: {
      type: "string",
      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",
      description: "See [Credit Note Status Codes](https://developer.xero.com/documentation/api/types#CreditNoteStatuses)",
      optional: true,
      options: [
        "DRAFT",
        "SUBMITTED",
        "DELETED",
        "AUTHORISED",
        "PAID",
        "VOIDED",
      ],
    },
    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",
      ],
    },
    line_items: {
      type: "object",
      description: "See [Invoice Line Items](https://developer.xero.com/documentation/api/Invoices#LineItems)",
      optional: true,
    },
    currency_code: {
      type: "string",
      description: "Currency used for the Credit Note",
      optional: true,
    },
    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: {
      type: "string",
      description: "ACCRECCREDIT only - additional reference number",
      optional: true,
    },
    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,
    },
    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,
    },
    branding_theme_id: {
      type: "string",
      description: "See [BrandingThemes](https://developer.xero.com/documentation/api/branding-themes)",
      optional: true,
    },
  },
  async run({ $ }) {
  //See the API docs: https://developer.xero.com/documentation/api/credit-notes#POST

    if ((!this.contact_id && !this.contact_name && !this.contact_number) || !this.tenant_id || !this.type) {
      throw new Error("Must provide one of contact_id or contact_name or contact_number, and tenant_id, type parameters.");
    }

    return await axios($, {
      method: "post",
      url: "https://api.xero.com/api.xro/2.0/CreditNotes",
      headers: {
        "Authorization": `Bearer ${this.xero_accounting_api.$auth.oauth_access_token}`,
        "xero-tenant-id": this.tenant_id,
      },
      data: {
        Type: this.type,
        Contact: {
          ContactID: this.contact_id,
          ContactNumber: this.contact_number,
          Name: this.contact_name,
        },
        Date: this.date,
        Status: this.status,
        LineAmountTypes: this.line_amount_types,
        LineItems: this.line_items,
        CurrencyCode: this.currency_code,
        CreditNoteNumber: this.credit_note_number,
        Reference: this.reference,
        SentToContact: this.sent_to_contact,
        CurrencyRate: this.currency_rate,
        BrandingThemeID: this.branding_theme_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.
contact_id	`contact_id`	`string`	Id of the contact associated to the credit note.
contact_name	`contact_name`	`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	`contact_number`	`string`	Number of the contact associated to the credit note. If there is no contact matching this name, a new contact is created.
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.
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	`line_amount_types`	`string`	Select a value from the drop down menu:`ExclusiveInclusiveNoTax`
line_items	`line_items`	`object`	See Invoice Line Items
currency_code	`currency_code`	`string`	Currency used for the Credit Note
credit_note_number	`credit_note_number`	`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	`sent_to_contact`	`boolean`	Boolean to indicate if a credit note has been sent to a contact via the Xero app (currently read only)
currency_rate	`currency_rate`	`string`	The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used
branding_theme_id	`branding_theme_id`	`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.reports.readaccounting.settingsaccounting.settings.readaccounting.contactsaccounting.attachmentsaccounting.journals.read