POST api/ReportApi/OpenList
Open list (Offene Posten) report (JSON/XML).
Request Information
URI Parameters
None.
Body Parameters
Due date filter with sorting
ExtendedDueDateFilter| Name | Description | Type | Additional information |
|---|---|---|---|
| IncludePrePayments |
Include pre payments in the data set. Default = false |
boolean |
None. |
| Sorting |
Data set sorting. Default: Target = Name, Descending = false |
ReportSorting |
None. |
| Due |
Due date |
date |
Required |
Request Formats
application/json, text/json
Sample:
{
"IncludePrePayments": true,
"Sorting": {
"Target": 0,
"Descending": true
},
"Due": "2025-10-21T08:43:31.2181871+02:00"
}
application/xml, text/xml
Sample:
<ExtendedDueDateFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.CustomerPortal.Models.Api">
<Due>2025-10-21T08:43:31.2181871+02:00</Due>
<IncludePrePayments>true</IncludePrePayments>
<Sorting>
<Descending>true</Descending>
<Target>Name</Target>
</Sorting>
</ExtendedDueDateFilter>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
Report data as JSON or XML.
OpenPostListReportModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Name | string |
None. |
|
| PostcodeAndPlace | string |
None. |
|
| Vouchers | Collection of OpenPostListVoucherReportModel |
None. |
|
| AddressVoucherBalanceTotal | decimal number |
None. |
|
| AddressBalanceTotal | decimal number |
None. |
Response Formats
application/json, text/json
Sample:
{
"Name": "sample string 1",
"PostcodeAndPlace": "sample string 2",
"Vouchers": [
{
"AddressNumber": "sample string 1",
"OrderNumber": "sample string 2",
"VoucherNumber": "sample string 3",
"VoucherDate": "2025-10-21T08:43:31.2338099+02:00",
"VoucherBalance": 5.0,
"Balance": 6.0,
"PaymentType": "sample string 7"
},
{
"AddressNumber": "sample string 1",
"OrderNumber": "sample string 2",
"VoucherNumber": "sample string 3",
"VoucherDate": "2025-10-21T08:43:31.2338099+02:00",
"VoucherBalance": 5.0,
"Balance": 6.0,
"PaymentType": "sample string 7"
}
],
"AddressVoucherBalanceTotal": 10.0,
"AddressBalanceTotal": 12.0
}
application/xml, text/xml
Sample:
<OpenPostListReportModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.CustomerPortal.Models.Web">
<Name>sample string 1</Name>
<PostcodeAndPlace>sample string 2</PostcodeAndPlace>
<Vouchers>
<OpenPostListVoucherReportModel>
<AddressNumber>sample string 1</AddressNumber>
<Balance>6</Balance>
<OrderNumber>sample string 2</OrderNumber>
<PaymentType>sample string 7</PaymentType>
<VoucherBalance>5</VoucherBalance>
<VoucherDate>2025-10-21T08:43:31.2338099+02:00</VoucherDate>
<VoucherNumber>sample string 3</VoucherNumber>
</OpenPostListVoucherReportModel>
<OpenPostListVoucherReportModel>
<AddressNumber>sample string 1</AddressNumber>
<Balance>6</Balance>
<OrderNumber>sample string 2</OrderNumber>
<PaymentType>sample string 7</PaymentType>
<VoucherBalance>5</VoucherBalance>
<VoucherDate>2025-10-21T08:43:31.2338099+02:00</VoucherDate>
<VoucherNumber>sample string 3</VoucherNumber>
</OpenPostListVoucherReportModel>
</Vouchers>
</OpenPostListReportModel>