Xero Projects Endpoint: GetTimes

From OdataLink
Jump to navigation Jump to search

Overview

The Xero GetTimes endpoint provides the list of times defined within Xero for a single project.

It is a function that accepts a series of parameters.

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


Parameters

The GetTimes 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.
FromDate
A date field that determines the start date for which to retrieve data.
If omitted, it will use the default model start date or the first date of the last calendar month.
ToDate
A date field that determines the end date for which to retrieve data.
If omitted, it will use the default model end date or the last date of the last calendar month.


Fields

The following fields are available for the Times endpoint.

timeEntryId
A guid field that provides the id of the time entry.
userId
A guid field that provides the id of the associated user.
projectId
A guid field that provides the id of the associated project.
taskId
A guid field that provides the id of the associated task.
dateUtc
A date time field that provides the date and time this entry was logged.
dateEnteredUtc
A date time field that provides the date and time this entry was created/recorded in Xero.
duration
A whole number field that provides the total duration in minutes of the time entry.
description
A text field that provides the narrative description of the time entry
status
A text field that indicates the status of the project.
Possible values are:
  • ACTIVE: Indicates the time entry is active and editable.
  • INVOICED: Indicates the time entry has been invoiced.
  • LOCKED: Indicates the time entry is changing state and may be in the process of being invoiced.


Xero API

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


Related Fields

None


Related Endpoints

Projects
Times
Users


Related Topics

Xero Projects Models
Xero Projects Endpoints