Xero Projects Endpoint: GetTasks

From OdataLink
Jump to navigation Jump to search

Overview

The Xero GetTasks endpoint provides the list of tasks defined within Xero for a single project.

It is a function that accepts a series of parameters.

You may also use the Tasks endpoint which provides similar data but for all known projects. The GetTasks function provides more control.


Parameters

The GetTasks is a function that accepts the following parameters.

ProjectID
A guid field that determines the project for which to retrieve data.
This field is mandatory.


Fields

The following fields are available for the GetTasks endpoint.

taskId
A guid field that provides the id of the task.
projectId
A guid field that provides the id of the associated project.
name
A text field that provides the name of the project.
chargeType
A 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 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 whole number field that provides the total estimated minutes.
totalMinutes
A whole number field that provides the total actual minutes.
minutesToBeInvoiced
A whole number field that provides the total minutes yet to be invoiced.
minutesInvoiced
A whole number field that provides the total minutes already invoiced.
nonChargeableMinutes
A whole number field that provides the total minutes that will not be invoiced for tasks whose chargeType is set to NON_CHARGEABLE
fixedMinutes
A whole number field that provides the total minutes for tasks whose chargeType is set to FIXED.
rate
A record field that provides the billable rate of the task.
totalAmount
A record field that provides the total billable amount of the task.
amountToBeInvoiced
A record field that provides the total billable amount of the task yet to be invoiced.
amountInvoiced
A record field that provides the total billable amount of the task already invoiced.


Xero API

For a detailed run through of the endpoint, you can see the Xero API.


Related Fields

Amounts


Related Endpoints

Projects
Tasks


Related Topics

Xero Projects Models
Xero Projects Endpoints