GET api/creditnote/redeemed/timespan?dateFrom={dateFrom}&dateTo={dateTo}

Provides all redeemed credit notes in a given timespan.

Request Information

URI Parameters

Name	Description	Type	Additional information
dateFrom		date	Required
dateTo		date	Required

Body Parameters

None.

Response Information

Resource Description

Collection of PublicAPI.Models.GiftCertificateDto

Name	Description	Type	Additional information
VoucherNumber	ID of the voucher (24 digits).	string	None.
AlternativeVoucherNumber	Alternative id of the voucher. Should be "unique" within a group. Null if VoucherState == Faulty.	integer	None.
Amount	Always positive value.	decimal number	None.
State	Has the voucher been used?	Core.Models.Domain.VoucherState	None.
IssuedAtShopId	Which shop issued the voucher? Null if voucher was redeemed but was not registered as issued.	integer	None.
RedeemedAtShopId	Which shop redeemed the voucher? Null if not yet redeemed or manually redeemed via BO.	integer	None.
IssuedTransactionNumber	The transaction number at the issueing shop. Null if voucher was redeemed but was not registered as issued.	integer	None.
RedeemedTransactionNumber	The transaction number at the redeeming shop. Null if not yet redeemed or manually redeemed via BO.	integer	None.
IssuedDate	Date of issueing. Null if voucher was redeemed but was not registered as issued.	date	None.
RedeemedDate	Date of redeeming. Null if not yet redeemed.	date	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "VoucherNumber": "sample string 1",
    "AlternativeVoucherNumber": 1,
    "Amount": 2.0,
    "State": "Open",
    "IssuedAtShopId": 1,
    "RedeemedAtShopId": 1,
    "IssuedTransactionNumber": 1,
    "RedeemedTransactionNumber": 1,
    "IssuedDate": "2025-10-24T06:45:03.2593911+02:00",
    "RedeemedDate": "2025-10-24T06:45:03.2593911+02:00"
  },
  {
    "VoucherNumber": "sample string 1",
    "AlternativeVoucherNumber": 1,
    "Amount": 2.0,
    "State": "Open",
    "IssuedAtShopId": 1,
    "RedeemedAtShopId": 1,
    "IssuedTransactionNumber": 1,
    "RedeemedTransactionNumber": 1,
    "IssuedDate": "2025-10-24T06:45:03.2593911+02:00",
    "RedeemedDate": "2025-10-24T06:45:03.2593911+02:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfGiftCertificateDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PublicAPI.Models">
  <GiftCertificateDto>
    <AlternativeVoucherNumber>1</AlternativeVoucherNumber>
    <Amount>2</Amount>
    <IssuedAtShopId>1</IssuedAtShopId>
    <IssuedDate>2025-10-24T06:45:03.2593911+02:00</IssuedDate>
    <IssuedTransactionNumber>1</IssuedTransactionNumber>
    <RedeemedAtShopId>1</RedeemedAtShopId>
    <RedeemedDate>2025-10-24T06:45:03.2593911+02:00</RedeemedDate>
    <RedeemedTransactionNumber>1</RedeemedTransactionNumber>
    <State>Open</State>
    <VoucherNumber>sample string 1</VoucherNumber>
  </GiftCertificateDto>
  <GiftCertificateDto>
    <AlternativeVoucherNumber>1</AlternativeVoucherNumber>
    <Amount>2</Amount>
    <IssuedAtShopId>1</IssuedAtShopId>
    <IssuedDate>2025-10-24T06:45:03.2593911+02:00</IssuedDate>
    <IssuedTransactionNumber>1</IssuedTransactionNumber>
    <RedeemedAtShopId>1</RedeemedAtShopId>
    <RedeemedDate>2025-10-24T06:45:03.2593911+02:00</RedeemedDate>
    <RedeemedTransactionNumber>1</RedeemedTransactionNumber>
    <State>Open</State>
    <VoucherNumber>sample string 1</VoucherNumber>
  </GiftCertificateDto>
</ArrayOfGiftCertificateDto>