InvoicingGet a contract hourly rate

Get a contract hourly rate

Returns one contract hourly rate by its integer ID, including superseded (indexed) versions.

Reads a single rate row. Unlike the list, it also returns rows that were superseded by an indexation (re-pricing) — nothing in the response says the row is no longer current, so do not use this to read "the current price" of an ID you stored earlier: after an indexation the current rate has a NEW ContractHourlyRateID (find it with the list). An unknown ID is a 500, not a 404.

Use it to:

  • Resolve the HourlyRateID of a task or allocation to its name, amount and currency

Behaviour:

  • Idempotent.
  • Safe to retry.
  • Changes are visible to the next read immediately.

Call first: GET /v1/contract-hourly-rate

Not yet documented: examples.

curl -X GET "https://app3.timelog.com/your-account/api/v1/contract-hourly-rate/get-by-id?contractHourlyRateID=123" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "Properties": {
    "ContractHourlyRateID": 123,
    "ContractHourlyRateGUID": "123e4567-e89b-12d3-a456-426614174000",
    "ProjectSubContractID": 123,
    "Name": "John Doe",
    "Amount": 3.14,
    "Type": "Standard",
    "ContractSpecificHourlyRateID": "null",
    "IsActive": true,
    "IsManuallyAdjusted": true,
    "ProductNo": "null",
    "CurrencyISO": "example_string"
  },
  "Links": [
    {
      "Href": "example_string",
      "Rel": "example_string"
    }
  ],
  "Actions": [
    {}
  ]
}
GET
/v1/contract-hourly-rate/get-by-id
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. JWT and reference tokens are both accepted. The token must carry the required scope (default tlp). The token's sub claim is the acting user. A token WITHOUT sub (client-credentials) acts as the system service user. If the sub user cannot log in (inactive, locked, deleted), the request is rejected with 401 — it is no longer let through without a user. > Not yet documented: how to obtain a token. > Not yet documented: token lifetime.

OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. JWT and reference tokens are both accepted. The token must carry the required scope (default tlp). The token's sub claim is the acting user. A token WITHOUT sub (client-credentials) acts as the system service user. If the sub user cannot log in (inactive, locked, deleted), the request is rejected with 401 — it is no longer let through without a user. > Not yet documented: how to obtain a token. > Not yet documented: token lifetime.
query
contractHourlyRateIDinteger
Required

The rate's ContractHourlyRateID. Omitted → 404 action-not-matched (captured). Unknown → 500 Code 100. Refers to ContractHourlyRateRead.ContractHourlyRateID. Look up valid values with GET /v1/contract-hourly-rate.

Format: int32
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. JWT and reference tokens are both accepted. The token must carry the required scope (default tlp).

The token's sub claim is the acting user. A token WITHOUT sub (client-credentials) acts as the system service user. If the sub user cannot log in (inactive, locked, deleted), the request is rejected with 401 — it is no longer let through without a user.

Not yet documented: how to obtain a token.

Not yet documented: token lifetime.

Query Parameters

contractHourlyRateIDinteger
Required

The rate's ContractHourlyRateID. Omitted → 404 action-not-matched (captured). Unknown → 500 Code 100.

Refers to ContractHourlyRateRead.ContractHourlyRateID. Look up valid values with GET /v1/contract-hourly-rate.

Responses

Propertiesobject

One hourly (sales) rate that a contract (ProjectSubContract) charges for time. A contract carries its own list of rates; tasks and allocations on the contract point at one of them, and registered hours are priced with it. A rate is a COPY: Standard and Customer rates are copied from the account's price list (standard or customer specific) when they are added to the contract, Project rates exist only on this contract. Changing a rate's amount ("indexation") does not edit the row — the old row is marked indexed and a new row with a new ContractHourlyRateID takes over; the list hides indexed rows, get-by-id still returns them.

Not yet documented: description.

Linksarray
Actionsobject[]