/* Options:
Date: 2026-02-14 10:16:45
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: GetInvoice.*
//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.*


/**
* Invoice
*/
@Route(Path="/invoice", Verbs="GET")
@Api(Description="Invoice")
@ApiResponse(Description="Invoice message", IsDefaultResponse=true, StatusCode=200)
// @ApiResponse(Description="No Content", ResponseType=IReturnVoid::class, StatusCode=204)
open class GetInvoice : IReturn<ResultItem<InvoiceMessage>>
{
    companion object { private val responseType = object : TypeToken<ResultItem<InvoiceMessage>>(){}.type }
    override fun getResponseType(): Any? = GetInvoice.responseType
}

open class ResultItem<T> : IDocument
{
    open var token:UUID? = null
    open var item:InvoiceMessage? = null
}

interface IDocument : IHaveToken
{
}

interface IHaveToken
{
    var token: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 InvoiceClass : BaseDocument()
{
    open var countryOfSupplyOfGoods:String? = null
    open var buyer:TransactionalParty? = null
    open var seller:TransactionalParty? = null
    open var payee:TransactionalParty? = null
    open var payer:TransactionalParty? = null
    open var shipFrom:TransactionalParty? = null
    open var shipTo:TransactionalParty? = null
    open var ultimateConsignee:TransactionalParty? = null
    open var supplierAccountReceivable:String? = null
    open var invoiceIdentification:String? = null
    open var invoice:Invoice? = null
    open var salesOrder:DocumentReference? = null
    open var purchaseOrder:DocumentReference? = null
    open var deliveryNote:DocumentReference? = null
    open var tradeAgreement:DocumentReference? = null
    open var shipmentTransportationInformation:ShipmentTransportationInformation? = null
    open var paymentTerms:String? = null
    open var invoiceLineItem:ArrayList<InvoiceLineItem> = ArrayList<InvoiceLineItem>()
    open var invoiceTotals:InvoiceTotals? = 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>()
}

@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 Invoice
{
    open var creationDate:Date? = null
    open var revisionNumber:Long? = null
    open var entityIdentification:String? = null
}

open class ShipmentTransportationInformation
{
    open var carrier:TransactionalParty? = null
    open var freightForwarder:TransactionalParty? = null
}

open class InvoiceLineItem
{
    open var lineNumber:Long? = null
    open var parentLineItemNumber:String? = null
    open var invoicedQuantity:Quantity? = null
    open var transactionalTradeItem:TransactionalTradeItem? = null
    open var itemPriceBaseQuantity:BigDecimal? = null
    open var retailPriceExcludingExcise:BigDecimal? = null
    open var recommendedRetailPrice:BigDecimal? = null
    open var taxInformation:TaxInformation? = null
    open var amountExclusiveAllowancesCharges:BigDecimal? = null
    open var amountInclusiveAllowancesCharges:BigDecimal? = null
    open var itemPriceExclusiveAllowancesCharges:BigDecimal? = null
    open var itemPriceInclusiveAllowancesCharges:BigDecimal? = null
    open var tradeAgreement:String? = null
    open var deliveryNote:String? = null
    open var promotionalDeal:DocumentReference? = null
    open var invoiceAllowanceCharge:ArrayList<InvoiceAllowanceCharge> = ArrayList<InvoiceAllowanceCharge>()
    open var extendedProperties:Extension? = null
}

open class InvoiceTotals
{
    open var baseAmount:BigDecimal? = null
    open var prepaidAmount:BigDecimal? = null
    open var prepaidAmountDate:Date? = null
    open var totalAmountInvoiceAllowancesCharges:BigDecimal? = null
    open var totalLineAmountInclusiveAllowancesCharges:BigDecimal? = null
    open var totalTaxAmount:BigDecimal? = null
    open var totalInvoiceAmount:BigDecimal? = null
    open var totalInvoiceAmountPayable:BigDecimal? = 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 AllowanceCharge
{
    open var allowanceChargeAmount:BigDecimal? = null
    open var allowanceChargePercentage:BigDecimal? = null
    open var allowanceChargeType:String? = null
    open var allowanceOrChargeType:String? = null
    open var amountPerUnit:BigDecimal? = null
    open var baseAmount:BigDecimal? = null
    open var baseNumberOfUnits:String? = null
    open var bracketIdentifier:String? = null
    open var effectiveDateType:Date? = null
    open var sequenceNumber:String? = null
    open var settlementType:String? = null
    open var specialServiceType:String? = null
    open var allowanceChargeDescription:String? = null
}

@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 TaxInformation
{
    open var taxPercentage:BigDecimal? = null
    open var taxAmount:BigDecimal? = null
}

open class InvoiceAllowanceCharge
{
    open var allowanceCharge:AllowanceCharge? = null
    open var leviedDutyFeeTax:TaxInformation? = null
}

open class Extension
{
}

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 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 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 InvoiceMessage
{
    open var header:Header? = null
    open var invoice:InvoiceClass? = null
}