Wiresk

Wiresk

Xero – Contact, Invoice, Payment

Estimated reading time: 3 min

What your automation will do…

A connection to your Xero account is needed so we can sync it with our platform.
Refer to Xero – Connection
You can include between 1 and 255 Methods to build complex Flows.
XERO Xero - Contact, Invoice, Payment
Use this Method to add contacts to a contact group.

Tip: Get ID and Code value (for example Contact ID) from Method “Get Records“, “Find Record” or from Trigger “Get all Records of an Entity“.

See Xero Contact Groups API Reference.

Configuration Table:

Input Options (Field Mapping):

  • Input: Allows dynamic inputs, e.g., from a Trigger or from Step responses. Input tab>uncheck “Show recommended” to see all fields).
  • Default Value: Select value from a defined list or specify a fixed attribute.
  • Manual input: Set a custom value by using the Lightning Bold feature.
Name*Add Contacts
Connection*Select your connection or create one.
MATCHING CRITERIA
Contact Group ID*Unique Identifier of the Contact Group.
Tenant
Available in All entities.		Optionally select a specific Organization (for Xero Account with multiple Organisations).
MAP FIELDS
Contacts*[⊕ Element][⊕ Map] Add a repeating group of fields or Map it from an array. See Field Mapping.

Additional Contact can be added as elements.
Element 1: Represents the first Contact.

Contact ID*: Unique Identifier of the contact to add to the contact group.

(*) required field

Use this Method to remove all contacts from a contact group.

Tip: Get ID and Code value (for example Contact ID) from Method “Get Records“, “Find Record” or from Trigger “Get all Records of an Entity“.

See Xero Contact Groups API Reference.

Configuration Table:

Input Options (Field Mapping):

  • Input: Allows dynamic inputs, e.g., from a Trigger or from Step responses. Input tab>uncheck “Show recommended” to see all fields).
  • Default Value: Select value from a defined list or specify a fixed attribute.
  • Manual input: Set a custom value by using the Lightning Bold feature.
Name*Remove All Contacts
Connection*Select your connection or create one.
MATCHING CRITERIA
Contact Group ID*Unique Identifier of the Contact Group from which all the contacts will be removed.
Tenant
Available in All entities.		Optionally select a specific Organization (for Xero Account with multiple Organisations).

(*) required field

Use this Method to remove 1 contact from a contact group.
 
Tip: Get ID and Code value (for example Contact ID) from Method “Get Records“, “Find Record” or from Trigger “Get all Records of an Entity“.
 
See Xero Contact Groups API Reference. 

Configuration Table:

Input Options (Field Mapping):

  • Input: Allows dynamic inputs, e.g., from a Trigger or from Step responses. Input tab>uncheck “Show recommended” to see all fields).
  • Default Value: Select value from a defined list or specify a fixed attribute.
  • Manual input: Set a custom value by using the Lightning Bold feature.
Name*Remove a Contact
Connection*Select your connection or create one.
MATCHING CRITERIA
Contact Group ID*Unique Identifier of the Contact Group from which all the contacts will be removed.
Contact ID*Unique Identifier of the Contact to remove from the Contact Group.
Tenant Available in All entities.Optionally select a specific Organization (for Xero Account with multiple Organisations).

(*) required field

This Method allows you to send sales invoices via email directly from Xero.
 
▪️ The invoice must be of Type ACCREC and a valid Status for sending (SUBMITTED,AUTHORISED or PAID).
▪️ Invoices go to the main contact and those marked for email.
▪️ The sender is the app connection author. 
▪️ The email uses the organization’s default template (see details on email templates). 
▪️ Xero limits daily invoice emails: 1000 for paid accounts, 20 for trials, including both app and API usage.

Tip: Get ID and Code value (for example Contact ID) from Method “Get Records“, “Find Record” or from Trigger “Get all Records of an Entity“.
 
See Xero Emailling an Invoice API Reference. 

Configuration Table:

Input Options (Field Mapping):

  • Input: Allows dynamic inputs, e.g., from a Trigger or from Step responses. Input tab>uncheck “Show recommended” to see all fields).
  • Default Value: Select value from a defined list or specify a fixed attribute.
  • Manual input: Set a custom value by using the Lightning Bold feature.
Name*Email The Invoice
Connection*Select your connection or create one.
MATCHING CRITERIA
Invoice ID*Unique Identifier of the Invoice to send.
Tenant Available in All entities.Optionally select a specific Organization (for Xero Account with multiple Organisations).

(*) required field

Use this Method to retrieve the online invoice url for sales (ACCREC) invoices.
 
▪️  You cannot retrieve an online invoice url for DRAFT invoices. 

Tip: Get ID and Code value (for example Contact ID) from Method “Get Records“, “Find Record” or from Trigger “Get all Records of an Entity“.
 
See Xero Retrieving the Online Invoice URL API Reference. 

Configuration Table:

Input Options (Field Mapping):

  • Input: Allows dynamic inputs, e.g., from a Trigger or from Step responses. Input tab>uncheck “Show recommended” to see all fields).
  • Default Value: Select value from a defined list or specify a fixed attribute.
  • Manual input: Set a custom value by using the Lightning Bold feature.
Name*Get Online Invoice
Connection*Select your connection or create one.
MATCHING CRITERIA
Invoice ID*Unique Identifier of the Invoice.
Tenant Available in All entities.Optionally select a specific Organization (for Xero Account with multiple Organisations).

(*) required field

Response example of Get Online Invoice 
{
  "OnlineInvoiceUrl": "https://in.xero.com/rX78CnzsBQQWHcpDIzjjijuQvpvmb0FjfGdBeNbZ"
}
Use this Method to apply Multiple Payments to various Invoices (identified by InvoiceID) from various Accounts (identified by AccountID) across various dates.

Tip: Get ID and Code value (for example Contact ID) from Method “Get Records“, “Find Record” or from Trigger “Get all Records of an Entity“.

See Xero Multiple Payments API Reference. 

Configuration Table:

Input Options (Field Mapping):

  • Input: Allows dynamic inputs, e.g., from a Trigger or from Step responses. Input tab>uncheck “Show recommended” to see all fields).
  • Default Value: Select value from a defined list or specify a fixed attribute.
  • Manual input: Set a custom value by using the Lightning Bold feature.
Name*Create Multiple Payments
Connection*Select your connection or create one.
MAP FIELDS [+ Add Field] Select fields from a list, to configure the Payment creation:
Tenant, Payment ID.
Entity*
(Set of data that contain records)		Select the available Entities:
Payment
Batch Payment
Payments*[⊕ Element][⊕ Map] Add a repeating group of fields or Map it from an array. See Field Mapping.Additional payments can be added as elements.
Element 1: Represents the first payment.Invoice ID*: Unique Identifier of the invoice you are applying payment to.
You can Look up the value by select Input > Lookup tab > Select Search button to display a list.

Account ID*: Specify the unique identifier of the account from which the payment will be made, or Look up the value by select Input > Lookup tab > Select Search button to display a list.
Ensure that this account is either a BANK account or has the ‘enable payments’ setting activated.

Amount*: The amount of the payment.

[+ Add Field] add more fields
Date: Date the payment is being made (YYYY-MM-DD).
Reference: An optional description for the payment e.g. Direct Deb
Tenant
Available in All entities.		Optionally select a specific Organization (for Xero Account with multiple Organisations).
Select Input > Lookup tab > Select Search button to display a list.

(*) required field

Example of request from Create Multiple Payments 
{
  "Payments": [
    {
      "Invoice": { "InvoiceID": "96df0dff-43ec-4899-a7d9-e9d63ef12b19" },
      "Account": { "AccountID": "297c2dc5-cc47-4afd-8ec8-74990b8761e9" },
      "Date": "2009-07-13",
      "Amount": 3375.00
    },
    {
      "Invoice": { "InvoiceID": "0a1d0d71-b001-4c71-a260-31e77c9d4a92" },
      "Account": { "AccountID": "a65b0dac-b444-4b41-959b-c1580cd6268f" },
      "Date": "2009-09-01",
      "Amount": 393.75
    },
    {
      "Invoice": { "InvoiceID": "93c9be81-1df4-4338-b5dc-e67a89cd2d7c" },
      "Account": { "AccountID": "a65b0dac-b444-4b41-959b-c1580cd6268f" },
      "Date": "2009-07-21",
      "Amount": 398
    }
  ]
}


After setting up your Flow, you can choose to:

  • “Run once”, your Flow will run only a single time. You can use this function to test your Flow.
  • “Run Scheduler” will automate your Flows with the recurrence rule you previously defined.


For more details, refer to How to run a Flow tutorial in our Help Center.
 
If you are using a Webhook Trigger, the Flow will initiate automatically when a webhook is received from your connected apps. This means that the Flow is automated without a scheduler and will run until you deactivate the Flow manually. Refer to Webhook documentation in our Help Center.

Learn more about Wiresk, explore our user guide.

If you need an integration that you cannot find in Wiresk, you can make a request to our team, and we will try our best to satisfy your needs.