ProjectsValidate a payment-plan amount update of a recurring contract

Validate a payment-plan amount update of a recurring contract

Takes the same body as POST /v1/contract/update-recurring-contract-payment-plan-amount and answers 200 with the literal JSON null. A non-recurring contract answers 200 as well.

Use it to:

  • Check that a new periodic fee passes the continuous-service revenue rule (37633) before applying it

Not for:

  • Applying the change: POST /v1/contract/update-recurring-contract-payment-plan-amount
  • Confirming that the contract is recurring: a non-recurring contract also answers 200

Rules across fields:

  • R1: As the update: ProjectSubContractId should be a contract of ProjectId; not enforced.

Behaviour:

  • Idempotent.
  • Safe to retry. Writes nothing; repeatable.
  • Side effect: None persisted.
  • Changes are visible to the next read immediately.

Call first: GET /v1/project/get-all, GET /v1/contract

Next: POST /v1/contract/update-recurring-contract-payment-plan-amount

Not yet documented: behaviour → side effects; errors; examples.

curl -X POST "https://app3.timelog.com/your-account/api/v1/contract/validate-update-recurring-contract-payment-plan-amount" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "ProjectId": 123,
  "ProjectSubContractId": 123,
  "PaymentPlanAmount": 3.14
}'
"null"
POST
/v1/contract/validate-update-recurring-contract-payment-plan-amount
POST
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.
Content-Typestring
Required

The media type of the request body

Options: application/json
ProjectIdinteger
Required

The project the contract belongs to. Used only as the save context (budget sync, multi-customer handling, recalculation); it is NOT checked against the contract's own project. An unknown or 0 value fails with a 500 (captured for 0). Refers to ProjectRead.ProjectID. Look up valid values with GET /v1/project/get-all. - 0 / omitted / unknown — 500 Code 100, no 400. - An existing project that is not the contract's project — Accepted; the save runs with that project as context. Valid values come from GET /v1/project/get-all.

Format: int32
ProjectSubContractIdinteger
Required

The contract to update (ContractID in ContractRead). Unknown or 0 fails with a 500. Refers to ContractRead.ContractID. Look up valid values with GET /v1/contract. - 0 / omitted / unknown — 500 Code 100. - A contract that is not model 4, 7 or 8 (not recurring) — Nothing changes; 200. Valid values come from GET /v1/contract.

Format: int32
PaymentPlanAmountnumber
Required

The contract's new payment-plan amount (the fixed price per recurrence period), in the project currency. The server also sets the contract's BudgetWorkAmount = round(PaymentPlanAmount / RecurrenceMonth, 2, away from zero) — the per-month work budget. No range, sign or decimal check. Unit: project currency, per recurrence period - Model 7 or 8 — PaymentPlanAmount stored; BudgetWorkAmount derived. - Model 7 (continuous service) — 37633 when round(amount / months, 2) differs from the contract's allocated budget amount — 'You must allocate all revenue amount to proceed.' - Omitted — 0 is applied (non-nullable). > Not yet documented: constraints → unit.

Format: double
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.

Body

application/json
ProjectIdinteger
Required

The project the contract belongs to. Used only as the save context (budget sync, multi-customer handling, recalculation); it is NOT checked against the contract's own project. An unknown or 0 value fails with a 500 (captured for 0).

Refers to ProjectRead.ProjectID. Look up valid values with GET /v1/project/get-all.

  • 0 / omitted / unknown — 500 Code 100, no 400.

  • An existing project that is not the contract's project — Accepted; the save runs with that project as context.

Valid values come from GET /v1/project/get-all.

ProjectSubContractIdinteger
Required

The contract to update (ContractID in ContractRead). Unknown or 0 fails with a 500.

Refers to ContractRead.ContractID. Look up valid values with GET /v1/contract.

  • 0 / omitted / unknown — 500 Code 100.

  • A contract that is not model 4, 7 or 8 (not recurring) — Nothing changes; 200.

Valid values come from GET /v1/contract.

PaymentPlanAmountnumber
Required

The contract's new payment-plan amount (the fixed price per recurrence period), in the project currency. The server also sets the contract's BudgetWorkAmount = round(PaymentPlanAmount / RecurrenceMonth, 2, away from zero) — the per-month work budget. No range, sign or decimal check.

Unit: project currency, per recurrence period

  • Model 7 or 8 — PaymentPlanAmount stored; BudgetWorkAmount derived.

  • Model 7 (continuous service) — 37633 when round(amount / months, 2) differs from the contract's allocated budget amount — 'You must allocate all revenue amount to proceed.'

  • Omitted — 0 is applied (non-nullable).

Not yet documented: constraints → unit.

Responses

Success without content: HTTP 200 with the literal JSON body null. Literal JSON null (TafSuccessResult) — also when the contract is not recurring and nothing was checked.