List the payments of a contract
Lists the billing-plan instalments of one contract, in creation order, one page at a time.
contractID is required (without it no action matches → 405). An unknown contract returns an empty list, not an error. The caller needs access to the contract's project (403 otherwise).
Use it to:
- Sync a contract's payment plan to an ERP
- Find PaymentIDs for GET / update / delete
Behaviour:
- Idempotent.
- Safe to retry.
- Changes are visible to the next read immediately.
Next: GET /v1/payment/{paymentID}
See also: POST /v1/payment
curl -X GET "https://app3.timelog.com/your-account/api/v1/payment?contractID=123&$page=1&$pagesize=10" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"
import requests
import json
url = "https://app3.timelog.com/your-account/api/v1/payment?contractID=123&$page=1&$pagesize=10"
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/payment?contractID=123&$page=1&$pagesize=10", {
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/payment?contractID=123&$page=1&$pagesize=10", 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/payment?contractID=123&$page=1&$pagesize=10')
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
{
"Properties": {
"TotalRecord": "example_string",
"TotalPage": "example_string",
"PageNumber": "example_string"
},
"Entities": [
{
"Properties": {
"Name": "John Doe",
"PaymentID": 123,
"PaymentGuid": "123e4567-e89b-12d3-a456-426614174000",
"Comment": "example_string",
"Amount": 3.14,
"InvoiceDate": "2024-12-25T10:00:00Z",
"IsReadyForInvoicing": true,
"InstallmentType": 42,
"ProjectID": 123,
"TaskID": 123,
"ProductNumberID": 123,
"Discount": 3.14,
"ProjectSubContractID": 123,
"Quantity": 3.14,
"UnitType": 42,
"Rate": 3.14,
"IsFixedPricePayment": true,
"ExpensesCost": 3.14
},
"Links": [
{
"Href": "example_string",
"Rel": "example_string"
}
],
"Actions": [
{}
]
}
],
"Links": [
{
"Href": "example_string",
"Rel": "example_string"
}
]
}
{
"Message": "Authorization has been denied for this request."
}
{
"Code": 103,
"Message": "…",
"Details": [],
"Parameters": "…",
"Url": "https://app{server-number}.timelog.com/{account}/api/v1/payment"
}
{
"code": "UnsupportedApiVersion",
"error": "No route providing a controller name with API version '1' was found to match HTTP method 'GET' and request URI 'https://app{server-number}.timelog.com/{account}/api/v1/payment'.",
"traceId": "…",
"type": "https://docs.api-versioning.org/problems#unsupported",
"title": "Unsupported API version",
"status": 405,
"detail": "The requested resource with API version '1' does not support HTTP method 'GET'."
}
{
"Code": 100,
"Message": "Unknown error occur in system, please contact system administrator.",
"Details": [],
"Parameters": "…",
"Url": "https://app{server-number}.timelog.com/{account}/api/v1/payment"
}
/v1/payment
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.
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.The contract (ProjectSubContractID). Omitted → 405 UnsupportedApiVersion (no action matched).
Page number.
Page size. No maximum in the API layer.
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.
Query Parameters
The contract (ProjectSubContractID). Omitted → 405 UnsupportedApiVersion (no action matched).
Page number.
Page size. No maximum in the API layer.
Responses
Paging values. They are returned as STRINGS, for example "TotalRecord": "12".
Omitted (not []) when the list is empty.