Xero Accounting Endpoints: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (13 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
= Overview = | |||
[[Xero Accounting Models]] provides access to Profit and Loss, Balance Sheet and most other Transactions and Accounting data present in Xero. | |||
OdataLink's Accounting [[Endpoints]] replicates Xero's '''[https://developer.xero.com/documentation/api/accounting/overview Accounting API,]''' and are available only for data files attached to a Xero [[Models | Accounting Model]] | |||
Other data viz. '''Assets, Files, Projects, and Payroll''' data is not available in Accounting endpoints. | |||
This is because Assets, Payroll and Projects endpoints belong either to optional modules in Xero, or differ by regions. | |||
Additional endpoints related to other Xero APIs are available in corresponding Xero models: | |||
:[[Xero Assets Endpoints|Xero Assets Model Endpoints]] | |||
:[[Xero Files Endpoints|Xero Files Model Endpoints]] | |||
:[[Xero Projects Endpoints|Xero Projects Model Endpoints]] | |||
:[[Xero Payroll (Australia) Endpoints|Xero Payroll (Australia) Model Endpoints]], [[Xero Payroll (New Zealand) Endpoints|Xero Payroll (New Zealand) Model Endpoints]], and [[Xero Payroll (UK) Endpoints|Xero Payroll (UK) Model Endpoints]] | |||
Please note that these models are Xero data file specific and would not work for mismatched model types. | |||
== Xero Accounting Model Endpoints == | |||
Here is the full list of endpoints for [[Xero Accounting Models]] available in OdataLink. | Here is the full list of endpoints for [[Xero Accounting Models]] available in OdataLink. | ||
| Line 7: | Line 29: | ||
:[[Xero Accounting Endpoint: AgedPayablesByContact|AgedPayablesByContact]] | :[[Xero Accounting Endpoint: AgedPayablesByContact|AgedPayablesByContact]] | ||
:[[Xero Accounting Endpoint: AgedReceivablesByContact|AgedReceivablesByContact]] | :[[Xero Accounting Endpoint: AgedReceivablesByContact|AgedReceivablesByContact]] | ||
:[[Xero Accounting Endpoint: BalanceSheet|BalanceSheet]] ''' --- ''' [[Xero Accounting Endpoint: BalanceSheetTable|BalanceSheetTable]] ''' --- ''' [[Xero Accounting Endpoint: BalanceSheetByMonth|BalanceSheetByMonth]] ''' --- ''' [[Xero Accounting Endpoint: BalanceSheetMultiPeriodTable|BalanceSheetMultiPeriodTable]] | :[[Xero Accounting Endpoint: BalanceSheet|BalanceSheet]] ''' --- ''' [[Xero Accounting Endpoint: BalanceSheetTable|BalanceSheetTable]] ''' --- ''' [[Xero Accounting Endpoint: BalanceSheetByMonth|BalanceSheetByMonth]] ''' --- ''' [[Xero Accounting Endpoint: BalanceSheetMultiPeriodTable|BalanceSheetMultiPeriodTable]] ''' --- ''' [[Xero Accounting Endpoint: BalanceSheetByTrackingOption|BalanceSheetByTrackingOption]] ''' --- ''' [[Xero Accounting Endpoint: BalanceSheetAdvanced|BalanceSheetAdvanced]] | ||
:[[Xero Accounting Endpoint: BankSummary|BankSummary]] | :[[Xero Accounting Endpoint: BankSummary|BankSummary]] | ||
:[[Xero Accounting Endpoint: BankTransactions|BankTransactions]] ''' --- ''' [[Xero Accounting Endpoint: BankTransactionsExpanded|BankTransactionsExpanded]] | :[[Xero Accounting Endpoint: BankTransactions|BankTransactions]] ''' --- ''' [[Xero Accounting Endpoint: BankTransactionsExpanded|BankTransactionsExpanded]] | ||
| Line 17: | Line 39: | ||
:[[Xero Accounting Endpoint: BudgetSummary|BudgetSummary]] ''' --- ''' [[Xero Accounting Endpoint: BudgetSummaryByMonth|BudgetSummaryByMonth]] | :[[Xero Accounting Endpoint: BudgetSummary|BudgetSummary]] ''' --- ''' [[Xero Accounting Endpoint: BudgetSummaryByMonth|BudgetSummaryByMonth]] | ||
:[[Xero Accounting Endpoint: ContactGroups|ContactGroups]] | :[[Xero Accounting Endpoint: ContactGroups|ContactGroups]] | ||
:[[Xero Accounting Endpoint: Contacts|Contacts]] ''' --- ''' [[Xero Accounting Endpoint: ContactsExpanded|ContactsExpanded]] | :[[Xero Accounting Endpoint: Contacts|Contacts]] ''' --- ''' [[Xero Accounting Endpoint: ContactsExpanded|ContactsExpanded]] ''' --- ''' [[Xero Accounting Endpoint: ContactsExpandedTable|ContactsExpandedTable]] | ||
:[[Xero Accounting Endpoint: CreditNotes|CreditNotes]] ''' --- ''' [[Xero Accounting Endpoint: CreditNotesExpanded|CreditNotesExpanded]] | :[[Xero Accounting Endpoint: CreditNotes|CreditNotes]] ''' --- ''' [[Xero Accounting Endpoint: CreditNotesExpanded|CreditNotesExpanded]] ''' --- ''' [[Xero Accounting Endpoint: CreditNotesExpandedTable|CreditNotesExpandedTable]] ''' --- ''' [[Xero Accounting Endpoint: CreditNotesTable|CreditNotesTable]] | ||
:[[Xero Accounting Endpoint: Currencies|Currencies]] | :[[Xero Accounting Endpoint: Currencies|Currencies]] | ||
:[[Endpoint: DataFiles|DataFiles]] | :[[Endpoint: DataFiles|DataFiles]] | ||
| Line 24: | Line 46: | ||
:[[Endpoint: DatesByMonth|DatesByMonth]] | :[[Endpoint: DatesByMonth|DatesByMonth]] | ||
:[[Endpoint: DatesByYear|DatesByYear]] | :[[Endpoint: DatesByYear|DatesByYear]] | ||
:[[Xero Accounting Endpoint: ExpenseClaims|ExpenseClaims]] ''' --- ''' [[Xero Accounting Endpoint: GetExpenseClaimDetail|GetExpenseClaimDetail]] | |||
:[[Xero Accounting Endpoint: ExecutiveSummary|ExecutiveSummary]] | :[[Xero Accounting Endpoint: ExecutiveSummary|ExecutiveSummary]] | ||
:[[Xero Accounting Endpoint: GetHistoryBankTransaction|GetHistoryBankTransaction]] | :[[Xero Accounting Endpoint: GetHistoryBankTransaction|GetHistoryBankTransaction]] | ||
| Line 39: | Line 62: | ||
:[[Xero Accounting Endpoint: GetHistoryRepeatingInvoice|GetHistoryRepeatingInvoice]] | :[[Xero Accounting Endpoint: GetHistoryRepeatingInvoice|GetHistoryRepeatingInvoice]] | ||
:[[Xero Accounting Endpoint: GetImage|GetImage]] | :[[Xero Accounting Endpoint: GetImage|GetImage]] | ||
:[[Xero Accounting Endpoint: Invoices|Invoices]] ''' --- ''' [[Xero Accounting Endpoint: InvoicesExpanded|InvoicesExpanded]] ''' | :[[Xero Accounting Endpoint: GetInvoiceUrl|GetInvoiceUrl]] | ||
:[[Xero Accounting Endpoint: Items|Items]] ''' | :[[Xero Accounting Endpoint: Invoices|Invoices]] ''' --- ''' [[Xero Accounting Endpoint: InvoicesExpanded|InvoicesExpanded]] ''' --- ''' [[Xero Accounting Endpoint: InvoicesExpandedTable|InvoicesExpandedTable]] | ||
:[[Xero Accounting Endpoint: JournalsAccrual|JournalsAccrual]] ''' | :[[Xero Accounting Endpoint: Items|Items]] ''' --- ''' [[Xero Accounting Endpoint: ItemsTable|ItemsTable]] | ||
:[[Xero Accounting Endpoint: JournalsAccrual|JournalsAccrual]] ''' --- ''' [[Xero Accounting Endpoint: JournalsAccrualTable|JournalsAccrualTable]] | |||
:[[Xero Accounting Endpoint: JournalsCash|JournalsCash]] | :[[Xero Accounting Endpoint: JournalsCash|JournalsCash]] | ||
:[[Xero Accounting Endpoint: LinkedTransactions|LinkedTransactions]] | :[[Xero Accounting Endpoint: LinkedTransactions|LinkedTransactions]] | ||
| Line 47: | Line 71: | ||
:[[Xero Accounting Endpoint: Organisation|Organisation]] | :[[Xero Accounting Endpoint: Organisation|Organisation]] | ||
:[[Xero Accounting Endpoint: Overpayments|Overpayments]] ''' --- ''' [[Xero Accounting Endpoint: OverpaymentsExpanded|OverpaymentsExpanded]] | :[[Xero Accounting Endpoint: Overpayments|Overpayments]] ''' --- ''' [[Xero Accounting Endpoint: OverpaymentsExpanded|OverpaymentsExpanded]] | ||
:[[Xero Accounting Endpoint: Payments|Payments]] ''' | :[[Xero Accounting Endpoint: Payments|Payments]] ''' --- ''' [[Xero Accounting Endpoint: PaymentsTable|PaymentsTable]] | ||
:[[Xero Accounting Endpoint: Prepayments|Prepayments]] ''' --- ''' [[Xero Accounting Endpoint: PrepaymentsExpanded|PrepaymentsExpanded]] | :[[Xero Accounting Endpoint: Prepayments|Prepayments]] ''' --- ''' [[Xero Accounting Endpoint: PrepaymentsExpanded|PrepaymentsExpanded]] | ||
:[[Xero Accounting Endpoint: ProfitAndLoss|ProfitAndLoss]] ''' --- ''' [[Xero Accounting Endpoint: ProfitAndLossTable|ProfitAndLossTable]] ''' --- ''' [[Xero Accounting Endpoint: ProfitAndLossAdvanced|ProfitAndLossAdvanced]] ''' --- ''' [[Xero Accounting Endpoint: | :[[Xero Accounting Endpoint: ProfitAndLoss|ProfitAndLoss]] ''' --- ''' [[Xero Accounting Endpoint: ProfitAndLossTable|ProfitAndLossTable]] ''' --- ''' [[Xero Accounting Endpoint: ProfitAndLossAdvanced|ProfitAndLossAdvanced]] ''' --- ''' [[Xero Accounting Endpoint: ProfitAndLossByMonth|ProfitAndLossByMonth]] ''' --- ''' [[Xero Accounting Endpoint: ProfitAndLossByTrackingCategory|ProfitAndLossByTrackingCategory]] ''' --- ''' [[Xero Accounting Endpoint: ProfitAndLossByTrackingOption|ProfitAndLossByTrackingOption]] ''' --- ''' [[Xero Accounting Endpoint: ProfitAndLossMultiPeriodTable|ProfitAndLossMultiPeriodTable]] | ||
:[[Xero Accounting Endpoint: PurchaseOrders|PurchaseOrders]] | :[[Xero Accounting Endpoint: PurchaseOrders|PurchaseOrders]] | ||
:[[Xero Accounting Endpoint: Quotes|Quotes]] | :[[Xero Accounting Endpoint: Quotes|Quotes]] | ||
:[[Xero Accounting Endpoint: RepeatingInvoices|RepeatingInvoices]] | :[[Xero Accounting Endpoint: RepeatingInvoices|RepeatingInvoices]] | ||
:[[Xero Accounting Endpoint: TaxRates|TaxRates]] ''' | :[[Xero Accounting Endpoint: TaxRates|TaxRates]] ''' --- ''' [[Xero Accounting Endpoint: TaxRatesTable|TaxRatesTable]] | ||
:[[Xero Accounting Endpoint: TrackingCategories|TrackingCategories]] ''' | :[[Xero Accounting Endpoint: TrackingCategories|TrackingCategories]] ''' --- ''' [[Xero Accounting Endpoint: TrackingCategoriesTable|TrackingCategoriesTable]] | ||
:[[Xero Accounting Endpoint: TrialBalance|TrialBalance]] ''' --- ''' [[Xero Accounting Endpoint: TrialBalanceTable|TrialBalanceTable]] ''' --- ''' [[Xero Accounting Endpoint: TrialBalanceMultiPeriodTable|TrialBalanceMultiPeriodTable]] | :[[Xero Accounting Endpoint: TrialBalance|TrialBalance]] ''' --- ''' [[Xero Accounting Endpoint: TrialBalanceTable|TrialBalanceTable]] ''' --- ''' [[Xero Accounting Endpoint: TrialBalanceMultiPeriodTable|TrialBalanceMultiPeriodTable]] | ||
:[[Xero Accounting Endpoint: Users|Users]] | :[[Xero Accounting Endpoint: Users|Users]] | ||
| Line 63: | Line 87: | ||
:[[Endpoints]] | :[[Endpoints]] | ||
:[[Xero Accounting Models]] | :[[Xero Accounting Models]] | ||
== Search Words == | |||
End Points | |||
Latest revision as of 23:35, 7 October 2025
Overview
Xero Accounting Models provides access to Profit and Loss, Balance Sheet and most other Transactions and Accounting data present in Xero.
OdataLink's Accounting Endpoints replicates Xero's Accounting API, and are available only for data files attached to a Xero Accounting Model
Other data viz. Assets, Files, Projects, and Payroll data is not available in Accounting endpoints.
This is because Assets, Payroll and Projects endpoints belong either to optional modules in Xero, or differ by regions.
Additional endpoints related to other Xero APIs are available in corresponding Xero models:
- Xero Assets Model Endpoints
- Xero Files Model Endpoints
- Xero Projects Model Endpoints
- Xero Payroll (Australia) Model Endpoints, Xero Payroll (New Zealand) Model Endpoints, and Xero Payroll (UK) Model Endpoints
Please note that these models are Xero data file specific and would not work for mismatched model types.
Xero Accounting Model Endpoints
Here is the full list of endpoints for Xero Accounting Models available in OdataLink.
- Accounts --- AccountsTable
- AccountsClass
- AccountsTotals
- AccountsTypes
- AgedPayablesByContact
- AgedReceivablesByContact
- BalanceSheet --- BalanceSheetTable --- BalanceSheetByMonth --- BalanceSheetMultiPeriodTable --- BalanceSheetByTrackingOption --- BalanceSheetAdvanced
- BankSummary
- BankTransactions --- BankTransactionsExpanded
- BankTransfers
- BatchPayments
- BrandingThemes
- Budgets
- BudgetsAmounts
- BudgetSummary --- BudgetSummaryByMonth
- ContactGroups
- Contacts --- ContactsExpanded --- ContactsExpandedTable
- CreditNotes --- CreditNotesExpanded --- CreditNotesExpandedTable --- CreditNotesTable
- Currencies
- DataFiles
- Dates
- DatesByMonth
- DatesByYear
- ExpenseClaims --- GetExpenseClaimDetail
- ExecutiveSummary
- GetHistoryBankTransaction
- GetHistoryBatchPayment
- GetHistoryContact
- GetHistoryCreditNote
- GetHistoryInvoice
- GetHistoryItem
- GetHistoryManualJournal
- GetHistoryOverpayment
- GetHistoryPayment
- GetHistoryPrepayment
- GetHistoryPurchaseOrder
- GetHistoryQuote
- GetHistoryRepeatingInvoice
- GetImage
- GetInvoiceUrl
- Invoices --- InvoicesExpanded --- InvoicesExpandedTable
- Items --- ItemsTable
- JournalsAccrual --- JournalsAccrualTable
- JournalsCash
- LinkedTransactions
- ManualJournals --- ManualJournalsExpanded
- Organisation
- Overpayments --- OverpaymentsExpanded
- Payments --- PaymentsTable
- Prepayments --- PrepaymentsExpanded
- ProfitAndLoss --- ProfitAndLossTable --- ProfitAndLossAdvanced --- ProfitAndLossByMonth --- ProfitAndLossByTrackingCategory --- ProfitAndLossByTrackingOption --- ProfitAndLossMultiPeriodTable
- PurchaseOrders
- Quotes
- RepeatingInvoices
- TaxRates --- TaxRatesTable
- TrackingCategories --- TrackingCategoriesTable
- TrialBalance --- TrialBalanceTable --- TrialBalanceMultiPeriodTable
- Users
Related Topics
Search Words
End Points