Retrieve Project Billable

Auth required

GET/v1/projects/{project_id}/billable/

project_hourly is populated when hourly_rate_based_on = 'project_hourly'. person_hourlies is populated when hourly_rate_based_on = 'person_hourly'. All fields are null when no billable configuration exists.

Money values (billable_amount, project_hourly.rate, person_hourlies[].rate) are in major currency units (e.g. dollars, not cents).

Parameters

project_idrequiredstring · uuid

Credentials

X-APPLOYE-API-KEY

Stored in this browser tab only. Try It always sends your key; code samples show a YOUR_API_KEY placeholder until you reveal the key with the eye toggle.

curl --request GET \
  --url "https://api.apploye.com/v1/projects/__PROJECT_ID__/billable/" \
  --header "accept: application/json" \
  --header "X-APPLOYE-API-KEY: YOUR_API_KEY"

Response

Billable configuration

{
  "billable_type": "string",
  "billable_amount": 0,
  "hourly_rate_based_on": "string",
  "project_hourly": {
    "rate": 0
  },
  "person_hourlies": [
    {
      "rate": 0,
      "user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "email": "string",
      "first_name": "string",
      "last_name": "string",
      "image": "string",
      "thumbnail": "string",
      "color": "string"
    }
  ]
}

Retrieve Project Billable

Parameters#

Parameters