Allocations

Resources dedicated to allocations

put

Updates an existing allocation (cost or consulting revenue).

Secured by basic

Each request must contain the headers necessary for basic authentication

URI Parameters

  • allocationId: required (string)

Body

Media type: application/json

Type: object

Properties
  • startDate: required (string)

    yyyy-MM-dd

  • endDate: required (string)

    yyyy-MM-dd

  • deletedOn: (string)

    yyyy-MM-dd

  • percentage: required (number - minimum: 0 - maximum: 100)
  • id: (number)

Example:

{
  "startDate": "2017-02-11",
  "endDate": "2017-03-01",
  "percentage": 50
}

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • success: required (boolean)

Example:

{
  "success": true
}

HTTP status code 400

Body

Media type: application/json

Type: object

Properties
  • error: (string)
  • errorMessages: (array of )
  • errors: (object)

    Example:

    {
      "errors": {
        "endDate": "The start date must be before or equal to the end date"
      }
    }

    HTTP status code 404

    Body

    Media type: application/json

    Type: object

    Properties
    • error: (string)
    • errorMessages: (array of )
    • errors: (object)

      Example:

      {
        "errorMessages": [
          "Position does not exist"
        ]
      }

      Secured by basic

      Headers

      • Authorization: required (string)

        Used to send the Base64-encoded "username:password" credentials

      delete

      Deletes an existing allocation (cost or consulting revenue).

      Secured by basic

      Each request must contain the headers necessary for basic authentication

      URI Parameters

      • allocationId: required (string)

      HTTP status code 200

      Body

      Media type: application/json

      Type: object

      Properties
      • success: required (boolean)

      Example:

      {
        "success": true
      }

      HTTP status code 400

      Body

      Media type: application/json

      Type: object

      Properties
      • error: (string)
      • errorMessages: (array of )
      • errors: (object)

        Example:

        {
          "errorMessages": [
            "A staff member must have at least one availability period"
          ]
        }

        HTTP status code 404

        Body

        Media type: application/json

        Type: object

        Properties
        • error: (string)
        • errorMessages: (array of )
        • errors: (object)

          Example:

          {
            "errorMessages": [
              "Position does not exist"
            ]
          }

          Secured by basic

          Headers

          • Authorization: required (string)

            Used to send the Base64-encoded "username:password" credentials

          Billable Hours

          Resources dedicated to billable hours

          put

          Updates an existing consultant revenue billable hours.

          Secured by basic

          Each request must contain the headers necessary for basic authentication

          URI Parameters

          • billableHoursId: required (string)

          Body

          Media type: application/json

          Type: object

          Properties
          • otEffort: required (number)

            Number of overtime hours worked in period (format :####.##)

          • startDate: required (string)

            yyyy-MM-dd

          • endDate: required (string)

            yyyy-MM-dd

          • deletedOn: (string)

            yyyy-MM-dd

          • reporter: (string)
          • effort: required (number)

            Number of regular hours worked in period (format :####.##)

          • id: (number)

          Example:

          {
            "startDate": "2016-11-15",
            "endDate": "2017-05-30",
            "effort": 2.00,
            "otEffort": 1.00,
            "id": 1270
          }

          HTTP status code 200

          Body

          Media type: application/json

          Type: object

          Properties
          • success: required (boolean)

          Example:

          {
            "success": true
          }

          HTTP status code 400

          Body

          Media type: application/json

          Type: object

          Properties
          • error: (string)
          • errorMessages: (array of )
          • errors: (object)

            Example:

            {
              "errors": {
                "startDate": "Periods conflicting: 13/Nov/16 to 23/Nov/16 (50.00h)"
              }
            }

            HTTP status code 404

            Body

            Media type: application/json

            Type: object

            Properties
            • error: (string)
            • errorMessages: (array of )
            • errors: (object)

              Example:

              {
                "errorMessages": [
                  "Position does not exist"
                ]
              }

              Secured by basic

              Headers

              • Authorization: required (string)

                Used to send the Base64-encoded "username:password" credentials

              delete

              Deletes billable hours. Note that this will have no effect on worked hours that synchronized from the JIRA worklog or that are automatically calculated from the resource's allocation percentage. This method deletes only billable hours overrides entered either manually or programmatically.

              Secured by basic

              Each request must contain the headers necessary for basic authentication

              URI Parameters

              • billableHoursId: required (string)

              HTTP status code 200

              Body

              Media type: application/json

              Type: object

              Properties
              • success: required (boolean)

              Example:

              {
                "success": true
              }

              HTTP status code 404

              Body

              Media type: application/json

              Type: object

              Properties
              • error: (string)
              • errorMessages: (array of )
              • errors: (object)

                Example:

                {
                  "errorMessages": [
                    "Position does not exist"
                  ]
                }

                Secured by basic

                Headers

                • Authorization: required (string)

                  Used to send the Base64-encoded "username:password" credentials

                Expenses

                Resources dedicated to expenses

                /expense put post
                put

                Updates an existing expense (cost or non-consulting revenue).

                Secured by basic

                Each request must contain the headers necessary for basic authentication

                Body

                Media type: application/json

                Type: object

                Properties
                • folioId: required (number)
                • description: required (string)
                • deletedOn: (string)

                  yyyy-MM-dd

                • category: required (one of OPEX, CAPEX, FINEX, OPERATING, NON_OPERATING)
                • amount: required (number)
                • labels: (array of )
                • amortized: (boolean)
                • name: required (string)
                • customFields: (object)
                  • values: required (object)

                    ID of a default Tempo Holiday Scheme determining the non-working days of the team members of this Folio.

                  • type: required (string)
                  • reporter: (string)
                  • id: (number)
                  • kind: required (one of .ActualExpense, .PlannedRevenue, .ActualRevenue, .PlannedExpense)
                  • baselineId: (number)
                  • recurrence: required (object)
                    • convertedAmount: (number)
                    • currencyCode: required (string)

                    Example:

                    {
                      "name": "def",
                      "type": "A New Type",
                      "category": "CAPEX",
                      "amount": 40.00,
                      "description": "A New Desc",
                      "currencyCode": "CAD",
                      "folioId": 9275,
                      "kind": ".ActualExpense",
                      "recurrence": {
                        "startDate": "2013-01-10",
                        "kind": ".Daily"
                      },
                      "id": 35282,
                      "amortized": true
                    }

                    HTTP status code 200

                    Body

                    Media type: application/json

                    Type: object

                    Properties
                    • success: required (object)
                      • folioId: required (number)
                      • description: required (string)
                      • deletedOn: (string)

                        yyyy-MM-dd

                      • category: required (one of OPEX, CAPEX, FINEX, OPERATING, NON_OPERATING)
                      • amount: required (number)
                      • labels: (array of )
                      • amortized: (boolean)
                      • name: required (string)
                      • customFields: (object)
                        • values: required (object)

                          ID of a default Tempo Holiday Scheme determining the non-working days of the team members of this Folio.

                        • type: required (string)
                        • reporter: (string)
                        • id: (number)
                        • kind: required (one of .ActualExpense, .PlannedRevenue, .ActualRevenue, .PlannedExpense)
                        • baselineId: (number)
                        • recurrence: required (object)
                          • convertedAmount: (number)
                          • currencyCode: required (string)

                        Example:

                        {
                          "success": {
                            "id": 35282,
                            "kind": ".ActualExpense",
                            "folioId": 9275,
                            "name": "def",
                            "reporter": "admin",
                            "description": "A New Desc",
                            "customFields": {
                              "values": {
                        
                              }
                            },
                            "type": "A New Type",
                            "amount": 40.00,
                            "convertedAmount": 40.00,
                            "currencyCode": "CAD",
                            "recurrence": {
                              "kind": ".Daily",
                              "kind": ".Daily",
                              "startDate": "2013-01-10",
                              "occurrences": 0,
                              "interval": 1
                            },
                            "amortized": true,
                            "labels": [
                        
                            ],
                            "category": "CAPEX"
                          }
                        }

                        HTTP status code 400

                        Body

                        Media type: application/json

                        Type: object

                        Properties
                        • error: (string)
                        • errorMessages: (array of )
                        • errors: (object)

                          Example:

                          {
                            "error": "Unable to unmarshal (to type [simple type, class java.lang.String]): Illegal date format: must be yyyy-MM-dd (through reference chain: com.tempoplugin.folio.web.rest.api.model.expense.PlannedRevenue[\"recurrence\"]->com.tempoplugin.folio.web.rest.api.model.recurrence.Once[\"startDate\"])",
                            "errors": {
                              "name": "Name is required",
                              "type": "Expense type is required",
                              "amount": "Amount is required"
                            }
                          }

                          Secured by basic

                          Headers

                          • Authorization: required (string)

                            Used to send the Base64-encoded "username:password" credentials

                          post

                          Adds an expense (cost or non-consulting revenue) to a Folio.

                          Secured by basic

                          Each request must contain the headers necessary for basic authentication

                          Body

                          Media type: application/json

                          Type: object

                          Properties
                          • folioId: required (number)
                          • description: required (string)
                          • deletedOn: (string)

                            yyyy-MM-dd

                          • category: required (one of OPEX, CAPEX, FINEX, OPERATING, NON_OPERATING)
                          • amount: required (number)
                          • labels: (array of )
                          • amortized: (boolean)
                          • name: required (string)
                          • customFields: (object)
                            • values: required (object)

                              ID of a default Tempo Holiday Scheme determining the non-working days of the team members of this Folio.

                            • type: required (string)
                            • reporter: (string)
                            • id: (number)
                            • kind: required (one of .ActualExpense, .PlannedRevenue, .ActualRevenue, .PlannedExpense)
                            • baselineId: (number)
                            • recurrence: required (object)
                              • convertedAmount: (number)
                              • currencyCode: required (string)

                              Examples:

                              Once:

                              {
                                "name": "An Expense",
                                "type": "Equipment",
                                "category": "OPERATING",
                                "amount": 543.21,
                                "description": "My Description",
                                "currencyCode": "CAD",
                                "folioId": 9252,
                                "kind": ".PlannedRevenue",
                                "recurrence": {
                                  "startDate": "2014-01-21",
                                  "kind": ".Once"
                                }
                              }
                              

                              Weekly:

                              {
                                "name": "An Expense",
                                "type": "Equipment",
                                "category": "OPEX",
                                "amount": 123.45,
                                "description": "My Description",
                                "currencyCode": "CAD",
                                "folioId": 9263,
                                "kind": ".PlannedExpense",
                                "recurrence": {
                                  "startDate": "2013-01-01",
                                  "kind": ".Weekly",
                                  "endDate": "2013-01-20",
                                  "recurrenceOn": [
                                    1,
                                    5
                                  ]
                                }
                              }

                              Monthly:

                              {
                                "name": "An Expense",
                                "type": "Equipment",
                                "category": "OPEX",
                                "amount": 123.45,
                                "description": "My Description",
                                "currencyCode": "CAD",
                                "folioId": 9264,
                                "kind": ".PlannedExpense",
                                "recurrence": {
                                  "startDate": "2013-01-20",
                                  "kind": ".Monthly",
                                  "occurrences": 3,
                                  "recurrenceBy": "DAY_OF_MONTH"
                                }
                              }

                              Yearly:

                              {
                                "name": "An Expense",
                                "type": "Equipment",
                                "category": "OPEX",
                                "amount": 123.45,
                                "description": "My Description",
                                "currencyCode": "CAD",
                                "folioId": 9265,
                                "kind": ".PlannedExpense",
                                "customFields": {
                                  "values": {
                                    "3483": "def",
                                    "3482": "abc"
                                  }
                                },
                                "recurrence": {
                                  "startDate": "2013-01-20",
                                  "kind": ".Yearly",
                                  "interval": 2,
                                  "occurrences": 3,
                                  "endDate": "2013-01-25"
                                }
                              }

                              HTTP status code 200

                              Body

                              Media type: application/json

                              Type: object

                              Properties
                              • success: required (number)

                              Example:

                              {
                                "success": 2322
                              }

                              HTTP status code 400

                              Body

                              Media type: application/json

                              Type: object

                              Properties
                              • error: (string)
                              • errorMessages: (array of )
                              • errors: (object)

                                Example:

                                {
                                  "error": "Unable to unmarshal (to type [simple type, class java.lang.String]): Illegal date format: must be yyyy-MM-dd (through reference chain: com.tempoplugin.folio.web.rest.api.model.expense.PlannedRevenue[\"recurrence\"]->com.tempoplugin.folio.web.rest.api.model.recurrence.Once[\"startDate\"])",
                                  "errors": {
                                    "name": "Name is required",
                                    "type": "Expense type is required",
                                    "amount": "Amount is required"
                                  }
                                }

                                Secured by basic

                                Headers

                                • Authorization: required (string)

                                  Used to send the Base64-encoded "username:password" credentials

                                get

                                Retrieves an expense (cost or non-consulting revenue) by its ID

                                Secured by basic

                                Each request must contain the headers necessary for basic authentication

                                URI Parameters

                                • expenseId: required (string)

                                HTTP status code 200

                                Body

                                Media type: application/json

                                Type: object

                                Properties
                                • success: required (object)
                                  • folioId: required (number)
                                  • description: required (string)
                                  • deletedOn: (string)

                                    yyyy-MM-dd

                                  • category: required (one of OPEX, CAPEX, FINEX, OPERATING, NON_OPERATING)
                                  • amount: required (number)
                                  • labels: (array of )
                                  • amortized: (boolean)
                                  • name: required (string)
                                  • customFields: (object)
                                    • values: required (object)

                                      ID of a default Tempo Holiday Scheme determining the non-working days of the team members of this Folio.

                                    • type: required (string)
                                    • reporter: (string)
                                    • id: (number)
                                    • kind: required (one of .ActualExpense, .PlannedRevenue, .ActualRevenue, .PlannedExpense)
                                    • baselineId: (number)
                                    • recurrence: required (object)
                                      • convertedAmount: (number)
                                      • currencyCode: required (string)

                                    Example:

                                    {
                                      "success": {
                                        "id": 35267,
                                        "kind": ".PlannedRevenue",
                                        "folioId": 9252,
                                        "name": "An Expense",
                                        "reporter": "admin",
                                        "description": "My Description",
                                        "customFields": {
                                          "values": {
                                    
                                          }
                                        },
                                        "type": "Equipment",
                                        "amount": 543.21,
                                        "convertedAmount": 543.21,
                                        "currencyCode": "CAD",
                                        "recurrence": {
                                          "kind": ".Once",
                                          "kind": ".Once",
                                          "startDate": "2014-01-21"
                                        },
                                        "amortized": false,
                                        "labels": [
                                    
                                        ],
                                        "category": "OPERATING"
                                      }
                                    }

                                    HTTP status code 404

                                    Body

                                    Media type: application/json

                                    Type: object

                                    Properties
                                    • error: (string)
                                    • errorMessages: (array of )
                                    • errors: (object)

                                      Example:

                                      {
                                        "errorMessages": [
                                          "The requested folio cannot be viewed because it either does not exist or you do not have permission to view it."
                                        ]
                                      }

                                      Secured by basic

                                      Headers

                                      • Authorization: required (string)

                                        Used to send the Base64-encoded "username:password" credentials

                                      delete

                                      Deletes an expense (cost or non-consulting revenue).

                                      Secured by basic

                                      Each request must contain the headers necessary for basic authentication

                                      URI Parameters

                                      • expenseId: required (string)

                                      HTTP status code 200

                                      Body

                                      Media type: application/json

                                      Type: object

                                      Properties
                                      • success: required (boolean)

                                      Example:

                                      {
                                        "success": true
                                      }

                                      HTTP status code 404

                                      Body

                                      Media type: application/json

                                      Type: object

                                      Properties
                                      • error: (string)
                                      • errorMessages: (array of )
                                      • errors: (object)

                                        Example:

                                        {
                                          "errorMessages": [
                                            "The requested folio cannot be viewed because it either does not exist or you do not have permission to view it."
                                          ]
                                        }

                                        Secured by basic

                                        Headers

                                        • Authorization: required (string)

                                          Used to send the Base64-encoded "username:password" credentials

                                        get

                                        Retrieves an expenses' payments (planned expense or revenue).

                                        Secured by basic

                                        Each request must contain the headers necessary for basic authentication

                                        URI Parameters

                                        • expenseId: required (string)

                                        HTTP status code 200

                                        Body

                                        Media type: application/json

                                        Type: object

                                        Properties
                                        • success: required (array of Expense Payment)

                                          Items: Expense Payment

                                          • date: required (string)

                                            yyyy-MM-dd

                                          • totalAmount: (number)

                                            Total amount of this payment, adding up amount and overtimeAmount, if any.

                                          • amount: required (number)

                                            The amount of this payment. If it is a payment for a Position, then it includes only the payment for regular hours.

                                          • overtimeAmount: (number)

                                            Amount for overtime hours included in this payment.

                                          • rate: (number)

                                            Cost rate used to calculate the payment.

                                          • totalEffort: (number)

                                            Total effort included in this payment, adding up effort and overtimeEffort, if any.

                                          • overtimeEffort: (number)

                                            Effort in overtime hours included in this payment.

                                          • effort: (number)

                                            Effort in regular (non-overtime) hours included in this payment.

                                        Example:

                                        {
                                          "success": [
                                            {
                                              "date": "2013-01-01",
                                              "amount": 1000.0000
                                            },
                                            {
                                              "date": "2013-02-01",
                                              "amount": 1000.0000
                                            },
                                            {
                                              "date": "2013-03-01",
                                              "amount": 1000.0000
                                            }
                                          ]
                                        }

                                        Secured by basic

                                        Headers

                                        • Authorization: required (string)

                                          Used to send the Base64-encoded "username:password" credentials

                                        Folios

                                        Resources dedicated to folios

                                        /folio get post
                                        get

                                        Retrieves summary information of all Folios that are visible to the user performing the request.

                                        Secured by basic

                                        Each request must contain the headers necessary for basic authentication

                                        HTTP status code 200

                                        Body

                                        Media type: application/json

                                        Type: object

                                        Properties
                                        • success: required (array of Portfolio child Folio)

                                          Items: Portfolio child Folio

                                          • id: required (number)
                                          • name: required (string)
                                          • startDate: required (string)

                                            yyyy-MM-dd

                                          • closedDate: (string)

                                            yyyy-MM-dd

                                          • endDate: required (string)

                                            yyyy-MM-dd

                                          • owner: required (string)
                                          • status: required (string)
                                          • withRevenue: (boolean)
                                          • withEarned: (boolean)

                                        Example:

                                        {
                                          "success": [
                                            {
                                              "id": 9076,
                                              "name": "All issues",
                                              "startDate": "2016-01-01",
                                              "endDate": "2017-12-31",
                                              "owner": "admin",
                                              "status": "executing",
                                              "withRevenue": false,
                                              "withEarned": false
                                            },
                                            {
                                              "id": 7639,
                                              "name": "Folio under test [ST]",
                                              "startDate": "2016-01-23",
                                              "endDate": "2016-08-10",
                                              "closedDate": "2016-07-31",
                                              "owner": "admin",
                                              "status": "closed",
                                              "withRevenue": false,
                                              "withEarned": false
                                            }
                                          ]
                                        }

                                        Secured by basic

                                        Headers

                                        • Authorization: required (string)

                                          Used to send the Base64-encoded "username:password" credentials

                                        post

                                        Creates and configures a new Folio

                                        Secured by basic

                                        Each request must contain the headers necessary for basic authentication

                                        Body

                                        Media type: application/json

                                        Type: object

                                        Properties
                                        • description: required (string - maxLength: 500)
                                        • deletedOn: (string)

                                          yyyy-MM-dd

                                        • reserve: required (number)

                                          A positive number indicating the percentage of reserve, applied to the total budget of the Folio.

                                        • closedDate: required (string)

                                          yyyy-MM-dd

                                        • name: required (string)
                                        • customFields: (object)
                                          • values: required (object)

                                            ID of a default Tempo Holiday Scheme determining the non-working days of the team members of this Folio.

                                          • tolerance: required (number)

                                            A positive number representing a percentage that provides a range of values for which performance indices turn amber, instead of red.

                                          • startDate: required (string)

                                            yyyy-MM-dd

                                          • usesUserRates: required (boolean)

                                            Does this Folio use global user rates by default to calculate actual hourly cost of its team members?

                                          • isSynchronizedWithAccounts: (boolean)
                                          • isSynchronizedWithTempoBilledHours: required (boolean)

                                            Does this Folio use Tempo billed hours by default for consulting revenues it contains? This is applicable only if withRevenue is true.

                                          • savedFilterId: required (number)

                                            ID of a valid JIRA saved filter associated with this Folio.

                                          • holidaySchemeId: required (number)

                                            ID of a default Tempo Holiday Scheme determining the non-working days of the team members of this Folio.

                                          • withEarned: required (boolean)

                                            Does this folio use evm technique or not?

                                          • revenuesAsClientCosts: required (boolean)

                                            ndicates if revenues included in this Folio should be considered as client costs. This implies a different status for revenue related performance indices. This is applicable only if withRevenue is true.

                                          • isSynchronizedWithWorkLogs: required (boolean)

                                            Does this Folio use JIRA work logs by default for calculating the actual effort of its team members?

                                          • endDate: required (string)

                                            yyyy-MM-dd

                                          • status: (string)

                                            Read-only. determined by start date, end date and today's date.

                                          • id: required (number)
                                          • withRevenue: required (boolean)

                                            Does this folio include revenues or not?

                                          • currencyCode: required (string)

                                            ISO 4217 Three letters currency code specifying the currency used for all amounts in this Folio.

                                          • contingency: required (number)

                                            A positive number indicating the percentage of contingency, applied to the planned value to date of the Folio.

                                          • hoursPerDay: required (number)

                                            This parameter is not used anymore and will be empty for all Folios created since version 7.3.

                                          • workloadSchemeId: required (number)

                                            ID of a default Tempo Workload Scheme determining the weekly work schedule of the team members of this Folio.

                                          • owner: required (string)

                                            JIRA user key

                                          Example:

                                          {
                                            "id": 0,
                                            "name": "Folio under test [TEST]",
                                            "description": "description",
                                            "owner": "admin",
                                            "startDate": "2016-11-13",
                                            "endDate": "2017-06-01",
                                            "closedDate": "2017-05-22",
                                            "withRevenue": true,
                                            "withEarned": true,
                                            "hoursPerDay": 8.0,
                                            "tolerance": 15.0,
                                            "contingency": 20.0,
                                            "reserve": 25.0,
                                            "currencyCode": "CAD",
                                            "usesUserRates": false,
                                            "isSynchronizedWithWorkLogs": true,
                                            "revenuesAsClientCosts": false,
                                            "isSynchronizedWithTempoBilledHours": true,
                                            "savedFilterId": 16800,
                                            "holidaySchemeId": 90,
                                            "workloadSchemeId": 92
                                          }

                                          HTTP status code 200

                                          Body

                                          Media type: application/json

                                          Type: object

                                          Properties
                                          • success: required (number)

                                          Example:

                                          {
                                            "success": 2322
                                          }

                                          Secured by basic

                                          Headers

                                          • Authorization: required (string)

                                            Used to send the Base64-encoded "username:password" credentials

                                          get

                                          Retrieves summary information of a Folio.

                                          Secured by basic

                                          Each request must contain the headers necessary for basic authentication

                                          URI Parameters

                                          • folioId: required (string)

                                          HTTP status code 200

                                          Body

                                          Media type: application/json

                                          Type: object

                                          Properties
                                          • success: required (object)
                                            • description: required (string - maxLength: 500)
                                            • deletedOn: (string)

                                              yyyy-MM-dd

                                            • reserve: required (number)

                                              A positive number indicating the percentage of reserve, applied to the total budget of the Folio.

                                            • closedDate: required (string)

                                              yyyy-MM-dd

                                            • name: required (string)
                                            • customFields: (object)
                                              • values: required (object)

                                                ID of a default Tempo Holiday Scheme determining the non-working days of the team members of this Folio.

                                              • tolerance: required (number)

                                                A positive number representing a percentage that provides a range of values for which performance indices turn amber, instead of red.

                                              • startDate: required (string)

                                                yyyy-MM-dd

                                              • usesUserRates: required (boolean)

                                                Does this Folio use global user rates by default to calculate actual hourly cost of its team members?

                                              • isSynchronizedWithAccounts: (boolean)
                                              • isSynchronizedWithTempoBilledHours: required (boolean)

                                                Does this Folio use Tempo billed hours by default for consulting revenues it contains? This is applicable only if withRevenue is true.

                                              • savedFilterId: required (number)

                                                ID of a valid JIRA saved filter associated with this Folio.

                                              • holidaySchemeId: required (number)

                                                ID of a default Tempo Holiday Scheme determining the non-working days of the team members of this Folio.

                                              • withEarned: required (boolean)

                                                Does this folio use evm technique or not?

                                              • revenuesAsClientCosts: required (boolean)

                                                ndicates if revenues included in this Folio should be considered as client costs. This implies a different status for revenue related performance indices. This is applicable only if withRevenue is true.

                                              • isSynchronizedWithWorkLogs: required (boolean)

                                                Does this Folio use JIRA work logs by default for calculating the actual effort of its team members?

                                              • endDate: required (string)

                                                yyyy-MM-dd

                                              • status: (string)

                                                Read-only. determined by start date, end date and today's date.

                                              • id: required (number)
                                              • withRevenue: required (boolean)

                                                Does this folio include revenues or not?

                                              • currencyCode: required (string)

                                                ISO 4217 Three letters currency code specifying the currency used for all amounts in this Folio.

                                              • contingency: required (number)

                                                A positive number indicating the percentage of contingency, applied to the planned value to date of the Folio.

                                              • hoursPerDay: required (number)

                                                This parameter is not used anymore and will be empty for all Folios created since version 7.3.

                                              • workloadSchemeId: required (number)

                                                ID of a default Tempo Workload Scheme determining the weekly work schedule of the team members of this Folio.

                                              • owner: required (string)

                                                JIRA user key

                                            Example:

                                            {
                                              "success": {
                                                "id": 9326,
                                                "name": "Folio under test [TEST]",
                                                "startDate": "2016-11-13",
                                                "endDate": "2017-06-01",
                                                "closedDate": "2017-05-22",
                                                "owner": "admin",
                                                "status": "closed",
                                                "reserve": 25.0,
                                                "contingency": 20.0,
                                                "tolerance": 15.0,
                                                "savedFilterId": 16800,
                                                "withRevenue": true,
                                                "withEarned": true,
                                                "revenuesAsClientCosts": false,
                                                "description": "description",
                                                "currencyCode": "CAD",
                                                "hoursPerDay": 7.0,
                                                "isSynchronizedWithTempoBilledHours": true,
                                                "isSynchronizedWithWorkLogs": true,
                                                "isSynchronizedWithAccounts": false,
                                                "usesUserRates": false,
                                                "holidaySchemeId": 89,
                                                "workloadSchemeId": 91,
                                                "customFields": {
                                                  "values": {
                                            
                                                  }
                                                }
                                              }
                                            }

                                            HTTP status code 404

                                            Body

                                            Media type: application/json

                                            Type: object

                                            Properties
                                            • error: (string)
                                            • errorMessages: (array of )
                                            • errors: (object)

                                              Example:

                                              {
                                                "errorMessages": [
                                                  "The requested folio cannot be viewed because it either does not exist or you do not have permission to view it."
                                                ]
                                              }

                                              Secured by basic

                                              Headers

                                              • Authorization: required (string)

                                                Used to send the Base64-encoded "username:password" credentials

                                              get

                                              Retrieves the baselines of a Folio. This allows you to retrieve either planned costs or planned revenues baselines, or both.

                                              Secured by basic

                                              Each request must contain the headers necessary for basic authentication

                                              URI Parameters

                                              • folioId: required (string)

                                              Query Parameters

                                              • costs: required (boolean)

                                                Should return the planned costs baselines?

                                              • revenues: required (boolean)

                                                Should return the planned revenues baselines?

                                              HTTP status code 200

                                              Body

                                              Media type: application/json

                                              Type: object

                                              Properties
                                              • success: required (array of Baseline)

                                                Items: Baseline

                                                • expenditureType: required (one of ACTUAL, BUDGET, PLANNED, REVENUE)
                                                • deletedOn: (string)

                                                  yyyy-MM-dd

                                                • created: required (string)

                                                  yyyy-MM-dd

                                                • name: required (string)
                                                • approvedBy: required (string)
                                                • description: (string)
                                                • id: required (number)
                                                • folioId: required (number)

                                              Examples:

                                              Costs:

                                              {
                                                "success": [
                                                  {
                                                    "id": 709,
                                                    "approvedBy": "admin",
                                                    "created": "2016-11-18",
                                                    "expenditureType": "BUDGET",
                                                    "folioId": 9346,
                                                    "name": "B2"
                                                  },
                                                  {
                                                    "id": 708,
                                                    "approvedBy": "admin",
                                                    "created": "2016-11-13",
                                                    "expenditureType": "BUDGET",
                                                    "folioId": 9346,
                                                    "name": "B1"
                                                  }
                                                ]
                                              }

                                              Revenues:

                                              {
                                                "success": [
                                                  {
                                                    "id": 712,
                                                    "approvedBy": "admin",
                                                    "created": "2016-11-18",
                                                    "expenditureType": "PLANNED",
                                                    "folioId": 9347,
                                                    "name": "B2"
                                                  },
                                                  {
                                                    "id": 711,
                                                    "approvedBy": "admin",
                                                    "created": "2016-11-13",
                                                    "expenditureType": "PLANNED",
                                                    "folioId": 9347,
                                                    "name": "B1"
                                                  }
                                                ]
                                              }

                                              Secured by basic

                                              Headers

                                              • Authorization: required (string)

                                                Used to send the Base64-encoded "username:password" credentials

                                              get

                                              Retrieves the custom fields definitions of a Folio. This allows you to retrieve the unique ID of each custom field.

                                              Secured by basic

                                              Each request must contain the headers necessary for basic authentication

                                              URI Parameters

                                              • folioId: required (string)

                                              HTTP status code 200

                                              Body

                                              Media type: application/json

                                              Type: object

                                              Properties
                                              • success: required (object)
                                                • customFields: required (object)
                                                  • //: required (array of Custom Field)

                                                    Items: Custom Field

                                                    • style: required (one of TEXT, SELECT, DATE, NUMBER, AMOUNT, USER)
                                                    • deletedOn: (string)

                                                      yyyy-MM-dd

                                                    • options: (array of )
                                                    • name: required (string)
                                                    • id: required (number)
                                                    • type: required (one of ACTUAL, TEAM, REVENUE, FOLIO)
                                                    • required: required (boolean)

                                              Example:

                                              {
                                                "success": {
                                                  "customFields": {
                                                    "ACTUAL": [
                                                      {
                                                        "id": 3535,
                                                        "name": "cf_actual",
                                                        "style": "SELECT",
                                                        "options": [
                                                          "option1",
                                                          "option2"
                                                        ],
                                                        "type": "ACTUAL",
                                                        "required": false
                                                      }
                                                    ],
                                                    "FOLIO": [
                                                      {
                                                        "id": 104,
                                                        "name": "Version",
                                                        "style": "TEXT",
                                                        "type": "FOLIO",
                                                        "required": false
                                                      },
                                                      {
                                                        "id": 106,
                                                        "name": "Select one",
                                                        "style": "SELECT",
                                                        "options": [
                                                          "one"
                                                        ],
                                                        "type": "FOLIO",
                                                        "required": true
                                                      },
                                                      {
                                                        "id": 107,
                                                        "name": "text_cf_ST_",
                                                        "style": "TEXT",
                                                        "type": "FOLIO",
                                                        "required": false
                                                      },
                                                      {
                                                        "id": 108,
                                                        "name": "user_cf_ST_",
                                                        "style": "USER",
                                                        "type": "FOLIO",
                                                        "required": false
                                                      },
                                                      {
                                                        "id": 109,
                                                        "name": "date_cf_ST_",
                                                        "style": "DATE",
                                                        "type": "FOLIO",
                                                        "required": false
                                                      },
                                                      {
                                                        "id": 110,
                                                        "name": "number_cf_ST_",
                                                        "style": "NUMBER",
                                                        "type": "FOLIO",
                                                        "required": false
                                                      },
                                                      {
                                                        "id": 112,
                                                        "name": "select_cf_ST_",
                                                        "style": "SELECT",
                                                        "options": [
                                                          "a",
                                                          "b",
                                                          "c"
                                                        ],
                                                        "type": "FOLIO",
                                                        "required": false
                                                      },
                                                      {
                                                        "id": 111,
                                                        "name": "amount_cf_ST_",
                                                        "style": "AMOUNT",
                                                        "type": "FOLIO",
                                                        "required": false
                                                      }
                                                    ],
                                                    "TEAM": [
                                                      {
                                                        "id": 3533,
                                                        "name": "cf_team",
                                                        "style": "TEXT",
                                                        "type": "TEAM",
                                                        "required": true
                                                      }
                                                    ],
                                                    "REVENUE": [
                                                      {
                                                        "id": 3534,
                                                        "name": "cf_revenue",
                                                        "style": "DATE",
                                                        "type": "REVENUE",
                                                        "required": false
                                                      }
                                                    ]
                                                  }
                                                }
                                              }

                                              Secured by basic

                                              Headers

                                              • Authorization: required (string)

                                                Used to send the Base64-encoded "username:password" credentials

                                              get

                                              Retrieves expenditures of a Folio. Expenditures include both expenses and positions and both costs and revenues (client costs) that are not deleted. Query parameters allows you to select between costs or revenues and between planned or actuals. You can also specify the baseline ID of the expenses to retrieve. If no baseline ID is specified, then the latest version of the expenditures is returned.

                                              Secured by basic

                                              Each request must contain the headers necessary for basic authentication

                                              URI Parameters

                                              • folioId: required (string)

                                              Query Parameters

                                              • baselineId: required (number)

                                                ID of the baseline.

                                              • actual: required (boolean)

                                                set to true to retrieve actual costs or revenues, false for planned.

                                              • revenue: required (boolean)

                                                set to true to retrieve revenues, false for costs.

                                              HTTP status code 200

                                              Body

                                              Media type: application/json

                                              Type: object

                                              Properties
                                              • success: required (object)
                                                • positions: required (array of Position)

                                                  Items: Position

                                                  • teamRoleId: required (number)

                                                    Tempo team role ID. This id has precedence over title and will override the title specified for this Position on PUT and POST operations, if any. If neither teamRoleId and title are specified, then the default Tempo Team Role will be assigned to this Position.

                                                  • deletedOn: (string)

                                                    yyyy-MM-dd

                                                  • category: (string)
                                                  • accountKey: (string)
                                                  • revenue: (boolean)
                                                  • name: required (string)
                                                  • kind: (string)
                                                  • description: required (string)
                                                  • reporter: (string)

                                                    Ignored on POST and PUT

                                                  • id: (number)
                                                  • folioId: required (number)
                                                  • title: required (string)

                                                    Position role. e.g. Developer, Quality Assurance, etc.

                                                  • baselineId: (number)
                                                  • holidaySchemeId: (number)

                                                    ID of an associated Tempo Holiday Scheme, defining the position's holidays.

                                                  • synchedWithJIRA: (boolean)
                                                  • rate: required (object)
                                                    • rate: required (number)
                                                    • deletedOn: (string)

                                                      yyyy-MM-dd

                                                    • id: (number)
                                                    • startDate: required (string)

                                                      yyyy-MM-dd

                                                  • teamMemberId: (number)
                                                  • userRates: (boolean)
                                                  • teamId: (number)
                                                  • member: (string)

                                                    JIRA user key (or 'unassigned' if an unassigned team position)

                                                  • otRuleId: (number)
                                                  • workloadSchemeId: (number)

                                                    ID of an associated Tempo Workload Scheme, defining the position's weekly work schedule.

                                                  • customFields: (object)
                                                    • values: required (object)

                                                      ID of a default Tempo Holiday Scheme determining the non-working days of the team members of this Folio.

                                                  • allocation: required (object)
                                                    • startDate: required (string)

                                                      yyyy-MM-dd

                                                    • endDate: required (string)

                                                      yyyy-MM-dd

                                                    • deletedOn: (string)

                                                      yyyy-MM-dd

                                                    • percentage: required (number - minimum: 0 - maximum: 100)
                                                    • id: (number)
                                                  • billableHours: (array of BillableHour)

                                                    Items: BillableHour

                                                    • otEffort: required (number)

                                                      Number of overtime hours worked in period (format :####.##)

                                                    • startDate: required (string)

                                                      yyyy-MM-dd

                                                    • endDate: required (string)

                                                      yyyy-MM-dd

                                                    • deletedOn: (string)

                                                      yyyy-MM-dd

                                                    • reporter: (string)
                                                    • effort: required (number)

                                                      Number of regular hours worked in period (format :####.##)

                                                    • id: (number)
                                                • expenses: required (array of Expense)

                                                  Items: Expense

                                                  • id: (number)
                                                  • name: required (string)
                                                  • amount: required (number)
                                                  • deletedOn: (string)

                                                    yyyy-MM-dd

                                                  • description: required (string)
                                                  • currencyCode: required (string)
                                                  • reporter: (string)
                                                  • amortized: (boolean)
                                                  • folioId: required (number)
                                                  • type: required (string)
                                                  • baselineId: (number)
                                                  • convertedAmount: (number)
                                                  • kind: required (one of .ActualExpense, .PlannedRevenue, .ActualRevenue, .PlannedExpense)
                                                  • recurrence: required (object)
                                                  • labels: (array of )
                                                  • category: required (one of OPEX, CAPEX, FINEX, OPERATING, NON_OPERATING)
                                                  • customFields: (object)
                                                    • values: required (object)

                                                      ID of a default Tempo Holiday Scheme determining the non-working days of the team members of this Folio.

                                              Secured by basic

                                              Headers

                                              • Authorization: required (string)

                                                Used to send the Base64-encoded "username:password" credentials

                                              get

                                              Retrieves the team of a Folio. The team of a folio is a list of team members or in other words, actual cost positions. The team potentially includes unassigned positions, if any.

                                              Secured by basic

                                              Each request must contain the headers necessary for basic authentication

                                              URI Parameters

                                              • folioId: required (string)

                                              HTTP status code 200

                                              Body

                                              Media type: application/json

                                              Type: object

                                              Properties
                                              • success: required (object)
                                                • members: required (array of Member)

                                                  Items: Member

                                                  • deletedOn: (string)

                                                    yyyy-MM-dd

                                                  • holidaySchemeId: required (number)

                                                    ID of an associated Tempo Holiday Scheme, defining the position's holidays.

                                                  • synchedWithJIRA: required (boolean)
                                                  • kind: required (string)
                                                  • rates: required (array of Rate)

                                                    Items: Rate

                                                    • rate: required (number)
                                                    • deletedOn: (string)

                                                      yyyy-MM-dd

                                                    • id: (number)
                                                    • startDate: required (string)

                                                      yyyy-MM-dd

                                                  • teamMemberId: (number)
                                                  • description: required (string)
                                                  • reporter: required (string)
                                                  • usesUserRates: required (boolean)
                                                  • folioId: required (number)
                                                  • title: required (string)

                                                    Position role. e.g. Developer, Quality Assurance, etc.

                                                  • baselineId: (number)
                                                  • teamRoleId: required (number)

                                                    Tempo team role ID. This id has precedence over title and will override the title specified for this Position on PUT and POST operations, if any. If neither teamRoleId and title are specified, then the default Tempo Team Role will be assigned to this Position.

                                                  • allocations: required (array of Allocation)

                                                    Items: Allocation

                                                    • startDate: required (string)

                                                      yyyy-MM-dd

                                                    • endDate: required (string)

                                                      yyyy-MM-dd

                                                    • deletedOn: (string)

                                                      yyyy-MM-dd

                                                    • percentage: required (number - minimum: 0 - maximum: 100)
                                                    • id: (number)
                                                  • teamId: (number)
                                                  • name: required (string)
                                                  • member: required (string)

                                                    JIRA user key (or 'unassigned' if an unassigned team position)

                                                  • otRuleId: (number)
                                                  • id: required (number)
                                                  • workedHours: required (array of BillableHour)

                                                    Items: BillableHour

                                                    • otEffort: required (number)

                                                      Number of overtime hours worked in period (format :####.##)

                                                    • startDate: required (string)

                                                      yyyy-MM-dd

                                                    • endDate: required (string)

                                                      yyyy-MM-dd

                                                    • deletedOn: (string)

                                                      yyyy-MM-dd

                                                    • reporter: (string)
                                                    • effort: required (number)

                                                      Number of regular hours worked in period (format :####.##)

                                                    • id: (number)
                                                  • workloadSchemeId: required (number)

                                                    ID of an associated Tempo Workload Scheme, defining the position's weekly work schedule.

                                                  • customFields: required (object)
                                                    • values: required (object)

                                                      ID of a default Tempo Holiday Scheme determining the non-working days of the team members of this Folio.

                                              Example:

                                              {
                                                "success": {
                                                  "members": [
                                                    {
                                                      "kind": ".TeamMember",
                                                      "id": 25761,
                                                      "folioId": 9343,
                                                      "name": "erika_test",
                                                      "reporter": "admin",
                                                      "description": "Java Dev",
                                                      "customFields": {
                                                        "values": {
                                              
                                                        }
                                                      },
                                                      "title": "developer_st",
                                                      "teamRoleId": 14,
                                                      "member": "erika_test",
                                                      "synchedWithJIRA": false,
                                                      "holidaySchemeId": -1,
                                                      "workloadSchemeId": -1,
                                                      "rates": [
                                                        {
                                                          "id": 26524,
                                                          "startDate": "2016-11-13",
                                                          "rate": 10.0000
                                                        }
                                                      ],
                                                      "allocations": [
                                              
                                                      ],
                                                      "usesUserRates": false,
                                                      "workedHours": [
                                              
                                                      ]
                                                    },
                                                    {
                                                      "kind": ".TeamMember",
                                                      "id": 25760,
                                                      "folioId": 9343,
                                                      "name": "j.smith_test",
                                                      "reporter": "admin",
                                                      "description": "Java Dev",
                                                      "customFields": {
                                                        "values": {
                                              
                                                        }
                                                      },
                                                      "title": "developer_st",
                                                      "teamRoleId": 14,
                                                      "member": "j.smith_test",
                                                      "synchedWithJIRA": false,
                                                      "holidaySchemeId": -1,
                                                      "workloadSchemeId": -1,
                                                      "rates": [
                                                        {
                                                          "id": 26523,
                                                          "startDate": "2016-11-13",
                                                          "rate": 10.0000
                                                        }
                                                      ],
                                                      "allocations": [
                                              
                                                      ],
                                                      "usesUserRates": false,
                                                      "workedHours": [
                                              
                                                      ]
                                                    },
                                                    {
                                                      "kind": ".TeamMember",
                                                      "id": 25759,
                                                      "folioId": 9343,
                                                      "name": "Edgar Allan Poe",
                                                      "reporter": "admin",
                                                      "description": "Java Dev",
                                                      "customFields": {
                                                        "values": {
                                              
                                                        }
                                                      },
                                                      "title": "developer_st",
                                                      "teamRoleId": 14,
                                                      "member": "admin",
                                                      "synchedWithJIRA": false,
                                                      "holidaySchemeId": -1,
                                                      "workloadSchemeId": -1,
                                                      "rates": [
                                                        {
                                                          "id": 26522,
                                                          "startDate": "2016-11-13",
                                                          "rate": 10.0000
                                                        }
                                                      ],
                                                      "allocations": [
                                              
                                                      ],
                                                      "usesUserRates": false,
                                                      "workedHours": [
                                              
                                                      ]
                                                    }
                                                  ]
                                                }
                                              }

                                              Secured by basic

                                              Headers

                                              • Authorization: required (string)

                                                Used to send the Base64-encoded "username:password" credentials

                                              Overtime Rules

                                              Resources dedicated to overtime rules

                                              get

                                              Retrieves all overtime rules defined in FOLIO.

                                              Secured by basic

                                              Each request must contain the headers necessary for basic authentication

                                              HTTP status code 200

                                              Body

                                              Media type: application/json

                                              Type: object

                                              Properties
                                              • success: required (array of Overtime Rule)

                                                Items: Overtime Rule

                                                • deletedOn: (string)

                                                  yyyy-MM-dd

                                                • coefficient: required (number)
                                                • name: required (string)
                                                • id: required (number)
                                                • regularHours: required (number)
                                                • frequency: required (string)

                                                  The frequency of the overtime rule

                                              Example:

                                              {
                                                "success": [
                                                  {
                                                    "id": 179,
                                                    "name": "35 hours / week",
                                                    "regularHours": 35.00,
                                                    "frequency": "WEEKLY",
                                                    "coefficient": 2.00
                                                  },
                                                  {
                                                    "id": 180,
                                                    "name": "7h / day",
                                                    "regularHours": 7.00,
                                                    "frequency": "DAILY",
                                                    "coefficient": 1.50
                                                  },
                                                  {
                                                    "id": 336,
                                                    "name": "OT1[TEST]",
                                                    "regularHours": 7.50,
                                                    "frequency": "DAILY",
                                                    "coefficient": 1.00
                                                  },
                                                  {
                                                    "id": 337,
                                                    "name": "OT2[TEST]",
                                                    "regularHours": 40.00,
                                                    "frequency": "WEEKLY",
                                                    "coefficient": 2.00
                                                  }
                                                ]
                                              }

                                              Secured by basic

                                              Headers

                                              • Authorization: required (string)

                                                Used to send the Base64-encoded "username:password" credentials

                                              Positions

                                              Resources dedicated to positions

                                              /position put post
                                              put

                                              Updates an existing position (cost or consulting revenue). Planned positions can be either planned costs or revenues (distinguished by the boolean value in the "revenue" field. For actual positions (team members or actual consulting revenues), the member specified is the user key of the JIRA user to bind to the position. Set member to 'unassigned' for unassigned positions.

                                              Secured by basic

                                              Each request must contain the headers necessary for basic authentication

                                              Body

                                              Media type: application/json

                                              Type: object

                                              Properties
                                              • teamRoleId: required (number)

                                                Tempo team role ID. This id has precedence over title and will override the title specified for this Position on PUT and POST operations, if any. If neither teamRoleId and title are specified, then the default Tempo Team Role will be assigned to this Position.

                                              • deletedOn: (string)

                                                yyyy-MM-dd

                                              • category: (string)
                                              • accountKey: (string)
                                              • revenue: (boolean)
                                              • name: required (string)
                                              • kind: (string)
                                              • description: required (string)
                                              • reporter: (string)

                                                Ignored on POST and PUT

                                              • id: (number)
                                              • folioId: required (number)
                                              • title: required (string)

                                                Position role. e.g. Developer, Quality Assurance, etc.

                                              • baselineId: (number)
                                              • holidaySchemeId: (number)

                                                ID of an associated Tempo Holiday Scheme, defining the position's holidays.

                                              • synchedWithJIRA: (boolean)
                                              • rate: required (object)
                                                • rate: required (number)
                                                • deletedOn: (string)

                                                  yyyy-MM-dd

                                                • id: (number)
                                                • startDate: required (string)

                                                  yyyy-MM-dd

                                              • teamMemberId: (number)
                                              • userRates: (boolean)
                                              • teamId: (number)
                                              • member: (string)

                                                JIRA user key (or 'unassigned' if an unassigned team position)

                                              • otRuleId: (number)
                                              • workloadSchemeId: (number)

                                                ID of an associated Tempo Workload Scheme, defining the position's weekly work schedule.

                                              • customFields: (object)
                                                • values: required (object)

                                                  ID of a default Tempo Holiday Scheme determining the non-working days of the team members of this Folio.

                                              • allocation: required (object)
                                                • startDate: required (string)

                                                  yyyy-MM-dd

                                                • endDate: required (string)

                                                  yyyy-MM-dd

                                                • deletedOn: (string)

                                                  yyyy-MM-dd

                                                • percentage: required (number - minimum: 0 - maximum: 100)
                                                • id: (number)
                                              • billableHours: (array of BillableHour)

                                                Items: BillableHour

                                                • otEffort: required (number)

                                                  Number of overtime hours worked in period (format :####.##)

                                                • startDate: required (string)

                                                  yyyy-MM-dd

                                                • endDate: required (string)

                                                  yyyy-MM-dd

                                                • deletedOn: (string)

                                                  yyyy-MM-dd

                                                • reporter: (string)
                                                • effort: required (number)

                                                  Number of regular hours worked in period (format :####.##)

                                                • id: (number)

                                              Example:

                                              {
                                                "folioId": 9450,
                                                "name": "Java Guru",
                                                "title": "developer_st",
                                                "description": "Java Dev",
                                                "teamRoleId": 14,
                                                "kind": ".PlannedPositionByTimeFrame",
                                                "category": "CAPEX",
                                                "id": 25838,
                                                "rate": {
                                                  "rate": 23.45,
                                                  "startDate": "2016-11-13"
                                                },
                                                "allocation": {
                                                  "startDate": "2016-11-13",
                                                  "endDate": "2017-06-01",
                                                  "percentage": 80.00
                                                },
                                                "accountKey": "capex_account_st"
                                              }

                                              HTTP status code 200

                                              Body

                                              Media type: application/json

                                              Type: object

                                              Properties
                                              • success: required (object)
                                                • teamRoleId: required (number)

                                                  Tempo team role ID. This id has precedence over title and will override the title specified for this Position on PUT and POST operations, if any. If neither teamRoleId and title are specified, then the default Tempo Team Role will be assigned to this Position.

                                                • deletedOn: (string)

                                                  yyyy-MM-dd

                                                • category: (string)
                                                • accountKey: (string)
                                                • revenue: (boolean)
                                                • name: required (string)
                                                • kind: (string)
                                                • description: required (string)
                                                • reporter: (string)

                                                  Ignored on POST and PUT

                                                • id: (number)
                                                • folioId: required (number)
                                                • title: required (string)

                                                  Position role. e.g. Developer, Quality Assurance, etc.

                                                • baselineId: (number)
                                                • holidaySchemeId: (number)

                                                  ID of an associated Tempo Holiday Scheme, defining the position's holidays.

                                                • synchedWithJIRA: (boolean)
                                                • rate: required (object)
                                                  • rate: required (number)
                                                  • deletedOn: (string)

                                                    yyyy-MM-dd

                                                  • id: (number)
                                                  • startDate: required (string)

                                                    yyyy-MM-dd

                                                • teamMemberId: (number)
                                                • userRates: (boolean)
                                                • teamId: (number)
                                                • member: (string)

                                                  JIRA user key (or 'unassigned' if an unassigned team position)

                                                • otRuleId: (number)
                                                • workloadSchemeId: (number)

                                                  ID of an associated Tempo Workload Scheme, defining the position's weekly work schedule.

                                                • customFields: (object)
                                                  • values: required (object)

                                                    ID of a default Tempo Holiday Scheme determining the non-working days of the team members of this Folio.

                                                • allocation: required (object)
                                                  • startDate: required (string)

                                                    yyyy-MM-dd

                                                  • endDate: required (string)

                                                    yyyy-MM-dd

                                                  • deletedOn: (string)

                                                    yyyy-MM-dd

                                                  • percentage: required (number - minimum: 0 - maximum: 100)
                                                  • id: (number)
                                                • billableHours: (array of BillableHour)

                                                  Items: BillableHour

                                                  • otEffort: required (number)

                                                    Number of overtime hours worked in period (format :####.##)

                                                  • startDate: required (string)

                                                    yyyy-MM-dd

                                                  • endDate: required (string)

                                                    yyyy-MM-dd

                                                  • deletedOn: (string)

                                                    yyyy-MM-dd

                                                  • reporter: (string)
                                                  • effort: required (number)

                                                    Number of regular hours worked in period (format :####.##)

                                                  • id: (number)

                                              Example:

                                              {
                                                "success": {
                                                  "id": 25838,
                                                  "folioId": 9450,
                                                  "name": "Java Guru",
                                                  "description": "Java Dev",
                                                  "accountKey": "capex_account_st",
                                                  "title": "developer_st",
                                                  "teamRoleId": 14,
                                                  "revenue": false,
                                                  "category": "CAPEX",
                                                  "rate": {
                                                    "startDate": "2016-11-13",
                                                    "rate": 23.45
                                                  },
                                                  "allocation": {
                                                    "startDate": "2016-11-13",
                                                    "endDate": "2017-06-01",
                                                    "percentage": 80.00
                                                  }
                                                }
                                              }

                                              Secured by basic

                                              Headers

                                              • Authorization: required (string)

                                                Used to send the Base64-encoded "username:password" credentials

                                              post

                                              Adds a position (planned position, consulting revenue or team member) to a Folio. Planned positions can be either planned costs or revenues (distinguished by the boolean value in the "revenue" field. For actual positions (team members or actual consulting revenues), the member specified is the user key of the JIRA user to bind to the position. Set member to 'unassigned' for unassigned positions.

                                              Secured by basic

                                              Each request must contain the headers necessary for basic authentication

                                              Body

                                              Media type: application/json

                                              Type: object

                                              Properties
                                              • teamRoleId: required (number)

                                                Tempo team role ID. This id has precedence over title and will override the title specified for this Position on PUT and POST operations, if any. If neither teamRoleId and title are specified, then the default Tempo Team Role will be assigned to this Position.

                                              • deletedOn: (string)

                                                yyyy-MM-dd

                                              • category: (string)
                                              • accountKey: (string)
                                              • revenue: (boolean)
                                              • name: required (string)
                                              • kind: (string)
                                              • description: required (string)
                                              • reporter: (string)

                                                Ignored on POST and PUT

                                              • id: (number)
                                              • folioId: required (number)
                                              • title: required (string)

                                                Position role. e.g. Developer, Quality Assurance, etc.

                                              • baselineId: (number)
                                              • holidaySchemeId: (number)

                                                ID of an associated Tempo Holiday Scheme, defining the position's holidays.

                                              • synchedWithJIRA: (boolean)
                                              • rate: required (object)
                                                • rate: required (number)
                                                • deletedOn: (string)

                                                  yyyy-MM-dd

                                                • id: (number)
                                                • startDate: required (string)

                                                  yyyy-MM-dd

                                              • teamMemberId: (number)
                                              • userRates: (boolean)
                                              • teamId: (number)
                                              • member: (string)

                                                JIRA user key (or 'unassigned' if an unassigned team position)

                                              • otRuleId: (number)
                                              • workloadSchemeId: (number)

                                                ID of an associated Tempo Workload Scheme, defining the position's weekly work schedule.

                                              • customFields: (object)
                                                • values: required (object)

                                                  ID of a default Tempo Holiday Scheme determining the non-working days of the team members of this Folio.

                                              • allocation: required (object)
                                                • startDate: required (string)

                                                  yyyy-MM-dd

                                                • endDate: required (string)

                                                  yyyy-MM-dd

                                                • deletedOn: (string)

                                                  yyyy-MM-dd

                                                • percentage: required (number - minimum: 0 - maximum: 100)
                                                • id: (number)
                                              • billableHours: (array of BillableHour)

                                                Items: BillableHour

                                                • otEffort: required (number)

                                                  Number of overtime hours worked in period (format :####.##)

                                                • startDate: required (string)

                                                  yyyy-MM-dd

                                                • endDate: required (string)

                                                  yyyy-MM-dd

                                                • deletedOn: (string)

                                                  yyyy-MM-dd

                                                • reporter: (string)
                                                • effort: required (number)

                                                  Number of regular hours worked in period (format :####.##)

                                                • id: (number)

                                              Example:

                                              {
                                                "folioId": 9437,
                                                "name": "admin",
                                                "title": "developer_st",
                                                "description": "Java Dev",
                                                "teamRoleId": 14,
                                                "kind": ".ConsultingRevenue",
                                                "member": "admin",
                                                "rate": {
                                                  "rate": 23.45,
                                                  "startDate": "2016-11-13"
                                                },
                                                "allocation": {
                                                  "startDate": "2016-11-13",
                                                  "endDate": "2017-06-01",
                                                  "percentage": 80.00
                                                },
                                                "otRuleId": 342,
                                                "synchedWithJIRA": false,
                                                "billableHours": [
                                                  {
                                                    "startDate": "2016-11-14",
                                                    "endDate": "2017-05-31",
                                                    "effort": 20.00,
                                                    "otEffort": 10,
                                                    "reporter": "dummy"
                                                  }
                                                ]
                                              }

                                              HTTP status code 200

                                              Body

                                              Media type: application/json

                                              Type: object

                                              Properties
                                              • success: required (number)

                                              Example:

                                              {
                                                "success": 2322
                                              }

                                              HTTP status code 400

                                              Body

                                              Media type: application/json

                                              Type: object

                                              Properties
                                              • error: (string)
                                              • errorMessages: (array of )
                                              • errors: (object)

                                                Example:

                                                {
                                                  "errorMesssages": [
                                                    "The staff member must have at least one cost rate",
                                                    "The percentage or capacity is required"
                                                  ],
                                                  "errors": {
                                                    "member": "Please select a valid option",
                                                    "wage": "Cost rate is required",
                                                    "startDate": "Start date is required",
                                                    "endDate": "The period end is required",
                                                    "name": "Name is required",
                                                    "weight": "The percentage of the availability period is required",
                                                    "effort": "Worked hours must be a numeric value equals or greater than 0"
                                                  }
                                                }

                                                Secured by basic

                                                Headers

                                                • Authorization: required (string)

                                                  Used to send the Base64-encoded "username:password" credentials

                                                get

                                                Retrieves a position (planned position, team member or consulting revenue) by its ID.

                                                Secured by basic

                                                Each request must contain the headers necessary for basic authentication

                                                URI Parameters

                                                • positionId: required (string)

                                                HTTP status code 200

                                                Body

                                                Media type: application/json

                                                Type: object

                                                Properties
                                                • success: required (object)
                                                  • teamRoleId: required (number)

                                                    Tempo team role ID. This id has precedence over title and will override the title specified for this Position on PUT and POST operations, if any. If neither teamRoleId and title are specified, then the default Tempo Team Role will be assigned to this Position.

                                                  • deletedOn: (string)

                                                    yyyy-MM-dd

                                                  • category: (string)
                                                  • accountKey: (string)
                                                  • revenue: (boolean)
                                                  • name: required (string)
                                                  • kind: (string)
                                                  • description: required (string)
                                                  • reporter: (string)

                                                    Ignored on POST and PUT

                                                  • id: (number)
                                                  • folioId: required (number)
                                                  • title: required (string)

                                                    Position role. e.g. Developer, Quality Assurance, etc.

                                                  • baselineId: (number)
                                                  • holidaySchemeId: (number)

                                                    ID of an associated Tempo Holiday Scheme, defining the position's holidays.

                                                  • synchedWithJIRA: (boolean)
                                                  • rate: required (object)
                                                    • rate: required (number)
                                                    • deletedOn: (string)

                                                      yyyy-MM-dd

                                                    • id: (number)
                                                    • startDate: required (string)

                                                      yyyy-MM-dd

                                                  • teamMemberId: (number)
                                                  • userRates: (boolean)
                                                  • teamId: (number)
                                                  • member: (string)

                                                    JIRA user key (or 'unassigned' if an unassigned team position)

                                                  • otRuleId: (number)
                                                  • workloadSchemeId: (number)

                                                    ID of an associated Tempo Workload Scheme, defining the position's weekly work schedule.

                                                  • customFields: (object)
                                                    • values: required (object)

                                                      ID of a default Tempo Holiday Scheme determining the non-working days of the team members of this Folio.

                                                  • allocation: required (object)
                                                    • startDate: required (string)

                                                      yyyy-MM-dd

                                                    • endDate: required (string)

                                                      yyyy-MM-dd

                                                    • deletedOn: (string)

                                                      yyyy-MM-dd

                                                    • percentage: required (number - minimum: 0 - maximum: 100)
                                                    • id: (number)
                                                  • billableHours: (array of BillableHour)

                                                    Items: BillableHour

                                                    • otEffort: required (number)

                                                      Number of overtime hours worked in period (format :####.##)

                                                    • startDate: required (string)

                                                      yyyy-MM-dd

                                                    • endDate: required (string)

                                                      yyyy-MM-dd

                                                    • deletedOn: (string)

                                                      yyyy-MM-dd

                                                    • reporter: (string)
                                                    • effort: required (number)

                                                      Number of regular hours worked in period (format :####.##)

                                                    • id: (number)

                                                Example:

                                                {
                                                  "success": {
                                                    "id": 25830,
                                                    "kind": ".ConsultingRevenue",
                                                    "folioId": 9437,
                                                    "name": "Edgar Allan Poe",
                                                    "reporter": "admin",
                                                    "description": "Java Dev",
                                                    "customFields": {
                                                      "values": {
                                                
                                                      }
                                                    },
                                                    "title": "developer_st",
                                                    "teamRoleId": 14,
                                                    "member": "admin",
                                                    "synchedWithJIRA": false,
                                                    "otRuleId": 342,
                                                    "rate": {
                                                      "id": 26600,
                                                      "startDate": "2016-11-13",
                                                      "rate": 23.4500
                                                    },
                                                    "allocation": {
                                                      "id": 32692,
                                                      "startDate": "2016-11-13",
                                                      "endDate": "2017-06-01",
                                                      "percentage": 80.0000000000
                                                    },
                                                    "billableHours": [
                                                      {
                                                        "id": 1253,
                                                        "startDate": "2016-11-14",
                                                        "endDate": "2017-05-31",
                                                        "effort": 20.00,
                                                        "otEffort": 10.00,
                                                        "reporter": "admin"
                                                      }
                                                    ]
                                                  }
                                                }

                                                HTTP status code 404

                                                Body

                                                Media type: application/json

                                                Type: object

                                                Properties
                                                • error: (string)
                                                • errorMessages: (array of )
                                                • errors: (object)

                                                  Example:

                                                  {
                                                    "errorMessages": [
                                                      "The requested folio cannot be viewed because it either does not exist or you do not have permission to view it."
                                                    ]
                                                  }

                                                  Secured by basic

                                                  Headers

                                                  • Authorization: required (string)

                                                    Used to send the Base64-encoded "username:password" credentials

                                                  delete

                                                  Deletes a position (planned cost, team member or consulting revenue).

                                                  Secured by basic

                                                  Each request must contain the headers necessary for basic authentication

                                                  URI Parameters

                                                  • positionId: required (string)

                                                  HTTP status code 200

                                                  Body

                                                  Media type: application/json

                                                  Type: object

                                                  Properties
                                                  • success: required (boolean)

                                                  Example:

                                                  {
                                                    "success": true
                                                  }

                                                  HTTP status code 404

                                                  Body

                                                  Media type: application/json

                                                  Type: object

                                                  Properties
                                                  • error: (string)
                                                  • errorMessages: (array of )
                                                  • errors: (object)

                                                    Example:

                                                    {
                                                      "errorMessages": [
                                                        "The requested folio cannot be viewed because it either does not exist or you do not have permission to view it."
                                                      ]
                                                    }

                                                    Secured by basic

                                                    Headers

                                                    • Authorization: required (string)

                                                      Used to send the Base64-encoded "username:password" credentials

                                                    post

                                                    Adds an allocation to a team position.

                                                    Secured by basic

                                                    Each request must contain the headers necessary for basic authentication

                                                    URI Parameters

                                                    • positionId: required (string)

                                                    Body

                                                    Media type: application/json

                                                    Type: object

                                                    Properties
                                                    • startDate: required (string)

                                                      yyyy-MM-dd

                                                    • endDate: required (string)

                                                      yyyy-MM-dd

                                                    • deletedOn: (string)

                                                      yyyy-MM-dd

                                                    • percentage: required (number - minimum: 0 - maximum: 100)
                                                    • id: (number)

                                                    HTTP status code 200

                                                    Body

                                                    Media type: application/json

                                                    Type: object

                                                    Properties
                                                    • success: required (boolean)

                                                    HTTP status code 400

                                                    Body

                                                    Media type: application/json

                                                    Type: object

                                                    Properties
                                                    • error: (string)
                                                    • errorMessages: (array of )
                                                    • errors: (object)

                                                      Example:

                                                      {
                                                        "errorMessages": [
                                                          "Availability can only be added to staff members."
                                                        ],
                                                        "errors": {
                                                          "endDate": "The start date must be before or equal to the end date"
                                                        }
                                                      }

                                                      Secured by basic

                                                      Headers

                                                      • Authorization: required (string)

                                                        Used to send the Base64-encoded "username:password" credentials

                                                      post

                                                      Adds billable hours to a consulting revenue.

                                                      Secured by basic

                                                      Each request must contain the headers necessary for basic authentication

                                                      URI Parameters

                                                      • positionId: required (string)

                                                      Body

                                                      Media type: application/json

                                                      Type: object

                                                      Properties
                                                      • otEffort: required (number)

                                                        Number of overtime hours worked in period (format :####.##)

                                                      • startDate: required (string)

                                                        yyyy-MM-dd

                                                      • endDate: required (string)

                                                        yyyy-MM-dd

                                                      • deletedOn: (string)

                                                        yyyy-MM-dd

                                                      • reporter: (string)
                                                      • effort: required (number)

                                                        Number of regular hours worked in period (format :####.##)

                                                      • id: (number)

                                                      Example:

                                                      {
                                                        "startDate": "2016-11-23",
                                                        "endDate": "2016-12-03",
                                                        "effort": 30.00,
                                                        "otEffort": 10.00
                                                      }

                                                      HTTP status code 200

                                                      Body

                                                      Media type: application/json

                                                      Type: object

                                                      Properties
                                                      • success: required (number)

                                                      Example:

                                                      {
                                                        "success": 2322
                                                      }

                                                      Secured by basic

                                                      Headers

                                                      • Authorization: required (string)

                                                        Used to send the Base64-encoded "username:password" credentials

                                                      get

                                                      Retrieves a position's payments (planned position, team member or consulting revenue).

                                                      Secured by basic

                                                      Each request must contain the headers necessary for basic authentication

                                                      URI Parameters

                                                      • positionId: required (string)

                                                      HTTP status code 200

                                                      Body

                                                      Media type: application/json

                                                      Type: object

                                                      Properties
                                                      • success: required (array of Expense Payment)

                                                        Items: Expense Payment

                                                        • date: required (string)

                                                          yyyy-MM-dd

                                                        • totalAmount: (number)

                                                          Total amount of this payment, adding up amount and overtimeAmount, if any.

                                                        • amount: required (number)

                                                          The amount of this payment. If it is a payment for a Position, then it includes only the payment for regular hours.

                                                        • overtimeAmount: (number)

                                                          Amount for overtime hours included in this payment.

                                                        • rate: (number)

                                                          Cost rate used to calculate the payment.

                                                        • totalEffort: (number)

                                                          Total effort included in this payment, adding up effort and overtimeEffort, if any.

                                                        • overtimeEffort: (number)

                                                          Effort in overtime hours included in this payment.

                                                        • effort: (number)

                                                          Effort in regular (non-overtime) hours included in this payment.

                                                      Example:

                                                      {
                                                        "success": [
                                                          {
                                                            "date": "2013-01-10",
                                                            "amount": 80.0000,
                                                            "effort": 8.0000,
                                                            "overtimeAmount": 0.0000,
                                                            "overtimeEffort": 0.0000,
                                                            "rate": 10.0000,
                                                            "totalAmount": 80.0000,
                                                            "totalEffort": 8.0000
                                                          },
                                                          {
                                                            "date": "2013-01-11",
                                                            "amount": 80.0000,
                                                            "effort": 8.0000,
                                                            "overtimeAmount": 0.0000,
                                                            "overtimeEffort": 0.0000,
                                                            "rate": 10.0000,
                                                            "totalAmount": 80.0000,
                                                            "totalEffort": 8.0000
                                                          },
                                                          {
                                                            "date": "2013-01-12",
                                                            "amount": 80.0000,
                                                            "effort": 8.0000,
                                                            "overtimeAmount": 0.0000,
                                                            "overtimeEffort": 0.0000,
                                                            "rate": 10.0000,
                                                            "totalAmount": 80.0000,
                                                            "totalEffort": 8.0000
                                                          },
                                                          {
                                                            "date": "2013-01-13",
                                                            "amount": 80.0000,
                                                            "effort": 8.0000,
                                                            "overtimeAmount": 0.0000,
                                                            "overtimeEffort": 0.0000,
                                                            "rate": 10.0000,
                                                            "totalAmount": 80.0000,
                                                            "totalEffort": 8.0000
                                                          },
                                                          {
                                                            "date": "2013-01-14",
                                                            "amount": 80.0000,
                                                            "effort": 8.0000,
                                                            "overtimeAmount": 0.0000,
                                                            "overtimeEffort": 0.0000,
                                                            "rate": 10.0000,
                                                            "totalAmount": 80.0000,
                                                            "totalEffort": 8.0000
                                                          }
                                                        ]
                                                      }

                                                      Secured by basic

                                                      Headers

                                                      • Authorization: required (string)

                                                        Used to send the Base64-encoded "username:password" credentials

                                                      post

                                                      Adds a rate/wage to a team position.

                                                      Secured by basic

                                                      Each request must contain the headers necessary for basic authentication

                                                      URI Parameters

                                                      • positionId: required (string)

                                                      Body

                                                      Media type: application/json

                                                      Type: object

                                                      Properties
                                                      • rate: required (number)
                                                      • deletedOn: (string)

                                                        yyyy-MM-dd

                                                      • id: (number)
                                                      • startDate: required (string)

                                                        yyyy-MM-dd

                                                      Example:

                                                      {
                                                        "rate": 10.0,
                                                        "startDate": "2016-11-14"
                                                      }

                                                      HTTP status code 200

                                                      Body

                                                      Media type: application/json

                                                      Type: object

                                                      Properties
                                                      • success: required (number)

                                                      Example:

                                                      {
                                                        "success": 2322
                                                      }

                                                      HTTP status code 400

                                                      Body

                                                      Media type: application/json

                                                      Type: object

                                                      Properties
                                                      • error: (string)
                                                      • errorMessages: (array of )
                                                      • errors: (object)

                                                        Example:

                                                        {
                                                          "errors": {
                                                            "startDate": "A cost rate already exists with effective date (13/Nov/16)"
                                                          }
                                                        }

                                                        Secured by basic

                                                        Headers

                                                        • Authorization: required (string)

                                                          Used to send the Base64-encoded "username:password" credentials

                                                        post

                                                        Adds worked hours to a team member.

                                                        Secured by basic

                                                        Each request must contain the headers necessary for basic authentication

                                                        URI Parameters

                                                        • positionId: required (string)

                                                        Body

                                                        Media type: application/json

                                                        Type: object

                                                        Properties
                                                        • otEffort: required (number)

                                                          Number of overtime hours worked in period (format :####.##)

                                                        • startDate: required (string)

                                                          yyyy-MM-dd

                                                        • endDate: required (string)

                                                          yyyy-MM-dd

                                                        • deletedOn: (string)

                                                          yyyy-MM-dd

                                                        • reporter: (string)
                                                        • effort: required (number)

                                                          Number of regular hours worked in period (format :####.##)

                                                        • id: (number)

                                                        Example:

                                                        {
                                                          "startDate": "2016-11-23",
                                                          "endDate": "2016-12-02",
                                                          "effort": 13.00,
                                                          "otEffort": 10.00
                                                        }

                                                        HTTP status code 200

                                                        Body

                                                        Media type: application/json

                                                        Type: object

                                                        Properties
                                                        • success: required (number)

                                                        Example:

                                                        {
                                                          "success": 2322
                                                        }

                                                        HTTP status code 400

                                                        Body

                                                        Media type: application/json

                                                        Type: object

                                                        Properties
                                                        • error: (string)
                                                        • errorMessages: (array of )
                                                        • errors: (object)

                                                          Example:

                                                          {
                                                            "errors": {
                                                              "startDate": "Periods conflicting: 13/Nov/16 to 1/Jun/17 (20.00h)"
                                                            }
                                                          }

                                                          Secured by basic

                                                          Headers

                                                          • Authorization: required (string)

                                                            Used to send the Base64-encoded "username:password" credentials

                                                          Rates

                                                          Resources dedicated to rates (cost or consulting revenue)

                                                          /rate/{rateId} put delete
                                                          put

                                                          Updates an existing rate (cost or consulting revenue).

                                                          Secured by basic

                                                          Each request must contain the headers necessary for basic authentication

                                                          URI Parameters

                                                          • rateId: required (string)

                                                          Body

                                                          Media type: application/json

                                                          Type: object

                                                          Properties
                                                          • rate: required (number)
                                                          • deletedOn: (string)

                                                            yyyy-MM-dd

                                                          • id: (number)
                                                          • startDate: required (string)

                                                            yyyy-MM-dd

                                                          Example:

                                                          {
                                                            "rate": 12.0,
                                                            "startDate": "2016-11-12",
                                                            "id": 26633
                                                          }

                                                          HTTP status code 200

                                                          Body

                                                          Media type: application/json

                                                          Type: object

                                                          Properties
                                                          • success: required (object)
                                                            • rate: required (number)
                                                            • deletedOn: (string)

                                                              yyyy-MM-dd

                                                            • id: (number)
                                                            • startDate: required (string)

                                                              yyyy-MM-dd

                                                          Example:

                                                          {
                                                            "success": {
                                                              "id": 26633,
                                                              "startDate": "2016-11-12",
                                                              "rate": 12.0000
                                                            }
                                                          }

                                                          HTTP status code 400

                                                          Body

                                                          Media type: application/json

                                                          Type: object

                                                          Properties
                                                          • error: (string)
                                                          • errorMessages: (array of )
                                                          • errors: (object)

                                                            Example:

                                                            {
                                                              "errorMessages": [
                                                                "The staff member must have at least one cost rate"
                                                              ],
                                                              "errors": {
                                                                "startDate": "A cost rate already exists with effective date (14/Nov/16)"
                                                              }
                                                            }

                                                            Secured by basic

                                                            Headers

                                                            • Authorization: required (string)

                                                              Used to send the Base64-encoded "username:password" credentials

                                                            delete

                                                            Deletes a rate/wage.

                                                            Secured by basic

                                                            Each request must contain the headers necessary for basic authentication

                                                            URI Parameters

                                                            • rateId: required (string)

                                                            HTTP status code 200

                                                            Body

                                                            Media type: application/json

                                                            Type: object

                                                            Properties
                                                            • success: required (boolean)

                                                            Example:

                                                            {
                                                              "success": true
                                                            }

                                                            HTTP status code 400

                                                            Body

                                                            Media type: application/json

                                                            Type: object

                                                            Properties
                                                            • error: (string)
                                                            • errorMessages: (array of )
                                                            • errors: (object)

                                                              Example:

                                                              {
                                                                "errorMessages": [
                                                                  "The staff member must have at least one cost rate"
                                                                ],
                                                                "errors": {
                                                                  "startDate": "A cost rate already exists with effective date (14/Nov/16)"
                                                                }
                                                              }

                                                              Secured by basic

                                                              Headers

                                                              • Authorization: required (string)

                                                                Used to send the Base64-encoded "username:password" credentials

                                                              Worked Hours

                                                              Resources dedicated to worked hours

                                                              put

                                                              Updates an existing team member worked hours.

                                                              Secured by basic

                                                              Each request must contain the headers necessary for basic authentication

                                                              URI Parameters

                                                              • workedHoursId: required (string)

                                                              Body

                                                              Media type: application/json

                                                              Type: object

                                                              Properties
                                                              • otEffort: required (number)

                                                                Number of overtime hours worked in period (format :####.##)

                                                              • startDate: required (string)

                                                                yyyy-MM-dd

                                                              • endDate: required (string)

                                                                yyyy-MM-dd

                                                              • deletedOn: (string)

                                                                yyyy-MM-dd

                                                              • reporter: (string)
                                                              • effort: required (number)

                                                                Number of regular hours worked in period (format :####.##)

                                                              • id: (number)

                                                              Example:

                                                              {
                                                                "startDate": "2016-11-15",
                                                                "endDate": "2017-05-30",
                                                                "effort": 2.00,
                                                                "otEffort": 1.00,
                                                                "id": 1273
                                                              }

                                                              HTTP status code 200

                                                              Body

                                                              Media type: application/json

                                                              Type: object

                                                              Properties
                                                              • success: required (boolean)

                                                              Example:

                                                              {
                                                                "success": true
                                                              }

                                                              HTTP status code 404

                                                              Body

                                                              Media type: application/json

                                                              Type: object

                                                              Properties
                                                              • error: (string)
                                                              • errorMessages: (array of )
                                                              • errors: (object)

                                                                Example:

                                                                {
                                                                  "errorMessages": [
                                                                    "Position does not exist"
                                                                  ]
                                                                }

                                                                Secured by basic

                                                                Headers

                                                                • Authorization: required (string)

                                                                  Used to send the Base64-encoded "username:password" credentials

                                                                delete

                                                                Deletes worked hours. Note that this will have no effect on worked hours that synchronized from the JIRA worklog or that are automatically calculated from the resource's allocation percentage. This method deletes only worked hours overrides entered either manually or programmatically.

                                                                Secured by basic

                                                                Each request must contain the headers necessary for basic authentication

                                                                URI Parameters

                                                                • workedHoursId: required (string)

                                                                HTTP status code 200

                                                                Body

                                                                Media type: application/json

                                                                Type: object

                                                                Properties
                                                                • success: required (boolean)

                                                                Example:

                                                                {
                                                                  "success": true
                                                                }

                                                                HTTP status code 404

                                                                Body

                                                                Media type: application/json

                                                                Type: object

                                                                Properties
                                                                • error: (string)
                                                                • errorMessages: (array of )
                                                                • errors: (object)

                                                                  Example:

                                                                  {
                                                                    "errorMessages": [
                                                                      "Position does not exist"
                                                                    ]
                                                                  }

                                                                  Secured by basic

                                                                  Headers

                                                                  • Authorization: required (string)

                                                                    Used to send the Base64-encoded "username:password" credentials

                                                                  Portfolios

                                                                  Resources dedicated to portfolios

                                                                  get

                                                                  Will return all portfolios

                                                                  Secured by basic

                                                                  Each request must contain the headers necessary for basic authentication

                                                                  HTTP status code 200

                                                                  Body

                                                                  Media type: application/json

                                                                  Type: object

                                                                  Properties
                                                                  • success: required (array of Position)

                                                                    Items: Position

                                                                    • id: required (number)
                                                                    • name: required (string)
                                                                    • description: (string)
                                                                    • currencyCode: required (string)
                                                                    • isPrivate: required (boolean)
                                                                    • owner: required (string)
                                                                    • color: required (string)
                                                                    • ordering: (object)
                                                                      • rankingFieldId: (number)
                                                                      • ascendingOrder: (boolean)
                                                                    • admins: required (array of )
                                                                    • folios: required (array of Portfolio child Folio)

                                                                      Items: Portfolio child Folio

                                                                      • id: required (number)
                                                                      • name: required (string)
                                                                      • startDate: required (string)

                                                                        yyyy-MM-dd

                                                                      • closedDate: (string)

                                                                        yyyy-MM-dd

                                                                      • endDate: required (string)

                                                                        yyyy-MM-dd

                                                                      • owner: required (string)
                                                                      • status: required (string)
                                                                      • withRevenue: (boolean)
                                                                      • withEarned: (boolean)
                                                                    • portfolios: required (array of )
                                                                    • parentId: (number)

                                                                  Example:

                                                                  {
                                                                    "success": [
                                                                      {
                                                                        "id": 316,
                                                                        "name": "A [TEST]",
                                                                        "owner": "admin",
                                                                        "currencyCode": "USD",
                                                                        "color": "red",
                                                                        "isPrivate": false,
                                                                        "ordering": {
                                                                          "ascendingOrder": false
                                                                        },
                                                                        "admins": [
                                                                  
                                                                        ],
                                                                        "folios": [
                                                                  
                                                                        ],
                                                                        "portfolios": [
                                                                  
                                                                        ]
                                                                      },
                                                                      {
                                                                        "id": 122,
                                                                        "name": "ABC",
                                                                        "owner": "admin",
                                                                        "description": "DESC",
                                                                        "currencyCode": "EUR",
                                                                        "color": "#666666",
                                                                        "isPrivate": false,
                                                                        "ordering": {
                                                                          "rankingFieldId": -1,
                                                                          "ascendingOrder": false
                                                                        },
                                                                        "admins": [
                                                                  
                                                                        ],
                                                                        "folios": [
                                                                          {
                                                                            "id": 221,
                                                                            "name": "Cupcake",
                                                                            "startDate": "2016-01-01",
                                                                            "endDate": "2016-12-30",
                                                                            "owner": "jane",
                                                                            "status": "expired"
                                                                          },
                                                                          {
                                                                            "id": 7454,
                                                                            "name": "Gingerbread",
                                                                            "startDate": "2016-10-04",
                                                                            "endDate": "2017-08-31",
                                                                            "owner": "jane",
                                                                            "status": "executing"
                                                                          },
                                                                          {
                                                                            "id": 6318,
                                                                            "name": "Lollipop",
                                                                            "startDate": "2014-12-03",
                                                                            "endDate": "2018-01-31",
                                                                            "owner": "admin",
                                                                            "status": "executing"
                                                                          }
                                                                        ],
                                                                        "portfolios": [
                                                                  
                                                                        ],
                                                                        "parentId": 10
                                                                      },
                                                                      {
                                                                        "id": 10,
                                                                        "name": "Android",
                                                                        "owner": "admin",
                                                                        "currencyCode": "NOK",
                                                                        "color": "#8EB021",
                                                                        "isPrivate": false,
                                                                        "ordering": {
                                                                          "ascendingOrder": false
                                                                        },
                                                                        "admins": [
                                                                          {
                                                                            "id": 1,
                                                                            "user": "amelie"
                                                                          }
                                                                        ],
                                                                        "folios": [
                                                                          {
                                                                            "id": 1860,
                                                                            "name": "Ice Cream Sandwich",
                                                                            "startDate": "2015-04-01",
                                                                            "endDate": "2015-08-28",
                                                                            "owner": "admin",
                                                                            "status": "expired"
                                                                          },
                                                                          {
                                                                            "id": 6317,
                                                                            "name": "Donut",
                                                                            "startDate": "2015-04-14",
                                                                            "endDate": "2015-09-30",
                                                                            "owner": "admin",
                                                                            "status": "expired"
                                                                          },
                                                                          {
                                                                            "id": 6502,
                                                                            "name": "Honeycomb",
                                                                            "startDate": "2015-02-02",
                                                                            "endDate": "2015-10-29",
                                                                            "owner": "admin",
                                                                            "status": "expired"
                                                                          },
                                                                          {
                                                                            "id": 6503,
                                                                            "name": "Jelly Bean",
                                                                            "startDate": "2015-02-02",
                                                                            "endDate": "2015-10-29",
                                                                            "owner": "admin",
                                                                            "status": "expired"
                                                                          },
                                                                          {
                                                                            "id": 6501,
                                                                            "name": "KitKat",
                                                                            "startDate": "2015-02-02",
                                                                            "endDate": "2015-10-29",
                                                                            "owner": "admin",
                                                                            "status": "expired"
                                                                          }
                                                                        ],
                                                                        "portfolios": [
                                                                          122
                                                                        ],
                                                                        "parentId": 117
                                                                      },
                                                                      {
                                                                        "id": 317,
                                                                        "name": "B [TEST]",
                                                                        "owner": "admin",
                                                                        "currencyCode": "USD",
                                                                        "color": "red",
                                                                        "isPrivate": false,
                                                                        "ordering": {
                                                                          "ascendingOrder": false
                                                                        },
                                                                        "admins": [
                                                                  
                                                                        ],
                                                                        "folios": [
                                                                  
                                                                        ],
                                                                        "portfolios": [
                                                                  
                                                                        ]
                                                                      },
                                                                      {
                                                                        "id": 318,
                                                                        "name": "C [TEST]",
                                                                        "owner": "admin",
                                                                        "currencyCode": "USD",
                                                                        "color": "red",
                                                                        "isPrivate": false,
                                                                        "ordering": {
                                                                          "ascendingOrder": false
                                                                        },
                                                                        "admins": [
                                                                  
                                                                        ],
                                                                        "folios": [
                                                                  
                                                                        ],
                                                                        "portfolios": [
                                                                  
                                                                        ]
                                                                      }
                                                                    ]
                                                                  }

                                                                  HTTP status code 404

                                                                  Body

                                                                  Media type: application/json

                                                                  Type: object

                                                                  Properties
                                                                  • error: (string)
                                                                  • errorMessages: (array of )
                                                                  • errors: (object)

                                                                    Example:

                                                                    {
                                                                      "errorMessages": [
                                                                        "Portfolio not found."
                                                                      ]
                                                                    }

                                                                    Secured by basic

                                                                    Headers

                                                                    • Authorization: required (string)

                                                                      Used to send the Base64-encoded "username:password" credentials