Sign in
latestOpenAPI 3.1.0Apache 2.02026-07-22160175414.0 KB

110f9897756c

Projects

Create a new Project

Create a new Project

post/timmi-project/api/v4/projects

Request body

idinteger
namestring required
codestring nullable

Defaults to an automatically generated value.

clientIdinteger required
ownerIdinteger
status'draft' | 'ongoing' | 'completed' | 'cancelled' | 'suspended' | 'archived'

Project is only available for time submission when having a "ongoing" status. Status can be updated through the "status-updates" API.

contractType'nonBillable' | 'fixedPrice' | 'timeAndMaterials' | 'cappedTimeAndMaterials'

Describes project contract types:

  • Non-billable (internal): no revenue recognized, budget estimates are optional.
  • Fixed price: progress-based revenue recognition, budget estimates are mandatory.
  • Time and Materials: time-based revenue recognition, initial estimates are indicative.
  • Not-to-exceed Time and Materials: time-based revenue recognition with a maximum value, initial estimate sets the maximum value.
startsOnstring date nullable

Start of the project execution.

createdAtstring date-time

Timestamp of the project creation.

lastModifiedAtstring date-time

Timestamp of the last update to the project.

authorizedActionsstring[]

Actions the current user can do on the project.

organizationIdinteger

Identifier of the organization this project belongs to. Inherited from the client.

descriptionstring nullable

Optional markdown formatted description.

initialDeliveryDatestring date nullable

Initially planned delivery date.

revisedDeliveryDatestring date nullable

Updated planned (or actual) delivery date.

launchedAtstring date-time nullable

Timestamp of the project launch.

lastChargedOnstring date nullable

Timestamp of the last time or expense allocated on the project.

standardRateCardIdinteger required
discountRatenumber nullable
initialRecoveryRatenumber nullable
estimatedRecoveryRatenumber nullable

Example request

{
  "initialTimeEstimate": {
    "iso": "PT7H30M"
  },
  "revisedTimeEstimate": {
    "iso": "PT7H30M"
  },
  "invoicingWarnings": [
    {
      "applicableFrom": "2021-07-22"
    }
  ]
}

Response

Created

idinteger
namestring required
codestring nullable

Defaults to an automatically generated value.

clientIdinteger required
ownerIdinteger
status'draft' | 'ongoing' | 'completed' | 'cancelled' | 'suspended' | 'archived'

Project is only available for time submission when having a "ongoing" status. Status can be updated through the "status-updates" API.

contractType'nonBillable' | 'fixedPrice' | 'timeAndMaterials' | 'cappedTimeAndMaterials'

Describes project contract types:

  • Non-billable (internal): no revenue recognized, budget estimates are optional.
  • Fixed price: progress-based revenue recognition, budget estimates are mandatory.
  • Time and Materials: time-based revenue recognition, initial estimates are indicative.
  • Not-to-exceed Time and Materials: time-based revenue recognition with a maximum value, initial estimate sets the maximum value.
startsOnstring date nullable

Start of the project execution.

createdAtstring date-time

Timestamp of the project creation.

lastModifiedAtstring date-time

Timestamp of the last update to the project.

authorizedActionsstring[]

Actions the current user can do on the project.

organizationIdinteger

Identifier of the organization this project belongs to. Inherited from the client.

descriptionstring nullable

Optional markdown formatted description.

initialDeliveryDatestring date nullable

Initially planned delivery date.

revisedDeliveryDatestring date nullable

Updated planned (or actual) delivery date.

launchedAtstring date-time nullable

Timestamp of the project launch.

lastChargedOnstring date nullable

Timestamp of the last time or expense allocated on the project.

standardRateCardIdinteger required
discountRatenumber nullable
initialRecoveryRatenumber nullable
estimatedRecoveryRatenumber nullable

Example response

{
  "initialTimeEstimate": {
    "iso": "PT7H30M"
  },
  "revisedTimeEstimate": {
    "iso": "PT7H30M"
  },
  "invoicingWarnings": [
    {
      "applicableFrom": "2021-07-22"
    }
  ]
}