Create Sales Invoice with Xero Accounting API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create Sales Invoice 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 Sales Invoice 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 Sales Invoice action
1. Connect your Xero Accounting account
2. Select a Tenant ID
3. Optional- Select a Contact
4. Optional- Configure Contact Name
5. Configure Line items
6. Optional- Configure Date
7. Optional- Configure Due Date
8. Optional- Configure Line Amount Type
9. Optional- Configure Invoice Number
10. Optional- Configure Reference
11. Optional- Configure Branding Theme ID
12. Optional- Configure URL
13. Optional- Configure Currency Code
14. Optional- Configure Currency Rate
15. Optional- Configure Status
16. Optional- Configure Sent To Contact
17. Optional- Configure Expected Payment Date
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 Sales Invoice with Xero Accounting API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Xero Accounting

Try it

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

RSS + Xero Accounting

Try it

Create Sales Invoice with Xero Accounting API on New Message from Discord API

Discord + Xero Accounting

Try it

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

Slack + Xero Accounting

Try it

Create Sales Invoice 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 Sales Invoice on Xero Accounting

Description:Creates a new sales invoice. [See the documentation](https://developer.xero.com/documentation/api/invoices#post)

Version:0.3.2

Key:xero_accounting_api-xero-create-sales-invoice

View on GitHub

Code#

import xero from "../../xero_accounting_api.app.mjs";
import { formatLineItems } from "../../common/util.mjs";

export default {
  key: "xero_accounting_api-xero-create-sales-invoice",
  name: "Create Sales Invoice",
  description: "Creates a new sales invoice. [See the documentation](https://developer.xero.com/documentation/api/invoices#post)",
  version: "0.3.2",
  type: "action",
  props: {
    xero,
    tenantId: {
      propDefinition: [
        xero,
        "tenantId",
      ],
    },
    contactId: {
      type: "string",
      label: "Contact",
      description: "Id of the contact associated to the invoice.",
      async options() {
        if (!this.tenantId) {
          return [];
        }
        const { Contacts: contacts } = await this.xero.getContact(null, this.tenantId);
        return contacts?.map(({
          ContactID: value, Name: label,
        }) => ({
          value,
          label,
        })) || [];
      },
      optional: true,
    },
    contactName: {
      type: "string",
      label: "Contact Name",
      description: "Name of the contact associated to the invoice. If there is no contact matching this name, a new contact is created.",
      optional: true,
    },
    lineItems: {
      propDefinition: [
        xero,
        "lineItems",
      ],
    },
    date: {
      type: "string",
      label: "Date",
      description: "Date invoice was issued - YYYY-MM-DD. If the Date element is not specified it will default to the current date based on the timezone setting of the organisation.",
      optional: true,
    },
    dueDate: {
      type: "string",
      label: "Due Date",
      description: "Date invoice is due - YYYY-MM-DD.",
      optional: true,
    },
    lineAmountType: {
      type: "string",
      label: "Line Amount Type",
      description: "Line amounts are exclusive of tax by default if you don't specify this element. See [Line Amount Types](https://developer.xero.com/documentation/api/types#LineAmountTypes)",
      optional: true,
    },
    invoiceNumber: {
      type: "string",
      label: "Invoice Number",
      description: "Unique alpha numeric code identifying invoice (* when missing will auto-generate from your Organisation Invoice Settings*) (max length = 255)",
      optional: true,
    },
    reference: {
      type: "string",
      label: "Reference",
      description: "Additional reference number (max length = 255)",
      optional: true,
    },
    brandingThemeId: {
      type: "string",
      label: "Branding Theme ID",
      description: "See [BrandingThemes](https://developer.xero.com/documentation/api/branding-themes)",
      optional: true,
    },
    url: {
      type: "string",
      label: "URL",
      description: "URL link to a source document - shown as \"Go to [appName]\" in the Xero app",
      optional: true,
    },
    currencyCode: {
      type: "string",
      label: "Currency Code",
      description: "The currency that invoice has been raised in (see [Currencies](https://developer.xero.com/documentation/api/currencies))",
      optional: true,
    },
    currencyRate: {
      type: "string",
      label: "Currency Rate",
      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. (max length = [18].[6])",
      optional: true,
    },
    status: {
      type: "string",
      label: "Status",
      description: "See [Invoice Status Codes](https://developer.xero.com/documentation/api/invoices#status-codes)",
      optional: true,
    },
    sentToContact: {
      type: "string",
      label: "Sent To Contact",
      description: "Boolean to set whether the invoice in the Xero app should be marked as \"sent\". This can be set only on invoices that have been approved",
      optional: true,
    },
    expectedPaymentData: {
      type: "string",
      label: "Expected Payment Date",
      description: "Shown on the sales invoices when this has been set",
      optional: true,
    },
  },
  async run({ $ }) {
    if ((!this.contactId && !this.contactName) || !this.tenantId || !this.lineItems) {
      throw new Error("Must provide one of `contactId` or `contactName`, and `tenantId`, `type`, `lineItems` parameters.");
    }

    const response = await this.xero.createInvoice($, this.tenantId, {
      Type: "ACCREC", //ACCREC = Sales Invoice
      Contact: {
        ContactID: this.contactId,
        Name: this.contactName,
      },
      LineItems: formatLineItems(this.lineItems),
      Date: this.date,
      DueDate: this.dueDate,
      LineAmountTypes: this.lineAmountType,
      InvoiceNumber: this.invoiceNumber,
      Reference: this.reference,
      BrandingThemeID: this.brandingThemeId,
      Url: this.url,
      CurrencyCode: this.currencyCode,
      CurrencyRate: this.currencyRate,
      Status: this.status,
      SentToContact: this.sentToContact,
      ExpectedPaymentDate: this.expectedPaymentData,
    });

    return response;
  },
};

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`	`app`	This component uses the Xero Accounting app.
Tenant ID	`tenantId`	`string`	Select a value from the drop down menu.
Contact	`contactId`	`string`	Select a value from the drop down menu.
Contact Name	`contactName`	`string`	Name of the contact associated to the invoice. If there is no contact matching this name, a new contact is created.
Line items	`lineItems`	`string[]`	The LineItems collection can contain any number of individual LineItem sub-elements. At least one is required to create a complete Invoice. Refer to Tax Type, Refer to Line Items Example: `[{"Description":"Football", "Quantity":"20", "UnitAmount":"50000", "TaxType":"OUTPUT" }]`
Date	`date`	`string`	Date invoice was issued - YYYY-MM-DD. If the Date element is not specified it will default to the current date based on the timezone setting of the organisation.
Due Date	`dueDate`	`string`	Date invoice is due - YYYY-MM-DD.
Line Amount Type	`lineAmountType`	`string`	Line amounts are exclusive of tax by default if you don't specify this element. See Line Amount Types
Invoice Number	`invoiceNumber`	`string`	Unique alpha numeric code identifying invoice (* when missing will auto-generate from your Organisation Invoice Settings*) (max length = 255)
Reference	`reference`	`string`	Additional reference number (max length = 255)
Branding Theme ID	`brandingThemeId`	`string`	See BrandingThemes
URL	`url`	`string`	URL link to a source document - shown as "Go to [appName]" in the Xero app
Currency Code	`currencyCode`	`string`	The currency that invoice has been raised in (see Currencies)
Currency Rate	`currencyRate`	`string`	The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used. (max length = [18].[6])
Status	`status`	`string`	See Invoice Status Codes
Sent To Contact	`sentToContact`	`string`	Boolean to set whether the invoice in the Xero app should be marked as "sent". This can be set only on invoices that have been approved
Expected Payment Date	`expectedPaymentData`	`string`	Shown on the sales invoices when this has been set

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