Xero Accounting Endpoint: ExecutiveSummary
Jump to navigation
Jump to search
Overview
The Xero ExecutiveSummary endpoint provides various totals for a given date. These totals range covers Profit and Loss, Balance Sheet, Financial Performance, Financial Position, etc.
It is a function that accepts a series of parameters.
Parameters
The ExecutiveSummary is a function that accepts the following parameters.
- Date
- A date field that determines the date for which to produce values.
- If omitted, it will use the last date of the last calendar month.
Fields
The following fields are available for the ExecutiveSummary endpoint.
- Date
- A date field that indicates the date used to produce the values.
- This will match the Date entered as parameter.
- UpdatedDateUTC
- A date time field that indicates when the data was calculated.
- Lines
- A table field that provides the list of values.
- See Lines Fields for more information.
Lines Fields
The Lines Fields include the following sub fields.
- Description
- A text field that indicates the type of value.
- Possible values are:
- Average creditors days
- Average debtors days
- Average value of invoices
- Cash received
- Cash spent
- Cash surplus (deficit)
- Closing bank balance
- Creditors
- Current assets to liabilities
- Debtors
- Direct costs
- Expenses
- Gross profit (loss)
- Gross profit margin
- Income
- Net assets
- Net profit margin
- Number of invoices issued
- Other Income
- Profit (loss)
- Return on investment (p.a.)
- Short term cash forecast
- Term assets to liabilities
- Type
- A text field that indicates the category of the value.
- Possible values are:
- Balance Sheet
- Cash
- Income
- Performance
- Position
- Profitability
- ThisMonthAmount
- A decimal field that provides the value for the month.
- LastMonthAmount
- A decimal field that provides the value for the previous month.
- VariancePercent
- A decimal field that provides a variance between the two months.
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Fields
- None
Related Endpoints
- None