Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

idInteger A unique id assigned to the period.
budget_typeString 
allowance_typeString 
date_createdunix timestamp 
date_commencedunix timestamp 
date_expiresunix timestamp 
date_closedunix timestamp 
rate_typeString 
rate_idUnsigned int 
service_item_idUnsigned int 
duration_typeString 
rolloverString 
standingStringStanding status
contractStringAPI url for the contract
contract_idUnsigned int 
contract_budgetUnsigned int or object 
Status
colourGreen
titleNEW
budget_used

Object.

If the type is time, the value is time in seconds

If the type is currency, the value is decimal.

 
Status
colourGreen
titleNEW
budget

Object.

If the type is time, the value is time in seconds

If the type is currency, the value is decimal.

 
Status
colourGreen
titleNEW
allowance

Object.

billable: time in seconds.
charged: currency.

 
Status
colourGreen
titleNEW
total
 Decimal 
Status
colourGreen
titleNEW
unapproved_budget_used
 Unsigned int 
Status
colourGreen
titleNEW
on_budget
 Boolean, whether the it's on budget. 1 or 0
Status
colourGreen
titleNEW
overflow
 Decimal 
Status
colourGreen
titleNEW
usage
 Decimal 
Status
colourGreen
titleNEW
time_allocations
Array, time allocations for a period

Each element is the details of the time allocation.

It has three types, time allocated directly against the

period, time allocated to the task against period and

time allocated to other objects against period.

The item contains:

against title,

against_id,

against_type,

period_id,

nonbillable (time in seconds),

billable (time in seconds),

charged (currency).

Status
colourGreen
titleNEW
rate
Object

value: Decimal
using_allocated_rate: Bool, 1 or 0
title: String
excess: Bool, 1 or 0

Status
colourGreen
titleNEW
price
Decimal 

...