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