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