POST api/Subcontracts/{subcontractId}/PlannedPayment/Export

Get export PlannedPayment

Request Information

URI Parameters

Name	Description	Type	Additional information
subcontractId		integer	Required

Body Parameters

PlannedPaymentOrderFilter

Name	Type	Additional information
PlannedPaymentVersionId	integer	None.
Code	string	None.
PlannedPaymentEventId	integer	None.
PlannedPaymentSubtypeId	integer	None.
UserDescription	string	None.
PlannedDate	Collection of date	None.
Amount	Collection of decimal number	None.
IsActual	boolean	None.
ExcludePriorToLastApprovedCertif	boolean	None.
SortedColumns	Collection of Order	None.

Request Formats

application/json, text/json

Sample:

{
  "plannedPaymentVersionId": 1,
  "code": "sample string 2",
  "plannedPaymentEventId": 3,
  "plannedPaymentSubtypeId": 4,
  "userDescription": "sample string 5",
  "plannedDate": [
    "2026-05-09T11:11:23.0047619+02:00",
    "2026-05-09T11:11:23.0047619+02:00"
  ],
  "amount": [
    1.0,
    1.0
  ],
  "isActual": true,
  "excludePriorToLastApprovedCertif": true,
  "sortedColumns": [
    {
      "name": "sample string 1",
      "descending": true
    },
    {
      "name": "sample string 1",
      "descending": true
    }
  ]
}

text/html

Sample:

{"plannedPaymentVersionId":1,"code":"sample string 2","plannedPaymentEventId":3,"plannedPaymentSubtypeId":4,"userDescription":"sample string 5","plannedDate":["2026-05-09T11:11:23.0047619+02:00","2026-05-09T11:11:23.0047619+02:00"],"amount":[1.0,1.0],"isActual":true,"excludePriorToLastApprovedCertif":true,"sortedColumns":[{"name":"sample string 1","descending":true},{"name":"sample string 1","descending":true}]}

application/xml, text/xml

Sample:

<PlannedPaymentOrderFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.SubcontractModule.Application.Dtos.Dtos.PlannedPaymentAgg">
  <SortedColumns xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.Application.Base.SortAndPage.Entities">
    <Order>
      <Descending>true</Descending>
      <Name>sample string 1</Name>
    </Order>
    <Order>
      <Descending>true</Descending>
      <Name>sample string 1</Name>
    </Order>
  </SortedColumns>
  <Amount xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>1</d2p1:decimal>
    <d2p1:decimal>1</d2p1:decimal>
  </Amount>
  <Code>sample string 2</Code>
  <ExcludePriorToLastApprovedCertif>true</ExcludePriorToLastApprovedCertif>
  <IsActual>true</IsActual>
  <PlannedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:dateTime>2026-05-09T11:11:23.0047619+02:00</d2p1:dateTime>
    <d2p1:dateTime>2026-05-09T11:11:23.0047619+02:00</d2p1:dateTime>
  </PlannedDate>
  <PlannedPaymentEventId>3</PlannedPaymentEventId>
  <PlannedPaymentSubtypeId>4</PlannedPaymentSubtypeId>
  <PlannedPaymentVersionId>1</PlannedPaymentVersionId>
  <UserDescription>sample string 5</UserDescription>
</PlannedPaymentOrderFilter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.