User Figures

UserFigures Endpoints allow querying, and updating a user’s User Figure records.

Using the below endpoints can overwrite your data, use with caution!

Get User Figures

HTTP GET v2/Users/{UserId}/UserFigures

Returns all User Figures for a specific User in date order.

Note that ContractType, ContractMonthlySalary and ContractMultiplier are unavailable without the Dynamic Cost Rate feature being turned on. Data in these fields when this feature is not turned on will return null.

_Response

[
    {
        "UserFigureID": 12345,
        "StartDate": "2021-01-01T00:00:00",
        "EndDate": "2021-05-06T23:59:59",
        "WorkingHours": 0.0,
        "ProductivityTarget": 0.0,
        "ActualCostRate": 0.0,
        "RoleName": "Managing Director",
        "ContractType": null,
        "ContractMonthlySalary": null,
        "ContractMultiplier": null
    },
    {
        "UserFigureID": 12346,
        "StartDate": "2021-05-07T00:00:00",
        "EndDate": "2021-05-12T23:59:59",
        "WorkingHours": 37.5,
        "ProductivityTarget": 0.0,
        "ActualCostRate": 0.0,
        "RoleName": "Managing Director",
        "ContractType": null,
        "ContractMonthlySalary": null,
        "ContractMultiplier": null
    },
    ...
]

Create a New User Figure

HTTP POST v1/Users/{UserId}/UserFigures

Creates a new User Figure for a specific User with the information supplied.

_Request

{
    "StartDate": "2021-06-01T00:00:00",
    "EndDate": null,
    "WorkingHours": 40,
    "ProjectAvailability": 62.5,
    "ActualCost": 125,
    "Office": "Office Name",
    "Team": "Team Name",
    "Role": "Managing Director",
    "ContractType": "JobSalary" | "OvertimeSalary" | "Hourly",
    "ContractMonthlySalary": 2250,
    "ContractMultiplier": 1.41
}

Update an existing User Figure

HTTP PUT v1/Users/{UserId}/UserFigures

Updates an existing User Figure with the supplied UserFigureId for the user with the information supplied.

_Request

{
    "UserFigureId": 1234567,
    "StartDate": "2021-06-01T00:00:00",
    "EndDate": null,
    "WorkingHours": 40,
    "ProjectAvailability": 62.5,
    "ActualCost": 125,
    "Office": "Office Name",
    "Team": "Team Name",
    "Role": "Managing Director",
    "ContractType": "JobSalary" | "OvertimeSalary" | "Hourly",
    "ContractMonthlySalary": 2250,
    "ContractMultiplier": 1.41
}