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