ch.aaap.harvestclient.domain

Interface Project

All Superinterfaces:

BaseObject<Project>, Reference<Project>

@Gson.TypeAdapters(fieldNamingStrategy=true)
 @Value.Immutable
public interface Project
extends BaseObject<Project>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Project.BillingMethod
static class	Project.BudgetMethod

Method Summary

Modifier and Type	Method and Description
Boolean	getActive()
Boolean	getBillable()
Project.BillingMethod	getBillBy()
Double	getBudget()
Project.BudgetMethod	getBudgetBy()
Reference<Client>	getClient()
String	getCode()
Double	getCostBudget()
Boolean	getCostBudgetIncludeExpenses()
LocalDate	getEndsOn()
Double	getFee()
Boolean	getFixedFee()
Double	getHourlyRate()
String	getName()
String	getNotes() max length = 65,535
Boolean	getNotifyWhenOverBudget()
LocalDate	getOverBudgetNotificationDate()
Double	getOverBudgetNotificationPercentage()
Boolean	getShowBudgetToAll()
LocalDate	getStartsOn()

Methods inherited from interface ch.aaap.harvestclient.domain.BaseObject

getCreatedAt, getId, getUpdatedAt

Methods inherited from interface ch.aaap.harvestclient.domain.reference.Reference

requireId

Method Detail

getClient

@SerializedName(value="client_id",
                alternate="client")
Reference<Client> getClient()

getName

String getName()

getCode

@Nullable
String getCode()

getActive

@SerializedName(value="is_active")
 @Nullable
Boolean getActive()

getBillable

@SerializedName(value="is_billable")
Boolean getBillable()

getFixedFee

@SerializedName(value="is_fixed_fee")
 @Nullable
Boolean getFixedFee()

Returns:

Whether the project is a fixed-fee project or not. Setting this to true at creation will set billBy to NONE, regardless of input

getBillBy

Project.BillingMethod getBillBy()

getHourlyRate

@Nullable
Double getHourlyRate()

Returns:

Rate for projects when billedBy is Project.BillingMethod.PROJECT

getBudget

@Nullable
Double getBudget()

Returns:

Budget in hours for project when budgetBy is Project.BudgetMethod.HOURS_PER_PROJECT

getBudgetBy

Project.BudgetMethod getBudgetBy()

getNotifyWhenOverBudget

@Nullable
Boolean getNotifyWhenOverBudget()

getOverBudgetNotificationPercentage

@Nullable
Double getOverBudgetNotificationPercentage()

getOverBudgetNotificationDate

@Nullable
LocalDate getOverBudgetNotificationDate()

getShowBudgetToAll

@Nullable
Boolean getShowBudgetToAll()

Returns:

Option to show project budget to all employees. Does not apply to Total Project Fee projects. Defaults to false.

getCostBudget

@Nullable
Double getCostBudget()

Returns:

The monetary budget for the project when budgetBy is Project.BudgetMethod.TOTAL_PROJECT_FEES

getCostBudgetIncludeExpenses

@Nullable
Boolean getCostBudgetIncludeExpenses()

Returns:

Option for budget of Total Project Fees projects to include tracked expenses. Defaults to false.

getFee

@Nullable
Double getFee()

Returns:

The amount you plan to invoice for the project. Only used by fixed-fee projects.

getNotes

@Nullable
String getNotes()

max length = 65,535

Returns:

the current value

getStartsOn

@Nullable
LocalDate getStartsOn()

getEndsOn

@Nullable
LocalDate getEndsOn()