Delete a payment

Deletes a contract payment (billing-plan instalment) that is not on an invoice.

Removes one instalment from its project's billing plan and re-saves the project. Refused (400) when the contract model does not allow deleting payments, or when the instalment is booked, on a draft invoice, or (unbooked) has auto expenses on a draft invoice. Deleting a task's fixed-price instalment switches that task's payment recognition to the overall payment plan. Answers 200 with null. Requires access to the payment's project (same gate as GET /v1/payment/{paymentID}).

Use it to:

Remove an instalment that was created by mistake or is no longer agreed

Not for:

Invoiced instalments — credit the invoice in TimeLog first
A dry run → POST /v1/payment/{paymentID}/validate-delete-payment

Behaviour:

Not idempotent.
A second DELETE of the same ID answers 404.
Safe to retry only under a condition. Treat a 404 on retry as 'already deleted'. After a 400 from the project save (payment-delete-rule-violation) re-read the payment first.
Side effect: Removes the instalment from the project's billing plan and saves the project.
Side effect: If the instalment belongs to a task, sets that task's PaymentRecognitionModel to OverallPaymentPlan (the fixed-price task model is dropped).
Changes are visible to the next read immediately.

Call first: GET /v1/payment, POST /v1/payment/{paymentID}/validate-delete-payment

See also: PUT /v1/payment/{paymentID}, POST /v1/payment

curl -X DELETE "https://app3.timelog.com/your-account/api/v1/payment/123" \
  -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/123"
headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}

response = requests.delete(url, headers=headers)
print(response.json())

const response = await fetch("https://app3.timelog.com/your-account/api/v1/payment/123", {
  method: "DELETE",
  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("DELETE", "https://app3.timelog.com/your-account/api/v1/payment/123", 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/123')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'

response = http.request(request)
puts response.body

"null"

{
  "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/{paymentID}"
}

DELETE

/v1/payment/{paymentID}

DELETE

Base URLstring

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

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.

path

paymentIDinteger

Required

The payment to delete. Route constraint :int.

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.

Path Parameters

paymentIDinteger

Required

The payment to delete. Route constraint :int.

Responses

Success without content: HTTP 200 with the literal JSON body null. The literal null: the payment was deleted.

Was this page helpful?