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