/* Options:
Date: 2026-02-14 11:52:23
Version: 10.04
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://stf-api-uat.data-xchange.co.za

//Package: 
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
IncludeTypes: GetReceivingAdviceById.*
//ExcludeTypes: 
//InitializeCollections: False
//TreatTypesAsStrings: 
//DefaultImports: java.math.*,java.util.*,java.io.InputStream,net.servicestack.client.*,com.google.gson.annotations.*,com.google.gson.reflect.*
*/

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


/**
* Receiving Advice
*/
@Route(Path="/receivingAdvice/{Id}", Verbs="GET")
@Api(Description="Receiving Advice")
@ApiResponse(Description="ReceivingAdvice data", IsDefaultResponse=true, StatusCode=200)
// @ApiResponse(Description="No Content", ResponseType=IReturnVoid::class, StatusCode=204)
// @ApiResponse(Description="Specified argument was out of the range of valid values.", ResponseType=ArgumentOutOfRangeException::class, StatusCode=400)
open class GetReceivingAdviceById : IReturn<ReceivingAdviceMessage>, IGetDocumentById
{
    /**
    * ReceivingAdvice ID or Token
    */
    @ApiMember(Description="ReceivingAdvice ID or Token", ExcludeInSchema=true, ParameterType="path")
    open var id:UUID? = null
    companion object { private val responseType = ReceivingAdviceMessage::class.java }
    override fun getResponseType(): Any? = GetReceivingAdviceById.responseType
}

open class ReceivingAdviceMessage
{
    open var header:Header? = null
    open var receivingAdvice:ReceivingAdvice? = null
}

interface IGetDocumentById : ISingleEntityQuery
{
}

interface ISingleEntityQuery
{
    var id:UUID?
}

@DataContract
open class Header
{
    @DataMember(Name="documentIdentification")
    @SerializedName("documentIdentification")
    open var documentIdentification:DocumentIdentification? = null

    @DataMember(Name="sender")
    @SerializedName("sender")
    open var sender:Partner? = null

    @DataMember(Name="receiver")
    @SerializedName("receiver")
    open var receiver:Partner? = null
}

open class TransactionalParty : Ecom_PartyIdentificationType()
{
    open var contact:ArrayList<Contact> = ArrayList<Contact>()
    open var address:Address? = null
    open var communicationChannel:ArrayList<AvpList> = ArrayList<AvpList>()
    open var financialInstitutionInformation:FinancialInstitutionInformation? = null
    open var dutyFeeTaxRegistration:String? = null
    open var entityIdentification:String? = null
}

enum class DocumentAction
{
    Add,
    ChangeByRefresh,
    Delete,
    Rejected,
}

enum class DocumentStatus
{
    AdditionalTransmission,
    Copy,
    Original,
}

open class AvpList
{
    open var code:String? = null
    open var value:String? = null
}

open class BaseDocument
{
    open var currencyCode:String? = null
    open var creationDateTime:Date? = null
    open var documentActionCode:DocumentAction? = null
    open var documentStatusCode:DocumentStatus? = null
    open var documentStructureVersion:String? = null
    open var lastUpdateDateTime:Date? = null
    open var revisionNumber:Long? = null
    open var avpList:ArrayList<AvpList> = ArrayList<AvpList>()
}

open class ReceivingAdvice : BaseDocument()
{
    open var despatchAdviceDeliveryDateTime:Date? = null
    open var note:String? = null
    open var paymentDateTime:Date? = null
    open var receivingDateTime:Date? = null
    open var reportingCode:String? = null
    open var totalDepositAmount:BigDecimal? = null
    open var receivingAdviceTransportInformation:ReceivingAdviceTransportInformation? = null
    open var billOfLadingNumber:DocumentReference? = null
    open var buyer:TransactionalParty? = null
    open var carrier:TransactionalParty? = null
    open var consignmentIdentification:ConsignmentIdentification? = null
    open var deliveryNote:DocumentReference? = null
    open var despatchAdvice:String? = null
    open var inventoryLocation:TransactionalParty? = null
    open var purchaseOrder:DocumentReference? = null
    open var receiver:TransactionalParty? = null
    open var receivingAdviceIdentification:String? = null
    open var seller:TransactionalParty? = null
    open var shipFrom:TransactionalParty? = null
    open var shipmentIdentification:ConsignmentIdentification? = null
    open var shipper:TransactionalParty? = null
    open var shipTo:TransactionalParty? = null
    open var receivingAdviceLogisticUnit:ArrayList<ReceivingAdviceLogisticUnit> = ArrayList<ReceivingAdviceLogisticUnit>()
}

@DataContract
open class DocumentIdentification
{
    @DataMember(Name="identifier")
    @SerializedName("identifier")
    open var identifier:String? = null

    @DataMember(Name="type")
    @SerializedName("type")
    open var Type:String? = null

    @DataMember(Name="creationDateAndTime")
    @SerializedName("creationDateAndTime")
    open var creationDateAndTime:Date? = null
}

@DataContract
open class Partner
{
    @DataMember(Name="identifier")
    @SerializedName("identifier")
    open var identifier:Identifier? = null

    @DataMember(Name="contactInformation")
    @SerializedName("contactInformation")
    open var contactInformation:ArrayList<ContactInformation> = ArrayList<ContactInformation>()
}

open class DocumentReference
{
    open var creationDateTime:Date? = null
    open var revisionNumber:Long? = null
    open var lineItemNumber:Long? = null
    open var entityIdentification:String? = null
}

open class Contact
{
    open var contactTypeCode:String? = null
    open var personName:String? = null
    open var departmentName:String? = null
    open var jobTitle:String? = null
    open var responsibility:String? = null
    open var communicationChannel:ArrayList<CommunicationChannel> = ArrayList<CommunicationChannel>()
}

open class Address
{
    open var streetAddressOne:String? = null
    open var streetAddressTwo:String? = null
    open var streetAddressThree:String? = null
    open var city:String? = null
    open var postalCode:String? = null
    open var provinceCode:String? = null
    open var countryCode:String? = null
}

open class FinancialInstitutionInformation
{
    open var financialInstitutionBranchName:String? = null
    open var financialInstitutionName:String? = null
    open var financialRoutingNumber:FinancialRoutingNumber? = null
    open var financialAccount:FinancialAccount? = null
    open var swiftCode:String? = null
    open var exportersCode:String? = null
}

open class Ecom_PartyIdentificationType
{
    open var gln:String? = null
    open var name:String? = null
    open var additionalPartyIdentification:ArrayList<AvpList> = ArrayList<AvpList>()
}

open class ReceivingAdviceTransportInformation
{
    open var routeID:Identifier? = null
    open var transportMeansID:Identifier? = null
    open var transportMeansName:String? = null
    open var driver:Contact? = null
    open var driverID:Person? = null
    open var receiver:Contact? = null
    open var receiverID:Person? = null
}

open class ConsignmentIdentification
{
    open var ginc:String? = null
    open var additionalConsignmentIdentification:AdditionalConsignmentIdentification? = null
}

open class ReceivingAdviceLogisticUnit : LogisticUnits()
{
    open var receivingAdviceLineItem:ArrayList<ReceivingAdviceLineItem> = ArrayList<ReceivingAdviceLineItem>()
}

@DataContract
open class Identifier
{
    @DataMember(Name="authority")
    @SerializedName("authority")
    open var authority:String? = null

    @DataMember(Name="text")
    @SerializedName("text")
    open var text:String? = null
}

@DataContract
open class ContactInformation
{
}

open class Quantity
{
    open var value:BigDecimal? = null
    open var measurementUnitCode:String? = null
    open var codeListVersion:String? = null
}

open class TransactionalTradeItem
{
    open var gtin:String? = null
    open var additionalTradeItemIdentification:ArrayList<AvpList> = ArrayList<AvpList>()
    open var tradeItemQuantity:BigDecimal? = null
    open var tradeItemDescription:String? = null
    open var productVariantIdentifier:String? = null
    open var itemTypeCode:String? = null
    open var tradeItemDataOwner:String? = null
    open var butterFatReference:String? = null
    open var transactionalItemData:ArrayList<TransactionalItemData> = ArrayList<TransactionalItemData>()
    open var colour:ArrayList<Colour> = ArrayList<Colour>()
    open var size:Size? = null
    open var tradeItemClassification:TradeItemClassification? = null
    open var avpList:ArrayList<AvpList> = ArrayList<AvpList>()
}

open class CommunicationChannel
{
    open var communicationChannelCode:String? = null
    open var communicationChannelName:String? = null
    open var communicationValue:String? = null
}

open class FinancialRoutingNumber
{
    open var number:String? = null
    open var numberTypeCode:String? = null
}

open class FinancialAccount
{
    open var number:String? = null
    open var numberTypeCode:String? = null
    open var name:String? = null
}

open class Person
{
    open var dateOfBirth:Date? = null
    open var gender:String? = null
    open var nationality:String? = null
    open var personName:String? = null
    open var identityDocument:ArrayList<IdentityDocument> = ArrayList<IdentityDocument>()
}

open class AdditionalConsignmentIdentification
{
    open var text:String? = null
    open var additionalConsignmentIdentificationTypeCode:String? = null
}

open class ReceivingAdviceLineItem
{
    open var extension:String? = null
    open var lineItemNumber:Long? = null
    open var note:String? = null
    open var parentLineItemNumber:Long? = null
    open var quantityAccepted:Quantity? = null
    open var quantityDespatched:Quantity? = null
    open var quantityReceived:Quantity? = null
    open var receivingConditionInformation:ArrayList<ReceivingConditionInformation> = ArrayList<ReceivingConditionInformation>()
    open var transactionalTradeItem:TransactionalTradeItem? = null
    open var consignmentIdentification:ConsignmentIdentification? = null
    open var avpList:AvpList? = null
    open var contract:DocumentReference? = null
    open var customerReference:DocumentReference? = null
    open var deliveryNote:DocumentReference? = null
    open var despatchAdvice:DocumentReference? = null
    open var productCertification:DocumentReference? = null
    open var promotionalDeal:DocumentReference? = null
    open var purchaseConditions:DocumentReference? = null
    open var purchaseOrder:DocumentReference? = null
    open var requestedItemIdentification:TradeItemIdentification? = null
    open var specification:DocumentReference? = null
}

open class LogisticUnitMeasurement
{
    open var dimension:Dimension? = null
    open var unitMeasurement:UnitMeasurement? = null
}

open class ReturnablePackaging
{
    open var currentHolderRegistration:Identifier? = null
    open var newHolderRegistration:Identifier? = null
    open var packagingConditionCode:String? = null
    open var packagingQuantity:Long? = null
    open var individualReturnableAssetIdentification:ArrayList<ReturnableAssetIdentification> = ArrayList<ReturnableAssetIdentification>()
    open var returnableAssetIdentification:ReturnableAssetIdentification? = null
}

open class CarrierTrackAndTraceInformation
{
    open var carrierTrackAndTraceURL:String? = null
    open var packageTrackingNumber:String? = null
}

open class Ecom_IndividualAssetIdentification
{
    open var additionalIndividualAssetIdentification:ArrayList<AdditionalIndividualAssetIdentification> = ArrayList<AdditionalIndividualAssetIdentification>()
    open var giai:String? = null
}

open class Ecom_LogisticUnitIdentification
{
    open var additionalLogisiticUnitIdentification:ArrayList<AdditionalLogisticUnitIdentification> = ArrayList<AdditionalLogisticUnitIdentification>()
    open var sscc:String? = null
}

open class LogisticUnits
{
    open var childPackageTypeCode:String? = null
    open var levelIdentification:Long? = null
    open var packageTypeCode:String? = null
    open var parentLevelIdentification:Long? = null
    open var quantityOfChildren:Long? = null
    open var quantityOfLogisticUnits:Long? = null
    open var logisticUnitMeasurement:LogisticUnitMeasurement? = null
    open var returnablePackaging:ArrayList<ReturnablePackaging> = ArrayList<ReturnablePackaging>()
    open var carrierTrackAndTraceInformation:CarrierTrackAndTraceInformation? = null
    open var avpList:AvpList? = null
    open var individualAssetIdentification:ArrayList<Ecom_IndividualAssetIdentification> = ArrayList<Ecom_IndividualAssetIdentification>()
    open var logisticUnitIdentification:Ecom_LogisticUnitIdentification? = null
}

open class TransactionalItemData
{
    open var availableForSaleDate:Date? = null
    open var batchNumber:String? = null
    open var bestBeforeDate:Date? = null
    open var countryOfOrigin:String? = null
    open var itemExpirationDate:Date? = null
    open var lotNumber:String? = null
    open var packagingDate:Date? = null
    open var productionDate:Date? = null
    open var productQualityIndication:String? = null
    open var sellByDate:Date? = null
    open var serialNumber:ArrayList<String> = ArrayList<String>()
    open var shelfLife:String? = null
    open var tradeItemQuantity:Long? = null
    open var itemInContactWithFoodProduct:Boolean? = null
    open var transactionalItemWeight:ArrayList<TransactionalItem> = ArrayList<TransactionalItem>()
    open var transactionalItemVolume:ArrayList<TransactionalItem> = ArrayList<TransactionalItem>()
    open var serialNumberRange:ArrayList<SerialNumberRange> = ArrayList<SerialNumberRange>()
    open var transactionalItemDimensions:ArrayList<TransactionalItemDimension> = ArrayList<TransactionalItemDimension>()
    open var transactionalItemLogisticUnitInformation:TransactionalItemLogisticUnitInformation? = null
    open var transactionalItemDataCarrierAndIdentification:TransactionalItemDataCarrierAndIdentification? = null
    open var tradeItemWaste:ArrayList<TradeItemWaste> = ArrayList<TradeItemWaste>()
    open var transactionalItemOrganicInformation:TransactionalItemOrganicInformation? = null
    open var avpList:ArrayList<AvpList> = ArrayList<AvpList>()
}

open class Colour
{
    open var colourCode:String? = null
    open var colourDescription:String? = null
}

open class Size
{
    open var descriptiveSize:String? = null
    open var sizeCode:String? = null
}

open class TradeItemClassification
{
    open var gpcCategoryCode:String? = null
    open var additionalTradeItemClassificationCode:ArrayList<AvpList> = ArrayList<AvpList>()
    open var gpcCategoryName:String? = null
    open var gpcAttribute:ArrayList<AvpList> = ArrayList<AvpList>()
}

open class Measurement
{
    open var value:BigDecimal? = null
    open var codeListVersion:String? = null
    open var measurementUnitCode:String? = null
}

open class Dimension
{
    open var depth:Measurement? = null
    open var height:Measurement? = null
    open var width:Measurement? = null
}

open class IdentityDocument
{
    open var identityDocumentIssuer:String? = null
    open var identityDocumentNumber:String? = null
    open var identityDocumentType:String? = null
}

open class ReceivingConditionInformation
{
    open var receivedGoodsDisposition:String? = null
    open var receivingConditionCode:String? = null
    open var receivingConditionQuantity:Quantity? = null
}

open class TradeItemIdentification
{
    open var additionalTradeItemIdentification:ArrayList<AvpList> = ArrayList<AvpList>()
    open var gtin:String? = null
}

open class UnitMeasurement
{
    open var measurementType:String? = null
    open var measurementValue:Measurement? = null
}

open class ReturnableAssetIdentification
{
    open var additionalReturnableAssetIdentification:ArrayList<AdditionalReturnableAssetIdentification> = ArrayList<AdditionalReturnableAssetIdentification>()
    open var grai:String? = null
}

open class AdditionalIndividualAssetIdentification
{
    open var value:BigDecimal? = null
    open var additionalIndividualAssetIdentificationTypeCode:String? = null
}

open class AdditionalLogisticUnitIdentification
{
    open var value:BigDecimal? = null
    open var additionalLogisticUnitIdentificationTypeCode:String? = null
}

open class TransactionalItem
{
    open var measurementUnitCode:String? = null
    open var measurementType:String? = null
    open var measurementValue:String? = null
}

open class SerialNumberRange
{
    open var maximumValue:String? = null
    open var minimumValue:String? = null
}

open class TransactionalItemDimension
{
    open var measurementUnitCode:String? = null
    open var depth:String? = null
    open var height:String? = null
    open var width:String? = null
}

open class TransactionalItemLogisticUnitInformation
{
    open var numberOfLayers:Long? = null
    open var numberOfUnitsPerLayer:Long? = null
    open var numberOfUnitsPerPallet:Long? = null
    open var packagingTerms:String? = null
    open var packageTypeCode:String? = null
    open var maximumStackingFactor:Long? = null
    open var returnablePackageTransportCostPayment:String? = null
    open var dimensionsOfLogisticUnit:ArrayList<TransactionalItemDimension> = ArrayList<TransactionalItemDimension>()
}

open class TransactionalItemDataCarrierAndIdentification
{
    open var gs1TransactionalItemIdentificationKey:String? = null
    open var dataCarrier:String? = null
}

open class TradeItemWaste
{
    open var wasteIdentification:String? = null
    open var typeOfWaste:ArrayList<AvpList> = ArrayList<AvpList>()
}

open class TransactionalItemOrganicInformation
{
    open var isTradeItemOrganic:Boolean? = null
    open var organicCertification:String? = null
}

open class AdditionalReturnableAssetIdentification
{
    open var value:String? = null
    open var additionalReturnableAssetIdentificationTypeCode:String? = null
}