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