Xero

Node: xero · Full type: n8n-nodes-base.xero · Version: 1

Credentials

xeroOAuth2Api (alias: @xero)

CREDENTIAL @xero = xeroOAuth2Api "My Xero"

Operations

Resource: contact

create

Parameter	Type	Default	Details
organizationId	options	""	required
name	string	""	required
additionalFields	collection	{}	keys: accountNumber, addressesUi, bankAccountDetails, contactNumber, contactStatus, defaultCurrency, ...

get

Parameter	Type	Default	Details
organizationId	options	""	required
contactId	string	""	required

getAll

Parameter	Type	Default	Details
organizationId	options	""	required
returnAll	boolean	false
limit	number	100
options	collection	{}	keys: includeArchived, orderBy, sortOrder, where

update

Parameter	Type	Default	Details
organizationId	options	""	required
contactId	string	""	required
updateFields	collection	{}	keys: accountNumber, addressesUi, bankAccountDetails, contactNumber, contactStatus, defaultCurrency, ...

Resource: invoice

create

Parameter	Type	Default	Details
organizationId	options	""	required
type	options	""	required; ACCPAY, ACCREC
contactId	string	""	required
lineItemsUi	fixedCollection	{}	groups: lineItemsValues
additionalFields	collection	{}	keys: brandingThemeId, currency, currencyRate, date, dueDate, expectedPaymentDate, ...

get

Parameter	Type	Default	Details
organizationId	options	""	required
invoiceId	string	""	required

getAll

Parameter	Type	Default	Details
organizationId	options	""	required
returnAll	boolean	false
limit	number	100
options	collection	{}	keys: createdByMyApp, orderBy, sortOrder, statuses, where

update

Parameter	Type	Default	Details
organizationId	options	""	required
invoiceId	string	""	required
updateFields	collection	{}	keys: brandingThemeId, contactId, currency, currencyRate, date, dueDate, ...

Parameter Details

additionalFields children:

Parameter	Type	Default	Details
accountNumber	string	""
addressesUi	fixedCollection	{}	groups: addressesValues
bankAccountDetails	string	""
contactNumber	string	""
contactStatus	options	""	ACTIVE, ARCHIVED, GDPRREQUEST
defaultCurrency	string	""
emailAddress	string	""
firstName	string	""
lastName	string	""
phonesUi	fixedCollection	{}	groups: phonesValues
purchasesDefaultAccountCode	options	""
salesDefaultAccountCode	options	""
skypeUserName	string	""
taxNumber	string	""
xeroNetworkKey	string	""

options children:

Parameter	Type	Default	Details
includeArchived	boolean	false
orderBy	string	""
sortOrder	options	""	ASC, DESC
where	string	""

updateFields children:

Parameter	Type	Default	Details
accountNumber	string	""
addressesUi	fixedCollection	{}	groups: addressesValues
bankAccountDetails	string	""
contactNumber	string	""
contactStatus	options	""	ACTIVE, ARCHIVED, GDPRREQUEST
defaultCurrency	string	""
emailAddress	string	""
firstName	string	""
lastName	string	""
name	string	""
phonesUi	fixedCollection	{}	groups: phonesValues
purchasesDefaultAccountCode	options	""
salesDefaultAccountCode	options	""
skypeUserName	string	""
taxNumber	string	""
xeroNetworkKey	string	""

lineItemsUi children:

lineItemsValues group:

Parameter	Type	Default	Details
description	string	""
quantity	number	1
unitAmount	string	""
itemCode	options	""
accountCode	options	""
taxType	options	""	required; INPUT, NONE, OUTPUT, GSTONIMPORTS
taxAmount	string	""
lineAmount	string	""
discountRate	string	""

Example

NODE "xero" @xero AS "Xero" {
  resource: "contact",
  operation: "get",
  name: {{ $json.name }},
  contactId: {{ $json.contactId }},
  invoiceId: {{ $json.invoiceId }}
}