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