SureXeroLite (Independent Publisher) (Preview)
Unlock the power of a versatile connector designed for effortless setup and seamless integration into your preferred business applications. With this connector, you can effortlessly generate invoices, manage customers and products, and effortlessly access invoice details, creating a smooth and efficient workflow.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | 848 Support |
| URL | https://service.nowplatform.co/csm |
| support@848.co |
| Connector Metadata | |
|---|---|
| Publisher | The 848 Group |
| Website | https://www.xero.com |
| Privacy policy | https://www.xero.com/uk/legal/privacy |
| Categories | Productivity;Finance |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Add a new contact |
This action allows you to add a new contact in Xero |
| Add a new invoice |
This action allows you to add a new invoice in Xero |
| List contacts |
This action allows you to list the contacts from Xero that match the selected options |
| List invoices |
This action allows you to list the invoices from Xero that match the selected options |
| Xero sign in |
Log in to your Xero account to get started |
Add a new contact
This action allows you to add a new contact in Xero
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Xero Tenant ID
|
xero-tenant-id | True | string |
Xero Tenant ID |
|
Name
|
Name | True | string |
Full name of contact/organisation |
|
First Name
|
FirstName | string |
Primary contact first name |
|
|
Last Name
|
LastName | string |
Primary contact last name |
|
|
Email Address
|
EmailAddress | string |
Primary contact email address |
|
|
Accounts Receivable Tax Type
|
AccountsReceivableTaxType | string |
Default tax type used for contact on AR invoices |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Contacts
|
Contacts | array of object |
Contacts |
|
Contact ID
|
Contacts.ContactID | string |
Xero identifier |
|
Contact Number
|
Contacts.ContactNumber | string |
Number to identify contacts in external systems |
|
Contact Status
|
Contacts.ContactStatus | string |
Current status of a contact |
|
Name
|
Contacts.Name | string |
Full name of contact/organisation |
|
First Name
|
Contacts.FirstName | string |
Primary contact first name |
|
Last Name
|
Contacts.LastName | string |
Primary contact last name |
|
Email Address
|
Contacts.EmailAddress | string |
Primary contact email address |
|
Bank Account Details
|
Contacts.BankAccountDetails | string |
Bank account number of contact |
|
Addresses
|
Contacts.Addresses | array of object |
Addresses for a contact |
|
AddressType
|
Contacts.Addresses.AddressType | string |
Address Type |
|
City
|
Contacts.Addresses.City | string |
City |
|
Region
|
Contacts.Addresses.Region | string |
Region |
|
PostalCode
|
Contacts.Addresses.PostalCode | string |
Postal Code |
|
Country
|
Contacts.Addresses.Country | string |
Country |
|
Phones
|
Contacts.Phones | array of object |
Phones for a contact |
|
PhoneType
|
Contacts.Phones.PhoneType | string |
Phone Type |
|
PhoneNumber
|
Contacts.Phones.PhoneNumber | string |
Phone Number |
|
PhoneAreaCode
|
Contacts.Phones.PhoneAreaCode | string |
Phone Area Code |
|
PhoneCountryCode
|
Contacts.Phones.PhoneCountryCode | string |
Phone Country Code |
|
|
Contacts.UpdatedDateUTC | string |
Updated Date UTC |
|
ContactPersons
|
Contacts.ContactPersons | array of object |
Additonal contact people |
|
First Name
|
Contacts.ContactPersons.FirstName | string |
Additional contact person first name |
|
Last Name
|
Contacts.ContactPersons.LastName | string |
Additonal contact person last name |
|
Email Address
|
Contacts.ContactPersons.EmailAddress | string |
Additonal contact person email address |
Add a new invoice
This action allows you to add a new invoice in Xero
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Xero tenant id
|
xero-tenant-id | True | string |
Xero Tenant Id |
|
Date
|
Date | string |
Date invoice was issued – YYYY-MM-DD |
|
|
Due Date
|
DueDate | string |
Date invoice is due – YYYY-MM-DD |
|
|
Invoice Type
|
Type | True | string |
Invoice Type (ACCREC - a sales invoice or customer invoice, ACCPAY-a bill or supplier invoice) |
|
Additional Reference Number
|
Reference | string |
ACCREC only – additional reference number |
|
|
Contact ID
|
ContactID | True | string |
Xero identifier (unique within organisations) |
|
Line Amount Types
|
LineAmountTypes | string |
Line amounts are exclusive of tax by default if you don't specify this element. (Exclusive, Inclusive, NoTax). |
|
|
Invoice Number
|
InvoiceNumber | string |
Unique alpha numeric code identifying invoice |
|
|
Line Item Description
|
Description | True | string |
Line Item Description |
|
Line Item Quantity
|
Quantity | True | number |
Line Item Quantity |
|
Line Item Unit Amount
|
UnitAmount | True | number |
Line Item Unit Amount |
|
Line Item Account Code
|
AccountCode | string |
Customer defined alpha numeric account code e.g 200 or SALES |
|
|
Discount Rate
|
DiscountRate | number |
Percentage discount or discount amount being applied to a line item. |
|
|
Currency Code
|
CurrencyCode | string |
The currency that invoice has been raised in |
|
|
Currency Rate
|
CurrencyRate | number |
The currency rate for a multicurrency invoice |
|
|
Invoice Status
|
Status | string |
Invoice status (DRAFT, SUBMITTED, AUTHORISED) |
|
|
Expected Payment Date
|
ExpectedPaymentDate | string |
Shown on sales invoices (Accounts Receivable) when this has been set |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Invoices
|
Invoices | array of object |
Invoices |
|
Contact ID
|
Invoices.Contact.ContactID | string |
Xero Contact identifier |
|
Name
|
Invoices.Contact.Name | string |
Full name of contact/organisation |
|
Date
|
Invoices.Date | string |
Date invoice was issued – YYYY-MM-DD |
|
Due Date
|
Invoices.DueDate | string |
Date invoice is due – YYYY-MM-DD |
|
Invoice Status
|
Invoices.Status | string |
Invoice status (DRAFT, SUBMITTED, AUTHORISED) |
|
Line Amount Types
|
Invoices.LineAmountTypes | string |
Line Amount Types(Exclusive, Inclusive, NoTax) |
|
LineItems
|
Invoices.LineItems | array of object |
LineItems |
|
Description
|
Invoices.LineItems.Description | string |
Line Item Description |
|
Unit Amount
|
Invoices.LineItems.UnitAmount | number |
Lineitem unit amount |
|
Tax Type
|
Invoices.LineItems.TaxType | string |
Used as an override if the default Tax Code for the selected AccountCode is not correct |
|
Tax Amount
|
Invoices.LineItems.TaxAmount | number |
The tax amount is auto calculated as a percentage of the line amount (see below) based on the tax rate. |
|
Line Amount
|
Invoices.LineItems.LineAmount | number |
The line amount reflects the discounted price if a DiscountRate has been used |
|
Account Code
|
Invoices.LineItems.AccountCode | string |
Customer defined alpha numeric account code e.g 200 or SALES |
|
Account Id
|
Invoices.LineItems.AccountId | string |
Xero Account identifier (unique within organisations) |
|
Quantity
|
Invoices.LineItems.Quantity | number |
LineItem Quantity |
|
LineItem ID
|
Invoices.LineItems.LineItemID | string |
The Xero generated identifier for a LineItem |
|
Sub Total
|
Invoices.SubTotal | number |
Total of invoice excluding taxes |
|
Total Tax
|
Invoices.TotalTax | number |
Total tax on invoice |
|
Total
|
Invoices.Total | number |
Total of Invoice tax inclusive (i.e. SubTotal + TotalTax) |
|
Updated Date UTC
|
Invoices.UpdatedDateUTC | string |
Last modified date UTC format |
|
Currency Code
|
Invoices.CurrencyCode | string |
The currency that invoice has been raised in |
|
|
Invoices.Type | string |
Invoice Type |
|
Invoice ID
|
Invoices.InvoiceID | string |
Xero generated identifier for invoice (unique within organisations) |
|
Invoice Number
|
Invoices.InvoiceNumber | string |
Unique alpha numeric code identifying invoice |
|
Amount Due
|
Invoices.AmountDue | number |
Amount remaining to be paid on invoice |
|
Amount Paid
|
Invoices.AmountPaid | number |
Sum of payments received for invoice |
|
Amount Credited
|
Invoices.AmountCredited | number |
Sum of all credit notes, over-payments and pre-payments applied to invoice |
|
Currency Rate
|
Invoices.CurrencyRate | number |
The currency rate for a multicurrency invoice |
List contacts
This action allows you to list the contacts from Xero that match the selected options
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Where Filter
|
where | string |
Filter, for example Name="ABC limited" |
|
|
Filter on ContactIDs
|
IDs | string |
Filter on a comma separated list of ContactIDs |
|
|
A smaller lightweight response
|
summaryOnly | boolean |
Retrieve a smaller version of the response object. |
|
|
Pagination
|
page | integer |
Retrieving a collection of invoices using paging |
|
|
Include Archived
|
includeArchived | boolean |
Contacts with a status of ARCHIVED will be included in the response |
|
|
Search Term
|
searchTerm | string |
Search parameter that performs a case-insensitive text search across the field (Name, FirstName, LastName, ContactNumber, CompanyNumber, EmailAddress) |
|
|
Xero Tenant Id
|
xero-tenant-id | True | string |
Specify Xero tenant id |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Contacts
|
Contacts | array of object |
Contacts |
|
Contact Id
|
Contacts.ContactID | string |
Xero identifier (unique within organisations) |
|
Contact Number
|
Contacts.ContactNumber | string |
This field is read only in the Xero UI, used to identify contacts in external systems. It is displayed as Contact Code in the Contacts UI in Xero. |
|
Contact Status
|
Contacts.ContactStatus | string |
Current status of a contact |
|
Name
|
Contacts.Name | string |
Full name of contact/organisation |
|
First Name
|
Contacts.FirstName | string |
First name of contact person |
|
Last Name
|
Contacts.LastName | string |
Last name of contact person |
|
Email Address
|
Contacts.EmailAddress | string |
Email address of contact person |
|
Bank Account Details
|
Contacts.BankAccountDetails | string |
Bank account number of contact |
|
Addresses
|
Contacts.Addresses | array of object |
Addresses |
|
AddressType
|
Contacts.Addresses.AddressType | string |
Address Type |
|
City
|
Contacts.Addresses.City | string |
City |
|
Region
|
Contacts.Addresses.Region | string |
Region |
|
PostalCode
|
Contacts.Addresses.PostalCode | string |
Postal Code |
|
Country
|
Contacts.Addresses.Country | string |
Country |
|
AttentionTo
|
Contacts.Addresses.AttentionTo | string |
Attention To |
|
Phones
|
Contacts.Phones | array of object |
Phones |
|
PhoneType
|
Contacts.Phones.PhoneType | string |
Phone Type |
|
PhoneNumber
|
Contacts.Phones.PhoneNumber | string |
Phone Number |
|
PhoneAreaCode
|
Contacts.Phones.PhoneAreaCode | string |
Phone Area Code |
|
PhoneCountryCode
|
Contacts.Phones.PhoneCountryCode | string |
Phone Country Code |
|
Updated Date UTC
|
Contacts.UpdatedDateUTC | string |
UTC timestamp of last update to contact |
|
ContactPersons
|
Contacts.ContactPersons | array of object |
Additonal contact people |
|
First Name
|
Contacts.ContactPersons.FirstName | string |
Additional contact person first name |
|
Last Name
|
Contacts.ContactPersons.LastName | string |
Additonal contact person last name |
|
Email Address
|
Contacts.ContactPersons.EmailAddress | string |
Additonal contact person email address |
List invoices
This action allows you to list the invoices from Xero that match the selected options
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Xero tenant id
|
xero-tenant-id | True | string |
Xero tenant id |
|
Where Filter
|
where | string |
Filter, for example Type=="ACCPAY" AND Status=="AUTHORISED" |
|
|
Filter on Statuses
|
Statuses | string |
Filter on a comma separated list of statuses. for example- AUTHORISED, DRAFT |
|
|
Filter on IDs
|
IDs | string |
Filter on a comma separated list of IDs |
|
|
Filter on invoice numbers
|
InvoiceNumbers | string |
Filter on a comma separated list of invoice number. |
|
|
Filter on contact ids
|
ContactIDs | string |
Filter on a comma separated list of contact ids. |
|
|
A smaller lightweight response
|
summaryOnly | boolean |
Retrieve a smaller version of the response object. |
|
|
Pagination
|
page | integer |
Retrieving a collection of invoices using paging |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Invoices
|
Invoices | array of object |
Invoices |
|
Contact ID
|
Invoices.Contact.ContactID | string |
Xero Contact identifier |
|
Name
|
Invoices.Contact.Name | string |
Full name of contact/organisation |
|
Date
|
Invoices.Date | string |
Date invoice was issued – YYYY-MM-DD |
|
Due Date
|
Invoices.DueDate | string |
Date invoice is due – YYYY-MM-DD |
|
Invoice Status
|
Invoices.Status | string |
Invoice status (DRAFT, SUBMITTED, AUTHORISED) |
|
Line Amount Types
|
Invoices.LineAmountTypes | string |
Line Amount Types(Exclusive, Inclusive, NoTax) |
|
LineItems
|
Invoices.LineItems | array of object |
LineItems |
|
Description
|
Invoices.LineItems.Description | string |
Line Item Description |
|
Unit Amount
|
Invoices.LineItems.UnitAmount | number |
Lineitem unit amount |
|
Tax Type
|
Invoices.LineItems.TaxType | string |
Used as an override if the default Tax Code for the selected AccountCode is not correct |
|
Tax Amount
|
Invoices.LineItems.TaxAmount | number |
The tax amount is auto calculated as a percentage of the line amount (see below) based on the tax rate. |
|
Line Amount
|
Invoices.LineItems.LineAmount | number |
The line amount reflects the discounted price if a DiscountRate has been used |
|
Account Code
|
Invoices.LineItems.AccountCode | string |
Customer defined alpha numeric account code e.g 200 or SALES |
|
Account Id
|
Invoices.LineItems.AccountId | string |
Xero Account identifier (unique within organisations) |
|
Quantity
|
Invoices.LineItems.Quantity | number |
LineItem Quantity |
|
LineItem ID
|
Invoices.LineItems.LineItemID | string |
The Xero generated identifier for a LineItem |
|
Sub Total
|
Invoices.SubTotal | number |
Total of invoice excluding taxes |
|
Total Tax
|
Invoices.TotalTax | number |
Total tax on invoice |
|
Total
|
Invoices.Total | number |
Total of Invoice tax inclusive (i.e. SubTotal + TotalTax) |
|
Updated Date UTC
|
Invoices.UpdatedDateUTC | string |
Last modified date UTC format |
|
Currency Code
|
Invoices.CurrencyCode | string |
The currency that invoice has been raised in |
|
|
Invoices.Type | string |
Invoice Type |
|
Invoice ID
|
Invoices.InvoiceID | string |
Xero generated identifier for invoice (unique within organisations) |
|
Invoice Number
|
Invoices.InvoiceNumber | string |
Unique alpha numeric code identifying invoice |
|
Amount Due
|
Invoices.AmountDue | number |
Amount remaining to be paid on invoice |
|
Amount Paid
|
Invoices.AmountPaid | number |
Sum of payments received for invoice |
|
Amount Credited
|
Invoices.AmountCredited | number |
Sum of all credit notes, over-payments and pre-payments applied to invoice |
|
Currency Rate
|
Invoices.CurrencyRate | number |
The currency rate for a multicurrency invoice |
|
Fully Paid On Date
|
Invoices.FullyPaidOnDate | string |
The date the invoice was fully paid |
|
Payments
|
Invoices.Payments | array of object |
Payments |
|
Batch Payment ID
|
Invoices.Payments.BatchPaymentID | string |
Present if the payment was created as part of a batch |
|
Payment ID
|
Invoices.Payments.PaymentID | string |
Xero generated identifier for payment (unique within organisations) |
|
Date
|
Invoices.Payments.Date | string |
Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06 |
|
Amount
|
Invoices.Payments.Amount | number |
The amount of the payment |
|
Currency Rate
|
Invoices.Payments.CurrencyRate | number |
Exchange rate when payment is received |
Xero sign in
Log in to your Xero account to get started
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string |
Id |
|
authEventId
|
authEventId | string |
Auth Event Id |
|
tenantId
|
tenantId | string |
Xero tenant Id |
|
tenantType
|
tenantType | string |
Tenant Type |
|
tenantName
|
tenantName | string |
Tenant Name |
|
createdDateUtc
|
createdDateUtc | string |
Created Date UTC |
|
updatedDateUtc
|
updatedDateUtc | string |
Updated Date UTC |