Xero Accounting Endpoint: ProfitAndLossByTrackingCategory - Revision history

Nic at 04:46, 6 July 2023

2023-07-06T04:46:09Z

← Older revision		Revision as of 23:46, 5 July 2023
Line 5:		Line 5:
	It is a [[Function Endpoints\|function]] that accepts a series of parameters.		It is a [[Function Endpoints\|function]] that accepts a series of parameters.


			== Video ==

			The following video describes the ProfitAndLossByTrackingCategory endpoint, including fields, parameters and tricks on how to use it.

			{{#ev:youtube\|rpk-QejlfiQ\|560\|left\|ProfitAndLossByTrackingCategory endpoint for Xero}}
			<br clear=all />

	== Parameters ==		== Parameters ==
Line 116:		Line 123:
	:A [[Field Type: Decimal\|decimal field]] that provides the value for the row.		:A [[Field Type: Decimal\|decimal field]] that provides the value for the row.


	~~== Video ==~~

	~~{{#ev:youtube\|rpk-QejlfiQ\|560\|left\|ProfitAndLossByTrackingCategory endpoint for Xero}}~~

	== Known Issue ==		== Known Issue ==

Nic at 04:45, 6 July 2023

2023-07-06T04:45:04Z

← Older revision		Revision as of 23:45, 5 July 2023
Line 116:		Line 116:
	:A [[Field Type: Decimal\|decimal field]] that provides the value for the row.		:A [[Field Type: Decimal\|decimal field]] that provides the value for the row.


			== Video ==

			{{#ev:youtube\|rpk-QejlfiQ\|560\|left\|ProfitAndLossByTrackingCategory endpoint for Xero}}

	== Known Issue ==		== Known Issue ==

Nic at 00:06, 27 March 2023

2023-03-27T00:06:02Z

← Older revision		Revision as of 19:06, 26 March 2023
Line 138:		Line 138:
	:[[Xero Accounting Endpoint: Accounts\|Accounts]]		:[[Xero Accounting Endpoint: Accounts\|Accounts]]
	:[[Xero Accounting Endpoint: ProfitAndLoss\|ProfitAndLoss]]		:[[Xero Accounting Endpoint: ProfitAndLoss\|ProfitAndLoss]]
			:[[Xero Accounting Endpoint: ProfitAndLossTable\|ProfitAndLossTable]]
	:[[Xero Accounting Endpoint: ProfitAndLossAdvanced\|ProfitAndLossAdvanced]]		:[[Xero Accounting Endpoint: ProfitAndLossAdvanced\|ProfitAndLossAdvanced]]
	:[[Xero Accounting Endpoint: ProfitAndLossByMonth\|ProfitAndLossByMonth]]		:[[Xero Accounting Endpoint: ProfitAndLossByMonth\|ProfitAndLossByMonth]]
	:[[Xero Accounting Endpoint: ProfitAndLossByTrackingOption\|ProfitAndLossByTrackingOption]]		:[[Xero Accounting Endpoint: ProfitAndLossByTrackingOption\|ProfitAndLossByTrackingOption]]
			:[[Xero Accounting Endpoint: ProfitAndLossMultiPeriodTable\|ProfitAndLossMultiPeriodTable]]
	:[[Xero Accounting Endpoint: TrackingCategories\|TrackingCategories]]		:[[Xero Accounting Endpoint: TrackingCategories\|TrackingCategories]]

Nic at 00:35, 7 December 2021

2021-12-07T00:35:19Z

← Older revision		Revision as of 19:35, 6 December 2021
Line 51:		Line 51:

	;StandardLayout		;StandardLayout
	: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.		: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]].		:This will match the StandardLayout entered as [[#Parameters\|parameter]].

Nic at 00:30, 7 December 2021

2021-12-07T00:30:14Z

← Older revision		Revision as of 19:30, 6 December 2021
Line 36:		Line 36:
	== Fields ==		== Fields ==

	The following fields are available for the ~~ProfitAndLoss~~ endpoint.		The following fields are available for the ProfitAndLossByTrackingCategory endpoint.

	;FromDate		;FromDate

Nic at 00:20, 7 December 2021

2021-12-07T00:20:18Z

← Older revision		Revision as of 19:20, 6 December 2021
Line 56:		Line 56:
	;TrackingCategoryID		;TrackingCategoryID
	:A [[Field Type: GUID\|guid field]] that indicates the [[Xero Accounting Endpoint: TrackingCategories\|tracking category]] used.		:A [[Field Type: GUID\|guid field]] that indicates the [[Xero Accounting Endpoint: TrackingCategories\|tracking category]] used.
	:This will match the ~~StandardLayout~~ entered as [[#Parameters\|parameter]].		:This will match the TrackingCategoryID entered as [[#Parameters\|parameter]].

	;TrackingCategoryID2		;TrackingCategoryID2
	:A [[Field Type: GUID\|guid field]] that indicates the secondary [[Xero Accounting Endpoint: TrackingCategories\|tracking category]] used.		:A [[Field Type: GUID\|guid field]] that indicates the secondary [[Xero Accounting Endpoint: TrackingCategories\|tracking category]] used.
	:This will match the ~~StandardLayout~~ entered as [[#Parameters\|parameter]].		:This will match the TrackingCategoryID2 entered as [[#Parameters\|parameter]].

	;UpdatedDateUTC		;UpdatedDateUTC

Nic at 00:14, 7 December 2021

2021-12-07T00:14:02Z

← Older revision		Revision as of 19:14, 6 December 2021
Line 100:		Line 100:

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

			;TrackingOptionID
			:A [[Field Type: GUID\|guid field]] that provides the ID of the tracking option belonging to the '''TrackingCategoryID'' parameter.

	;TrackingOptionName		;TrackingOptionName
	:A [[Field Type: Text\|text field]] that provides the name of the tracking option belonging to the '''TrackingCategoryID'' parameter.		:A [[Field Type: Text\|text field]] that provides the name of the tracking option belonging to the '''TrackingCategoryID'' parameter.

			;TrackingOptionID2
			:A [[Field Type: Text\|text field]] that provides the ID of the secondary tracking option belonging to the '''TrackingCategoryID2'' parameter.

	;TrackingOptionName2		;TrackingOptionName2

Nic: Created page with "== Overview == The Xero '''ProfitAndLossByTrackingCategory''' endpoint provides profit and loss values for all Xero Accounting Endpoint: Track..."

2021-12-06T22:59:53Z

Created page with "== Overview == The Xero '''ProfitAndLossByTrackingCategory''' endpoint provides profit and loss values for all Xero Accounting Endpoint: Track..."

New page

== Overview ==

The Xero '''ProfitAndLossByTrackingCategory''' [[Xero Accounting Endpoints|endpoint]] provides profit and loss values for all [[Xero Accounting Endpoint: TrackingCategories|tracking category options]] for a given date.

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

== Parameters ==

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

;FromDate
:A [[Field Type: Date|date field]] that determines the start date for which to produce values.
:If omitted, it will use the first date of the last calendar month.

;ToDate
:A [[Field Type: Date|date field]] that determines the end date for which to produce values.
:If omitted, it will use the last date of the last calendar month.

;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 values are produced only for accounts that are in the [[Xero Accounting Endpoint: Accounts|accounts]] endpoint.
:If omitted, it will be set to True.

;TrackingCategoryID
:A [[Field Type: GUID|guid field]] that specifies the list [[Xero Accounting Endpoint: TrackingCategories|tracking category options]].
:If omitted, OdataLink will choose one present within Xero.

;TrackingCategoryID2
:A [[Field Type: GUID|guid field]] that specifies a secondary list [[Xero Accounting Endpoint: TrackingCategories|tracking category options]].
:If omitted, OdataLink will only provide data for a single set of [[Xero Accounting Endpoint: TrackingCategories|tracking category options]] as specified by '''TrackingCategoryID'''.

== Fields ==

The following fields are available for the ProfitAndLoss endpoint.

;FromDate
:A [[Field Type: Date|date field]] that indicates the start date used to produce the values.
:This will match the FromDate entered as [[#Parameters|parameter]].

;ToDate
:A [[Field Type: Date|date field]] that indicates the end date used to produce the values.
:This will match the ToDate 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 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]].

;TrackingCategoryID
:A [[Field Type: GUID|guid field]] that indicates the [[Xero Accounting Endpoint: TrackingCategories|tracking category]] used.
:This will match the StandardLayout entered as [[#Parameters|parameter]].

;TrackingCategoryID2
:A [[Field Type: GUID|guid field]] that indicates the secondary [[Xero Accounting Endpoint: TrackingCategories|tracking category]] used.
: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 the 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 [[Xero Accounting Endpoint: TrackingCategories|tracking category options]].
:See [[#Amounts Fields|Amounts Fields]] for more information.

== Amounts Fields ==

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

;TrackingOptionName
:A [[Field Type: Text|text field]] that provides the name of the tracking option belonging to the '''TrackingCategoryID'' parameter.

;TrackingOptionName2
:A [[Field Type: Text|text field]] that provides the name of the secondary tracking option belonging to the '''TrackingCategoryID2'' parameter.

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

== Known Issue ==

Xero provides the tracking option name separated by a comma. OdataLink takes this name and parses it into two separate fields (TrackingOptionName and TrackingOptionName2). It is therefore recommended not to include commas (,) within Tracking Options.

Xero does not validate the [[Field Type: GUID|GUID]] specified by the TrackingCategoryID and TrackingCategoryID2 parameters. It is imperitive you use [[Field Type: GUID|GUID]] that exists.

== Xero API ==

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

== Related Fields ==

:None

== Related Endpoints ==

:[[Xero Accounting Endpoint: Accounts|Accounts]]
:[[Xero Accounting Endpoint: ProfitAndLoss|ProfitAndLoss]]
:[[Xero Accounting Endpoint: ProfitAndLossAdvanced|ProfitAndLossAdvanced]]
:[[Xero Accounting Endpoint: ProfitAndLossByMonth|ProfitAndLossByMonth]]
:[[Xero Accounting Endpoint: ProfitAndLossByTrackingOption|ProfitAndLossByTrackingOption]]
:[[Xero Accounting Endpoint: TrackingCategories|TrackingCategories]]

== Related Topics ==

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