UpdatePaymentQuantity

Financial service 1.4: Sets the Quantity of one payment and recalculates its amount and the contract's plan.


Service	Financial 1.4
Endpoint	`POST https://app{server-number}.timelog.com/{account}/WebServices/Financial/V1_4/FinancialServiceSecure.svc`
SOAPAction	`http://www.timelog.com/api/tlp/v1_4/FinancialService/UpdatePaymentQuantity`
Content-Type	`text/xml; charset=utf-8`
Authentication	A token from GetToken
Changes data	Yes
Safe to retry	Yes

How it works

Every other member of the sent Payment is ignored. The amount is recalculated from the payment's rate and discount; on fixed-price recurring contracts the contract's payment-plan figures are recalculated, and invoicing potential, currency data and booking status are refreshed. A payment that already has an invoice line is refused. Returns the saved payment.

Parameters

Each parameter has one label: Required, Conditional (required depending on other values) or Optional. Send them in the order shown.

paymentPayment

Required

The Payment to send. Its fields are listed below.

sourceinteger

Required

'Interface source number, in most cases use 0'.

tokenSecurityToken

Required

The token from GetToken: Initials, Expires and Hash, sent back unchanged.

Request

POST /{account}/WebServices/Financial/V1_4/FinancialServiceSecure.svc HTTP/1.1
Host: app{server-number}.timelog.com
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://www.timelog.com/api/tlp/v1_4/FinancialService/UpdatePaymentQuantity"

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:financial="http://www.timelog.com/api/tlp/v1_4"
                  xmlns:tok="http://www.timelog.com/api/tlp/v1_3"
                  xmlns:financial2="http://schemas.datacontract.org/2004/07/TimeLog.TLP.API.Proxy.Financial.V1_4">
  <soapenv:Body>
    <financial:UpdatePaymentQuantity>
      <financial:payment>
        <financial2:Amount>{Amount}</financial2:Amount>
        <financial2:InvoiceDate>{InvoiceDate}</financial2:InvoiceDate>
        <financial2:Name>{Name}</financial2:Name>
        <financial2:PaymentID>{PaymentID}</financial2:PaymentID>
        <financial2:ProjectID>{ProjectID}</financial2:ProjectID>
        <financial2:ProjectSubContractID>{ProjectSubContractID}</financial2:ProjectSubContractID>
        <!-- more fields: see Parameters -->
      </financial:payment>
      <financial:source>{source}</financial:source>
      <financial:token>
        <tok:Initials>{Initials from GetToken}</tok:Initials>
        <tok:Expires>{Expires from GetToken, unchanged}</tok:Expires>
        <tok:Hash>{Hash from GetToken}</tok:Hash>
      </financial:token>
    </financial:UpdatePaymentQuantity>
  </soapenv:Body>
</soapenv:Envelope>

curl -X POST "https://app{server-number}.timelog.com/{account}/WebServices/Financial/V1_4/FinancialServiceSecure.svc" \
  -H "Content-Type: text/xml; charset=utf-8" \
  -H 'SOAPAction: "http://www.timelog.com/api/tlp/v1_4/FinancialService/UpdatePaymentQuantity"' \
  --data-binary @request.xml

import requests

URL = "https://app{server-number}.timelog.com/{account}/WebServices/Financial/V1_4/FinancialServiceSecure.svc"
SOAP_ACTION = '"http://www.timelog.com/api/tlp/v1_4/FinancialService/UpdatePaymentQuantity"'

envelope = """<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:financial="http://www.timelog.com/api/tlp/v1_4"
                  xmlns:tok="http://www.timelog.com/api/tlp/v1_3"
                  xmlns:financial2="http://schemas.datacontract.org/2004/07/TimeLog.TLP.API.Proxy.Financial.V1_4">
  <soapenv:Body>
    <financial:UpdatePaymentQuantity>
      <financial:payment>
        <financial2:Amount>{Amount}</financial2:Amount>
        <financial2:InvoiceDate>{InvoiceDate}</financial2:InvoiceDate>
        <financial2:Name>{Name}</financial2:Name>
        <financial2:PaymentID>{PaymentID}</financial2:PaymentID>
        <financial2:ProjectID>{ProjectID}</financial2:ProjectID>
        <financial2:ProjectSubContractID>{ProjectSubContractID}</financial2:ProjectSubContractID>
        <!-- more fields: see Parameters -->
      </financial:payment>
      <financial:source>{source}</financial:source>
      <financial:token>
        <tok:Initials>{Initials from GetToken}</tok:Initials>
        <tok:Expires>{Expires from GetToken, unchanged}</tok:Expires>
        <tok:Hash>{Hash from GetToken}</tok:Hash>
      </financial:token>
    </financial:UpdatePaymentQuantity>
  </soapenv:Body>
</soapenv:Envelope>"""

response = requests.post(
    URL,
    data=envelope.encode("utf-8"),
    headers={"Content-Type": "text/xml; charset=utf-8", "SOAPAction": SOAP_ACTION},
    timeout=60,
)
result = parse_result(response)  # see "Responses and errors"

Replace every {…} placeholder with your own value.

Response

The call returns the standard response envelope. Check ResponseState first: a failed call still returns HTTP 200.

ResponseStatestring

Required

Success, Invalid or Error.

ErrorCodeinteger

0 on success, otherwise the error code. See Errors.

ReturnPayment[]

Response<Payment>: Return = the saved payment - but ProjectID is the value the caller sent. No success message is added; ResponseState stays Success.

Example response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <UpdatePaymentQuantityResponse xmlns="http://www.timelog.com/api/tlp/v1_4">
      <UpdatePaymentQuantityResult xmlns:a="http://api.timelog.com"
                                   xmlns:b="http://schemas.datacontract.org/2004/07/TimeLog.TLP.API.Proxy.Financial.V1_4"
                                   xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <a:Return>
          <b:Payment>
            <b:Amount>0</b:Amount>
            <b:InvoiceDate>2026-10-01T00:00:00</b:InvoiceDate>
            <b:Name>Example </b:Name>
            <b:PaymentID>1001</b:PaymentID>
            <b:ProjectID>1001</b:ProjectID>
            <b:ProjectSubContractID>1001</b:ProjectSubContractID>
            <b:Quantity>0</b:Quantity>
          </b:Payment>
        </a:Return>
        <a:ReturnTypeDescription>Payment</a:ReturnTypeDescription>
        <a:Request>…</a:Request>
        <a:ResponseState>Success</a:ResponseState>
        <a:Messages>
          <a:APIMessage>
            <a:Message>Duration of call was 0,0421337 sec.</a:Message>
            <a:Severity>Message</a:Severity>
            <a:ErrorCode>0</a:ErrorCode>
          </a:APIMessage>
        </a:Messages>
        <a:ErrorCode>0</a:ErrorCode>
        <a:IsReturnPaged>false</a:IsReturnPaged>
        <a:TotalPageCount>0</a:TotalPageCount>
      </UpdatePaymentQuantityResult>
    </UpdatePaymentQuantityResponse>
  </s:Body>
</s:Envelope>

Illustrative example: built from the service description (WSDL) in the same format as a real response, with made-up values. The Request block is shortened.

Errors

All errors come back with HTTP 200: check ResponseState, ErrorCode and Messages. The errors every operation can return (expired or invalid token, API not enabled, HTTPS required, general errors) are listed once in Responses and errors.

Errors specific to this operation:

ResponseState	ErrorCode	Message	What it means	What to do
Error	40001	Error during call on TimeLog.API, Message 'Unable to retrieve result from …'	No payment has PaymentID.	Take PaymentID from GetPaymentList.
Error	40001	Error during call on TimeLog.API, Message 'The InvoiceableInstallment violates the Business Rules for saving an InvoiceableInstallment'	The payment has an invoice line, or another save rule failed - the rule is not named.	Only change payments that are not yet on an invoice.

Was this page helpful?