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_generated_atDateTime (ISO 8601)

nameString

remote_dataArray

dateDateTime (ISO 8601)
Access ReportItem information
ReportItem fields
typeUnknown

valueNumber

remote_idString

parent_itemUnknown

nameString

balance_sheetUnknown
GET/2.0/TrackingCategories
Merge interacts with this API endpoint to...
Access TrackingCategory information
TrackingCategory fields
remote_dataArray

remote_idString

nameString

statusEnum

category_typeEnum
GET/2.0/Payments
Merge interacts with this API endpoint to...
Access Payment information
Payment fields
typeEnum

transaction_dateDateTime (ISO 8601)

invoiceUnknown

accountUUID

remote_dataArray

credit_noteUnknown

contactUUID

remote_idString

remote_updated_atDateTime (ISO 8601)

total_amountNumber

currencyEnum

exchange_rateString
Access PaymentLineItem information
PaymentLineItem fields
paymentUnknown

invoiceUnknown

applied_dateDateTime (ISO 8601)

credit_noteUnknown

applied_amountString
GET/2.0/BankTransactions
Merge interacts with this API endpoint to...
Access Expense information
Expense fields
transaction_dateDateTime (ISO 8601)

accountUUID

remote_dataArray

total_tax_amountNumber

contactUUID

memoString

remote_idString

total_amountNumber

inclusive_of_taxBoolean

sub_totalNumber

currencyEnum

exchange_rateString
Access ExpenseLine information
ExpenseLine fields
itemUUID

expenseUnknown

accountUUID

tax_rateUUID

remote_idString

net_amountNumber

descriptionString
GET/2.0/Invoices
Merge interacts with this API endpoint to...
Access Invoice information
Invoice fields
typeEnum

balanceNumber

total_discountNumber

paid_on_dateDateTime (ISO 8601)

issue_dateDateTime (ISO 8601)

remote_dataArray

total_tax_amountNumber

contactUUID

inclusive_of_taxBoolean

numberString

due_dateDateTime (ISO 8601)

remote_idString

remote_updated_atDateTime (ISO 8601)

currencyEnum

memoString

total_amountNumber

sub_totalNumber

statusEnum

exchange_rateString
Access InvoiceLineItem information
InvoiceLineItem fields
invoiceUnknown

itemUUID

unit_priceNumber

accountUUID

quantityNumber

remote_dataUnknown

tax_rateUUID

remote_idString

total_amountNumber

descriptionString
PUT/2.0/Payments
Merge interacts with this API endpoint to...
Access Invoice information
Invoice fields
remote_updated_atDateTime (ISO 8601)

remote_idString

balanceNumber

paid_on_dateDateTime (ISO 8601)

statusEnum
Access PaymentLineItem information
PaymentLineItem fields
credit_noteUnknown

invoiceUnknown

applied_amountString

applied_dateDateTime (ISO 8601)
Access CreditNote information
CreditNote fields
transaction_dateDateTime (ISO 8601)

remote_idString

remote_updated_atDateTime (ISO 8601)

remaining_creditNumber
GET/2.0/Reports/ProfitAndLoss
Merge interacts with this API endpoint to...
Access IncomeStatement information
IncomeStatement fields
remote_dataArray

net_operating_incomeNumber

gross_profitNumber

net_incomeNumber

end_periodDateTime (ISO 8601)

start_periodDateTime (ISO 8601)

nameString
Access ReportItem information
ReportItem fields
typeUnknown

remote_idString

parent_itemUnknown

nameString

income_statementUnknown
POST/2.0/Invoices
Merge interacts with this API endpoint to...
Access Invoice information
Invoice fields
typeEnum

issue_dateDateTime (ISO 8601)

total_tax_amountNumber

numberString

contactUUID

memoString

due_dateDateTime (ISO 8601)

balanceNumber

remote_idString

sub_totalNumber

total_amountNumber

remote_updated_atDateTime (ISO 8601)

currencyEnum

statusEnum

exchange_rateString
Access InvoiceLineItem information
InvoiceLineItem fields
invoiceUnknown

unit_priceNumber

itemUUID

accountUUID

quantityNumber

remote_idString

total_amountNumber

descriptionString
GET/2.0/Organisations
Merge interacts with this API endpoint to...
Access CompanyInfo information
CompanyInfo fields
fiscal_year_end_monthInteger

remote_dataArray

fiscal_year_end_dayInteger

remote_idString

legal_nameString

currencyEnum

nameString

remote_created_atDateTime (ISO 8601)

tax_numberString
Access Address information
Address fields
street_2String

remote_dataUnknown

company_infoUnknown

countryEnum

zip_codeString

cityString

street_1String

stateUnknown
Access AccountingPhoneNumber information
AccountingPhoneNumber fields
typeString

numberString

company_infoUnknown

remote_dataUnknown
GET/2.0/TaxRate
Merge interacts with this API endpoint to...
Access TaxRate information
TaxRate fields
remote_dataArray

effective_tax_rateNumber

total_tax_rateNumber

codeString

descriptionString

remote_idString

nameString

statusEnum
Access TaxComponent information
TaxComponent fields
remote_dataUnknown

tax_rateUnknown

rateString

nameString

is_compoundBoolean
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
GET/2.0/Contacts
Merge interacts with this API endpoint to...
Access Contact information
Contact fields
remote_dataArray

remote_updated_atDateTime (ISO 8601)

remote_idString

is_customerBoolean

currencyString

email_addressString

is_supplierBoolean

nameString

statusEnum

tax_numberString
Access AccountingPhoneNumber information
AccountingPhoneNumber fields
contactUnknown

numberString

remote_dataUnknown
Access Address information
Address fields
street_2String

remote_dataUnknown

contactUnknown

countryEnum

zip_codeString

cityString

street_1String

stateUnknown
GET/2.0/Contacts/{contact_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/BankTransactions
Merge interacts with this API endpoint to...
Access ExpenseLine information
ExpenseLine fields
itemUUID

accountUUID

remote_idString

tax_rateUUID

net_amountNumber

descriptionString
PUT/2.0/Invoices
Merge interacts with this API endpoint to...
Access InvoiceLineItem information
InvoiceLineItem fields
itemUUID

unit_priceNumber

accountUUID

quantityNumber

remote_idString

tax_rateUUID

total_amountNumber

descriptionString
Access Contact information
Contact fields
remote_idString
GET/2.0/Journals
Merge interacts with this API endpoint to...
Access JournalLine information
JournalLine fields
remote_dataUnknown

accountUUID

journal_entryUnknown

remote_idString

tax_rateUUID

net_amountNumber

descriptionString
Access JournalEntry information
JournalEntry fields
transaction_dateDateTime (ISO 8601)

remote_dataArray

memoString

remote_idString

journal_numberString

remote_created_atDateTime (ISO 8601)
POST/2.0/ManualJournals
Merge interacts with this API endpoint to...
Access JournalLine information
JournalLine fields
descriptionString

tax_rateUUID

net_amountNumber
GET/2.0/CreditNotes
Merge interacts with this API endpoint to...
Access CreditNote information
CreditNote fields
typeUnknown

transaction_dateDateTime (ISO 8601)

remote_dataArray

numberString

contactUUID

remote_idString

inclusive_of_taxBoolean

total_amountNumber

remote_updated_atDateTime (ISO 8601)

remote_created_atDateTime (ISO 8601)

currencyEnum

statusEnum

exchange_rateString

remaining_creditNumber
Access CreditNoteLineItem information
CreditNoteLineItem fields
itemUUID

unit_priceString

accountUUID

quantityString

remote_dataUnknown

total_line_amountString

credit_noteUnknown

remote_idString

tax_rateUUID

descriptionString
Access VendorCredit information
VendorCredit fields
transaction_dateDateTime (ISO 8601)

vendorUUID

remote_dataArray

numberString

remote_idString

inclusive_of_taxBoolean

total_amountNumber

currencyEnum

exchange_rateString
Access VendorCreditLine information
VendorCreditLine fields
accountUUID

vendor_creditUnknown

remote_idString

tax_rateUUID

net_amountNumber

descriptionString
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/PurchaseOrders
Merge interacts with this API endpoint to...
Access PurchaseOrder information
PurchaseOrder fields
issue_dateDateTime (ISO 8601)

purchase_order_numberString

vendorUUID

remote_dataArray

remote_updated_atDateTime (ISO 8601)

remote_idString

memoString

total_amountNumber

inclusive_of_taxBoolean

delivery_dateDateTime (ISO 8601)

currencyEnum

statusEnum

exchange_rateString
Access PurchaseOrderLineItem information
PurchaseOrderLineItem fields
itemUUID

unit_priceNumber

tax_amountString

accountUUID

quantityNumber

total_line_amountString

remote_idString

tax_rateUUID

purchase_orderUnknown

descriptionString
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
GET/2.0/Invoices/{invoice_id}
Merge interacts with this API endpoint to...
Access Invoice information
Invoice fields
typeEnum

issue_dateDateTime (ISO 8601)

remote_dataArray

total_tax_amountNumber

numberString

contactUUID

memoString

due_dateDateTime (ISO 8601)

balanceNumber

remote_idString

sub_totalNumber

total_amountNumber

total_discountNumber

remote_updated_atDateTime (ISO 8601)

paid_on_dateDateTime (ISO 8601)

currencyEnum

statusEnum

exchange_rateString
Access InvoiceLineItem information
InvoiceLineItem fields
invoiceUnknown

itemUUID

unit_priceNumber

accountUUID

quantityNumber

remote_dataUnknown

remote_idString

total_amountNumber

descriptionString
Access PaymentLineItem information
PaymentLineItem fields
applied_dateDateTime (ISO 8601)
Access Payment information
Payment fields
currencyEnum

remote_idString
GET/2.0/Payments/{payment_id}
Merge interacts with this API endpoint to...
Access PaymentLineItem information
PaymentLineItem fields
paymentUnknown

credit_noteUnknown

invoiceUnknown

applied_amountString
Access Payment information
Payment fields
typeEnum

accountUUID

remote_dataArray

contactUUID

remote_updated_atDateTime (ISO 8601)

total_amountNumber

exchange_rateString
GET/2.0/Item
Merge interacts with this API endpoint to...
Access Item information
Item fields
unit_priceNumber

remote_dataArray

purchase_priceNumber

remote_updated_atDateTime (ISO 8601)

remote_idString

purchase_accountUUID

sales_accountUUID

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
remote_dataArray

remote_updated_atDateTime (ISO 8601)

remote_idString

is_customerBoolean

currencyString

email_addressString

is_supplierBoolean

nameString

statusEnum

tax_numberString
Access AccountingPhoneNumber information
AccountingPhoneNumber fields
numberString

remote_dataUnknown

contactUnknown
Access Address information
Address fields
typeEnum

street_2String

remote_dataUnknown

contactUnknown

countryEnum

country_subdivisionString

zip_codeString

cityString

street_1String

stateUnknown
POST/2.0/Contacts
Merge interacts with this API endpoint to...
Access Contact information
Contact fields
remote_idString

is_customerBoolean

currencyString

email_addressString

is_supplierBoolean

nameString

statusEnum

tax_numberString
Access AccountingPhoneNumber information
AccountingPhoneNumber fields
numberString

contactUnknown
Access Address information
Address fields
typeEnum

street_2String

contactUnknown

countryEnum

zip_codeString

cityString

street_1String

country_subdivisionString
PUT/2.0/Contacts
Merge interacts with this API endpoint to...
Access AccountingPhoneNumber information
AccountingPhoneNumber fields
numberString
Access Address information
Address fields
typeEnum

street_2String

countryEnum

zip_codeString

cityString

street_1String

country_subdivisionString
GET/2.0/Accounts
Merge interacts with this API endpoint to...
Access Account information
Account fields
typeString

account_numberString

remote_dataArray

descriptionString

remote_idString

currencyEnum

account_typeEnum

nameString

statusEnum

classificationEnum
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