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