POST api/Subcontracts/{subcontractId}/PlannedPayment/Versions/{plannedPaymentListVersionId}
Create a planned payment
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| subcontractId | integer |
Required |
|
| plannedPaymentListVersionId | integer |
Required |
Body Parameters
PlannedPaymentCreateDto| Name | Description | Type | Additional information |
|---|---|---|---|
| PlannedPaymentEventId | PlannedPaymentEventId |
None. |
|
| UserDescription | string |
None. |
|
| PlannedDate | date |
None. |
|
| Amount | decimal number |
None. |
|
| PlannedPaymentSubtypeId | PlannedPaymentSubtypeId |
None. |
Request Formats
application/json, text/json
Sample:
{
"plannedPaymentEventId": 1,
"userDescription": "sample string 1",
"plannedDate": "2026-05-09T09:14:03.0265299+02:00",
"amount": 1.0,
"plannedPaymentSubtypeId": 1
}
text/html
Sample:
{"plannedPaymentEventId":1,"userDescription":"sample string 1","plannedDate":"2026-05-09T09:14:03.0265299+02:00","amount":1.0,"plannedPaymentSubtypeId":1}
application/xml, text/xml
Sample:
<PlannedPaymentCreateDto 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> <PlannedDate>2026-05-09T09:14:03.0265299+02:00</PlannedDate> <PlannedPaymentEventId>Regular</PlannedPaymentEventId> <PlannedPaymentSubtypeId>Fix</PlannedPaymentSubtypeId> <UserDescription>sample string 1</UserDescription> </PlannedPaymentCreateDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ApiDataResultOfBoolean| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | boolean |
None. |
|
| Success | boolean |
None. |
|
| Message | string |
None. |
|
| Errors | Collection of CustomError |
None. |
|
| Warnings | Collection of string |
None. |
Response Formats
application/json, text/json, text/html
Sample:
Sample not available.