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