Validate a payment update (dry run)
Checks whether a payment update would be accepted, without saving anything.
Takes the PaymentUpdate body of PUT /v1/payment/{paymentID}, applies it to a detached copy of the payment and runs the same refusals (editability, amount derivation) and the save's business rules (draft invoice, invoice-date change on Time & Material Basic, share-ratio rule). Answers 200 with null.
Use it to:
- Pre-check an instalment change before committing it from a sync job
Not for:
- Saving →
PUT /v1/payment/{paymentID}
Rules across fields:
- R1: As
PUT /v1/payment/{paymentID}R1: Amount needs a non-zero effective Quantity and a Discount below 100 %.
Behaviour:
- Idempotent.
- Safe to retry.
- Changes are visible to the next read immediately.
Call first: GET /v1/payment/{paymentID}
Next: PUT /v1/payment/{paymentID}
Not yet documented: examples.
curl -X POST "https://app3.timelog.com/your-account/api/v1/payment/123/validate-update-payment" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-d '{
"Name": "null",
"Amount": "null",
"InvoiceDate": "null",
"Quantity": "null"
}'
import requests
import json
url = "https://app3.timelog.com/your-account/api/v1/payment/123/validate-update-payment"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
data = {
"Name": "null",
"Amount": "null",
"InvoiceDate": "null",
"Quantity": "null"
}
response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://app3.timelog.com/your-account/api/v1/payment/123/validate-update-payment", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
},
body: JSON.stringify({
"Name": "null",
"Amount": "null",
"InvoiceDate": "null",
"Quantity": "null"
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"Name": "null",
"Amount": "null",
"InvoiceDate": "null",
"Quantity": "null"
}`)
req, err := http.NewRequest("POST", "https://app3.timelog.com/your-account/api/v1/payment/123/validate-update-payment", bytes.NewBuffer(data))
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/123/validate-update-payment')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request.body = '{
"Name": "null",
"Amount": "null",
"InvoiceDate": "null",
"Quantity": "null"
}'
response = http.request(request)
puts response.body
"null"
{
"error": "Bad Request",
"message": "The request contains invalid parameters or malformed data",
"code": 400,
"details": [
{
"field": "email",
"message": "Invalid email format"
}
]
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"error": "Forbidden",
"message": "You don't have permission to access this resource",
"code": 403
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
{
"error": "Internal Server Error",
"message": "An unexpected error occurred on the server",
"code": 500,
"requestId": "req_1234567890"
}
/v1/payment/{paymentID}/validate-update-paymentTarget 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.The payment to check. Route constraint :int.
The media type of the request body
New name (text) of the instalment. Null: null / omitted = unchanged; there is no way to clear the name. - Sent as empty string — 400 Code 200 'Name cannot be empty when supplied.' > Not yet documented: constraints → max length.
New amount of the instalment, in the project currency. Null: null / omitted = unchanged. Unit: project currency - Sent — Applied last (after Quantity); the unit Rate is then recalculated from the amount. - Effective Quantity (sent or stored) is 0 — 400 — the rate derivation would silently reset the amount to 0. - The payment's Discount is 100 % or more — 400 — same reason.
New invoice date of the instalment. Null: null / omitted = unchanged. Time zone: none — only the date part is kept - Not a valid date — 400 Code 200 'Invoice date is not valid date.' - Any time of day — Truncated to the date (.Date), like the payment page. - The payment's contract is Time & Material Basic and the date changes — 400 '…invoice date is not allowed to change.' (37526). - Changed — On save the instalment's exchange rate to system currency is refreshed for the new date and the system-currency amount recalculated.
New quantity, in the payment's UnitType units. Null: null / omitted = unchanged. Unit: the payment's UnitType (PaymentRead.UnitType) - Sent — The amount is recalculated from the stored unit Rate, Quantity and Discount (RecalculateAmount) — unless Amount is also sent, which then wins. > Not yet documented: constraints.
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.
Path Parameters
The payment to check. Route constraint :int.
Body
New name (text) of the instalment.
Null: null / omitted = unchanged; there is no way to clear the name.
- Sent as empty string — 400 Code 200 'Name cannot be empty when supplied.'
Not yet documented: constraints → max length.
New amount of the instalment, in the project currency.
Null: null / omitted = unchanged.
Unit: project currency
-
Sent — Applied last (after Quantity); the unit Rate is then recalculated from the amount.
-
Effective Quantity (sent or stored) is 0 — 400 — the rate derivation would silently reset the amount to 0.
-
The payment's Discount is 100 % or more — 400 — same reason.
New invoice date of the instalment.
Null: null / omitted = unchanged.
Time zone: none — only the date part is kept
-
Not a valid date — 400 Code 200 'Invoice date is not valid date.'
-
Any time of day — Truncated to the date (.Date), like the payment page.
-
The payment's contract is Time & Material Basic and the date changes — 400 '…invoice date is not allowed to change.' (37526).
-
Changed — On save the instalment's exchange rate to system currency is refreshed for the new date and the system-currency amount recalculated.
New quantity, in the payment's UnitType units.
Null: null / omitted = unchanged.
Unit: the payment's UnitType (PaymentRead.UnitType)
- Sent — The amount is recalculated from the stored unit Rate, Quantity and Discount (RecalculateAmount) — unless Amount is also sent, which then wins.
Not yet documented: constraints.
Responses
Success without content: HTTP 200 with the literal JSON body null. The literal null: the update would pass the checks.