Xero Accounting Endpoint: BalanceSheetByMonth - Revision history

Nic at 03:27, 5 September 2024

2024-09-05T03:27:42Z

← Older revision		Revision as of 22:27, 4 September 2024
Line 103:		Line 103:
	:[[Xero Accounting Endpoint: BalanceSheetMultiPeriodTable\|BalanceSheetMultiPeriodTable]]		:[[Xero Accounting Endpoint: BalanceSheetMultiPeriodTable\|BalanceSheetMultiPeriodTable]]
	:[[Xero Accounting Endpoint: BalanceSheetTable\|BalanceSheetTable]]		:[[Xero Accounting Endpoint: BalanceSheetTable\|BalanceSheetTable]]
			:[[Xero Accounting Endpoint: BalanceSheetByTrackingOption\|BalanceSheetByTrackingOption]]
			:[[Xero Accounting Endpoint: BalanceSheetAdvanced\|BalanceSheetAdvanced]]

Nic at 01:33, 19 April 2023

2023-04-19T01:33:02Z

← Older revision		Revision as of 20:33, 18 April 2023
Line 101:		Line 101:
	:[[Xero Accounting Endpoint: Accounts\|Accounts]]		:[[Xero Accounting Endpoint: Accounts\|Accounts]]
	:[[Xero Accounting Endpoint: BalanceSheet\|BalanceSheet]]		:[[Xero Accounting Endpoint: BalanceSheet\|BalanceSheet]]
			:[[Xero Accounting Endpoint: BalanceSheetMultiPeriodTable\|BalanceSheetMultiPeriodTable]]
			:[[Xero Accounting Endpoint: BalanceSheetTable\|BalanceSheetTable]]

Nic at 05:11, 22 September 2021

2021-09-22T05:11:31Z

← Older revision		Revision as of 00:11, 22 September 2021
Line 1:		Line 1:
	== Overview ==		== Overview ==

	The Xero '''BalanceSheetByMonth''' [[Endpoints\|endpoint]] provides closing balance sheet values for 12-months of a given financial year.		The Xero '''BalanceSheetByMonth''' [[Xero Accounting Endpoints\|endpoint]] provides closing balance sheet values for 12-months of a given financial year.

	You may also use the [[Xero Accounting Endpoint: BalanceSheet\|BalanceSheet]] which provides a similar data set but as at a given date.		You may also use the [[Xero Accounting Endpoint: BalanceSheet\|BalanceSheet]] which provides a similar data set but as at a given date.
Line 101:		Line 101:
	:[[Xero Accounting Endpoint: Accounts\|Accounts]]		:[[Xero Accounting Endpoint: Accounts\|Accounts]]
	:[[Xero Accounting Endpoint: BalanceSheet\|BalanceSheet]]		:[[Xero Accounting Endpoint: BalanceSheet\|BalanceSheet]]


			== Related Topics ==

			:[[Xero Accounting Models]]
			:[[Xero Accounting Endpoints]]

Nic at 04:30, 22 September 2021

2021-09-22T04:30:24Z

← Older revision		Revision as of 23:30, 21 September 2021
Line 81:		Line 81:

	;Date		;Date
	:A [[Field Type: Date\|date ~~value~~]] that provides the month as a date.		:A [[Field Type: Date\|date field]] that provides the month as a date.

	;Amount		;Amount
	:A [[Field Type: Decimal\|decimal ~~value~~]] that provides the value for the row.		:A [[Field Type: Decimal\|decimal field]] that provides the value for the row.

Nic at 04:56, 20 September 2021

2021-09-20T04:56:57Z

← Older revision		Revision as of 23:56, 19 September 2021
Line 21:		Line 21:

	;StandardLayout		;StandardLayout
	:A [[Field Type: Boolean\|true/false field]] that determines if the ~~balance sheet is~~ produced only for accounts that are in the [[Xero Accounting Endpoint: Accounts\|accounts]] endpoint.		:A [[Field Type: Boolean\|true/false field]] that determines if the values are produced only for accounts that are in the [[Xero Accounting Endpoint: Accounts\|accounts]] endpoint.
	:If omitted, it will be set to True.		:If omitted, it will be set to True.

Line 38:		Line 38:

	;StandardLayout		;StandardLayout
	:A [[Field Type: Table\|table field]] that indicates if ~~the balance sheet is~~ produced only for accounts that are in the [[Xero Accounting Endpoint: Accounts\|accounts]] endpoint.		:A [[Field Type: Table\|table field]] that indicates if values are produced only for accounts that are in the [[Xero Accounting Endpoint: Accounts\|accounts]] endpoint.
	:This will match the StandardLayout entered as [[#Parameters\|parameter]].		:This will match the StandardLayout entered as [[#Parameters\|parameter]].

Nic at 04:54, 20 September 2021

2021-09-20T04:54:26Z

← Older revision		Revision as of 23:54, 19 September 2021
Line 45:		Line 45:

	;Lines		;Lines
	:A [[Field Type: Table\|table field]] that provides list of values.		:A [[Field Type: Table\|table field]] that provides the list of values.
	:See [[#Lines Fields\|Lines Fields]] for more information.		:See [[#Lines Fields\|Lines Fields]] for more information.

Nic at 04:53, 20 September 2021

2021-09-20T04:53:58Z

← Older revision		Revision as of 23:53, 19 September 2021
Line 38:		Line 38:

	;StandardLayout		;StandardLayout
	:A [[Field Type: Table\|table field]] that ~~indictaes~~ if the balance sheet is produced only for accounts that are in the [[Xero Accounting Endpoint: Accounts\|accounts]] endpoint.		:A [[Field Type: Table\|table field]] that indicates if the balance sheet is produced only for accounts that are in the [[Xero Accounting Endpoint: Accounts\|accounts]] endpoint.
	:This will match the StandardLayout entered as [[#Parameters\|parameter]].		:This will match the StandardLayout entered as [[#Parameters\|parameter]].

Nic: Created page with "== Overview == The Xero '''BalanceSheetByMonth''' endpoint provides closing balance sheet values for 12-months of a given financial year. You may also use the..."

2021-09-20T04:08:10Z

Created page with "== Overview == The Xero '''BalanceSheetByMonth''' endpoint provides closing balance sheet values for 12-months of a given financial year. You may also use the..."

New page

== Overview ==

The Xero '''BalanceSheetByMonth''' [[Endpoints|endpoint]] provides closing balance sheet values for 12-months of a given financial year.

You may also use the [[Xero Accounting Endpoint: BalanceSheet|BalanceSheet]] which provides a similar data set but as at a given date.

It is a [[Function Endpoints|function]] that accepts a series of parameters.

== Parameters ==

The BalanceSheetByMonth endpoint is a [[Function Endpoints|function]] that accepts the following parameters.

;FinancialYear
:A [[Field Type: Integer|whole number field]] that determines the financial year for which to produce values.
:If omitted, it will use the current financial year.

;PaymentsOnly
:A [[Field Type: Boolean|true/false field]] that determines if only payments are included.
:If omitted, it will be set to False.

;StandardLayout
:A [[Field Type: Boolean|true/false field]] that determines if the balance sheet is produced only for accounts that are in the [[Xero Accounting Endpoint: Accounts|accounts]] endpoint.
:If omitted, it will be set to True.

== Fields ==

The following fields are available for the BalanceSheetSummaryReport endpoint.

;FinancialYear
:A [[Field Type: Integer|whole number field]] that indicates the financial year for which the values are produced.
:This will match the FinancialYear entered as [[#Parameters|parameter]].

;PaymentsOnly
:A [[Field Type: Boolean|true/false field]] that indicates if only payments are included.
:This will match the PaymentsOnly entered as [[#Parameters|parameter]].

;StandardLayout
:A [[Field Type: Table|table field]] that indictaes if the balance sheet is produced only for accounts that are in the [[Xero Accounting Endpoint: Accounts|accounts]] endpoint.
:This will match the StandardLayout entered as [[#Parameters|parameter]].

;UpdatedDateUTC
:A [[Field Type: DateTimeOffset|date time field]] that indicates when the data was calculated.

;Lines
:A [[Field Type: Table|table field]] that provides list of values.
:See [[#Lines Fields|Lines Fields]] for more information.

== Lines Fields ==

The [[#Fields|Lines Fields]] include the following sub fields.

;LineType
:A [[Field Type: Text|text field]] that indicates the type of line.
:Possible values are:
:* '''Header''': Indicates the row contains a header.
:* '''Detail''': Indicates the row contains the value of a given account.
:* '''Total''': Indicates the row contains a calculated value.

;AccountID
:A [[Field Type: GUID|GUID field]] that provides the id of the account.
:This field can be used to link to the [[Xero Accounting Endpoint: Accounts|Accounts]] endpoints.
:This field will be set to null for rows whose '''LineType''' is not set to '''Detail'''.

;AccountName
:A [[Field Type: Text|text field]] that provides the account name or the name of a header or total.

;AccountLineType
:A [[Field Type: Text|text field]] that provides the a descriptive field to indicate the type of account or row.

;Amounts
:A [[Field Type: Table|table field]] that provides the list of all amounts for each month.
:See [[#Amounts Fields|Amounts Fields]] for more information.

== Amounts Fields ==

The [[#Fields|Amounts Fields]] includes the following sub-fields.

;Date
:A [[Field Type: Date|date value]] that provides the month as a date.

;Amount
:A [[Field Type: Decimal|decimal value]] that provides the value for the row.

== Xero API ==

For a detailed run through of the endpoint, you can see the [https://developer.xero.com/documentation/api/accounting/reports#balance-sheet Xero API].

== Related Fields ==

:None

== Related Endpoints ==

:[[Xero Accounting Endpoint: Accounts|Accounts]]
:[[Xero Accounting Endpoint: BalanceSheet|BalanceSheet]]

← Older revision		Revision as of 22:27, 4 September 2024
Line 103:		Line 103:
	:[[Xero Accounting Endpoint: BalanceSheetMultiPeriodTable\|BalanceSheetMultiPeriodTable]]		:[[Xero Accounting Endpoint: BalanceSheetMultiPeriodTable\|BalanceSheetMultiPeriodTable]]
	:[[Xero Accounting Endpoint: BalanceSheetTable\|BalanceSheetTable]]		:[[Xero Accounting Endpoint: BalanceSheetTable\|BalanceSheetTable]]
			:[[Xero Accounting Endpoint: BalanceSheetByTrackingOption\|BalanceSheetByTrackingOption]]
			:[[Xero Accounting Endpoint: BalanceSheetAdvanced\|BalanceSheetAdvanced]]