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