Xero - Get a sales invoice or bill

Use the Xero - Get a sales invoice or bill action A tool for building the processes, logic, and direction within workflows. Actions are the steps the workflow performs to complete a process. to retrieve the details for a specific sales invoice or purchase bill in Xero.

For more information about Xero, go to Xero.

Before you begin: 

Jump to:

Configure the Xero - Get a sales invoice or bill action

  1. Add the action to the workflow and open the action configuration panel. For more information, see Add an action to the workflow.

  1. Select a Connection. If you do not have a connection, see Add a connection.
  1. Specify the Tenant for the sales invoices and bills you want to retrieve.
  2. Specify the ID of the invoice you want to retrieve.
  3. Select the Number of decimal places the currency amount displays.
  4. Create or select a variable for the Invoice and bill output.

Xero - Get a sales invoice or bill action fields and settings

Section

Field

Description

Variable types

(Unlabeled)

Connection Credentials and other settings that enables workflows to communicate with external systems, services, or applications. It's required to pass data between the workflow and the indicated service, which could be a cloud service, business application, or content store.

The Xero connection to use to get the event.

To refresh the available connections, click .

(n/a)
Tenant The tenant in Xero associated with the invoices and bills that you want to retrieve. If using a variable, use the Tenant ID.
You can use the output object of a Xero - Get tenants action to retrieve the tenant ID.
 Text, Decimal, Integer, Boolean, DateTime, Collection
  ID The ID of the invoice you want to retrieve.
You can use the output object of a Xero - Get sales invoices and bills action to retrieve the invoice ID.
  
  Number of decimal places The number of decimal places the currency amount displays. The default is 2 places, and you can select 2, 3, or 4 decimal places. Integer
Output Invoice and bill

Stores the result of the action as an object. The following values are returned:

  • ID: (Text) Unique identifier for each response.

  • Provider name: (Text) Name of the application that made the request.

  • Status: (Text) OK for a successful response. Other response statuses are:

    • 400: A validation exception occurred.
    • 404: The resource you're looking for cannot be found.
    • 500: An unexpected error occurred.

  • Invoices: (Collection) This is the collection of details for each returned invoice.

    • Amount credited: (Decimal) Sum of all credit notes, over-payments and prepayments applied to invoice.

    • Amount due: (Decimal) Amount remaining to be paid on invoice.

    • Amount paid: (Decimal) Sum of payments received for invoice.

    • Attachments: (Collection) The details for each attachment.

      • ID: (Text) Xero generated unique identifier for attachment.

      • Content length: (Integer) The content length in bytes.

      • File name: (Text) The file-name of the attachment.

      • Include online: (Boolean) Determines whether the attachment is included with the online invoice.

      • Mime type: (Text) The mime type of the attachment.

      • File location URL: (Text) The URL to where the attachment is located.

    • ID: (Text) Xero generated unique identifier for invoice.

    • Contact: (Object) Details for the contact.

      • ID: (Text) Xero identifier for the contact.

      • Full name: (Text) Full name of contact/organization.

    • Credit notes: (Collection) The details of each credit note.

      • Applied amount: (Decimal) The total applied to the invoice.

      • ID: (Text) Xero generated unique identifier for the credit note.

      • Number: (Text) Unique alpha numeric code identifying credit note.

      • Issued date: (Date) The date the credit note is issued YYYY-MM-DD.

      • Total: (Decimal) The total of the credit note (subtotal + total tax).

    • Currency code: (Text) The currency that invoice has been raised in.

    • Currency rate: (Decimal) The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used.

    • Due date: (Date) Date the invoice is due to be paid YYYY-MM-DD".

    • Expected payment date: (Date) Shown on sales invoices (Accounts Receivable) when this has been set.

    • Fully paid on date: (Date) The date the invoice was fully paid. Only returned on fully paid invoices.

    • Has attachment: (Boolean) Indicates if an invoice has an attachment.

    • Number: (Text) User defined alphanumeric code for identifying invoices.

    • Types: (Text) Shows the tax state of the line amounts: inclusive, exclusive, or no tax.

    • Line items: (Collection) Collection of line item details.

      • ID: (Text) The Xero generated identifier for a line item.

      • Account code: (Text) The account that the line item is being coded to.

      • Description: (Text) The description of the line item.

      • Discount rate: (Decimal) Percentage discount being applied to a line item.

      • Code: (Text) Code of the item.

      • Amount: (Decimal) The line amount reflects the discounted price if a DiscountRate has been used.

      • Quantity: (Decimal) Line item quantity.

      • Tax amount: (Decimal) The tax amount is auto calculated as a percentage of the line amount based on the tax rate.

      • Tax type: (Text) Used as an override if the default tax code for the selected <AccountCode> is not correct.

      • Tracking: (Object) The object containing the collection of tracking details.

        • Tracking: (Collection) The collection of tracking details.

          • ID: (Text) The identifier for the tracking category.

          • Name: (Text) The name of the tracking category.

          • Option: (Text) The name of the tracking option.

      • Unit amount: (Decimal) Line item unit amount.

    • Overpayments: (Collection) The collection of overpayment details.

      • ID: (Text) Xero generated unique identifier.

      • Amount: (Decimal) The total applied to the invoice.

      • Date: (Date) The date the overpayment was made YYYY-MM-DD.

      • Total: (Decimal) The total of the Overpayment (subtotal + total tax).

    • Payments: (Collection) The collection of payment details.

      • ID: (Text) The Xero identifier for an Payment.

      • Amount: (Decimal) The amount of the payment.

      • Date: (Date) Date the payment is being made (YYYY-MM-DD).

    • Planned payment date: (Date) Shown on bills (Accounts Payable) when this has been set.

    • Prepayments: (Collection) The collection of details for prepayments.

      • ID: (Text) Xero generated unique identifier.

      • Amount: (Decimal) The total applied to the invoice.

      • Date: (Date) The date the prepayment is issued YYYY-MM-DD.

      • Total: (Decimal) The total of the Prepayment (subtotal + total tax).

    • Reference: (Text) Additional reference number.

    • Send to contact: (Boolean) Whether the invoice in the Xero app should be marked as “sent”. This can only be set on invoices that have been approved.

    • Status: (Text) The status of the invoice. Values can be:

      • Draft
      • Submitted
      • Authorized
      • Paid
      • Voided
      • Deleted

    • Subtotal: (Decimal) Total of invoice excluding taxes.

    • Total: (Decimal) Total of Invoice tax inclusive.

    • Total discount: (Decimal) Total of discounts applied on the invoice line items.

    • Total tax: (Decimal) Total tax on the invoice.

    • Type: (Text) ACCREC (for sales) or ACCPAY (for bills).

    • URL: (Text) URL link to a source document.

 Object