Xero
Common Model Sync Frequencies
Accessed third-party endpoints
Merge interacts with Xero API endpoints to access certain information as detailed below.
API Endpoints
GET/2.0/Payments
Merge interacts with this API endpoint to...
Access Payment information
Payment fields
transaction_dateDateTime (ISO 8601)
typeEnum
credit_noteUnknown
remote_dataArray
total_amountNumber
remote_updated_atDateTime (ISO 8601)
accountUUID
currencyEnum
contactUUID
invoiceUnknown
exchange_rateString
remote_idString
Access PaymentLineItem information
PaymentLineItem fields
credit_noteUnknown
applied_amountString
paymentUnknown
applied_dateDateTime (ISO 8601)
invoiceUnknown
GET/2.0/Invoices
Merge interacts with this API endpoint to...
Access Invoice information
Invoice fields
total_discountNumber
statusEnum
total_amountNumber
contactUUID
exchange_rateString
remote_idString
typeEnum
inclusive_of_taxBoolean
currencyEnum
memoString
numberString
remote_updated_atDateTime (ISO 8601)
balanceNumber
sub_totalNumber
total_tax_amountNumber
issue_dateDateTime (ISO 8601)
remote_dataArray
paid_on_dateDateTime (ISO 8601)
due_dateDateTime (ISO 8601)
Access InvoiceLineItem information
InvoiceLineItem fields
quantityNumber
unit_priceNumber
descriptionString
remote_dataUnknown
total_amountNumber
accountUUID
tax_rateUUID
remote_idString
itemUUID
invoiceUnknown
GET/2.0/Invoices/{invoice_id}/Attachments
Merge interacts with this API endpoint to...
Access AccountingAttachment information
AccountingAttachment fields
file_urlString
remote_dataArray
remote_idString
file_nameString
GET/2.0/Journals
Merge interacts with this API endpoint to...
Access JournalLine information
JournalLine fields
descriptionString
remote_dataUnknown
journal_entryUnknown
accountUUID
net_amountNumber
tax_rateUUID
remote_idString
Access JournalEntry information
JournalEntry fields
transaction_dateDateTime (ISO 8601)
remote_created_atDateTime (ISO 8601)
remote_dataArray
memoString
journal_numberString
remote_idString
Access GeneralLedgerTransaction information
GeneralLedgerTransaction fields
underlying_transaction_typeEnum
remote_created_atDateTime (ISO 8601)
remote_updated_atDateTime (ISO 8601)
remote_dataArray
posting_dateDateTime (ISO 8601)
underlying_transaction_remote_idString
remote_idString
Access GeneralLedgerTransactionLine information
GeneralLedgerTransactionLine fields
descriptionString
remote_dataUnknown
accountUUID
general_ledger_transactionUnknown
remote_idString
POST/2.0/ManualJournals
Merge interacts with this API endpoint to...
Access JournalLine information
JournalLine fields
tax_rateUUID
descriptionString
net_amountNumber
GET/2.0/PurchaseOrders
Merge interacts with this API endpoint to...
Access PurchaseOrder information
PurchaseOrder fields
vendorUUID
statusEnum
issue_dateDateTime (ISO 8601)
inclusive_of_taxBoolean
remote_dataArray
total_amountNumber
remote_updated_atDateTime (ISO 8601)
currencyEnum
memoString
exchange_rateString
delivery_dateDateTime (ISO 8601)
remote_idString
purchase_order_numberString
Access PurchaseOrderLineItem information
PurchaseOrderLineItem fields
quantityNumber
unit_priceNumber
descriptionString
accountUUID
tax_rateUUID
purchase_orderUnknown
total_line_amountString
tax_amountString
itemUUID
remote_idString
GET/2.0/PurchaseOrders/{purchaseorder_id}/Attachments
Merge interacts with this API endpoint to...
Access AccountingAttachment information
AccountingAttachment fields
file_urlString
remote_dataArray
remote_idString
file_nameString
GET/2.0/BankTransfers
Merge interacts with this API endpoint to...
Access Transaction information
Transaction fields
transaction_dateDateTime (ISO 8601)
exchange_rateString
remote_dataArray
remote_idString
Access TransactionLineItem information
TransactionLineItem fields
transactionUnknown
accountUUID
memoString
exchange_rateString
total_line_amountString
GET/2.0/Contacts/{contact_id}
Merge interacts with this API endpoint to...
Access Contact information
Contact fields
statusEnum
remote_dataArray
nameString
email_addressString
remote_updated_atDateTime (ISO 8601)
tax_numberString
currencyString
is_customerBoolean
is_supplierBoolean
remote_idString
Access AccountingPhoneNumber information
AccountingPhoneNumber fields
numberString
remote_dataUnknown
contactUnknown
Access Address information
Address fields
typeEnum
remote_dataUnknown
street_1String
zip_codeString
contactUnknown
stateUnknown
cityString
street_2String
country_subdivisionString
countryEnum
GET/2.0/{related_object_remote_path}/{related_object_remote_id}/Attachments
Merge interacts with this API endpoint to...
Access AccountingAttachment information
AccountingAttachment fields
file_urlString
remote_dataArray
remote_idString
file_nameString
POST/2.0/Contacts
Merge interacts with this API endpoint to...
Access Contact information
Contact fields
statusEnum
email_addressString
nameString
remote_updated_atDateTime (ISO 8601)
tax_numberString
currencyString
is_customerBoolean
is_supplierBoolean
remote_idString
Access AccountingPhoneNumber information
AccountingPhoneNumber fields
numberString
contactUnknown
Access Address information
Address fields
typeEnum
street_1String
zip_codeString
contactUnknown
cityString
street_2String
country_subdivisionString
countryEnum
PUT/2.0/Contacts
Merge interacts with this API endpoint to...
Access AccountingPhoneNumber information
AccountingPhoneNumber fields
numberString
Access Address information
Address fields
typeEnum
street_1String
zip_codeString
cityString
street_2String
country_subdivisionString
countryEnum
GET/2.0/CreditNotes
Merge interacts with this API endpoint to...
Access CreditNote information
CreditNote fields
transaction_dateDateTime (ISO 8601)
typeUnknown
statusEnum
inclusive_of_taxBoolean
remote_dataArray
total_amountNumber
remote_created_atDateTime (ISO 8601)
remote_updated_atDateTime (ISO 8601)
currencyEnum
contactUUID
remaining_creditNumber
exchange_rateString
numberString
remote_idString
Access CreditNoteApplyLine information
CreditNoteApplyLine fields
credit_noteUnknown
remote_dataUnknown
applied_amountUnknown
applied_dateUnknown
invoiceUnknown
remote_idUnknown
Access CreditNoteLineItem information
CreditNoteLineItem fields
quantityString
unit_priceString
credit_noteUnknown
descriptionString
remote_dataUnknown
total_line_amountString
accountUUID
tax_rateUUID
itemUUID
remote_idString
Access VendorCredit information
VendorCredit fields
vendorUUID
transaction_dateDateTime (ISO 8601)
inclusive_of_taxBoolean
remote_dataArray
total_amountNumber
currencyEnum
exchange_rateString
numberString
remote_idString
Access VendorCreditApplyLine information
VendorCreditApplyLine fields
remote_dataUnknown
applied_amountUnknown
applied_dateUnknown
invoiceUnknown
vendor_creditUnknown
remote_idUnknown
Access VendorCreditLine information
VendorCreditLine fields
descriptionString
accountUUID
net_amountNumber
vendor_creditUnknown
tax_rateUUID
remote_idString
GET/2.0/CreditNotes/{creditnote_id}/Attachments
Merge interacts with this API endpoint to...
Access AccountingAttachment information
AccountingAttachment fields
file_urlString
remote_dataArray
remote_idString
file_nameString
GET/2.0/Invoices/{invoice_id}
Merge interacts with this API endpoint to...
Access Invoice information
Invoice fields
total_discountNumber
typeEnum
statusEnum
issue_dateDateTime (ISO 8601)
remote_dataArray
total_amountNumber
remote_updated_atDateTime (ISO 8601)
currencyEnum
paid_on_dateDateTime (ISO 8601)
contactUUID
memoString
balanceNumber
due_dateDateTime (ISO 8601)
exchange_rateString
total_tax_amountNumber
sub_totalNumber
numberString
remote_idString
Access InvoiceLineItem information
InvoiceLineItem fields
quantityNumber
unit_priceNumber
descriptionString
remote_dataUnknown
total_amountNumber
accountUUID
invoiceUnknown
itemUUID
remote_idString
Access PaymentLineItem information
PaymentLineItem fields
applied_dateDateTime (ISO 8601)
Access Payment information
Payment fields
currencyEnum
remote_idString
GET/2.0/Payments/{payment_id}
Merge interacts with this API endpoint to...
Access PaymentLineItem information
PaymentLineItem fields
credit_noteUnknown
paymentUnknown
invoiceUnknown
applied_amountString
Access Payment information
Payment fields
typeEnum
remote_dataArray
total_amountNumber
remote_updated_atDateTime (ISO 8601)
accountUUID
contactUUID
exchange_rateString
GET/2.0/Employees
Merge interacts with this API endpoint to...
Access Employee information
Employee fields
statusEnum
remote_dataArray
last_nameString
first_nameString
remote_idString
PUT/2.0/CreditNotes
Merge interacts with this API endpoint to...
Access VendorCreditLine information
VendorCreditLine fields
tax_rateUUID
descriptionString
remote_idString
net_amountNumber
Access CreditNoteLineItem information
CreditNoteLineItem fields
quantityString
unit_priceString
descriptionString
total_line_amountString
tax_rateUUID
itemUUID
remote_idString
Access CreditNote information
CreditNote fields
remote_idString
PUT/2.0/CreditNotes/{credit_note_id}/Allocations
Merge interacts with this API endpoint to...
Access VendorCreditApplyLine information
VendorCreditApplyLine fields
remote_idUnknown
applied_dateUnknown
invoiceUnknown
applied_amountUnknown
Access CreditNoteApplyLine information
CreditNoteApplyLine fields
remote_idUnknown
applied_dateUnknown
invoiceUnknown
applied_amountUnknown
GET/2.0/CreditNotes/{credit_note_id}
Merge interacts with this API endpoint to...
Access CreditNote information
CreditNote fields
remaining_creditNumber
statusEnum
remote_updated_atDateTime (ISO 8601)
remote_idString
Access CreditNoteApplyLine information
CreditNoteApplyLine fields
credit_noteUnknown
applied_amountUnknown
applied_dateUnknown
invoiceUnknown
remote_idUnknown
Access VendorCredit information
VendorCredit fields
remote_idString
Access VendorCreditApplyLine information
VendorCreditApplyLine fields
applied_amountUnknown
applied_dateUnknown
invoiceUnknown
vendor_creditUnknown
remote_idUnknown
GET/1.0/FeedConnections
Merge interacts with this API endpoint to...
Access BankFeedAccount information
BankFeedAccount fields
source_account_idString
remote_dataArray
target_account_nameString
currencyEnum
target_account_idString
account_typeEnum
remote_idString
GET/2.0/Contacts
Merge interacts with this API endpoint to...
Access Contact information
Contact fields
statusEnum
remote_dataArray
nameString
email_addressString
remote_updated_atDateTime (ISO 8601)
tax_numberString
currencyString
is_customerBoolean
is_supplierBoolean
remote_idString
Access AccountingPhoneNumber information
AccountingPhoneNumber fields
numberString
remote_dataUnknown
contactUnknown
Access Address information
Address fields
remote_dataUnknown
street_1String
zip_codeString
contactUnknown
stateUnknown
cityString
street_2String
countryEnum
PUT/2.0/Invoices
Merge interacts with this API endpoint to...
Access InvoiceLineItem information
InvoiceLineItem fields
quantityNumber
unit_priceNumber
descriptionString
total_amountNumber
accountUUID
tax_rateUUID
itemUUID
remote_idString
Access Contact information
Contact fields
remote_idString
POST/2.0/Invoices
Merge interacts with this API endpoint to...
Access Invoice information
Invoice fields
typeEnum
statusEnum
issue_dateDateTime (ISO 8601)
remote_updated_atDateTime (ISO 8601)
total_amountNumber
currencyEnum
contactUUID
memoString
balanceNumber
due_dateDateTime (ISO 8601)
exchange_rateString
total_tax_amountNumber
sub_totalNumber
numberString
remote_idString
Access InvoiceLineItem information
InvoiceLineItem fields
quantityNumber
unit_priceNumber
descriptionString
total_amountNumber
accountUUID
invoiceUnknown
itemUUID
remote_idString
GET/2.0/Accounts
Merge interacts with this API endpoint to...
Access Account information
Account fields
account_numberString
typeString
statusEnum
descriptionString
remote_dataArray
nameString
currencyEnum
classificationEnum
account_typeEnum
remote_idString
GET/2.0/Accounts/{account_id}/Attachments
Merge interacts with this API endpoint to...
Access AccountingAttachment information
AccountingAttachment fields
file_urlString
remote_dataArray
remote_idString
file_nameString
GET/2.0/Item
Merge interacts with this API endpoint to...
Access Item information
Item fields
typeEnum
unit_priceNumber
sales_accountUUID
remote_dataArray
nameString
remote_updated_atDateTime (ISO 8601)
purchase_priceNumber
purchase_accountUUID
remote_idString
POST/2.0/Items
Merge interacts with this API endpoint to...
Access Item information
Item fields
typeEnum
unit_priceNumber
sales_accountUUID
remote_updated_atDateTime (ISO 8601)
nameString
purchase_priceNumber
purchase_accountUUID
remote_idString
POST/2.0/CreditNotes
Merge interacts with this API endpoint to...
Access CreditNote information
CreditNote fields
transaction_dateDateTime (ISO 8601)
typeUnknown
statusEnum
inclusive_of_taxBoolean
remote_created_atDateTime (ISO 8601)
total_amountNumber
remote_updated_atDateTime (ISO 8601)
currencyEnum
remaining_creditNumber
exchange_rateString
numberString
remote_idString
Access CreditNoteLineItem information
CreditNoteLineItem fields
quantityString
unit_priceString
credit_noteUnknown
descriptionString
total_line_amountString
accountUUID
tax_rateUUID
itemUUID
remote_idString
Access VendorCredit information
VendorCredit fields
transaction_dateDateTime (ISO 8601)
inclusive_of_taxBoolean
total_amountNumber
currencyEnum
exchange_rateString
numberString
remote_idString
Access VendorCreditLine information
VendorCreditLine fields
descriptionString
accountUUID
net_amountNumber
vendor_creditUnknown
tax_rateUUID
remote_idString
POST/2.0/BankTransactions
Merge interacts with this API endpoint to...
Access ExpenseLine information
ExpenseLine fields
quantityString
unit_priceString
descriptionString
accountUUID
net_amountNumber
tax_rateUUID
itemUUID
remote_idString
GET/2.0/BankTransactions
Merge interacts with this API endpoint to...
Access Expense information
Expense fields
transaction_dateDateTime (ISO 8601)
inclusive_of_taxBoolean
remote_dataArray
total_amountNumber
accountUUID
currencyEnum
contactUUID
memoString
exchange_rateString
total_tax_amountNumber
sub_totalNumber
remote_idString
Access ExpenseLine information
ExpenseLine fields
quantityString
unit_priceString
descriptionString
expenseUnknown
accountUUID
net_amountNumber
tax_rateUUID
itemUUID
remote_idString
PUT/2.0/Payments
Merge interacts with this API endpoint to...
Access Invoice information
Invoice fields
statusEnum
remote_updated_atDateTime (ISO 8601)
paid_on_dateDateTime (ISO 8601)
balanceNumber
remote_idString
Access PaymentLineItem information
PaymentLineItem fields
credit_noteUnknown
applied_dateDateTime (ISO 8601)
invoiceUnknown
applied_amountString
Access CreditNote information
CreditNote fields
remaining_creditNumber
transaction_dateDateTime (ISO 8601)
remote_updated_atDateTime (ISO 8601)
remote_idString
GET/2.0/Reports/BalanceSheet
Merge interacts with this API endpoint to...
Access BalanceSheet information
BalanceSheet fields
remote_generated_atDateTime (ISO 8601)
dateDateTime (ISO 8601)
remote_dataArray
nameString
Access ReportItem information
ReportItem fields
parent_itemUnknown
balance_sheetUnknown
typeUnknown
nameString
valueNumber
remote_idString
GET/2.0/TrackingCategories
Merge interacts with this API endpoint to...
Access TrackingCategory information
TrackingCategory fields
statusEnum
remote_dataUnknown
category_typeEnum
nameString
remote_idString
GET/2.0/Reports/ProfitAndLoss
Merge interacts with this API endpoint to...
Access IncomeStatement information
IncomeStatement fields
end_periodDateTime (ISO 8601)
remote_dataArray
nameString
start_periodDateTime (ISO 8601)
net_incomeNumber
gross_profitNumber
net_operating_incomeNumber
Access ReportItem information
ReportItem fields
parent_itemUnknown
typeUnknown
income_statementUnknown
nameString
remote_idString
GET/2.0/Organisations
Merge interacts with this API endpoint to...
Access CompanyInfo information
CompanyInfo fields
remote_created_atDateTime (ISO 8601)
remote_dataArray
nameString
tax_numberString
fiscal_year_end_dayInteger
fiscal_year_end_monthInteger
currencyEnum
legal_nameString
remote_idString
Access Address information
Address fields
remote_dataUnknown
street_1String
zip_codeString
stateUnknown
cityString
street_2String
countryEnum
company_infoUnknown
Access AccountingPhoneNumber information
AccountingPhoneNumber fields
typeString
numberString
remote_dataUnknown
company_infoUnknown
GET/2.0/TaxRate
Merge interacts with this API endpoint to...
Access TaxRate information
TaxRate fields
statusEnum
descriptionString
remote_dataArray
nameString
effective_tax_rateNumber
codeString
total_tax_rateNumber
remote_idString
Access TaxComponent information
TaxComponent fields
is_compoundBoolean
remote_dataUnknown
nameString
rateString
tax_rateUnknown