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