/* Options:
Date: 2026-06-20 21:31:54
Version: 8.80
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://api.simplified.id/v2

//Package: 
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
IncludeTypes: GetCompanyLookup.*
//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.*


@Route(Path="/companylookups/get", Verbs="POST")
@DataContract
open class GetCompanyLookup : BaseRequest(), IReturn<GetCompanyLookupResponse>
{
    @DataMember
    open var request:GetCompanyLookupRequest? = null
    companion object { private val responseType = GetCompanyLookupResponse::class.java }
    override fun getResponseType(): Any? = GetCompanyLookup.responseType
}

@DataContract
open class GetCompanyLookupResponse
{
    @DataMember
    @SerializedName("data") open var Data:GetCompanyLookupData? = null
}

@DataContract
open class Authentication
{
    /**
    * The API User ID provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-User)
    */
    @DataMember
    @ApiMember(Description="The API User ID provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-User)", IsRequired=true, ParameterType="header, body")
    open var apiUserId:String? = null

    /**
    * The API User Key provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-Key)
    */
    @DataMember
    @ApiMember(Description="The API User Key provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-Key)", IsRequired=true, ParameterType="header, body")
    open var apiUserKey:String? = null

    /**
    * The User ID of the user making the request (e.g. a sub user). This is optional but can be used to associate API requests with a specific user, thereby allowing user permissions to be enforced. Can be provided in the body, or as a header parameter (X-User-Id).
    */
    @DataMember
    @ApiMember(Description="The User ID of the user making the request (e.g. a sub user). This is optional but can be used to associate API requests with a specific user, thereby allowing user permissions to be enforced. Can be provided in the body, or as a header parameter (X-User-Id).", ParameterType="header, body")
    open var userId:String? = null
}

@DataContract
open class BaseRequest : IBaseRequest
{
    /**
    * The authentication credentials
    */
    @DataMember
    @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
    override var authentication:Authentication? = null
}

interface IBaseRequest
{
    var authentication:Authentication?
}

open class GetCompanyLookupRequest
{
    /**
    * If the search is being accessed by a sub user, specify their username here to validate they have permissions to view it
    */
    @ApiMember(Description="If the search is being accessed by a sub user, specify their username here to validate they have permissions to view it")
    open var subUserName:String? = null

    open var id:Int? = null
}

open class GetCompanyLookupData : BaseResponse(), IBaseSearchResponse
{
    override var linkedTo:ArrayOfLinkedTo? = null
    open var searchRecord:CompanyLookupSearchRecord? = null
}

open class ArrayOfLists : ArrayList<String>()
{
}

open class ArrayOfLinkedTo : ArrayList<LinkedTo>()
{
}

open class BaseResponse : IBaseDataResponse, IHasResponseStatus
{
    /**
    * The status of the response
    */
    @ApiMember(Description="The status of the response")
    override var responseStatus:ResponseStatus? = null
}

interface IBaseDataResponse
{
    var responseStatus:ResponseStatus?
}

interface IHasResponseStatus
{
    var responseStatus:ResponseStatus?
}

interface IBaseSearchResponse : IBaseDataResponse
{
    var linkedTo:ArrayOfLinkedTo?
}

open class CompanyLookupSearchRecord
{
    open var id:Int? = null
    open var searchCriteria:SearchCriteria? = null
    open var selectedLists:ArrayOfLists? = null
    open var date:Date? = null
    open var hasCompanyId:Boolean? = null
    open var hasCompanyDetails:Boolean? = null
    open var hasStartedSearches:Boolean? = null
    open var hasCompletedSearches:Boolean? = null
    open var companyLookupType:String? = null
    open var isArchived:Boolean? = null
    open var companyChanges:ArrayOfCompanyChanges? = null
    open var companyDirectorsAndShareholders:ArrayList<CompanyDirectorOrShareholder>? = null
    open var companySearchRecord:SearchListItem? = null
    open var hasEnhancedInformation:Boolean? = null
    open var enhancedInformation:CompanyLookupEnhanced? = null
}

open class LinkedTo
{
    open var clientId:Int? = null
    open var id:Long? = null
    @SerializedName("type") open var Type:String? = null
    open var subtype:String? = null
    open var status:String? = null
    open var description:String? = null
    open var isArchived:Boolean? = null
    open var name:String? = null
    open var date:Date? = null
}

open class ArrayOfResponseError : ArrayList<ResponseError>()
{
}

open class SearchCriteria
{
    open var name:String? = null
    open var address:String? = null
    open var country:String? = null
    open var dateOfBirth:String? = null
    open var nationality:String? = null
    open var reference:String? = null
}

open class ArrayOfCompanyChanges : ArrayList<CompanyChange>()
{
}

open class CompanyDirectorOrShareholder
{
    open var id:Long? = null
    open var searchType:String? = null
    open var dateSearched:Date? = null
    open var dateUpdated:Date? = null
    open var numOfResults:Int? = null
    open var clientInResults:Boolean? = null
    open var clientNotInResults:Boolean? = null
    open var affectedByUpdate:Boolean? = null
    open var searchCriteria:SearchCriteria? = null
    open var isDirector:Boolean? = null
    open var isShareholder:Boolean? = null
}

open class SearchListItem
{
    open var id:Long? = null
    open var searchType:String? = null
    open var dateSearched:Date? = null
    open var dateUpdated:Date? = null
    open var dateArchived:Date? = null
    open var isArchived:Boolean? = null
    open var numOfResults:Int? = null
    open var clientInResults:Boolean? = null
    open var clientNotInResults:Boolean? = null
    open var affectedByUpdate:Boolean? = null
    open var searchCriteria:SearchCriteria? = null
    open var searchSources:ArrayList<SearchSource>? = null
}

open class CompanyLookupEnhanced
{
    open var summary:CompanyLookupEnhancedSummary? = null
    open var contactInformation:CompanyLookupEnhancedContactInfo? = null
    open var sicCodes:ArrayList<CompanyLookupEnhancedSicCode>? = null
    open var previousNames:ArrayList<CompanyLookupEnhancedPreviousName>? = null
    open var shareStructure:CompanyLookupEnhancedShareStructure? = null
    open var directors:CompanyLookupEnhancedDirectors? = null
    open var groupStructure:CompanyLookupEnhancedStructure? = null
    open var countyCourtJudgements:CompanyLookupEnhancedCCJs? = null
    open var eventHistory:ArrayList<CompanyLookupEnhancedEvent>? = null
    open var commentaries:ArrayList<CompanyLookupEnhancedCommentary>? = null
    open var creditAccounts:CompanyLookupEnhancedCreditAccount? = null
    open var financialStatements:ArrayList<CompanyLookupEnhancedFinancialStatement>? = null
}

open class SearchSource
{
    open var listId:String? = null
    open var listName:String? = null
    open var listShortName:String? = null
    open var isAffectedByListUpdate:Boolean? = null
}

open class CompanyChange
{
    open var dateOfChange:Date? = null
    open var changeEventType:String? = null
    open var isPending:Boolean? = null
    open var companyChangeData:ArrayOfCompanyChangeData? = null
}

open class CompanyLookupEnhancedSummary
{
    open var name:String? = null
    open var country:String? = null
    open var registrationNumber:String? = null
    open var dateOfIncorporation:String? = null
    open var typeOfIncorporation:String? = null
    open var companyStatus:String? = null
    open var address:String? = null
    open var telephone:String? = null
    open var sicCode:String? = null
    open var sicDescription:String? = null
    open var principleActivity:String? = null
    open var latestAccounts:CompanyLookupEnhancedLatestAccounts? = null
}

open class CompanyLookupEnhancedContactInfo
{
    open var registeredAddress:CompanyLookupEnhancedAddress? = null
    open var tradingAddresses:ArrayList<CompanyLookupEnhancedAddress>? = null
    open var websites:ArrayList<CompanyLookupEnhancedWebsite>? = null
    open var additionalContactInfo:CompanyLookupEnhancedAdditionalContact? = null
}

open class CompanyLookupEnhancedSicCode
{
    open var sicCode2003:Int? = null
    open var sicCode2003Description:String? = null
    open var sicCode2007:Int? = null
    open var sicCode2007Description:String? = null
    open var status:String? = null
}

open class CompanyLookupEnhancedPreviousName
{
    open var dateChanged:Date? = null
    open var name:String? = null
}

open class CompanyLookupEnhancedShareStructure
{
    open var issuedShareCapital:BigDecimal? = null
    open var shareholders:ArrayList<CompanyLookupEnhancedShareholder>? = null
}

open class CompanyLookupEnhancedDirectors
{
    open var currentDirectors:ArrayList<CompanyLookupEnhancedDirector>? = null
    open var previousDirectors:ArrayList<CompanyLookupEnhancedDirector>? = null
}

open class CompanyLookupEnhancedStructure
{
    open var parentCompanies:ArrayList<CompanyLookupEnhancedCompany>? = null
    open var subsidiaryCompanies:ArrayList<CompanyLookupEnhancedCompany>? = null
}

open class CompanyLookupEnhancedCCJs
{
    open var possibleCCJs:ArrayList<CompanyLookupEnhancedCCJ>? = null
    open var exactCCJs:ArrayList<CompanyLookupEnhancedCCJ>? = null
}

open class CompanyLookupEnhancedEvent
{
    open var date:Date? = null
    open var description:String? = null
}

open class CompanyLookupEnhancedCommentary
{
    open var text:String? = null
    open var positiveOrNegative:String? = null
    open var priority:Int? = null
}

open class CompanyLookupEnhancedCreditAccount
{
    open var creditLimitHistory:ArrayList<CompanyLookupEnhancedCreditLimit>? = null
    open var creditRatingHistory:ArrayList<CompanyLookupEnhancedCreditRating>? = null
}

open class CompanyLookupEnhancedFinancialStatement
{
    open var yearEndDateOrder:Int? = null
    open var yearEndDate:Date? = null
    open var summaryNumberOfWeeks:Int? = null
    open var summaryCurrency:String? = null
    open var summaryConsolidatedAccount:String? = null
    open var profitAndLoss:CompanyLookupFinancialProfit? = null
    open var balanceSheet:CompanyLookupFinancialBalance? = null
    open var capitalAndReserves:CompanyLookupFinancialCapital? = null
    open var other:CompanyLookupFinancialOther? = null
    open var cash:CompanyLookupFinancialCash? = null
    open var misc:CompanyLookupFinancialMisc? = null
    open var ratios:CompanyLookupFinancialRatios? = null
}

open class ArrayOfCompanyChangeData : ArrayList<CompanyChangeData>()
{
}

open class CompanyLookupEnhancedLatestAccounts
{
    open var currency:String? = null
    open var turnover:BigDecimal? = null
    open var shareholdersEquity:BigDecimal? = null
    open var creditRating:Int? = null
    open var creditLimit:Int? = null
    open var creditRatingDescription:String? = null
    open var accountRefDay:Int? = null
    open var accountRefMonth:Int? = null
    open var accountNextDueDate:Date? = null
    open var accountLastMadeUpDate:Date? = null
    open var accountCategory:String? = null
    open var returnLastMadeUpDate:Date? = null
}

open class CompanyLookupEnhancedAddress
{
    open var fullAddress:String? = null
    open var address1:String? = null
    open var address2:String? = null
    open var address3:String? = null
    open var address4:String? = null
    open var postCode:String? = null
    open var telephone:String? = null
}

open class CompanyLookupEnhancedWebsite
{
    open var website:String? = null
}

open class CompanyLookupEnhancedAdditionalContact
{
    open var telephone:String? = null
    open var faxNumber:String? = null
    open var emailAddress:String? = null
    open var webAddress:String? = null
    open var twitter:String? = null
    open var facebook:String? = null
    open var googlePlus:String? = null
    open var linkedIn:String? = null
    open var contactName:String? = null
    open var businessClassification:String? = null
}

open class CompanyLookupEnhancedShareholder
{
    open var title:String? = null
    open var forename:String? = null
    open var surname:String? = null
    open var address1:String? = null
    open var address2:String? = null
    open var address3:String? = null
    open var address4:String? = null
    open var address5:String? = null
    open var postCode:String? = null
    open var shareType:String? = null
    open var number:BigDecimal? = null
    open var value:BigDecimal? = null
    open var currency:String? = null
    open var shareholderType:String? = null
    open var shareClass:String? = null
}

open class CompanyLookupEnhancedDirector
{
    open var name:String? = null
    open var address:String? = null
    open var gender:String? = null
    open var appointmentDate:Date? = null
    open var resignationDate:Date? = null
    open var dateOfBirth:Date? = null
    open var position:String? = null
    open var idNumber:Int? = null
    open var currentDirectorships:Int? = null
    open var previousDirectorships:Int? = null
    open var totalDirectorships:Int? = null
}

open class CompanyLookupEnhancedCompany
{
    open var country:String? = null
    open var companyName:String? = null
    open var companyNumber:String? = null
}

open class CompanyLookupEnhancedCCJ
{
    open var date:Date? = null
    open var court:String? = null
    open var amount:BigDecimal? = null
    open var caseNumber:String? = null
    open var status:String? = null
    open var datePaid:String? = null
    open var incomingRecordDetails:String? = null
}

open class CompanyLookupEnhancedCreditLimit
{
    open var date:Date? = null
    open var dateOrder:Int? = null
    open var amount:Int? = null
}

open class CompanyLookupEnhancedCreditRating
{
    open var date:Date? = null
    open var dateOrder:Int? = null
    open var amount:Int? = null
    open var shortDescription:String? = null
    open var description:String? = null
}

open class CompanyLookupFinancialProfit
{
    open var turnover:BigDecimal? = null
    open var export:BigDecimal? = null
    open var costOfSales:BigDecimal? = null
    open var grossProfit:BigDecimal? = null
    open var wagesAndSalaries:BigDecimal? = null
    open var directorEmolument:BigDecimal? = null
    open var operatingProfit:BigDecimal? = null
    open var depreciation:BigDecimal? = null
    open var auditFees:BigDecimal? = null
    open var interestPayments:BigDecimal? = null
    open var pretaxProfit:BigDecimal? = null
    open var taxation:BigDecimal? = null
    open var profitAfterTax:BigDecimal? = null
    open var dividendsPayable:BigDecimal? = null
    open var retainedProfit:BigDecimal? = null
}

open class CompanyLookupFinancialBalance
{
    open var tangibleAccounts:BigDecimal? = null
    open var intangibleAssets:BigDecimal? = null
    open var totalFixedAssets:BigDecimal? = null
    open var stock:BigDecimal? = null
    open var tradeDebtors:BigDecimal? = null
    open var cash:BigDecimal? = null
    open var otherDebtors:BigDecimal? = null
    open var miscCurrentAssets:BigDecimal? = null
    open var totalCurrentAssets:BigDecimal? = null
    open var tradeCreditors:BigDecimal? = null
    open var bankLoansAndOverdrafts:BigDecimal? = null
    open var otherShortTermFinance:BigDecimal? = null
    open var miscCurrentLiabilities:BigDecimal? = null
    open var totalCurrentLiabilities:BigDecimal? = null
    open var bankLoansAndOverdraftsAndLTL:BigDecimal? = null
    open var otherLongTermFinance:BigDecimal? = null
    open var totalLongTermFinance:BigDecimal? = null
    open var totalLiabilities:BigDecimal? = null
    open var investmentAndOther:BigDecimal? = null
    open var investmentAndOtherAssets:BigDecimal? = null
    open var debtorsDueAfter1Year:BigDecimal? = null
    open var otherTangibleAssets:BigDecimal? = null
}

open class CompanyLookupFinancialCapital
{
    open var calledUpSharedCapital:BigDecimal? = null
    open var profitAndLossAccountReserve:BigDecimal? = null
    open var revaluationReserve:BigDecimal? = null
    open var sundryReserves:BigDecimal? = null
    open var shareholderFunds:BigDecimal? = null
}

open class CompanyLookupFinancialOther
{
    open var netWorth:BigDecimal? = null
    open var netAssets:BigDecimal? = null
    open var workingCapital:BigDecimal? = null
    open var totalAssets:BigDecimal? = null
    open var totalLiabilities:BigDecimal? = null
}

open class CompanyLookupFinancialCash
{
    open var netCashFlowFromOperations:BigDecimal? = null
    open var netCashFlowBeforeFinancing:BigDecimal? = null
    open var netCashFlowFromFinancing:BigDecimal? = null
    open var increaseInCash:BigDecimal? = null
}

open class CompanyLookupFinancialMisc
{
    open var contingentLiability:String? = null
    open var capitalEmployed:BigDecimal? = null
    open var numberOfEmployees:BigDecimal? = null
    open var auditors:String? = null
    open var auditorComments:String? = null
    open var bankers:String? = null
    open var bankBranchCode:String? = null
}

open class CompanyLookupFinancialRatios
{
    open var preTaxProfitMargin:BigDecimal? = null
    open var currentRatio:BigDecimal? = null
    open var salesNetworkingCapital:BigDecimal? = null
    open var gearing:BigDecimal? = null
    open var equity:BigDecimal? = null
    open var creditorDays:BigDecimal? = null
    open var debtorDays:BigDecimal? = null
    open var liquidityAcidTest:BigDecimal? = null
    open var returnOnCapitalEmployed:BigDecimal? = null
    open var returnOnNetAssetsEmployed:BigDecimal? = null
    open var returnOnTotalAssetsEmployed:BigDecimal? = null
    open var currentDebtRatio:BigDecimal? = null
    open var totalDebtRatio:BigDecimal? = null
    open var stockTurnoverRatio:BigDecimal? = null
}

open class CompanyChangeData
{
    open var name:String? = null
    open var previousValue:String? = null
    open var newValue:String? = null
}