PUT api/Subcontracts/{subcontractId}/PlannedPayment/Version/{versionId}/{plannedPaymentId}

Update a planned Payment

Request Information

URI Parameters

Name	Type	Additional information
subcontractId	integer	Required
versionId	integer	Required
plannedPaymentId	integer	Required

Body Parameters

PlannedPaymentUpdateDto

Name	Type	Additional information
PlannedPaymentEventId	PlannedPaymentEventId	None.
UserDescription	string	None.
PlannedDate	date	None.
Amount	decimal number	None.
PlannedPaymentSubtypeId	PlannedPaymentSubtypeId	None.
IsActual	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "plannedPaymentEventId": 1,
  "userDescription": "sample string 1",
  "plannedDate": "2026-05-09T14:11:14.1767519+02:00",
  "amount": 1.0,
  "plannedPaymentSubtypeId": 1,
  "isActual": true
}

text/html

Sample:

{"plannedPaymentEventId":1,"userDescription":"sample string 1","plannedDate":"2026-05-09T14:11:14.1767519+02:00","amount":1.0,"plannedPaymentSubtypeId":1,"isActual":true}

application/xml, text/xml

Sample:

<PlannedPaymentUpdateDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.SubcontractModule.Application.Dtos.Dtos.PlannedPaymentAgg">
  <Amount>1</Amount>
  <IsActual>true</IsActual>
  <PlannedDate>2026-05-09T14:11:14.1767519+02:00</PlannedDate>
  <PlannedPaymentEventId>Regular</PlannedPaymentEventId>
  <PlannedPaymentSubtypeId>Fix</PlannedPaymentSubtypeId>
  <UserDescription>sample string 1</UserDescription>
</PlannedPaymentUpdateDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiResult

Name	Type	Additional information
Success	boolean	None.
Message	string	None.
Errors	Collection of CustomError	None.
Warnings	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "success": false,
  "message": "sample string 1",
  "errors": [
    {
      "errorCode": 1,
      "errorMessage": "sample string 2"
    },
    {
      "errorCode": 1,
      "errorMessage": "sample string 2"
    }
  ],
  "warnings": [
    "sample string 1",
    "sample string 2"
  ]
}

text/html

Sample:

{"success":false,"message":"sample string 1","errors":[{"errorCode":1,"errorMessage":"sample string 2"},{"errorCode":1,"errorMessage":"sample string 2"}],"warnings":["sample string 1","sample string 2"]}

application/xml, text/xml

Sample:

<ApiResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.DistributedServices.WebApi.Base.Results">
  <Errors xmlns:d2p1="http://schemas.datacontract.org/2004/07/TR.eSAM.Infrastructure.Crosscutting.Exceptions">
    <d2p1:CustomError>
      <d2p1:ErrorCode>1</d2p1:ErrorCode>
      <d2p1:ErrorMessage>sample string 2</d2p1:ErrorMessage>
    </d2p1:CustomError>
    <d2p1:CustomError>
      <d2p1:ErrorCode>1</d2p1:ErrorCode>
      <d2p1:ErrorMessage>sample string 2</d2p1:ErrorMessage>
    </d2p1:CustomError>
  </Errors>
  <Message>sample string 1</Message>
  <Warnings xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Warnings>
</ApiResult>