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