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