POST api/ReportApi/CreditNoteJournal

Credit note journal (Gutschriftsjournal) report (JSON/XML).

Request Information

URI Parameters

None.

Body Parameters

Date range filter

DateRangeFilter
NameDescriptionTypeAdditional information
Start

Starting date of period

date

Required

End

End date of period

date

Required

Request Formats

application/json, text/json

Sample:
{
  "Start": "2024-05-07T12:44:30.4882212+02:00",
  "End": "2024-05-07T12:44:30.4882212+02:00"
}

application/xml, text/xml

Sample:
<DateRangeFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.CustomerPortal.Models.Api">
  <End>2024-05-07T12:44:30.4882212+02:00</End>
  <Start>2024-05-07T12:44:30.4882212+02:00</Start>
</DateRangeFilter>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'DateRangeFilter'.

Response Information

Resource Description

Report data as JSON or XML

Collection of CreditNoteJournalReportModel
NameDescriptionTypeAdditional information
AddressNumber

string

None.

OrderNumber

string

None.

VoucherNumber

string

None.

VoucherDate

date

None.

Name

string

None.

PostcodeAndPlace

string

None.

Balance

decimal number

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "AddressNumber": "sample string 1",
    "OrderNumber": "sample string 2",
    "VoucherNumber": "sample string 3",
    "VoucherDate": "2024-05-07T12:44:30.4882212+02:00",
    "Name": "sample string 5",
    "PostcodeAndPlace": "sample string 6",
    "Balance": 7.0
  },
  {
    "AddressNumber": "sample string 1",
    "OrderNumber": "sample string 2",
    "VoucherNumber": "sample string 3",
    "VoucherDate": "2024-05-07T12:44:30.4882212+02:00",
    "Name": "sample string 5",
    "PostcodeAndPlace": "sample string 6",
    "Balance": 7.0
  }
]

application/xml, text/xml

Sample:
<ArrayOfCreditNoteJournalReportModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.CustomerPortal.Models.Web">
  <CreditNoteJournalReportModel>
    <AddressNumber>sample string 1</AddressNumber>
    <Balance>7</Balance>
    <Name>sample string 5</Name>
    <OrderNumber>sample string 2</OrderNumber>
    <PostcodeAndPlace>sample string 6</PostcodeAndPlace>
    <VoucherDate>2024-05-07T12:44:30.4882212+02:00</VoucherDate>
    <VoucherNumber>sample string 3</VoucherNumber>
  </CreditNoteJournalReportModel>
  <CreditNoteJournalReportModel>
    <AddressNumber>sample string 1</AddressNumber>
    <Balance>7</Balance>
    <Name>sample string 5</Name>
    <OrderNumber>sample string 2</OrderNumber>
    <PostcodeAndPlace>sample string 6</PostcodeAndPlace>
    <VoucherDate>2024-05-07T12:44:30.4882212+02:00</VoucherDate>
    <VoucherNumber>sample string 3</VoucherNumber>
  </CreditNoteJournalReportModel>
</ArrayOfCreditNoteJournalReportModel>