Xero Projects Endpoint: Tasks - Revision history

Nic at 02:00, 5 September 2024

2024-09-05T02:00:50Z

← Older revision		Revision as of 21:00, 4 September 2024
Line 2:		Line 2:

	The Xero '''Tasks''' [[Xero Projects Endpoints\|endpoint]] provides the list of tasks defined within Xero.		The Xero '''Tasks''' [[Xero Projects Endpoints\|endpoint]] provides the list of tasks defined within Xero.

			You may also use the [[Xero Projects Endpoint: GetTasks\|GetTasks]] function which provides similar data but single project. This function gives you more control than the '''Tasks''' endpoint.


Line 74:		Line 76:
	== Related Endpoints ==		== Related Endpoints ==

			:[[Xero Projects Endpoint: GetTasks\|GetTasks]]
	:[[Xero Projects Endpoint: Projects\|Projects]]		:[[Xero Projects Endpoint: Projects\|Projects]]
	~~:[[Xero Projects Endpoint: GetTasks\|GetTasks]]~~
	:[[Xero Projects Endpoint: Times\|Times]]		:[[Xero Projects Endpoint: Times\|Times]]

Nic at 01:59, 5 September 2024

2024-09-05T01:59:46Z

← Older revision		Revision as of 20:59, 4 September 2024
Line 75:		Line 75:

	:[[Xero Projects Endpoint: Projects\|Projects]]		:[[Xero Projects Endpoint: Projects\|Projects]]
			:[[Xero Projects Endpoint: GetTasks\|GetTasks]]
	:[[Xero Projects Endpoint: Times\|Times]]		:[[Xero Projects Endpoint: Times\|Times]]

Nic at 05:34, 22 September 2021

2021-09-22T05:34:29Z

← Older revision		Revision as of 00:34, 22 September 2021
Line 76:		Line 76:
	:[[Xero Projects Endpoint: Projects\|Projects]]		:[[Xero Projects Endpoint: Projects\|Projects]]
	:[[Xero Projects Endpoint: Times\|Times]]		:[[Xero Projects Endpoint: Times\|Times]]


			== Related Topics ==

			:[[Xero Projects Models]]
			:[[Xero Projects Endpoints]]

Nic at 04:53, 22 September 2021

2021-09-22T04:53:34Z

← Older revision		Revision as of 23:53, 21 September 2021
Line 2:		Line 2:

	The Xero '''Tasks''' [[Xero Projects Endpoints\|endpoint]] provides the list of tasks defined within Xero.		The Xero '''Tasks''' [[Xero Projects Endpoints\|endpoint]] provides the list of tasks defined within Xero.

	~~Note that to make full use of the data in this endpoint may require using [[Xero Accounting Models\|endpoints belonging to a Xero Accounting Model]].~~

Nic at 04:47, 22 September 2021

2021-09-22T04:47:30Z

← Older revision		Revision as of 23:47, 21 September 2021
Line 76:		Line 76:
	== Related Endpoints ==		== Related Endpoints ==

	~~:[[Xero Accounting Endpoint: Contacts\|Contacts]]~~
	~~:[[Xero Accounting Endpoint: ContactsExpanded\|ContactsExpanded]]~~
	~~:[[Xero Accounting Endpoint: Invoices\|Invoices]]~~
	~~:[[Xero Accounting Endpoint: InvoicesExpanded\|InvoicesExpanded]]~~
	:[[Xero Projects Endpoint: Projects\|Projects]]		:[[Xero Projects Endpoint: Projects\|Projects]]
	:[[Xero Projects Endpoint: Times\|Times]]		:[[Xero Projects Endpoint: Times\|Times]]

Nic at 04:42, 22 September 2021

2021-09-22T04:42:43Z

← Older revision		Revision as of 23:42, 21 September 2021
Line 8:		Line 8:
	== Fields ==		== Fields ==

	The following fields are available for the ~~Projects~~ endpoint.		The following fields are available for the Tasks endpoint.

	;taskId		;taskId

Nic: Created page with "== Overview == The Xero '''Tasks''' endpoint provides the list of tasks defined within Xero. Note that to make full use of the data in this endpo..."

2021-09-22T04:41:42Z

Created page with "== Overview == The Xero '''Tasks''' endpoint provides the list of tasks defined within Xero. Note that to make full use of the data in this endpo..."

New page

== Overview ==

The Xero '''Tasks''' [[Xero Projects Endpoints|endpoint]] provides the list of tasks defined within Xero.

Note that to make full use of the data in this endpoint may require using [[Xero Accounting Models|endpoints belonging to a Xero Accounting Model]].

== Fields ==

The following fields are available for the Projects endpoint.

;taskId
:A [[Field Type: GUID|guid field]] that provides the id of the task.

;projectId
:A [[Field Type: GUID|guid field]] that provides the id of the associated project.

;name
:A [[Field Type: Text|text field]] that provides the name of the project.

;chargeType
:A [[Field Type: Text|text field]] that indicates the way the task is charged.
:Possible values are:
:* '''TIME''': Indicates the task is charged per hour.
:* '''FIXED''': Indicates the task is charged as a fixed amount.
:* '''NON_CHARGEABLE''': Indicates the task is not chargeable.

;status
:A [[Field Type: Text|text field]] that indicates the status of the project.
:Possible values are:
:* '''ACTIVE''': Indicates the task is active.
:* '''INVOICED''': Indicates a task whose '''chargeType''' is set to '''FIXED''' has been invoiced.
:* '''LOCKED''': Indicates the task is locked and cannt be modified.

;estimateMinutes
:A [[Field Type: Integer|whole number field]] that provides the total estimated minutes.

;totalMinutes
:A [[Field Type: Integer|whole number field]] that provides the total actual minutes.

;minutesToBeInvoiced
:A [[Field Type: Integer|whole number field]] that provides the total minutes yet to be invoiced.

;minutesInvoiced
:A [[Field Type: Integer|whole number field]] that provides the total minutes already invoiced.

;nonChargeableMinutes
:A [[Field Type: Integer|whole number field]] that provides the total minutes that will not be invoiced for tasks whose '''chargeType''' is set to '''NON_CHARGEABLE'''

;fixedMinutes
:A [[Field Type: Integer|whole number field]] that provides the total minutes for tasks whose '''chargeType''' is set to '''FIXED'''.

;rate
:A [[Field Type: Record|record field]] that provides the [[Xero Projects Field: Amounts|billable rate]] of the task.

;totalAmount
:A [[Field Type: Record|record field]] that provides the total [[Xero Projects Field: Amounts|billable amount]] of the task.

;amountToBeInvoiced
:A [[Field Type: Record|record field]] that provides the total [[Xero Projects Field: Amounts|billable amount]] of the task yet to be invoiced.

;amountInvoiced
:A [[Field Type: Record|record field]] that provides the total [[Xero Projects Field: Amounts|billable amount]] of the task already invoiced.

== Xero API ==

For a detailed run through of the endpoint, you can see the [https://developer.xero.com/documentation/api/projects/tasks Xero API].

== Related Fields ==

:[[Xero Projects Field: Amounts|Amounts]]

== Related Endpoints ==

:[[Xero Accounting Endpoint: Contacts|Contacts]]
:[[Xero Accounting Endpoint: ContactsExpanded|ContactsExpanded]]
:[[Xero Accounting Endpoint: Invoices|Invoices]]
:[[Xero Accounting Endpoint: InvoicesExpanded|InvoicesExpanded]]
:[[Xero Projects Endpoint: Projects|Projects]]
:[[Xero Projects Endpoint: Times|Times]]