List contract models
Lists the contract (payment) models enabled in the account.
The value set for a contract's model. The models are fixed in code (ContractModelType); the list contains the ones whose account feature is on (for example ContractModelPrepaidServices). Names are enum member names, not UI titles. No paging: the whole list (at most 8 entries) is returned.
Use it to:
- Check which contract models the account has enabled before creating contracts
Behaviour:
- Idempotent.
- Safe to retry.
- Changes are visible to the next read immediately.
See also: POST /v1/payment
Not yet documented: related → next.
curl -X GET "https://app3.timelog.com/your-account/api/v1/ContractModel" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"
import requests
import json
url = "https://app3.timelog.com/your-account/api/v1/ContractModel"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://app3.timelog.com/your-account/api/v1/ContractModel", {
method: "GET",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://app3.timelog.com/your-account/api/v1/ContractModel", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://app3.timelog.com/your-account/api/v1/ContractModel')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
response = http.request(request)
puts response.body
{
"Entities": [
{
"Properties": {
"ContractModelID": 1,
"Name": "TimeMaterialBasic"
}
},
{
"Properties": {
"ContractModelID": 3,
"Name": "TimeMaterialAccountEndBalancing"
}
},
{
"Properties": {
"ContractModelID": 5,
"Name": "PrepaidServices"
}
},
{
"Properties": {
"ContractModelID": 4,
"Name": "TimeMaterialAccountPeriodicBalancing"
}
},
{
"Properties": {
"ContractModelID": 2,
"Name": "FixedPriceBasic"
}
},
{
"Properties": {
"ContractModelID": 7,
"Name": "ContinuousService"
}
},
{
"Properties": {
"ContractModelID": 6,
"Name": "TaskDrivenRevenue"
}
},
{
"Properties": {
"ContractModelID": 8,
"Name": "ContinuousItemInvoicing"
}
}
],
"Links": [
{
"Href": "https://app{server-number}.timelog.com/{account}/api/v1/ContractModel",
"Rel": "self"
}
]
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
/v1/ContractModel
Target server for requests. Edit to use your own host.
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.
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.Request Preview
Response
Response will appear here after sending the request
Authentication
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.
Responses
Omitted (not []) when the list is empty.