' Options:
'Date: 2026-02-14 10:10:05
'Version: 10.04
'Tip: To override a DTO option, remove "''" prefix before updating
'BaseUrl: https://stf-api-uat.data-xchange.co.za
'
'''GlobalNamespace: 
'''MakePartial: True
'''MakeVirtual: True
'''MakeDataContractsExtensible: False
'''AddReturnMarker: True
'''AddDescriptionAsComments: True
'''AddDataContractAttributes: False
'''AddIndexesToDataMembers: False
'''AddGeneratedCodeAttributes: False
'''AddResponseStatus: False
'''AddImplicitVersion: 
'''InitializeCollections: False
'''ExportValueTypes: False
'IncludeTypes: GetCreditNoteById.*
'''ExcludeTypes: 
'''AddNamespaces: 
'''AddDefaultXmlNamespace: http://schemas.servicestack.net/types

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports DX.STF.Contracts.Queries
Imports DX.Framework.Core.Querying
Imports DX.STF.Models.Dto.GS1
Imports DX.STF.Application.ClientApi.Messages.CreditNote

Namespace Global

    Namespace DX.Framework.Core.Querying

        Public Interface ISingleEntityQuery
            Property Id As Guid
        End Interface
    End Namespace

    Namespace DX.STF.Application.ClientApi.Messages.CreditNote

        '''<Summary>
        '''Credit Note
        '''</Summary>
        <Route("/creditNote/{Id}", "GET")>
        <Api(Description:="Credit Note")>
        <ApiResponse(Description:="Credit Note data", IsDefaultResponse:=true, StatusCode:=200)>
        <ApiResponse(Description:="No Content", ResponseType:=GetType(IReturnVoid), StatusCode:=204)>
        <ApiResponse(Description:="Specified argument was out of the range of valid values.", ResponseType:=GetType(ArgumentOutOfRangeException), StatusCode:=400)>
        Public Partial Class GetCreditNoteById
            Implements IReturn(Of InvoiceMessage)
            Implements IGetDocumentById
            '''<Summary>
            '''Credit Note ID or Token
            '''</Summary>
            <ApiMember(Description:="Credit Note ID or Token", ExcludeInSchema:=true, ParameterType:="path")>
            Public Overridable Property Id As Guid
        End Class
    End Namespace

    Namespace DX.STF.Contracts.Queries

        Public Interface IGetDocumentById
            Implements ISingleEntityQuery
        End Interface
    End Namespace

    Namespace DX.STF.Models.Dto.GS1

        Public Partial Class Address
            Public Overridable Property StreetAddressOne As String
            Public Overridable Property StreetAddressTwo As String
            Public Overridable Property StreetAddressThree As String
            Public Overridable Property City As String
            Public Overridable Property PostalCode As String
            Public Overridable Property ProvinceCode As String
            Public Overridable Property CountryCode As String
        End Class

        Public Partial Class AllowanceCharge
            Public Overridable Property AllowanceChargeAmount As Decimal?
            Public Overridable Property AllowanceChargePercentage As Decimal?
            Public Overridable Property AllowanceChargeType As String
            Public Overridable Property AllowanceOrChargeType As String
            Public Overridable Property AmountPerUnit As Decimal?
            Public Overridable Property BaseAmount As Decimal?
            Public Overridable Property BaseNumberOfUnits As String
            Public Overridable Property BracketIdentifier As String
            Public Overridable Property EffectiveDateType As Date?
            Public Overridable Property SequenceNumber As String
            Public Overridable Property SettlementType As String
            Public Overridable Property SpecialServiceType As String
            Public Overridable Property AllowanceChargeDescription As String
        End Class

        Public Partial Class AvpList
            Public Overridable Property Code As String
            Public Overridable Property Value As String
        End Class

        Public Partial Class BaseDocument
            Public Overridable Property CurrencyCode As String
            Public Overridable Property CreationDateTime As Date
            Public Overridable Property DocumentActionCode As DocumentAction
            Public Overridable Property DocumentStatusCode As DocumentStatus
            Public Overridable Property DocumentStructureVersion As String
            Public Overridable Property LastUpdateDateTime As Date?
            Public Overridable Property RevisionNumber As Long?
            Public Overridable Property AvpList As List(Of AvpList) = New List(Of AvpList)
        End Class

        Public Partial Class Colour
            Public Overridable Property ColourCode As String
            Public Overridable Property ColourDescription As String
        End Class

        Public Partial Class CommunicationChannel
            Public Overridable Property CommunicationChannelCode As String
            Public Overridable Property CommunicationChannelName As String
            Public Overridable Property CommunicationValue As String
        End Class

        Public Partial Class Contact
            Public Overridable Property ContactTypeCode As String
            Public Overridable Property PersonName As String
            Public Overridable Property DepartmentName As String
            Public Overridable Property JobTitle As String
            Public Overridable Property Responsibility As String
            Public Overridable Property CommunicationChannel As List(Of CommunicationChannel) = New List(Of CommunicationChannel)
        End Class

        <DataContract>
        Public Partial Class ContactInformation
        End Class

        Public Enum DocumentAction
            ADD
            CHANGE_BY_REFRESH
            DELETE
            REJECTED
        End Enum

        <DataContract>
        Public Partial Class DocumentIdentification
            <DataMember(Name:="identifier")>
            Public Overridable Property Identifier As String

            <DataMember(Name:="type")>
            Public Overridable Property Type As String

            <DataMember(Name:="creationDateAndTime")>
            Public Overridable Property CreationDateAndTime As Date
        End Class

        Public Partial Class DocumentReference
            Public Overridable Property CreationDateTime As Date?
            Public Overridable Property RevisionNumber As Long?
            Public Overridable Property LineItemNumber As Long?
            Public Overridable Property EntityIdentification As String
        End Class

        Public Enum DocumentStatus
            ADDITIONAL_TRANSMISSION
            COPY
            ORIGINAL
        End Enum

        Public Partial Class Ecom_PartyIdentificationType
            Public Overridable Property Gln As String
            Public Overridable Property Name As String
            Public Overridable Property AdditionalPartyIdentification As List(Of AvpList) = New List(Of AvpList)
        End Class

        Public Partial Class Extension
        End Class

        Public Partial Class FinancialAccount
            Public Overridable Property Number As String
            Public Overridable Property NumberTypeCode As String
            Public Overridable Property Name As String
        End Class

        Public Partial Class FinancialInstitutionInformation
            Public Overridable Property FinancialInstitutionBranchName As String
            Public Overridable Property FinancialInstitutionName As String
            Public Overridable Property FinancialRoutingNumber As FinancialRoutingNumber
            Public Overridable Property FinancialAccount As FinancialAccount
            Public Overridable Property SwiftCode As String
            Public Overridable Property ExportersCode As String
        End Class

        Public Partial Class FinancialRoutingNumber
            Public Overridable Property Number As String
            Public Overridable Property NumberTypeCode As String
        End Class

        <DataContract>
        Public Partial Class Header
            <DataMember(Name:="documentIdentification")>
            Public Overridable Property DocumentIdentification As DocumentIdentification

            <DataMember(Name:="sender")>
            Public Overridable Property Sender As Partner

            <DataMember(Name:="receiver")>
            Public Overridable Property Receiver As Partner
        End Class

        <DataContract>
        Public Partial Class Identifier
            <DataMember(Name:="authority")>
            Public Overridable Property Authority As String

            <DataMember(Name:="text")>
            Public Overridable Property Text As String
        End Class

        Public Partial Class Invoice
            Public Overridable Property CreationDate As Date?
            Public Overridable Property RevisionNumber As Long?
            Public Overridable Property EntityIdentification As String
        End Class

        Public Partial Class InvoiceAllowanceCharge
            Public Overridable Property AllowanceCharge As AllowanceCharge
            Public Overridable Property LeviedDutyFeeTax As TaxInformation
        End Class

        Public Partial Class InvoiceClass
            Inherits BaseDocument
            Public Overridable Property CountryOfSupplyOfGoods As String
            Public Overridable Property Buyer As TransactionalParty
            Public Overridable Property Seller As TransactionalParty
            Public Overridable Property Payee As TransactionalParty
            Public Overridable Property Payer As TransactionalParty
            Public Overridable Property ShipFrom As TransactionalParty
            Public Overridable Property ShipTo As TransactionalParty
            Public Overridable Property UltimateConsignee As TransactionalParty
            Public Overridable Property SupplierAccountReceivable As String
            Public Overridable Property InvoiceIdentification As String
            Public Overridable Property Invoice As Invoice
            Public Overridable Property SalesOrder As DocumentReference
            Public Overridable Property PurchaseOrder As DocumentReference
            Public Overridable Property DeliveryNote As DocumentReference
            Public Overridable Property TradeAgreement As DocumentReference
            Public Overridable Property ShipmentTransportationInformation As ShipmentTransportationInformation
            Public Overridable Property PaymentTerms As String
            Public Overridable Property InvoiceLineItem As List(Of InvoiceLineItem) = New List(Of InvoiceLineItem)
            Public Overridable Property InvoiceTotals As InvoiceTotals
        End Class

        Public Partial Class InvoiceLineItem
            Public Overridable Property LineNumber As Long?
            Public Overridable Property ParentLineItemNumber As String
            Public Overridable Property InvoicedQuantity As Quantity
            Public Overridable Property TransactionalTradeItem As TransactionalTradeItem
            Public Overridable Property ItemPriceBaseQuantity As Decimal?
            Public Overridable Property RetailPriceExcludingExcise As Decimal?
            Public Overridable Property RecommendedRetailPrice As Decimal?
            Public Overridable Property TaxInformation As TaxInformation
            Public Overridable Property AmountExclusiveAllowancesCharges As Decimal?
            Public Overridable Property AmountInclusiveAllowancesCharges As Decimal?
            Public Overridable Property ItemPriceExclusiveAllowancesCharges As Decimal?
            Public Overridable Property ItemPriceInclusiveAllowancesCharges As Decimal?
            Public Overridable Property TradeAgreement As String
            Public Overridable Property DeliveryNote As String
            Public Overridable Property PromotionalDeal As DocumentReference
            Public Overridable Property InvoiceAllowanceCharge As List(Of InvoiceAllowanceCharge) = New List(Of InvoiceAllowanceCharge)
            Public Overridable Property ExtendedProperties As Extension
        End Class

        Public Partial Class InvoiceMessage
            Public Overridable Property Header As Header
            Public Overridable Property Invoice As InvoiceClass
        End Class

        Public Partial Class InvoiceTotals
            Public Overridable Property BaseAmount As Decimal?
            Public Overridable Property PrepaidAmount As Decimal?
            Public Overridable Property PrepaidAmountDate As Date?
            Public Overridable Property TotalAmountInvoiceAllowancesCharges As Decimal?
            Public Overridable Property TotalLineAmountInclusiveAllowancesCharges As Decimal?
            Public Overridable Property TotalTaxAmount As Decimal?
            Public Overridable Property TotalInvoiceAmount As Decimal?
            Public Overridable Property TotalInvoiceAmountPayable As Decimal?
        End Class

        <DataContract>
        Public Partial Class Partner
            <DataMember(Name:="identifier")>
            Public Overridable Property Identifier As Identifier

            <DataMember(Name:="contactInformation")>
            Public Overridable Property ContactInformation As List(Of ContactInformation) = New List(Of ContactInformation)
        End Class

        Public Partial Class Quantity
            Public Overridable Property Value As Decimal?
            Public Overridable Property MeasurementUnitCode As String
            Public Overridable Property CodeListVersion As String
        End Class

        Public Partial Class SerialNumberRange
            Public Overridable Property MaximumValue As String
            Public Overridable Property MinimumValue As String
        End Class

        Public Partial Class ShipmentTransportationInformation
            Public Overridable Property Carrier As TransactionalParty
            Public Overridable Property FreightForwarder As TransactionalParty
        End Class

        Public Partial Class Size
            Public Overridable Property DescriptiveSize As String
            Public Overridable Property SizeCode As String
        End Class

        Public Partial Class TaxInformation
            Public Overridable Property TaxPercentage As Decimal?
            Public Overridable Property TaxAmount As Decimal?
        End Class

        Public Partial Class TradeItemClassification
            Public Overridable Property GpcCategoryCode As String
            Public Overridable Property AdditionalTradeItemClassificationCode As List(Of AvpList) = New List(Of AvpList)
            Public Overridable Property GpcCategoryName As String
            Public Overridable Property GpcAttribute As List(Of AvpList) = New List(Of AvpList)
        End Class

        Public Partial Class TradeItemWaste
            Public Overridable Property WasteIdentification As String
            Public Overridable Property TypeOfWaste As List(Of AvpList) = New List(Of AvpList)
        End Class

        Public Partial Class TransactionalItem
            Public Overridable Property MeasurementUnitCode As String
            Public Overridable Property MeasurementType As String
            Public Overridable Property MeasurementValue As String
        End Class

        Public Partial Class TransactionalItemData
            Public Overridable Property AvailableForSaleDate As Date?
            Public Overridable Property BatchNumber As String
            Public Overridable Property BestBeforeDate As Date?
            Public Overridable Property CountryOfOrigin As String
            Public Overridable Property ItemExpirationDate As Date?
            Public Overridable Property LotNumber As String
            Public Overridable Property PackagingDate As Date?
            Public Overridable Property ProductionDate As Date?
            Public Overridable Property ProductQualityIndication As String
            Public Overridable Property SellByDate As Date?
            Public Overridable Property SerialNumber As List(Of String) = New List(Of String)
            Public Overridable Property ShelfLife As String
            Public Overridable Property TradeItemQuantity As Long?
            Public Overridable Property ItemInContactWithFoodProduct As Boolean?
            Public Overridable Property TransactionalItemWeight As List(Of TransactionalItem) = New List(Of TransactionalItem)
            Public Overridable Property TransactionalItemVolume As List(Of TransactionalItem) = New List(Of TransactionalItem)
            Public Overridable Property SerialNumberRange As List(Of SerialNumberRange) = New List(Of SerialNumberRange)
            Public Overridable Property TransactionalItemDimensions As List(Of TransactionalItemDimension) = New List(Of TransactionalItemDimension)
            Public Overridable Property TransactionalItemLogisticUnitInformation As TransactionalItemLogisticUnitInformation
            Public Overridable Property TransactionalItemDataCarrierAndIdentification As TransactionalItemDataCarrierAndIdentification
            Public Overridable Property TradeItemWaste As List(Of TradeItemWaste) = New List(Of TradeItemWaste)
            Public Overridable Property TransactionalItemOrganicInformation As TransactionalItemOrganicInformation
            Public Overridable Property AvpList As List(Of AvpList) = New List(Of AvpList)
        End Class

        Public Partial Class TransactionalItemDataCarrierAndIdentification
            Public Overridable Property Gs1TransactionalItemIdentificationKey As String
            Public Overridable Property DataCarrier As String
        End Class

        Public Partial Class TransactionalItemDimension
            Public Overridable Property MeasurementUnitCode As String
            Public Overridable Property Depth As String
            Public Overridable Property Height As String
            Public Overridable Property Width As String
        End Class

        Public Partial Class TransactionalItemLogisticUnitInformation
            Public Overridable Property NumberOfLayers As Long?
            Public Overridable Property NumberOfUnitsPerLayer As Long?
            Public Overridable Property NumberOfUnitsPerPallet As Long?
            Public Overridable Property PackagingTerms As String
            Public Overridable Property PackageTypeCode As String
            Public Overridable Property MaximumStackingFactor As Long?
            Public Overridable Property ReturnablePackageTransportCostPayment As String
            Public Overridable Property DimensionsOfLogisticUnit As List(Of TransactionalItemDimension) = New List(Of TransactionalItemDimension)
        End Class

        Public Partial Class TransactionalItemOrganicInformation
            Public Overridable Property IsTradeItemOrganic As Boolean?
            Public Overridable Property OrganicCertification As String
        End Class

        Public Partial Class TransactionalParty
            Inherits Ecom_PartyIdentificationType
            Public Overridable Property Contact As List(Of Contact) = New List(Of Contact)
            Public Overridable Property Address As Address
            Public Overridable Property CommunicationChannel As List(Of AvpList) = New List(Of AvpList)
            Public Overridable Property FinancialInstitutionInformation As FinancialInstitutionInformation
            Public Overridable Property DutyFeeTaxRegistration As String
            Public Overridable Property EntityIdentification As String
        End Class

        Public Partial Class TransactionalTradeItem
            Public Overridable Property Gtin As String
            Public Overridable Property AdditionalTradeItemIdentification As List(Of AvpList) = New List(Of AvpList)
            Public Overridable Property TradeItemQuantity As Decimal?
            Public Overridable Property TradeItemDescription As String
            Public Overridable Property ProductVariantIdentifier As String
            Public Overridable Property ItemTypeCode As String
            Public Overridable Property TradeItemDataOwner As String
            Public Overridable Property ButterFatReference As String
            Public Overridable Property TransactionalItemData As List(Of TransactionalItemData) = New List(Of TransactionalItemData)
            Public Overridable Property Colour As List(Of Colour) = New List(Of Colour)
            Public Overridable Property Size As Size
            Public Overridable Property TradeItemClassification As TradeItemClassification
            Public Overridable Property AvpList As List(Of AvpList) = New List(Of AvpList)
        End Class
    End Namespace
End Namespace