Xero Accounting Endpoint: ProfitAndLossByMonth: Difference between revisions

(11 intermediate revisions by the same user not shown)

Line 1:

== Disclaimer ==

'''''The [[Xero Accounting Endpoint: ProfitAndLossMultiPeriodTable|ProfitAndLossMultiPeriodTable]] is the recommend endpoint for building Profit and Loss reports. We recommend using it over the ProfitAndLossByMonth endpoint.'''''

== Overview ==

The Xero '''ProfitAndLossByMonth''' [[Endpoints|endpoint]] provides net movement values for 12-months of a given financial year.

The Xero '''ProfitAndLossByMonth''' [[Xero Accounting Endpoints|endpoint]] provides net movement values for 12-months of a given financial year.

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

Line 21:

Line 26:

;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.

Line 27:

Line 32:

== Fields ==

The following fields are available for the ~~BalanceSheetSummaryReport~~ endpoint.

The following fields are available for the ProfitAndLossByMonth endpoint.

;FinancialYear

Line 38:

Line 43:

;StandardLayout

:A [[Field Type: ~~Table~~|~~table~~ field]] that ~~indictaes~~ if values are produced only for accounts that are in the [[Xero Accounting Endpoint: Accounts|accounts]] endpoint.

:A [[Field Type: Boolean|true/false 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]].

Line 81:

Line 86:

;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

: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.

== Known Issue ==

There is a known bug in the Xero API which incorrectly calculates values if your financial year ends in a month without 31 days.

There is a known bug in the Xero API which incorrectly calculates values if your financial year ends in a month without 31 days (e.g. Australian Businesses). To work around this issue, OdataLink will call the endpoint twice for affected businesses. This does not apply to all regions. For instance, New Zealand data files are mostly unaffected as their financial year already ends on a month with 31 days.

To work around this issue, OdataLink will ~~choose a different end-month when producing values.~~

~~This means for most Australian business that run July to June,~~ the endpoint ~~will actually calculate values from June to May instead. As such, it may actually need to be called~~ twice ~~to create the correct complete set of values~~.

This does not apply to all regions. For instance, New Zealand data files are mostly unaffected as their financial year already ends on a month with 31 days.

== Xero API ==

Line 112:

Line 110:

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

:[[Xero Accounting Endpoint: ProfitAndLoss|ProfitAndLoss]]

:[[Xero Accounting Endpoint: ProfitAndLossAdvanced|ProfitAndLossAdvanced]]

:[[Xero Accounting Endpoint: ProfitAndLossByTrackingCategory|ProfitAndLossByTrackingCategory]]

:[[Xero Accounting Endpoint: ProfitAndLossByTrackingOption|ProfitAndLossByTrackingOption]]

:[[Xero Accounting Endpoint: ProfitAndLossMultiPeriodTable|ProfitAndLossMultiPeriodTable]]

:[[Xero Accounting Endpoint: ProfitAndLossTable|ProfitAndLossTable]]

== Related Topics ==

:[[Xero Accounting Models]]

:[[Xero Accounting Endpoints]]

@@ Line 1: / Line 1: @@
+== Disclaimer ==
+'''''The [[Xero Accounting Endpoint: ProfitAndLossMultiPeriodTable|ProfitAndLossMultiPeriodTable]] is the recommend endpoint for building Profit and Loss reports. We recommend using it over the ProfitAndLossByMonth endpoint.'''''
 == Overview ==
-The Xero '''ProfitAndLossByMonth''' [[Endpoints|endpoint]] provides net movement values for 12-months of a given financial year.
+The Xero '''ProfitAndLossByMonth''' [[Xero Accounting Endpoints|endpoint]] provides net movement values for 12-months of a given financial year.
 It is a [[Function Endpoints|function]] that accepts a series of parameters.
@@ Line 21: / Line 26: @@
 ;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.
@@ Line 27: / Line 32: @@
 == Fields ==
-The following fields are available for the BalanceSheetSummaryReport endpoint.
+The following fields are available for the ProfitAndLossByMonth endpoint.
 ;FinancialYear
@@ Line 38: / Line 43: @@
 ;StandardLayout
-:A [[Field Type: Table|table field]] that indictaes if values are produced only for accounts that are in the [[Xero Accounting Endpoint: Accounts|accounts]] endpoint.
+:A [[Field Type: Boolean|true/false 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]].
@@ Line 81: / Line 86: @@
 ;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
-: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.
 == Known Issue ==
-There is a known bug in the Xero API which incorrectly calculates values if your financial year ends in a month without 31 days.
+There is a known bug in the Xero API which incorrectly calculates values if your financial year ends in a month without 31 days (e.g. Australian Businesses). To work around this issue, OdataLink will call the endpoint twice for affected businesses. This does not apply to all regions. For instance, New Zealand data files are mostly unaffected as their financial year already ends on a month with 31 days.
-To work around this issue, OdataLink will choose a different end-month when producing values.
-This means for most Australian business that run July to June, the endpoint will actually calculate values from June to May instead. As such, it may actually need to be called twice to create the correct complete set of values.
-This does not apply to all regions. For instance, New Zealand data files are mostly unaffected as their financial year already ends on a month with 31 days.
 == Xero API ==
@@ Line 112: / Line 110: @@
 :[[Xero Accounting Endpoint: Accounts|Accounts]]
 :[[Xero Accounting Endpoint: ProfitAndLoss|ProfitAndLoss]]
+:[[Xero Accounting Endpoint: ProfitAndLossAdvanced|ProfitAndLossAdvanced]]
+:[[Xero Accounting Endpoint: ProfitAndLossByTrackingCategory|ProfitAndLossByTrackingCategory]]
+:[[Xero Accounting Endpoint: ProfitAndLossByTrackingOption|ProfitAndLossByTrackingOption]]
+:[[Xero Accounting Endpoint: ProfitAndLossMultiPeriodTable|ProfitAndLossMultiPeriodTable]]
+:[[Xero Accounting Endpoint: ProfitAndLossTable|ProfitAndLossTable]]
+== Related Topics ==
+:[[Xero Accounting Models]]
+:[[Xero Accounting Endpoints]]