Você está na página 1de 424

Avaloq Front Platform (AFP), Interface Specification

Release 2.4
Version 17-Nov-2016
AFP Interface Specification

Table of Content
1. Avaloq Web Services Description
1.1 NotificationEvent
1.1.1 processEvent
1.1.2 sendNotificationForEvent
1.2 AssetService
1.2.1 getAssetListings
1.2.2 resolveAssets
1.2.3 resolveAsset
1.2.4 findTradableAssets
1.2.5 getAssetTypes
1.3 Notification
1.3.1 sendNotificationEmail
1.3.2 sendNotificationSms
1.4 LookupCRM
1.4.1 lookupPersonCRM
1.4.2 lookupBusinessPartnerCRM
1.4.3 lookupContainerCRM
1.4.4 lookupIpsCRM
1.4.5 getPersonTypeJobId
1.4.6 getExportTableRoleId
1.4.7 getExportTableBpPersonRelationTypeId
1.4.8 getExportTableAdvisoryTypeContainerClassId
1.4.9 getExportTableMandateIpsClassId
1.4.10 getExportTableBranchBpClassId
1.4.11 getStrategyCollectionClassId
1.5 ClientAdvisor
1.5.1 getClientAdvisorList
1.6 AdvisoryCollection
1.6.1 saveOrUpdateAdvisoryCollection
1.6.2 deleteCollection
1.7 AcpSessionManager
1.7.1 openSession
1.7.2 closeSession
1.7.3 heartbeat
1.8 Lookup
1.8.1 lookupBusinessPartner
1.8.2 lookupContainer
1.8.3 lookupIps
1.8.4 lookupPerson
1.8.5 lookupCountry
1.8.6 lookupCurrency
1.8.7 lookupAssetAllocation
1.8.8 lookupModelPortfolio
1.8.9 lookupBenchmark
1.8.10 lookupEfficientFrontier
1.8.11 lookupCollection
1.8.12 lookupRestriction
1.8.13 lookupOrganisationalEntity
1.8.14 lookupCode
1.8.15 lookupCard
1.8.16 lookupAddress
1.8.17 lookupMoneyAccount
1.8.18 lookupPosition
1.8.19 lookupAsset
1.8.20 lookupChequeBookProfile
1.8.21 lookupDirectDebit

Copyright 201, Avaloq Evolution AG Page 2 of 424


AFP Interface Specification

1.8.22 lookupDocument
1.8.23 lookupQuestionnaire
1.8.24 lookupFinancing
1.8.25 lookupSafeDepositBoxContract
1.8.26 lookupGenericObject
1.8.27 lookupBusinessOrder
1.9 ObjectExtension
1.9.1 getObjectKeys
1.9.2 getObjectClasses
1.9.3 getObjectsByKeys
1.10 SensitiveDataSeparation
1.10.1 encodeStringValue
1.10.2 encodeDateValue
1.10.3 encodeBinaryTextValue
1.10.4 encodeValueList
1.10.5 resolveDateKey
1.10.6 resolveStringKey
1.10.7 resolveBinaryTextKey
1.10.8 resolveKeyList
1.10.9 resolveBinaryKeyList
1.10.1 resolveText
1.10.1 resolveBinaryText
1.10.1 resolveTextList
1.10.1 resolveFile
1.10.1 encodeText
1.10.1 parseDateValue
1.10.1 getPersonId
1.10.1 lookupObjects
1.11 Booking
1.11.1 getBookingList
1.11.2 getBookingPaymentList
1.12 InvestmentProposition
1.12.1 getInvestmentPropositionList
1.12.2 getInvestmentProposition
1.12.3 editInvestmentProposition
1.12.4 newInvestmentProposition
1.12.5 modifyInvestmentPropositionBasicData
1.12.6 addInvestmentPropositionPosition
1.12.7 modifyInvestmentPropositionPosition
1.12.8 optimizeInvestmentProposition
1.12.9 executeInvestmentPropositionWorkflowAction
1.12.1 addInvestmentPropositionCash
1.12.1 modifyInvestmentPropositionCash
1.12.1 getInvestmentPropositionRiskAnalytics
1.12.1 modifyInvestorProtectionDiscussedPosition
1.12.1 addInvestmentPropositionPostIt
1.12.1 setAdvisorySituation
1.13 SingleTradingOrderView
1.13.1 getOverviewItems
1.13.2 getOrderDetails
1.14 CrmIssue
1.14.1 getBBSCrmIssue
1.14.2 createBBSCrmIssue
1.14.3 modifyBBSCrmIssue
1.15 InvestmentPolicyStatement
1.15.1 getInvestmentPolicyStatementOrderList
1.15.2 getInvestmentPolicyStatementOrder
1.15.3 editInvestmentPolicyStatementOrder
Copyright 201, Avaloq Evolution AG Page 3 of 424
AFP Interface Specification

1.15.4 newInvestmentPolicyStatement
1.15.5 modifyInvestmentPolicyStatement
1.15.6 modifyInvestmentPolicyStatementBasicData
1.15.7 executeInvestmentPolicyStatementWorkflowAction
1.15.8 addInvestmentPolicyStatementAssetAllocationLink
1.15.9 modifyInvestmentPolicyStatementAssetAllocationLink
1.15.1 removeInvestmentPolicyStatementAssetAllocationLink
1.15.1 setInvestmentPolicyStatementAssetAllocationLinkOverrideList
1.15.1 addInvestmentPolicyStatementRestrictionLink
1.15.1 modifyInvestmentPolicyStatementRestrictionLink
1.15.1 removeInvestmentPolicyStatementRestrictionLink
1.15.1 addInvestmentPolicyStatementRestrictionAcknowledgement
1.15.1 modifyInvestmentPolicyStatementRestrictionAcknowledgement
1.15.1 removeInvestmentPolicyStatementRestrictionAcknowledgement
1.15.1 addInvestmentPolicyStatementAssetAcknowledgement
1.15.1 modifyInvestmentPolicyStatementAssetAcknowledgement
1.15.2 removeInvestmentPolicyStatementAssetAcknowledgement
1.15.2 addInvestmentPolicyStatementContainerLink
1.15.2 modifyInvestmentPolicyStatementContainerLink
1.15.2 removeInvestmentPolicyStatementContainerLink
1.15.2 getEfficientFrontierAnalytics
1.15.2 getStrategicAssetAllocationAnalytics
1.16 BaseBankData
1.16.1 getCurrencyList
1.16.2 getBusinessUnitDefaultCurrency
1.16.3 getBusinessUnitBankDate
1.16.4 getBusinessUnitHolidayList
1.16.5 getCountryList
1.16.6 getCommonCountryList
1.16.7 getBusinessUnitCountry
1.16.8 getCurrencyById
1.16.9 getCurrencyConversion
1.17 AttentionItemCounter
1.17.1 retrieveCounters
1.18 AppointmentService
1.18.1 createAppointment
1.18.2 modifyAppointment
1.18.3 getAppointment
1.19 ClientData
1.19.1 getPortfolioList
1.19.2 getIpsList
1.19.3 getBusinessPartnerList
1.19.4 getBusinessPartnerAddressList
1.20 Position
1.20.1 getPositionList
1.21 AssetAllocation
1.21.1 getAssetAllocationTreeList
1.21.2 getAssetAllocationNodeMappingList
1.22 UserManagementService
1.22.1 createUser
1.22.2 updateUser
1.23 PaymentOverview
1.23.1 getPaymentOrderOverviewList
1.23.2 getPaymentOrder
1.23.3 getPaymentCordOrder
1.24 ServerInfo
1.24.1 getServerInfo
1.24.2 isAcpAvailable
Copyright 201, Avaloq Evolution AG Page 4 of 424
AFP Interface Specification

1.25 Signature
1.25.1 uploadSignature
1.25.2 downloadSignature
1.25.3 deleteSignature
1.26 NotificationSubscription
1.26.1 createNotificationSubscription
1.26.2 updateNotificationSubscription
1.26.3 deleteNotificationSubscription
1.26.4 getNotificationSubscriptionList
1.26.5 getPresentationData
1.26.6 getDeliveryChannelList
1.27 Collaboration
1.27.1 getCollaborationIssueMetaData
1.27.2 createCollaborationIssue
1.27.3 getCollaborationIssueList
1.27.4 addComment
1.27.5 closeCollaborationIssues
1.27.6 getCollaborationIssueAttachment
1.27.7 addCollaborationIssueAttachment
1.27.8 getUnreadIssuesCount
1.27.9 getNotificationEventType
1.28 Performance
1.28.1 getBusinessObjectsPerformance
1.28.2 getBusinessObjectsHistoricalPerformance
1.29 TaskService
1.29.1 createTask
1.29.2 modifyTask
1.29.3 getTask
1.30 UserInfo
1.30.1 getUser
1.30.2 getContactInformationList
1.30.3 getFunctionalAccessCodeList
2. Avaloq Web Parameter Description
2.1 com.avaloq.afs.server.bsp.ws.to.advisorycollection
2.1.0 AdvisoryOutputTO
2.1.1 AdvisoryCollectionTO
2.1.2 AdvisoryCollectionOutputTO
2.2 com.avaloq.afs.server.bsp.ws.to.afscollection
2.2.0 CollectionListOutputTO
2.2.1 CollectionTO
2.3 com.avaloq.afs.server.bsp.ws.to.asset
2.3.0 AssetListItemTO
2.3.1 AssetTypeListOutputTO
2.3.2 AssetSearchQueryTO
2.3.3 ListingTO
2.3.4 SimpleListingTO
2.3.5 AssetParametersTO
2.3.6 ListingListOutputTO
2.3.7 AssetListOutputTO
2.3.8 AssetTO
2.3.9 AssetListItemOutputTO
2.3.10 AssetOutputTO
2.3.11 DocumentInfoTO
2.4 com.avaloq.afs.server.bsp.ws.to.assetallocation
2.4.0 AssetAllocationTreeQueryTO
2.4.1 AssetAllocationNodeMappingEntryTO
2.4.2 AssetAllocationNodeMappingListOutputTO
2.4.3 AssetAllocationNodeMappingParametersTO
Copyright 201, Avaloq Evolution AG Page 5 of 424
AFP Interface Specification

2.4.4 AssetAllocationNodeMappingTO
2.4.5 AssetAllocationNodeTO
2.4.6 AssetAllocationTreeListOutputTO
2.4.7 AssetAllocationTreeTO
2.4.8 AssetAllocationNodeMappingQueryTO
2.5 com.avaloq.afs.server.bsp.ws.to.attentionitemcounter
2.5.0 AttentionItemCounterQueryTO
2.5.1 AttentionItemCounterResultTO
2.5.2 AttentionItemCounterOutputTO
2.6 com.avaloq.afs.server.bsp.ws.to.basebankdata
2.6.0 BusinessPartnerListOutputTO
2.6.1 AddressListOutputTO
2.6.2 CurrencyConversionParametersTO
2.6.3 HolidayListOutputTO
2.6.4 AddressTO
2.6.5 BankingObjectListOutputTO
2.6.6 BusinessPartnerTO
2.6.7 PersonListOutputTO
2.7 com.avaloq.afs.server.bsp.ws.to.bbs.crm_issue
2.7.0 TaskOutputTO
2.7.1 AppointmentOutputTO
2.7.2 CrmIssueBBSOutputTO
2.8 com.avaloq.afs.server.bsp.ws.to.booking
2.8.0 BookingPaymentCordOrderTO
2.8.1 BookingTradingOrderTO
2.8.2 BookingPaymentQueryTO
2.8.3 BookingListOutputTO
2.8.4 BookingTO
2.8.5 BookingPaymentListOutputTO
2.8.6 BookingQueryTO
2.8.7 BookingParametersTO
2.8.8 BookingPaymentOrderTO
2.8.9 BookingOrderDetailTO
2.9 com.avaloq.afs.server.bsp.ws.to.businessobject
2.9.0 SimpleBusinessObjectTO
2.10 com.avaloq.afs.server.bsp.ws.to.clientadvisor
2.10.0 ClientAdvisorTO
2.10.1 ClientAdvisorQueryTO
2.10.2 ClientAdvisorListOutputTO
2.11 com.avaloq.afs.server.bsp.ws.to.clientdata
2.11.0 IpsParametersTO
2.11.1 PortfolioTO
2.11.2 BusinessPartnerQueryTO
2.11.3 IpsQueryTO
2.11.4 PortfolioListOutputTO
2.11.5 BusinessPartnerAddressQueryTO
2.11.6 PortfolioQueryTO
2.11.7 PortfolioParametersTO
2.12 com.avaloq.afs.server.bsp.ws.to.code
2.12.0 SimpleClassTO
2.12.1 CodeOutputTO
2.12.2 CodeTO
2.12.3 SimpleCodeTO
2.12.4 CodeListOutputTO
2.13 com.avaloq.afs.server.bsp.ws.to.code.notification
2.13.0 NotificationDeliveryChannelCodeTO
2.13.1 NotificationEventTypeCodeTO
2.13.2 NotificationTriggerCodeTO
Copyright 201, Avaloq Evolution AG Page 6 of 424
AFP Interface Specification

2.14 com.avaloq.afs.server.bsp.ws.to.collaboration
2.14.0 CollaborationIssueQueryTO
2.14.1 CollaborationIssueOutputTO
2.14.2 CollaborationIssueCommentTO
2.14.3 CollaborationIssueMetaDataOutputTO
2.14.4 CollaborationParametersTO
2.14.5 CollaborationIssueTO
2.14.6 CollaborationIssueListOutputTO
2.14.7 CollaborationIssueCreationTO
2.15 com.avaloq.afs.server.bsp.ws.to.dms
2.15.0 DocumentMetaDataTO
2.15.1 DocumentKeyOutputTO
2.15.2 DocumentInputTO
2.15.3 DocumentOutputTO
2.16 com.avaloq.afs.server.bsp.ws.to.extension
2.16.0 ObjectExtensionQueryTO
2.16.1 ObjectClassExtensionTO
2.16.2 ObjectClassExtensionListOutputTO
2.16.3 KeyExtensionValueTO
2.16.4 ObjectClassExtensionEntryTO
2.16.5 KeyExtensionQueryTO
2.16.6 ObjectKeyExtensionTO
2.16.7 ClassExtensionValueTO
2.16.8 ObjectKeyExtensionListOutputTO
2.16.9 ObjectKeyExtensionQueryTO
2.16.1 ObjectClassExtensionQueryTO
2.16.1 ObjectKeyExtensionEntryTO
2.16.1 KeyExtensionKeyTypeTO
2.16.1 ObjectExtensionTO
2.17 com.avaloq.afs.server.bsp.ws.to.impl
2.17.0 EditableCodeTO
2.17.1 EditableDateTO
2.17.2 ObjTO
2.17.3 PagingResultTO
2.17.4 OutputTO
2.17.5 IdOutputTO
2.17.6 LongOutputTO
2.17.7 NotificationTO
2.17.8 EditableBigDecimalTO
2.17.9 UserContextTO
2.17.1 ServerInfoTO
2.17.1 TransactionSigningRequestTO
2.17.1 DateOutputTO
2.17.1 EditableObjTO
2.17.1 AddOrderPostItTO
2.17.1 IdListOutputTO
2.17.1 ValidationOverrideTO
2.17.1 BaseBankingObjectTO
2.17.1 EditableStringTO
2.17.1 OrderPostItTO
2.17.2 QuerySortTO
2.17.2 PagingTO
2.17.2 ObjectAccessFilterTO
2.17.2 EditableBooleanTO
2.18 com.avaloq.afs.server.bsp.ws.to.investmentpolicystatement
2.18.0 ModifyInvestmentPolicyStatementAssetAcknowledgementTO
2.18.1 AddInvestmentPolicyStatementAssetAllocationLinkTO
2.18.2 ModifyInvestmentPolicyStatementContainerLinkTO
Copyright 201, Avaloq Evolution AG Page 7 of 424
AFP Interface Specification

2.18.3 InvestmentPolicyStatementRestrictionAcknowledgementTO
2.18.4 ModifyInvestmentPolicyStatementRestrictionAcknowledgementTO
2.18.5 InvestmentPolicyStatementAssetAllocationLinkIdentifierTO
2.18.6 InvestmentPolicyStatementAssetAcknowledgementTO
2.18.7 InvestmentPolicyStatementAssetAcknowledgementIdentifierTO
2.18.8 EfficientFrontierAnalyticsOutputTO
2.18.9 NewInvestmentPolicyStatementTO
2.18.1 ModifyInvestmentPolicyStatementRestrictionLinkTO
2.18.1 StrategicAssetAllocationAnalyticsQueryTO
2.18.1 AddInvestmentPolicyStatementRestrictionAcknowledgementTO
2.18.1 StrategicAssetAllocationAnalyticsOutputTO
2.18.1 InvestmentPolicyStatementContainerLinkIdentifierTO
2.18.1 AddInvestmentPolicyStatementContainerLinkTO
2.18.1 SetInvestmentPolicyStatementAssetAllocationLinkOverrideTO
2.18.1 InvestmentPolicyStatementAssetAllocationLinkPeriodOverrideTO
2.18.1 ModifyInvestmentPolicyStatementTO
2.18.1 InvestmentPolicyStatementAssetAllocationLinkTO
2.18.2 ModifyInvestmentPolicyStatementBasicDataTO
2.18.2 InvestmentPolicyStatementContainerLinkTO
2.18.2 InvestmentPolicyStatementAssetAllocationLinkOverrideTO
2.18.2 EfficientFrontierAnalyticsQueryTO
2.18.2 InvestmentPolicyStatementOrderQueryTO
2.18.2 InvestmentPolicyStatementRestrictionAcknowledgementIdentifierTO
2.18.2 InvestmentPolicyStatementRestrictionLinkTO
2.18.2 InvestmentPolicyStatementOrderOutputTO
2.18.2 ModifyInvestmentPolicyStatementAssetAllocationLinkTO
2.18.2 AddInvestmentPolicyStatementAssetAcknowledgementTO
2.18.3 InvestmentPolicyStatementAssetAllocationLinkOverrideResultTO
2.19 com.avaloq.afs.server.bsp.ws.to.investmentproposition
2.19.0 InvestmentPropositionForeignExchangeTradeTO
2.19.1 InvestmentPropositionRiskAnalyticsOutputTO
2.19.2 InvestmentPropositionPopulateInstructionTO
2.19.3 AddInvestmentPropositionPositionTO
2.19.4 InvestmentPropositionHobsNodeTO
2.19.5 InvestmentPropositionTradeTO
2.19.6 ModifyInvestmentPropositionBasicDataTO
2.19.7 InvestmentPropositionInvestmentAmountTO
2.19.8 InvestmentPropositionRestrictionViolationTO
2.19.9 InvestmentPropositionOptimizationInstructionTO
2.19.1 InvestmentPropositionPositionTO
2.19.1 InvestmentPropositionMoneyTransferTO
2.19.1 ModifyInvestorProtectionDiscussedPositionTO
2.19.1 InvestmentPropositionQueryTO
2.19.1 InvestmentPropositionPositionNodeTO
2.19.1 NewInvestmentPropositionTO
2.19.1 InvestmentPropositionRiskAnalyticsTO
2.19.1 InvestmentPropositionUnsupportedTradeTO
2.19.1 ModifyInvestmentPropositionPositionTO
2.19.1 ModifyInvestmentPropositionInvestmentAmountDetailTO
2.19.2 InvestmentPropositionOutputTO
2.19.2 InvestmentPropositionNodeTO
2.19.2 AddInvestmentPropositionInvestmentAmountTO
2.19.2 ModifyInvestmentPropositionInvestmentAmountTO
2.20 com.avaloq.afs.server.bsp.ws.to.investorprotection
2.20.0 InvestorProtectionTO
2.20.1 InvestorProtectionAdvisorySituationDetailTO
2.20.2 InvestorProtectionClientTO
2.20.3 InvestorProtectionAdvisorySituationTO
Copyright 201, Avaloq Evolution AG Page 8 of 424
AFP Interface Specification

2.20.4 InvestorProtectionPositionTO
2.21 com.avaloq.afs.server.bsp.ws.to.key
2.21.0 SimpleKeyTO
2.22 com.avaloq.afs.server.bsp.ws.to.lookup
2.22.0 LookupSearchCriteriaOrganisationalEntityTO
2.22.1 LookupAddressSearchCriteriaTO
2.22.2 LookupContainerCRMSearchCriteriaTO
2.22.3 LookupCurrencySearchCriteriaTO
2.22.4 LookupAssetSearchCriteriaTO
2.22.5 LookupSearchCriteriaCollectionTO
2.22.6 LookupPersonSearchCriteriaTO
2.22.7 LookupSafeDepositBoxContractSearchCriteriaTO
2.22.8 LookupPositionSearchCriteriaTO
2.22.9 LookupBenchmarkSearchCriteriaTO
2.22.1 LookupModelPortfolioSearchCriteriaTO
2.22.1 LookupRestrictionSearchCriteriaTO
2.22.1 LookupAssetAllocationSearchCriteriaTO
2.22.1 LookupIpsCRMSearchCriteriaTO
2.22.1 LookupDocumentSearchCriteriaTO
2.22.1 LookupQuestionnaireSearchCriteriaTO
2.22.1 LookupChequeBookProfileSearchCriteriaTO
2.22.1 LookupBusinessOrderSearchCriteriaTO
2.22.1 LookupCodeSearchCriteriaTO
2.22.1 LookupMoneyAccountSearchCriteriaTO
2.22.2 LookupIpsSearchCriteriaTO
2.22.2 LookupBusinessPartnerCRMSearchCriteriaTO
2.22.2 LookupSearchCriteriaKeyTO
2.22.2 LookupBusinessPartnerSearchCriteriaTO
2.22.2 LookupDirectDebitSearchCriteriaTO
2.22.2 LookupSearchCriteriaHistNameTO
2.22.2 LookupSearchCriteriaRelationTO
2.22.2 LookupOrganisationalEntitySearchCriteriaTO
2.22.2 LookupEfficientFrontierSearchCriteriaTO
2.22.2 LookupCardSearchCriteriaTO
2.22.3 LookupSearchCriteriaBpPersonRelationTypeTO
2.22.3 LookupSearchCriteriaClassifTO
2.22.3 LookupGenericObjectSearchCriteriaTO
2.22.3 LookupContainerSearchCriteriaTO
2.22.3 LookupPersonCRMSearchCriteriaTO
2.22.3 LookupFinancingSearchCriteriaTO
2.22.3 LookupCollectionSearchCriteriaTO
2.22.3 LookupCountrySearchCriteriaTO
2.23 com.avaloq.afs.server.bsp.ws.to.notification
2.23.0 NotificationFrameworkPresentationDataOutputTO
2.24 com.avaloq.afs.server.bsp.ws.to.notification.event
2.24.0 EventValueTO
2.24.1 XmlEventContextTO
2.24.2 EventTaggingTO
2.24.3 EventValueTransitionTO
2.24.4 EventTO
2.24.5 AbstractEventContextTO
2.24.6 ValueEventContextTO
2.25 com.avaloq.afs.server.bsp.ws.to.notification.subscription
2.25.0 NotificationTagTO
2.25.1 NotificationSubscriptionQueryTO
2.25.2 NotificationSubscriptionListOutputTO
2.25.3 NotificationSubscriptionTO
2.25.4 NotificationSubscriptionOutputTO
Copyright 201, Avaloq Evolution AG Page 9 of 424
AFP Interface Specification

2.25.5 NotificationDeliveryChannelListOutputTO
2.25.6 NotificationSubscriptionRecipientTO
2.26 com.avaloq.afs.server.bsp.ws.to.notifications
2.26.0 EmailNotificationAddressTO
2.26.1 EmailNotificationTO
2.26.2 EmailNotificationAddressListTO
2.26.3 SmsNotificationTO
2.27 com.avaloq.afs.server.bsp.ws.to.objectclass
2.27.0 ObjectClassTypeTO
2.28 com.avaloq.afs.server.bsp.ws.to.payment
2.28.0 PaymentOrderTO
2.28.1 PaymentOrderOverviewListOutputTO
2.28.2 PaymentLogTO
2.28.3 BasePaymentOrderOutputTO
2.28.4 PaymentCordOrderOutputTO
2.28.5 PaymentCordOrderTO
2.28.6 AbstractStandingOrderTO
2.28.7 PaymentStatisticsTO
2.28.8 TotalAmountTO
2.28.9 PaymentCordQueryTO
2.28.1 BasePaymentOrderTO
2.28.1 PaymentOrderOverviewTO
2.28.1 StandingOrderTO
2.28.1 BalanceManagerTO
2.28.1 PaymentTemplateFolderTO
2.28.1 PaymentTemplateTO
2.28.1 PaymentOrderOverviewQueryTO
2.29 com.avaloq.afs.server.bsp.ws.to.payment.position.impl
2.29.0 SwissRedPaymentSlipTO
2.29.1 PaymentFraudDetectionTO
2.29.2 SwissOrangePaymentSlipTO
2.29.3 DomesticPaymentTO
2.29.4 InternalPaymentTO
2.29.5 InternationalPaymentTO
2.29.6 SepaPaymentTO
2.29.7 SwissPaymentInstructionTO
2.29.8 BalanceManagerPaymentTO
2.29.9 BasePaymentTO
2.29.1 InternationalPaymentInstructionTO
2.30 com.avaloq.afs.server.bsp.ws.to.performance
2.30.0 PerformanceListOutputTO
2.30.1 PerformanceQueryTO
2.30.2 PerformanceTO
2.30.3 HistoricalPerformanceQueryTO
2.31 com.avaloq.afs.server.bsp.ws.to.position
2.31.0 PositionPaymentRightsTO
2.31.1 PositionQueryTO
2.31.2 PositionTO
2.31.3 PositionListOutputTO
2.31.4 PositionParametersTO
2.32 com.avaloq.afs.server.bsp.ws.to.sds
2.32.0 StringFieldOutputTO
2.32.1 StringListOutputTO
2.32.2 SdsDateInputTO
2.32.3 SdsStringOutputTO
2.32.4 ValueListInputTO
2.32.5 FieldListOutputTO
2.32.6 SdsStringInputTO
Copyright 201, Avaloq Evolution AG Page 10 of 424
AFP Interface Specification

2.32.7 DateFieldOutputTO
2.32.8 SdsInOutFileInputTO
2.32.9 SdsParseDateInputTO
2.32.1 SdsPersonSelectorInputTO
2.32.1 BinaryTextValueInputTO
2.32.1 SdsDateOutputTO
2.32.1 SdsBinaryTextFieldOutputTO
2.32.1 StringListInputTO
2.32.1 BinaryTextValueOutputTO
2.32.1 LookupArgumentTO
2.32.1 SdsFieldOutputTO
2.32.1 KeyListInputTO
2.32.1 LookupFilterAttributeTO
2.33 com.avaloq.afs.server.bsp.ws.to.serverinfo
2.33.0 AcpAvailabilityOutputTO
2.34 com.avaloq.afs.server.bsp.ws.to.signature
2.34.0 UploadSignatureInputTO
2.34.1 DeleteSignatureOutputTO
2.34.2 DownloadSignatureOutputTO
2.34.3 UploadSignatureOutputTO
2.34.4 DownloadSignatureInputTO
2.34.5 DeleteSignatureInputTO
2.35 com.avaloq.afs.server.bsp.ws.to.trading
2.35.0 OrderCostTO
2.35.1 BilledSingleTradingOrderTO
2.35.2 TradingOrderCoreTO
2.35.3 TradingOrderOverviewItemListOutputTO
2.35.4 TradingOrderQueryTO
2.35.5 CalculatedTradingOrderCoreTO
2.35.6 OrderTransitionTO
2.35.7 CalculatedTradingTransactionTO
2.35.8 SingleTradingOrderTO
2.35.9 TradingOrderOverviewItemTO
2.35.1 SingleTradingOrderDetailsOutputTO
2.35.1 TradingOrderTradeTO
2.35.1 TradingTransactionTO
2.36 com.avaloq.afs.server.bsp.ws.to.user
2.36.0 FunctionalAccessCodeListOutputTO
2.36.1 FunctionalAccessCodeTO
2.36.2 UserOutputTO
2.36.3 UserTO
2.36.4 ContactInformationListOutputTO
2.36.5 ContactInformationTO
2.37 com.avaloq.afs.server.bsp.ws.to.wealth
2.37.0 CurrencyConversionTO
2.37.1 PortfolioIdTO
2.37.2 BusinessOrderListOutputTO
2.37.3 EfficientFrontierTO
2.37.4 CountryTO
2.37.5 ModelPortfolioTO
2.37.6 InvestmentPolicyStatementOrderListOutputTO
2.37.7 CurrencyConversionOutputTO
2.37.8 RestrictionListOutputTO
2.37.9 EfficientFrontierListOutputTO
2.37.1 PersonTO
2.37.1 IpsTO
2.37.1 MoneyAccountListOutputTO
2.37.1 BusinessOrderTO
Copyright 201, Avaloq Evolution AG Page 11 of 424
AFP Interface Specification

2.37.1 OrganisationalEntityListOutputTO
2.37.1 InvestmentPropositionOrderListOutputTO
2.37.1 CountryListOutputTO
2.37.1 IpsListOutputTO
2.37.1 CurrencyListOutputTO
2.37.1 AssetAllocationListOutputTO
2.37.2 AssetAllocationTO
2.37.2 BenchmarkListOutputTO
2.37.2 ModelPortfolioListOutputTO
2.37.2 OrganisationalEntityTO
2.37.2 CurrencyOutputTO
2.37.2 RestrictionTO
2.37.2 InvestmentPolicyStatementOrderTO
2.37.2 CountryOutputTO
2.37.2 CurrencyTO
2.37.2 MoneyAccountTO
2.37.3 ContainerPortfolioTO
2.37.3 ContainerPortfolioListOutputTO
2.37.3 BenchmarkTO
2.37.3 InvestmentPropositionOrderTO
3. Avaloq Enumeration Description
3.1 AttentionItemCounterType
3.2 PortfolioAuthorityRestriction
3.3 AdvisoryRawDataFormat
3.4 BookingOrderBusinessType
3.5 QueryOrderingSpecification
3.6 TransactionSigningOperation
3.7 TransactionSigningObjectType
3.8 Sign
3.9 SelectionMethod
3.10 Status
3.11 LookupScope
3.12 CharacterEncoding
3.13 MimeType
3.14 HistoricalPerformancePeriod
3.15 PerformancePeriod
3.16 PortfolioType
3.17 UserContactInformationMedium
3.18 StandingOrderSearchStateType
3.19 PositionType
3.20 PositionQuantityType
3.21 PaymentType
3.22 PaymentSubType
3.23 PaymentStateType
3.24 PaymentSearchStateType
3.25 PaymentPriority
3.26 PaymentOrderSource
3.27 PaymentLogType
3.28 PaymentGroupType
3.29 PaymentChannelType
3.30 InternationalPaymentInstructionFormType
3.31 CollaborationIssueType
3.32 CollaborationIssueSearchReadStatus
3.33 CollaborationIssueDescriptionActionType
3.34 ChargeOptionType
3.35 ChannelType
3.36 BookingOrderDetailType
3.37 BookingDateType
Copyright 201, Avaloq Evolution AG Page 12 of 424
AFP Interface Specification

3.38 BalanceMethodType
3.39 AdviceOptionType
3.40 AddressOwningRelationshipType
3.41 BusinessTypeCodeEnum
3.42 AssetListedInTypeCodeEnum
3.43 AssetBookKeepingMethodTypeCodeEnum
3.44 PaymentFraudDetectionOriginTypeCodeEnum
3.45 PaymentFraudDetectionClientTypeCodeEnum
3.46 PaymentFraudDetectionAuthenticationTypeCodeEnum
3.47 BookingType

Copyright 201, Avaloq Evolution AG Page 13 of 424


AFP Interface Specification

1. Avaloq Web Services Description

Copyright 201, Avaloq Evolution AG Page 14 of 424


AFP Interface Specification

1.1 NotificationEvent
Service providing operations to publish events to the framework and direct to individual users.

Event publishers can use these operations to broadcast events to subscribers. Subscribers register interest in receiving
notifications about events of a given type using the NotificationSubscription service. A subscriber can optionally
specify a predicate on the subscription which is matched to the event using context data provided by the publisher or
calculated from this context data using a scope generator.

In cases where publish/subscribe functionality is already managed by the event publishing system, events can be submitted
directly for formatting and delivery without subscription matching with operation .sendNotificationForEvent.

When a scope is being generated, any reqiured data access must be performed in the security context of the subscriber to
ensure that they are authorised to view all data which might be potentially contained in the notification. To enable the user
context switch from the event publisher to the event subscriber, the publisher must have the authorisation to switch security
context to any user who might receive a notification of the published type. In general, this means the publishing user should
be a technical user with object security access to all Front user objects.

All event types (including types where subscription management is not performed by the framework) must be registered with
the framework using customisation of the Avaloq Core.

1.1.1 processEvent
Publishes an event to the framework.

The framework will match the event to subscriptions and then format and deliver any required notifications.

This is intended to be invoked asynchronously by the event publishing system; once the framework has accepted a well
formed request, any failures during formatting and delivery will be logged internally and not reported to the caller.

Return Value
Type OutputTO
Description An empty response on success, or an error response if there was a problem publishing the
event.
Method Parameter
event
Type EventTO
Description The event to process.
Mandatory yes

1.1.2 sendNotificationForEvent
Delivers a notification for single event to the specified login across the specified channels, ignoring subscriptions.

Return Value
Type OutputTO
Description An empty response on success, or an error response if there was a problem sending the
event.

Copyright 201, Avaloq Evolution AG Page 15 of 424


AFP Interface Specification

Method Parameter
event
Type EventTO
Description The event to deliver.
Mandatory yes

Method Parameter
loginId
Type java.lang.String
Description Login to send the notification to.
Mandatory yes

Method Parameter
deliveryChannelList
Type java.util.List [com.avaloq.afs.server.database.enumeration.fwom.notification.
NotificationDeliveryChannelTypeCodeEnum]
Description Channels to send the notification across.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 16 of 424


AFP Interface Specification

1.2 AssetService
Service providing search and resolve functionality for assets in the AFP database.

• getAssetListings(): Returns the list of pairs market/currency (here called listing) for a given asset.
• getAssets(): Returns the assets with the given IDs.
• getAsset(): Returns an asset with the given id.
• findTradableAssets(): search for a tradable asset using a given search string and class type, and returns a list of
AssetSearchListItemTO objects.
• getAssetTypes(): returns the list of asset types that have been configured on the server properties.

1.2.1 getAssetListings
Returns the list of pairs market/currency (here called listing) for a given asset.

Return Value
Type ListingListOutputTO
Description the list of listings for the given asset.

Method Parameter
userContext
Type UserContextTO
Description the user context.
Mandatory yes

Method Parameter
assetId
Type long
Description the ID of the asset.
Mandatory yes

1.2.2 resolveAssets
Returns the assets with the given IDs.

Return Value
Type AssetListOutputTO
Description The asset output object containing notifications if necessary.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
assetIdList
Type java.util.List [java.lang.Long]
Description the IDs of the assets to resolve.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 17 of 424


AFP Interface Specification

Method Parameter
extensionQuery
Type ObjectExtensionQueryTO
Description The extension query for the asset object extensions.
Mandatory no

Method Parameter
parameters
Type AssetParametersTO
Description The query parameters.
Mandatory yes

1.2.3 resolveAsset
Returns an asset for the supplied id.

Return Value
Type AssetOutputTO
Description the asset.

Method Parameter
userContext
Type UserContextTO
Description Current user context
Mandatory yes

Method Parameter
assetId
Type long
Description the id for the asset.
Mandatory yes

Method Parameter
extensionQuery
Type ObjectExtensionQueryTO
Description The extension query for the asset object extensions.
Mandatory no

1.2.4 findTradableAssets
Returns a list of tradeable assets that match the given query.

Return Value
Type AssetListItemOutputTO
Description The list output object containing the matching assets and notifications if necessary.

Copyright 201, Avaloq Evolution AG Page 18 of 424


AFP Interface Specification

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
query
Type AssetSearchQueryTO
Description the query containing the search criteria.
Mandatory yes

1.2.5 getAssetTypes
Returns the list of asset types that have been configured on the server properties.

Return Value
Type AssetTypeListOutputTO
Description the list of asset types.

Method Parameter
userContext
Type UserContextTO
Description Current user context
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 19 of 424


AFP Interface Specification

1.3 Notification
Web service to send notifications.

1.3.1 sendNotificationEmail
Send a notification as email.

Return Value
Type OutputTO
Description A response object which is empty if everything is correct or otherwise holds a list of
notifications.
Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
notification
Type EmailNotificationTO
Description The notification to send.
Mandatory yes

1.3.2 sendNotificationSms
Send a notification as SMS.

Return Value
Type OutputTO
Description A response object which is empty if everything is correct or otherwise holds a list of
notifications.
Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
notification
Type SmsNotificationTO
Description The notification to send.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 20 of 424


AFP Interface Specification

1.4 LookupCRM
Web service for CRM lookup functionality.

1.4.1 lookupPersonCRM
Retrieve the list of persons matching the given CRM search criteria.

Return Value
Type PersonListOutputTO
Description A response object which holds a list of persons matching the given search criteria.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
searchCriteria
Type LookupPersonCRMSearchCriteriaTO
Description The search criteria required for the lookup.
Mandatory yes

1.4.2 lookupBusinessPartnerCRM
Retrieve the list of BP's (relationship containers) matching the given search criteria.

Return Value
Type BusinessPartnerListOutputTO
Description A response object which holds a list of BP's (relationship containers) matching the given
search criteria.
Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
searchCriteria
Type LookupBusinessPartnerCRMSearchCriteriaTO
Description The search criteria required for the lookup.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 21 of 424


AFP Interface Specification

1.4.3 lookupContainerCRM
Retrieve the list of containers matching the given CRM search criteria.

Return Value
Type ContainerPortfolioListOutputTO
Description A response object which holds a list of containers matching the given search criteria.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
searchCriteria
Type LookupContainerCRMSearchCriteriaTO
Description The search criteria required for the lookup.
Mandatory yes

1.4.4 lookupIpsCRM
Retrieve the list of ips matching the given CRM search criteria.

Return Value
Type IpsListOutputTO
Description A response object which holds a list of ips matching the given search criteria.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
searchCriteria
Type LookupIpsCRMSearchCriteriaTO
Description The search criteria required for the lookup.
Mandatory yes

1.4.5 getPersonTypeJobId
Get person type id for job. TODO SAP no longer used?

Return Value
Type java.lang.Long
Description the person type id for job.

Copyright 201, Avaloq Evolution AG Page 22 of 424


AFP Interface Specification

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

1.4.6 getExportTableRoleId
Get code export table id for roles.

Return Value
Type java.lang.Long
Description the code export table id for roles.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

1.4.7 getExportTableBpPersonRelationTypeId
Get code export table id for bp person relation types.

Return Value
Type java.lang.Long
Description the code export table id for bp person relation types.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

1.4.8 getExportTableAdvisoryTypeContainerClassId
Get code export table id for advisory type container class id.

Return Value
Type java.lang.Long
Description the code export table id for advisory type container class id.

Copyright 201, Avaloq Evolution AG Page 23 of 424


AFP Interface Specification

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

1.4.9 getExportTableMandateIpsClassId
Get code export table id for mandate ips class id.

Return Value
Type java.lang.Long
Description the code export table id for mandate ips class id.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

1.4.10 getExportTableBranchBpClassId
Get code export table id for branch bp class id.

Return Value
Type java.lang.Long
Description the code export table id for branch bp class id.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

1.4.11 getStrategyCollectionClassId
Get strategy collection class id.

Return Value
Type java.lang.Long
Description the strategy collection class id.

Copyright 201, Avaloq Evolution AG Page 24 of 424


AFP Interface Specification

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 25 of 424


AFP Interface Specification

1.5 ClientAdvisor
The web service to retrieve information related to the client advisor.

1.5.1 getClientAdvisorList
Returns a list of client advisor information related to the current user.

Return Value
Type ClientAdvisorListOutputTO
Description A list of client advisor information.

Method Parameter
userContext
Type UserContextTO
Description user context
Mandatory yes

Method Parameter
query
Type ClientAdvisorQueryTO
Description client advisor query object
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 26 of 424


AFP Interface Specification

1.6 AdvisoryCollection
Advisory collection web service.

1.6.1 saveOrUpdateAdvisoryCollection
Creates a new collection or updates an existing one.

Return Value
Type AdvisoryCollectionOutputTO
Description created or modified collection along with the information about the request execution.

Method Parameter
userContext
Type UserContextTO
Description Holding general information about the user.
Mandatory yes

Method Parameter
collection
Type AdvisoryCollectionTO
Description Collection to be created or modified.
Mandatory yes

Method Parameter
collectionItemIdList
Type java.util.List [java.lang.Long]
Description List of collection item id's.
Mandatory yes

1.6.2 deleteCollection
Deletes a collection.

Return Value
Type AdvisoryOutputTO
Description information about the request execution.

Method Parameter
userContext
Type UserContextTO
Description Holding general information about the user.
Mandatory yes

Method Parameter
collection
Type AdvisoryCollectionTO
Description collection to be deleted.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 27 of 424


AFP Interface Specification

Copyright 201, Avaloq Evolution AG Page 28 of 424


AFP Interface Specification

1.7 AcpSessionManager
WebService for ACP session handling.

1.7.1 openSession
Opens an ACP session and returns the ACP session information.

Return Value
Type UserContextTO
Description UserContextTO

Method Parameter
userContextTO
Type UserContextTO
Description Holding general information about the user
Mandatory yes

1.7.2 closeSession
Closes an existing ACP session.

Return Value
Type void
Description No return value

Method Parameter
userContextTO
Type UserContextTO
Description Holding general information about the user
Mandatory yes

1.7.3 heartbeat
Sends a heart beat to ACP to signal that the ACP session has to stay open.

Return Value
Type void
Description No return value

Method Parameter
userContextTO
Type UserContextTO
Description Holding general information about the user
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 29 of 424


AFP Interface Specification

Copyright 201, Avaloq Evolution AG Page 30 of 424


AFP Interface Specification

1.8 Lookup
Web service for lookup functionality.

1.8.1 lookupBusinessPartner
Retrieve the list of BP's (relationship containers) matching the given search criteria.

Return Value
Type BusinessPartnerListOutputTO
Description A response object which holds a list of BP's (relationship containers) matching the given
search criteria.
Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
searchCriteria
Type LookupBusinessPartnerSearchCriteriaTO
Description The search criteria required for the lookup.
Mandatory yes

1.8.2 lookupContainer
Retrieve the list of containers matching the given search criteria.

Return Value
Type ContainerPortfolioListOutputTO
Description A response object which holds a list of containers matching the given search criteria.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
searchCriteria
Type LookupContainerSearchCriteriaTO
Description The search criteria required for the lookup.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 31 of 424


AFP Interface Specification

1.8.3 lookupIps
Retrieve the list of ips matching the given search criteria.

Return Value
Type IpsListOutputTO
Description A response object which holds a list of ips matching the given search criteria.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
searchCriteria
Type LookupIpsSearchCriteriaTO
Description The search criteria required for the lookup.
Mandatory yes

1.8.4 lookupPerson
Retrieve the list of persons matching the given search criteria.

Return Value
Type PersonListOutputTO
Description A response object which holds a list of persons matching the given search criteria.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
searchCriteria
Type LookupPersonSearchCriteriaTO
Description The search criteria required for the lookup.
Mandatory yes

1.8.5 lookupCountry
Retrieve the list of countries.

Return Value
Type CountryListOutputTO
Description A response object which holds a list of countries.

Copyright 201, Avaloq Evolution AG Page 32 of 424


AFP Interface Specification

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
searchCriteria
Type LookupCountrySearchCriteriaTO
Description The search criteria required for the lookup.
Mandatory yes

1.8.6 lookupCurrency
Retrieve the list of currencies.

Return Value
Type CurrencyListOutputTO
Description A response object which holds a list of currencies.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
searchCriteria
Type LookupCurrencySearchCriteriaTO
Description The search criteria required for the lookup.
Mandatory yes

1.8.7 lookupAssetAllocation
Retrieve the list of asset allocations.

Return Value
Type AssetAllocationListOutputTO
Description A response object which holds a list of asset allocations.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 33 of 424


AFP Interface Specification

Method Parameter
searchCriteria
Type LookupAssetAllocationSearchCriteriaTO
Description The search criteria required for the lookup.
Mandatory yes

1.8.8 lookupModelPortfolio
Retrieve the list of model portfolios.

Return Value
Type ModelPortfolioListOutputTO
Description A response object which holds a list of model portfolios.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
searchCriteria
Type LookupModelPortfolioSearchCriteriaTO
Description The search criteria required for the lookup.
Mandatory yes

1.8.9 lookupBenchmark
Retrieve the list of benchmarks.

Return Value
Type BenchmarkListOutputTO
Description A response object which holds a list of benchmarks.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
searchCriteria
Type LookupBenchmarkSearchCriteriaTO
Description The search criteria required for the lookup.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 34 of 424


AFP Interface Specification

1.8.10 lookupEfficientFrontier
Retrieve the list of Efficient Frontiers.

Return Value
Type EfficientFrontierListOutputTO
Description A response object which holds a list of Efficient Frontiers.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
searchCriteria
Type LookupEfficientFrontierSearchCriteriaTO
Description The search criteria required for the lookup.
Mandatory yes

1.8.11 lookupCollection
Retrieve the list of collections matching the given search criteria.

Return Value
Type CollectionListOutputTO
Description A response object which holds a list of collections matching the given search criteria.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
searchCriteria
Type LookupCollectionSearchCriteriaTO
Description The search criteria required for the lookup.
Mandatory yes

1.8.12 lookupRestriction
Retrieve the list of restrictions matching the given search criteria.

Return Value
Type RestrictionListOutputTO
Description A response object which holds a list of restrictions matching the given search criteria.

Copyright 201, Avaloq Evolution AG Page 35 of 424


AFP Interface Specification

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
searchCriteria
Type LookupRestrictionSearchCriteriaTO
Description The search criteria required for the lookup.
Mandatory yes

1.8.13 lookupOrganisationalEntity
Retrieve the list of organisational entities matching the given search criteria.

Return Value
Type OrganisationalEntityListOutputTO
Description A response object which holds a list of organisational entities matching the given search
criteria.
Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
searchCriteria
Type LookupOrganisationalEntitySearchCriteriaTO
Description The search criteria required for the lookup.
Mandatory yes

1.8.14 lookupCode
Retrieve the list of (ABS) code values matching the given search criteria.

Return Value
Type CodeListOutputTO
Description A response object which holds a list of (ABS) code values matching the given search criteria.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 36 of 424


AFP Interface Specification

Method Parameter
searchCriteria
Type LookupCodeSearchCriteriaTO
Description The search criteria required for the lookup.
Mandatory yes

1.8.15 lookupCard
Retrieve the list of cards matching the given search criteria.

Return Value
Type BankingObjectListOutputTO
Description A response object which holds a list of cards matching the given search criteria.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
searchCriteria
Type LookupCardSearchCriteriaTO
Description The search criteria required for the lookup.
Mandatory yes

1.8.16 lookupAddress
Retrieve the list of addresses matching the given search criteria.

Return Value
Type AddressListOutputTO
Description A response object which holds a list of addresses matching the given search criteria.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
searchCriteria
Type LookupAddressSearchCriteriaTO
Description The search criteria required for the lookup.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 37 of 424


AFP Interface Specification

1.8.17 lookupMoneyAccount
Retrieve the list of money accounts matching the given search criteria.

Return Value
Type MoneyAccountListOutputTO
Description A response object which holds a list of money accounts matching the given search criteria.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
searchCriteria
Type LookupMoneyAccountSearchCriteriaTO
Description The search criteria required for the lookup.
Mandatory yes

1.8.18 lookupPosition
Retrieve the list of positions matching the given search criteria.

Return Value
Type PositionListOutputTO
Description A response object which holds a list of positions matching the given search criteria.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
searchCriteria
Type LookupPositionSearchCriteriaTO
Description The search criteria required for the lookup.
Mandatory yes

1.8.19 lookupAsset
Retrieve the list of assets matching the given search criteria.

Return Value
Type AssetListOutputTO
Description A response object which holds a list of assets matching the given search criteria.

Copyright 201, Avaloq Evolution AG Page 38 of 424


AFP Interface Specification

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
searchCriteria
Type LookupAssetSearchCriteriaTO
Description The search criteria required for the lookup.
Mandatory yes

1.8.20 lookupChequeBookProfile
Retrieve the list of cheque book profiles matching the given search criteria.

Return Value
Type BankingObjectListOutputTO
Description A response object which holds a list of cheque book profiles matching the given search
criteria.
Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
searchCriteria
Type LookupChequeBookProfileSearchCriteriaTO
Description The search criteria required for the lookup.
Mandatory yes

1.8.21 lookupDirectDebit
Retrieve the list of direct debits matching the given search criteria.

Return Value
Type BankingObjectListOutputTO
Description A response object which holds a list of direct debits matching the given search criteria.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 39 of 424


AFP Interface Specification

Method Parameter
searchCriteria
Type LookupDirectDebitSearchCriteriaTO
Description The search criteria required for the lookup.
Mandatory yes

1.8.22 lookupDocument
Retrieve the list of documents matching the given search criteria.

Return Value
Type BankingObjectListOutputTO
Description A response object which holds a list of documents matching the given search criteria.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
searchCriteria
Type LookupDocumentSearchCriteriaTO
Description The search criteria required for the lookup.
Mandatory yes

1.8.23 lookupQuestionnaire
Retrieve the list of questionnaires matching the given search criteria.

Return Value
Type BankingObjectListOutputTO
Description A response object which holds a list of questionnaires matching the given search criteria.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
searchCriteria
Type LookupQuestionnaireSearchCriteriaTO
Description The search criteria required for the lookup.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 40 of 424


AFP Interface Specification

1.8.24 lookupFinancing
Retrieve the list of financing objects matching the given search criteria.

Return Value
Type BankingObjectListOutputTO
Description A response object which holds a list of financing objects matching the given search criteria.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
searchCriteria
Type LookupFinancingSearchCriteriaTO
Description The search criteria required for the lookup.
Mandatory yes

1.8.25 lookupSafeDepositBoxContract
Retrieve the list of safe deposit box contracts matching the given search criteria.

Return Value
Type BankingObjectListOutputTO
Description A response object which holds a list of safe deposit box contracts matching the given search
criteria.
Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
searchCriteria
Type LookupSafeDepositBoxContractSearchCriteriaTO
Description The search criteria required for the lookup.
Mandatory yes

1.8.26 lookupGenericObject
Retrieve the list of objects matching the given search criteria.

Return Value
Type BankingObjectListOutputTO
Description A response object which holds a list of objects matching the given search criteria.

Copyright 201, Avaloq Evolution AG Page 41 of 424


AFP Interface Specification

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
searchCriteria
Type LookupGenericObjectSearchCriteriaTO
Description The search criteria required for the lookup.
Mandatory yes

1.8.27 lookupBusinessOrder
Retrieve a list of business orders matching the given search criteria.

Return Value
Type BusinessOrderListOutputTO
Description A response object which holds a list of business orders matching the given search criteria.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
searchCriteria
Type LookupBusinessOrderSearchCriteriaTO
Description The search criteria required for the lookup.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 42 of 424


AFP Interface Specification

1.9 ObjectExtension
Web service implementation holding methods for the Extension service. This will handle keys and classes and potentially
later the additions. Key and Classification should be deprecated and this used instead.

1.9.1 getObjectKeys
Find key values for objects specified by 'objectIds' for keys specified by 'keyTypeIntlIds'. Each Object of those ids will have an
element in the list in the output object. The element will contain a list of object extensions entries. Each entry will have the key
internal id and key value for this object.

Return Value
Type ObjectKeyExtensionListOutputTO
Description a hierarchy that has for each object a list of keys with their type and value.

Method Parameter
userContext
Type UserContextTO
Description user context.
Mandatory yes

Method Parameter
query
Type ObjectKeyExtensionQueryTO
Description query to find specific key value for specific objects. Neither object id list nor key id list
should be empty.
Mandatory yes

1.9.2 getObjectClasses
Find class names for objects specified by 'objectIds' for classes specified by the classification's 'classificationTypeIntlIds'.
Each Object of those ids will have an element in the list in the output object. The element will contain a list of object
extensions entries. Each entry will have the classification type intl id and corresponding class value.

Return Value
Type ObjectClassExtensionListOutputTO
Description a hierarchy that has for each object a list of classes with their type and value.

Method Parameter
userContext
Type UserContextTO
Description user context.
Mandatory yes

Method Parameter
query
Type ObjectClassExtensionQueryTO
Description query to find specific class value for specific objects and classifications. Neither object id list
nor classification id list should be empty.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 43 of 424


AFP Interface Specification

1.9.3 getObjectsByKeys
Find objects queried by key values and key type.

Return Value
Type IdListOutputTO
Description a list of object id's.

Method Parameter
userContext
Type UserContextTO
Description user context.
Mandatory yes

Method Parameter
query
Type KeyExtensionQueryTO
Description query to find the objects for the given key values and key type.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 44 of 424


AFP Interface Specification

1.10 SensitiveDataSeparation
Service for saving(=encoding) and reading(=resolving) sensitive data.

1.10.1 encodeStringValue
Persists a sensitive string and returns an SDS key.

Return Value
Type StringFieldOutputTO
Description the SDS key and and the stringValue (as a StringFieldOutputTO representing the key value
pair).
Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
stringValue
Type SdsStringInputTO
Description the sensitive string to save.
Mandatory yes

1.10.2 encodeDateValue
Persists a sensitive date and returns an SDS key.

Return Value
Type DateFieldOutputTO
Description the SDS key and and the stringValue (as a DateFieldOutputTO representing the key value pair).

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
dateValue
Type SdsDateInputTO
Description the sensitive date to save.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 45 of 424


AFP Interface Specification

1.10.3 encodeBinaryTextValue
Persists a sensitive string and returns an SDS key.

Return Value
Type SdsBinaryTextFieldOutputTO
Description the SDS key and and the stringValue (as a SdsBinaryTextFieldOutputTO representing the key
value pair).
Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
content
Type BinaryTextValueInputTO
Description binary content
Mandatory yes

1.10.4 encodeValueList
Persists a list of both sensitive dates and strings.

Return Value
Type FieldListOutputTO
Description FieldListTO two lists of SDS keys and their values> One for the dates and one for the strings.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
valueList
Type ValueListInputTO
Description list of sensitive strings and dates to save.
Mandatory yes

1.10.5 resolveDateKey
Resolves a date value for a given SDS key.

Return Value
Type DateFieldOutputTO
Description DateFieldTO containing sdsKey and dateValue ->fallbackValue = "01.01.0001 00:00:00" if
no value can be resolved

Copyright 201, Avaloq Evolution AG Page 46 of 424


AFP Interface Specification

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
sdsKey
Type SdsStringInputTO
Description is an sdsKey to a dateValue e.g. $#$01$#$[d:BC0100.09.10T18:22:15]
Mandatory yes

1.10.6 resolveStringKey
Resolves a string value for a given SDS key.

Return Value
Type StringFieldOutputTO
Description StringFieldTO containing sdsKey and corresponding sensitive stringValue ->fallbackValue =
"***" if no value can be resolved
Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
sdsKey
Type SdsStringInputTO
Description sdsKey to a stringValue e.g. $#$01$#$[t:10758005]
Mandatory yes

1.10.7 resolveBinaryTextKey
Resolves a string value for a given SDS key.

Return Value
Type SdsBinaryTextFieldOutputTO
Description StringFieldTO containing sdsKey and corresponding sensitive stringValue ->fallbackValue =
"***" if no value can be resolved
Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 47 of 424


AFP Interface Specification

Method Parameter
charSet
Type SdsStringInputTO
Description characterSet of transferred content, e.g. UTF-8
Mandatory yes

Method Parameter
sdsKey
Type SdsStringInputTO
Description sdsKey to a stringValue e.g. $#$01$#$[t:10758005]
Mandatory yes

1.10.8 resolveKeyList
Resolves sensitive values for a given list of sdsKeys.

Return Value
Type FieldListOutputTO
Description FieldListOutputTO containing string- and dateValues with corresponding sdsKey.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
keyListInputTO
Type KeyListInputTO
Description KeyListInputTO containing sdsKeys
Mandatory yes

1.10.9 resolveBinaryKeyList
Resolves sensitive values for a given list of sdsKeys. This method behaves almost the same way as
.resolveKeyList(UserContextTO, KeyListInputTO) resolveKeyList. However when using
.resolveBinaryKeyList(UserContextTO, SdsStringInputTO, KeyListInputTO) resolveBinaryKeyList, the values
corresponding to provided SDS text keys are returned within FieldListOutputTO.getBinaryTextFieldList()
binaryTextFieldList in binary format (Base64 encoded in the provided charSet), whereas
.resolveTextList(UserContextTO, StringListInputTO) resolveKeyList returns them within
FieldListOutputTO.getSdsFieldList() sdsFieldList as strings. Compared to the non-binary alternative, this method
may incur some overhead in terms of message size and processing time, but is the preferable choice for transferring content
that may contain non-ANSI characters, as it ensures that the content is interpreted correctly and the correct encoding is
applied. The behaviour for SDS date keys is identical in both methods. Both methods return resolved dates within

Return Value
Type FieldListOutputTO
Description FieldListOutputTO containing string- and dateValues with corresponding sdsKey.

Copyright 201, Avaloq Evolution AG Page 48 of 424


AFP Interface Specification

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
charSet
Type SdsStringInputTO
Description characterSet of transferred content, e.g. UTF-8
Mandatory yes

Method Parameter
keyList
Type KeyListInputTO
Description KeyListInputTO containing sdsKeys.
Mandatory yes

1.10.10 resolveText
Replaces all sdsKeys in a document with their corresponding sensitive values.

Return Value
Type SdsStringOutputTO
Description resolved document like String 1 str 986 Date 1 AD 2007.07.28 12:00:00 String 2 George
Breghi Date 2 AD 1929.01.10 12:00:00 ->fallbackValue = "***" if no value can be resolved
Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
document
Type SdsStringInputTO
Description like String 1 $#$01$#$[t:10758005] Date 1 $#$01$#$[d:BC0100.09.10T18:22:15] String 2
$#$01$#$[t:10781005] Date 2 $#$01$#$[d:BC0100.09.10T17:48:55]
Mandatory yes

1.10.11 resolveBinaryText
Replaces all sdsKeys in a document with their corresponding sensitive values.

Return Value
Type BinaryTextValueOutputTO
Description resolved document

Copyright 201, Avaloq Evolution AG Page 49 of 424


AFP Interface Specification

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
content
Type BinaryTextValueInputTO
Description binary content and character set. e.g UTF-8
Mandatory yes

1.10.12 resolveTextList
Resolves the sensitive values for a list of documents.

Return Value
Type StringListOutputTO
Description documentList in which the sdsKeys are resolved and integrated within the text

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
stringList
Type StringListInputTO
Description list of documents with normal text plus sdsKeys
Mandatory yes

1.10.13 resolveFile
Resolve + Replace all SdsKeys of the InputFile and write the result into the given OutputFile.

Return Value
Type void
Description No return value

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 50 of 424


AFP Interface Specification

Method Parameter
inOutFile
Type SdsInOutFileInputTO
Description Filename of the input and output file located in the input/output directory given by the
application properties.
Mandatory yes

1.10.14 encodeText
Replaces all SDS-encode functions (storeText, storeDate, lookup) in a document with their corresponding resultes.

Return Value
Type SdsStringOutputTO
Description encoded document like This i is public Person $#$1#$[t:21212]. This is a private person
$#$1$#$[t:123]
Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
document
Type SdsStringInputTO
Description like This i is public Person $#$evel$#$[storeText("Huber")]. This is a private person
$#$1$#$[t:123]
Mandatory yes

1.10.15 parseDateValue
create a date object from a date- plus formatString.

Return Value
Type SdsDateOutputTO
Description Date

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
parseDate
Type SdsParseDateInputTO
Description contains the date String and the specification of date parsing.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 51 of 424


AFP Interface Specification

1.10.16 getPersonId
Restricted Sensitive Data Separation Lookup for Person Objects. If an SDS key is specified in key, the lookup scope is in
EWOM. For non SDS keys, the lookup scope is in FWOM.

Return Value
Type IdOutputTO
Description person object id

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
personSelector
Type SdsPersonSelectorInputTO
Description contains the specification to select a person.
Mandatory yes

1.10.17 lookupObjects
Executes an <style size="9" pdfFontName="Courier"> LookupScope.SDS_EWOM_LOOKUP</style> with the provided
arguments. <p> This API is for exclusive usage by the SmartClient! Any other consumer MUST use the <style size="9"
pdfFontName="Courier"> Lookup</style> web service which provides a typed API! </p>

Return Value
Type IdListOutputTO
Description List of GUIDs.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
lookupSearchArgument
Type LookupArgumentTO
Description specification of the lookup filter.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 52 of 424


AFP Interface Specification

1.11 Booking
Service to retrieve booking data.

1.11.1 getBookingList
Retrieve a list of bookings according to the selection criteria <style size="9" pdfFontName="Courier">
BookingQueryTO</style>. <p> The canonical booking data may be enriched with extra information by setting the flags
available in the <style size="9" pdfFontName="Courier"> BookingParametersTO</style>. </p>

Return Value
Type BookingListOutputTO
Description BookingListOutputTO, representation of a Booking list.

Method Parameter
userContext
Type UserContextTO
Description required authenticated user information for each request.
Mandatory yes

Method Parameter
query
Type BookingQueryTO
Description the selection criteria to retrieve the bookings.
Mandatory yes

Method Parameter
parameters
Type BookingParametersTO
Description loading extra information flags to control the amount of details returned.
Mandatory no

1.11.2 getBookingPaymentList
Retrieve a list of booking details of payments according to the selection criteria BookingPaymentQueryTO.

Return Value
Type BookingPaymentListOutputTO
Description BookingPaymentListOutputTO containing a list of com.avaloq.afs.server.bsp.client.ws.
BookingPaymentOrderTO

Method Parameter
userContext
Type UserContextTO
Description required authenticated user information for each request.
Mandatory yes

Method Parameter
query
Type BookingPaymentQueryTO
Description the selection criteria
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 53 of 424


AFP Interface Specification

Copyright 201, Avaloq Evolution AG Page 54 of 424


AFP Interface Specification

1.12 InvestmentProposition
The webservice for handling investment proposition functionality.

1.12.1 getInvestmentPropositionList
Retrieve a list of investment proposition orders matching the given search criteria. This method only works with EWOM data

Return Value
Type InvestmentPropositionOrderListOutputTO
Description A response object which holds a list of investment proposition orders matching the given
search criteria.
Method Parameter
userContext
Type UserContextTO
Description general information about the user
Mandatory yes

Method Parameter
query
Type InvestmentPropositionQueryTO
Description The search criteria required for the lookup.
Mandatory yes

1.12.2 getInvestmentProposition
Returns the investment proposition in read-only mode.

Return Value
Type InvestmentPropositionOutputTO
Description the investment proposition details.

Method Parameter
userContext
Type UserContextTO
Description general information about the user
Mandatory yes

Method Parameter
investmentPropositionId
Type java.lang.Long
Description the investment proposition id
Mandatory yes

Method Parameter
populateInstruction
Type InvestmentPropositionPopulateInstructionTO
Description the parameters used to populate the response
Mandatory no

Copyright 201, Avaloq Evolution AG Page 55 of 424


AFP Interface Specification

1.12.3 editInvestmentProposition
Returns the investment proposition in edit mode.

Return Value
Type InvestmentPropositionOutputTO
Description the investment proposition details.

Method Parameter
userContext
Type UserContextTO
Description general information about the user
Mandatory yes

Method Parameter
investmentPropositionId
Type java.lang.Long
Description the investment proposition id
Mandatory yes

Method Parameter
populateInstruction
Type InvestmentPropositionPopulateInstructionTO
Description the parameters used to populate the response
Mandatory no

1.12.4 newInvestmentProposition
Returns a new investment proposition.

Return Value
Type InvestmentPropositionOutputTO
Description the investment proposition details.

Method Parameter
userContext
Type UserContextTO
Description general information about the user
Mandatory yes

Method Parameter
workflowAction
Type java.lang.String
Description the workflow action to be performed after the order has been created
Mandatory no

Copyright 201, Avaloq Evolution AG Page 56 of 424


AFP Interface Specification

Method Parameter
acceptedOverrideList
Type java.util.List [java.lang.Long]
Description the accepted validation validation override ids
Mandatory no

Method Parameter
investmentProposition
Type NewInvestmentPropositionTO
Description Holding the parameters used to create the new Investment Proposition
Mandatory yes

Method Parameter
populateInstruction
Type InvestmentPropositionPopulateInstructionTO
Description the parameters used to populate the response
Mandatory no

1.12.5 modifyInvestmentPropositionBasicData
Modifies the investment proposition basic data.

Return Value
Type InvestmentPropositionOutputTO
Description the updated investment proposition details.

Method Parameter
userContext
Type UserContextTO
Description general information about the user
Mandatory yes

Method Parameter
investmentPropositionId
Type java.lang.Long
Description the investment proposition id
Mandatory yes

Method Parameter
workflowAction
Type java.lang.String
Description the workflow action to be executed after update
Mandatory no

Method Parameter
acceptedOverrideList
Type java.util.List [java.lang.Long]
Description the accepted validation validation override ids
Mandatory no

Copyright 201, Avaloq Evolution AG Page 57 of 424


AFP Interface Specification

Method Parameter
basicData
Type ModifyInvestmentPropositionBasicDataTO
Description Holding the parameters used to modify the basic data of an investment proposition
Mandatory yes

Method Parameter
populateInstruction
Type InvestmentPropositionPopulateInstructionTO
Description the parameters used to populate the response
Mandatory no

1.12.6 addInvestmentPropositionPosition
Returns the modified investment proposition containing a new position.

Return Value
Type InvestmentPropositionOutputTO
Description the updated investment proposition details.

Method Parameter
userContext
Type UserContextTO
Description general information about the user
Mandatory yes

Method Parameter
investmentPropositionId
Type java.lang.Long
Description the investment proposition id
Mandatory yes

Method Parameter
workflowAction
Type java.lang.String
Description the workflow action to be executed after update
Mandatory no

Method Parameter
acceptedOverrideList
Type java.util.List [java.lang.Long]
Description the accepted validation validation override ids
Mandatory no

Method Parameter
assetId
Type java.lang.Long
Description the asset id for the new position
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 58 of 424


AFP Interface Specification

Method Parameter
position
Type AddInvestmentPropositionPositionTO
Description the new position details to be inserted
Mandatory yes

Method Parameter
populateInstruction
Type InvestmentPropositionPopulateInstructionTO
Description the parameters used to populate the response
Mandatory no

1.12.7 modifyInvestmentPropositionPosition
Returns the modified investment proposition containing the updated position.

Return Value
Type InvestmentPropositionOutputTO
Description the updated investment proposition details.

Method Parameter
userContext
Type UserContextTO
Description general information about the user
Mandatory yes

Method Parameter
investmentPropositionId
Type java.lang.Long
Description the investment proposition id
Mandatory yes

Method Parameter
workflowAction
Type java.lang.String
Description the workflow action to be executed after update
Mandatory no

Method Parameter
acceptedOverrideList
Type java.util.List [java.lang.Long]
Description the accepted validation validation override ids
Mandatory no

Method Parameter
positionList
Type java.util.List [ModifyInvestmentPropositionPositionTO]
Description the position list that needs to be updated
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 59 of 424


AFP Interface Specification

Method Parameter
populateInstruction
Type InvestmentPropositionPopulateInstructionTO
Description the parameters used to populate the response
Mandatory no

1.12.8 optimizeInvestmentProposition
Returns the optimized investment proposition.

Return Value
Type InvestmentPropositionOutputTO
Description the optimized investment proposition details.

Method Parameter
userContext
Type UserContextTO
Description general information about the user
Mandatory yes

Method Parameter
investmentPropositionId
Type java.lang.Long
Description the investment proposition id
Mandatory yes

Method Parameter
workflowAction
Type java.lang.String
Description the intl_id of the BBS workflow action to be executed after optimization
Mandatory no

Method Parameter
acceptedOverrideList
Type java.util.List [java.lang.Long]
Description the accepted validation validation override ids
Mandatory no

Method Parameter
optimizationInstruction
Type InvestmentPropositionOptimizationInstructionTO
Description the parameters used for the optimization
Mandatory yes

Method Parameter
populateInstruction
Type InvestmentPropositionPopulateInstructionTO
Description the parameters used to populate the response
Mandatory no

Copyright 201, Avaloq Evolution AG Page 60 of 424


AFP Interface Specification

1.12.9 executeInvestmentPropositionWorkflowAction
Returns the updated investment proposition after executing a workflow action on it.

Return Value
Type InvestmentPropositionOutputTO
Description the optimized investment proposition details.

Method Parameter
userContext
Type UserContextTO
Description general information about the user
Mandatory yes

Method Parameter
investmentPropositionId
Type java.lang.Long
Description the investment proposition id
Mandatory yes

Method Parameter
workflowAction
Type java.lang.String
Description the workflow action to be executed
Mandatory no

Method Parameter
acceptedOverrideList
Type java.util.List [java.lang.Long]
Description the accepted validation validation override ids
Mandatory no

Method Parameter
populateInstruction
Type InvestmentPropositionPopulateInstructionTO
Description the parameters used to populate the response
Mandatory no

1.12.10 addInvestmentPropositionCash
Returns the modified investment proposition containing the new added cash.

Return Value
Type InvestmentPropositionOutputTO
Description the updated investment proposition details.

Copyright 201, Avaloq Evolution AG Page 61 of 424


AFP Interface Specification

Method Parameter
userContext
Type UserContextTO
Description general information about the user
Mandatory yes

Method Parameter
investmentPropositionId
Type java.lang.Long
Description the investment proposition id
Mandatory yes

Method Parameter
workflowAction
Type java.lang.String
Description the workflow action to be executed after update
Mandatory no

Method Parameter
acceptedOverrideList
Type java.util.List [java.lang.Long]
Description the accepted validation validation override ids
Mandatory no

Method Parameter
investmentAmountList
Type java.util.List [AddInvestmentPropositionInvestmentAmountTO]
Description the investment amount list to be added
Mandatory yes

Method Parameter
populateInstruction
Type InvestmentPropositionPopulateInstructionTO
Description the parameters used to populate the response
Mandatory no

1.12.11 modifyInvestmentPropositionCash
Returns the modified investment proposition containing the new updated cash.

Return Value
Type InvestmentPropositionOutputTO
Description the updated investment proposition details.

Method Parameter
userContext
Type UserContextTO
Description general information about the user
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 62 of 424


AFP Interface Specification

Method Parameter
investmentPropositionId
Type java.lang.Long
Description the investment proposition id
Mandatory yes

Method Parameter
workflowAction
Type java.lang.String
Description the workflow action to be executed after update
Mandatory no

Method Parameter
acceptedOverrideList
Type java.util.List [java.lang.Long]
Description the accepted validation validation override ids
Mandatory no

Method Parameter
investmentAmountList
Type java.util.List [ModifyInvestmentPropositionInvestmentAmountTO]
Description the investment amount list to be updated
Mandatory yes

Method Parameter
populateInstruction
Type InvestmentPropositionPopulateInstructionTO
Description the parameters used to populate the response
Mandatory no

1.12.12 getInvestmentPropositionRiskAnalytics
Returns the risk data for the specified investment proposition.

Return Value
Type InvestmentPropositionRiskAnalyticsOutputTO
Description the risk data for the specified investment proposition

Method Parameter
userContext
Type UserContextTO
Description general information about the user
Mandatory yes

Method Parameter
investmentPropositionId
Type java.lang.Long
Description the investment proposition id
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 63 of 424


AFP Interface Specification

Method Parameter
rawDataFormat
Type com.avaloq.afs.server.bsp.ws.to.advisory.AdvisoryRawDataFormat
Description the format of the answer
Mandatory yes

1.12.13 modifyInvestorProtectionDiscussedPosition
Returns the modified investment proposition containing the new updated discussed positions.

Return Value
Type InvestmentPropositionOutputTO
Description the modified investment proposition containing the new updated discussed positions

Method Parameter
userContext
Type UserContextTO
Description general information about the user
Mandatory yes

Method Parameter
investmentPropositionId
Type java.lang.Long
Description the investment proposition id
Mandatory yes

Method Parameter
workflowAction
Type java.lang.String
Description the workflow action to be executed after update
Mandatory no

Method Parameter
acceptedOverrideList
Type java.util.List [java.lang.Long]
Description the accepted validation validation override ids
Mandatory no

Method Parameter
positionId
Type java.lang.Long
Description the id of the position that will be updated
Mandatory yes

Method Parameter
position
Type ModifyInvestorProtectionDiscussedPositionTO
Description the position details that need to be updated
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 64 of 424


AFP Interface Specification

Method Parameter
populateInstruction
Type InvestmentPropositionPopulateInstructionTO
Description the parameters used to populate the response
Mandatory no

1.12.14 addInvestmentPropositionPostIt
Returns the modified investment proposition containing the new added postIts.

Return Value
Type InvestmentPropositionOutputTO
Description the modified investment proposition containing the new added postIts

Method Parameter
userContext
Type UserContextTO
Description general information about the user
Mandatory yes

Method Parameter
investmentPropositionId
Type java.lang.Long
Description the investment proposition id
Mandatory yes

Method Parameter
workflowAction
Type java.lang.String
Description the workflow action to be executed after update
Mandatory no

Method Parameter
acceptedOverrideList
Type java.util.List [java.lang.Long]
Description the accepted validation validation override ids
Mandatory no

Method Parameter
postItList
Type java.util.List [AddOrderPostItTO]
Description the postId list to be added
Mandatory yes

Method Parameter
populateInstruction
Type InvestmentPropositionPopulateInstructionTO
Description the parameters used to populate the response
Mandatory no

Copyright 201, Avaloq Evolution AG Page 65 of 424


AFP Interface Specification

1.12.15 setAdvisorySituation
Sets the Advisory Situation of the Investor Protection part. The order orderId is loaded in read-write mode.

Return Value
Type InvestmentPropositionOutputTO
Description the modified investment proposition containing the updated Investor Protection part

Method Parameter
userContext
Type UserContextTO
Description general information about the user
Mandatory yes

Method Parameter
investmentPropositionId
Type java.lang.Long
Description the investment proposition id
Mandatory yes

Method Parameter
workflowAction
Type java.lang.String
Description the workflow action to be executed after update
Mandatory no

Method Parameter
acceptedOverrideList
Type java.util.List [java.lang.Long]
Description the accepted validation validation override ids
Mandatory no

Method Parameter
advisorySituation
Type InvestorProtectionAdvisorySituationDetailTO
Description the Advisory Situation to set
Mandatory yes

Method Parameter
populateInstruction
Type InvestmentPropositionPopulateInstructionTO
Description the parameters used to populate the response
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 66 of 424


AFP Interface Specification

1.13 SingleTradingOrderView
Web service for view functionality of single trading orders.

1.13.1 getOverviewItems
Retrieve trading order overview items matching a query.

Return Value
Type TradingOrderOverviewItemListOutputTO
Description A TradingOrderOverviewItemListOutputTO containing the matching trading order overview
items.
Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
query
Type TradingOrderQueryTO
Description The trading order overview item query used to find matching overview items.
Mandatory yes

1.13.2 getOrderDetails
Retrieve a single trading order by id.

Return Value
Type SingleTradingOrderDetailsOutputTO
Description A SingleTradingOrderDetailsOutputTO containing the requested trading order and the list of
possible workflow actions.
Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
tradingOrderId
Type long
Description The single trading order id
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 67 of 424


AFP Interface Specification

1.14 CrmIssue
The web service to work with CRM issues using BBS framework.

1.14.1 getBBSCrmIssue
Get a CRM Issue via BBS framework.

Return Value
Type CrmIssueBBSOutputTO
Description A response object with the CRM issue if everything is correct or otherwise a list of
notifications.
Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
requestHead
Type com.avaloq.bbs.common.GetReqHead
Description The request head.
Mandatory yes

1.14.2 createBBSCrmIssue
Create a CRM Issue via BBS framework.

Return Value
Type CrmIssueBBSOutputTO
Description A response object with the CRM issue if everything is correct or otherwise a list of
notifications.
Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
requestHead
Type com.avaloq.bbs.common.NewReqHead
Description The request head.
Mandatory yes

Method Parameter
crmIssueBase
Type com.avaloq.bbs.crm_issue.CrmIssueBase
Description The CRM issue.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 68 of 424


AFP Interface Specification

1.14.3 modifyBBSCrmIssue
Modify an existing CRM Issue via BBS framework.

Return Value
Type CrmIssueBBSOutputTO
Description A response object with the CRM issue if everything is correct or otherwise a list of
notifications.
Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
requestHead
Type com.avaloq.bbs.common.MdfReqHead
Description The request head.
Mandatory yes

Method Parameter
crmIssueBase
Type com.avaloq.bbs.crm_issue.CrmIssueBase
Description The CRM issue.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 69 of 424


AFP Interface Specification

1.15 InvestmentPolicyStatement
Investment policy statement web service.

1.15.1 getInvestmentPolicyStatementOrderList
Retrieve a list of investment policy statement orders matching the given search criteria. This method only works with EWOM
data.

Return Value
Type InvestmentPolicyStatementOrderListOutputTO
Description A response object which holds a list of investment policy statement orders matching the
given search criteria.
Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
query
Type InvestmentPolicyStatementOrderQueryTO
Description The search criteria required for the order lookup.
Mandatory yes

1.15.2 getInvestmentPolicyStatementOrder
Returns the investment policy statement order in read-only mode.

Return Value
Type InvestmentPolicyStatementOrderOutputTO
Description the investment policy statement order details.

Method Parameter
userContext
Type UserContextTO
Description Holding general information about the user
Mandatory yes

Method Parameter
investmentPolicyStatementOrderId
Type java.lang.Long
Description the investment policy statement order id
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 70 of 424


AFP Interface Specification

1.15.3 editInvestmentPolicyStatementOrder
Returns the investment policy statement order in edit mode.

Return Value
Type InvestmentPolicyStatementOrderOutputTO
Description the investment policy statement order details.

Method Parameter
userContext
Type UserContextTO
Description Holding general information about the user
Mandatory yes

Method Parameter
investmentPolicyStatementOrderId
Type java.lang.Long
Description the investment policy statement order id
Mandatory yes

1.15.4 newInvestmentPolicyStatement
Creates an investment policy statement object.

Return Value
Type InvestmentPolicyStatementOrderOutputTO
Description the investment policy statement order details.

Method Parameter
userContext
Type UserContextTO
Description Holding general information about the user
Mandatory yes

Method Parameter
workflowAction
Type java.lang.String
Description the workflow action to be executed after creation
Mandatory no

Method Parameter
acceptedOverrideList
Type java.util.List [java.lang.Long]
Description the accepted validation override ids
Mandatory no

Method Parameter
investmentPolicyStatement
Type NewInvestmentPolicyStatementTO
Description Holding the parameters used to create the new investment policy statement object
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 71 of 424


AFP Interface Specification

1.15.5 modifyInvestmentPolicyStatement
Creates a new order to modify an existing investment policy statement object.

Return Value
Type InvestmentPolicyStatementOrderOutputTO
Description the investment policy statement order details.

Method Parameter
userContext
Type UserContextTO
Description Holding general information about the user
Mandatory yes

Method Parameter
workflowAction
Type java.lang.String
Description the workflow action to be executed after creation
Mandatory no

Method Parameter
acceptedOverrideList
Type java.util.List [java.lang.Long]
Description the accepted validation override ids
Mandatory no

Method Parameter
investmentPolicyStatement
Type ModifyInvestmentPolicyStatementTO
Description Holding the parameters used to create the new investment policy statement order
Mandatory yes

1.15.6 modifyInvestmentPolicyStatementBasicData
Modifies the investment policy statement basic data.

Return Value
Type InvestmentPolicyStatementOrderOutputTO
Description the investment policy statement order details.

Method Parameter
userContext
Type UserContextTO
Description Holding general information about the user
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 72 of 424


AFP Interface Specification

Method Parameter
investmentPolicyStatementOrderId
Type java.lang.Long
Description the investment policy statement order id
Mandatory yes

Method Parameter
workflowAction
Type java.lang.String
Description he workflow action to be performed after the order has been modified
Mandatory no

Method Parameter
acceptedOverrideList
Type java.util.List [java.lang.Long]
Description the accepted validation override ids
Mandatory no

Method Parameter
basicData
Type ModifyInvestmentPolicyStatementBasicDataTO
Description Holding the parameters used to modify the basic data of an investment policy statement
object
Mandatory yes

1.15.7 executeInvestmentPolicyStatementWorkflowAction
Executes a workflow action on the investment policy statement.

Return Value
Type InvestmentPolicyStatementOrderOutputTO
Description the investment policy statement order details.

Method Parameter
userContext
Type UserContextTO
Description Holding general information about the user
Mandatory yes

Method Parameter
investmentPolicyStatementOrderId
Type java.lang.Long
Description the investment policy statement order id
Mandatory yes

Method Parameter
workflowAction
Type java.lang.String
Description the workflow action to be executed
Mandatory no

Copyright 201, Avaloq Evolution AG Page 73 of 424


AFP Interface Specification

Method Parameter
acceptedOverrideList
Type java.util.List [java.lang.Long]
Description the accepted validation override ids
Mandatory no

1.15.8 addInvestmentPolicyStatementAssetAllocationLink
Adds an asset allocation link to the investment policy statement order.

Return Value
Type InvestmentPolicyStatementOrderOutputTO
Description the investment policy statement order details.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user
Mandatory yes

Method Parameter
investmentPolicyStatementOrderId
Type java.lang.Long
Description the investment policy statement order id
Mandatory yes

Method Parameter
workflowAction
Type java.lang.String
Description the workflow action to be executed after the asset allocation link has been added
Mandatory no

Method Parameter
acceptedOverrideList
Type java.util.List [java.lang.Long]
Description the accepted validation override ids
Mandatory no

Method Parameter
assetAllocationLink
Type AddInvestmentPolicyStatementAssetAllocationLinkTO
Description the asset allocation link that must be added
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 74 of 424


AFP Interface Specification

1.15.9 modifyInvestmentPolicyStatementAssetAllocationLink
Modifies an asset allocation link.

Return Value
Type InvestmentPolicyStatementOrderOutputTO
Description the investment policy statement order details.

Method Parameter
userContext
Type UserContextTO
Description Holding general information about the user
Mandatory yes

Method Parameter
investmentPolicyStatementOrderId
Type java.lang.Long
Description the investment policy statement order id
Mandatory yes

Method Parameter
workflowAction
Type java.lang.String
Description the workflow action to be executed after the asset allocation link has been modified
Mandatory no

Method Parameter
acceptedOverrideList
Type java.util.List [java.lang.Long]
Description the accepted validation override ids
Mandatory no

Method Parameter
assetAllocationLinkId
Type InvestmentPolicyStatementAssetAllocationLinkIdentifierTO
Description the asset allocation link identifier
Mandatory yes

Method Parameter
assetAllocationLink
Type ModifyInvestmentPolicyStatementAssetAllocationLinkTO
Description the asset allocation link details that must be modified
Mandatory yes

1.15.10 removeInvestmentPolicyStatementAssetAllocationLink
Removes an asset allocation link.

Return Value
Type InvestmentPolicyStatementOrderOutputTO
Description the investment policy statement order details.

Copyright 201, Avaloq Evolution AG Page 75 of 424


AFP Interface Specification

Method Parameter
userContext
Type UserContextTO
Description Holding general information about the user
Mandatory yes

Method Parameter
investmentPolicyStatementOrderId
Type java.lang.Long
Description the investment policy statement order id
Mandatory yes

Method Parameter
workflowAction
Type java.lang.String
Description the workflow action to be executed after the asset allocation link has been removed
Mandatory no

Method Parameter
acceptedOverrideList
Type java.util.List [java.lang.Long]
Description the accepted validation override ids
Mandatory no

Method Parameter
assetAllocationLinkId
Type InvestmentPolicyStatementAssetAllocationLinkIdentifierTO
Description the asset allocation link identifier
Mandatory yes

1.15.11 setInvestmentPolicyStatementAssetAllocationLinkOverrideList
Sets the overrides of an asset allocation link.

Return Value
Type InvestmentPolicyStatementOrderOutputTO
Description the investment policy statement order details.

Method Parameter
userContext
Type UserContextTO
Description Holding general information about the user
Mandatory yes

Method Parameter
investmentPolicyStatementOrderId
Type java.lang.Long
Description the investment policy statement order id
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 76 of 424


AFP Interface Specification

Method Parameter
workflowAction
Type java.lang.String
Description the workflow action to be executed after the asset allocation link overrides have been
modified
Mandatory no

Method Parameter
acceptedOverrideList
Type java.util.List [java.lang.Long]
Description the accepted validation override ids
Mandatory no

Method Parameter
assetAllocationLinkId
Type InvestmentPolicyStatementAssetAllocationLinkIdentifierTO
Description the asset allocation link identifier
Mandatory yes

Method Parameter
overrideList
Type java.util.List [SetInvestmentPolicyStatementAssetAllocationLinkOverrideTO]
Description the list of overrides to be modified
Mandatory no

1.15.12 addInvestmentPolicyStatementRestrictionLink
Adds a restriction link to the investment policy statement.

Return Value
Type InvestmentPolicyStatementOrderOutputTO
Description the investment policy statement order details.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user
Mandatory yes

Method Parameter
investmentPolicyStatementOrderId
Type java.lang.Long
Description the investment policy statement order id
Mandatory yes

Method Parameter
workflowAction
Type java.lang.String
Description the workflow action to be executed after the restriction link has been added
Mandatory no

Copyright 201, Avaloq Evolution AG Page 77 of 424


AFP Interface Specification

Method Parameter
acceptedOverrideList
Type java.util.List [java.lang.Long]
Description the accepted validation override ids
Mandatory no

Method Parameter
restrictionId
Type java.lang.Long
Description the id of the restriction to be linked
Mandatory yes

1.15.13 modifyInvestmentPolicyStatementRestrictionLink
Modifies a restriction link.

Return Value
Type InvestmentPolicyStatementOrderOutputTO
Description the investment policy statement order details.

Method Parameter
userContext
Type UserContextTO
Description Holding general information about the user
Mandatory yes

Method Parameter
investmentPolicyStatementOrderId
Type java.lang.Long
Description the investment policy statement order id
Mandatory yes

Method Parameter
workflowAction
Type java.lang.String
Description the workflow action to be executed after the restriction link has been modified
Mandatory no

Method Parameter
acceptedOverrideList
Type java.util.List [java.lang.Long]
Description the accepted validation override ids
Mandatory no

Method Parameter
restrictionLinkId
Type java.math.BigDecimal
Description the restriction link id
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 78 of 424


AFP Interface Specification

Method Parameter
restrictionLink
Type ModifyInvestmentPolicyStatementRestrictionLinkTO
Description the restriction link details to be modified
Mandatory yes

1.15.14 removeInvestmentPolicyStatementRestrictionLink
Removes a restriction link.

Return Value
Type InvestmentPolicyStatementOrderOutputTO
Description the investment policy statement order details.

Method Parameter
userContext
Type UserContextTO
Description Holding general information about the user
Mandatory yes

Method Parameter
investmentPolicyStatementOrderId
Type java.lang.Long
Description the investment policy statement order id
Mandatory yes

Method Parameter
workflowAction
Type java.lang.String
Description the workflow action to be executed after the restriction link has been removed
Mandatory no

Method Parameter
acceptedOverrideList
Type java.util.List [java.lang.Long]
Description the accepted validation override ids
Mandatory no

Method Parameter
restrictionLinkId
Type java.math.BigDecimal
Description the restriction link id
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 79 of 424


AFP Interface Specification

1.15.15 addInvestmentPolicyStatementRestrictionAcknowledgement
Adds a restriction acknowledgement.

Return Value
Type InvestmentPolicyStatementOrderOutputTO
Description the investment policy statement order details.

Method Parameter
userContext
Type UserContextTO
Description Holding general information about the user
Mandatory yes

Method Parameter
investmentPolicyStatementOrderId
Type java.lang.Long
Description the investment policy statement order id
Mandatory yes

Method Parameter
workflowAction
Type java.lang.String
Description the workflow action to be executed
Mandatory no

Method Parameter
acceptedOverrideList
Type java.util.List [java.lang.Long]
Description the accepted validation override ids
Mandatory no

Method Parameter
restrictionLinkId
Type java.math.BigDecimal
Description the restriction link identifier
Mandatory yes

Method Parameter
restrictionAcknowledgement
Type AddInvestmentPolicyStatementRestrictionAcknowledgementTO
Description the acknowledgement for a restriction link
Mandatory yes

1.15.16 modifyInvestmentPolicyStatementRestrictionAcknowledgement
Modifies a restriction acknowledgement.

Return Value
Type InvestmentPolicyStatementOrderOutputTO
Description the investment policy statement order details.

Copyright 201, Avaloq Evolution AG Page 80 of 424


AFP Interface Specification

Method Parameter
userContext
Type UserContextTO
Description Holding general information about the user
Mandatory yes

Method Parameter
investmentPolicyStatementOrderId
Type java.lang.Long
Description the investment policy statement order id
Mandatory yes

Method Parameter
workflowAction
Type java.lang.String
Description the workflow action to be executed
Mandatory no

Method Parameter
acceptedOverrideList
Type java.util.List [java.lang.Long]
Description the accepted validation override ids
Mandatory no

Method Parameter
restrictionLinkId
Type java.math.BigDecimal
Description the restriction link identifier
Mandatory yes

Method Parameter
restrictionAcknowledgementId
Type InvestmentPolicyStatementRestrictionAcknowledgementIdentifierTO
Description the restriction acknowledgment identifier
Mandatory yes

Method Parameter
restrictionAcknowledgement
Type ModifyInvestmentPolicyStatementRestrictionAcknowledgementTO
Description the acknowledgement for a restriction link
Mandatory yes

1.15.17 removeInvestmentPolicyStatementRestrictionAcknowledgement
Removes a restriction acknowledgement.

Return Value
Type InvestmentPolicyStatementOrderOutputTO
Description the investment policy statement order details.

Copyright 201, Avaloq Evolution AG Page 81 of 424


AFP Interface Specification

Method Parameter
userContext
Type UserContextTO
Description Holding general information about the user
Mandatory yes

Method Parameter
investmentPolicyStatementOrderId
Type java.lang.Long
Description the investment policy statement order id
Mandatory yes

Method Parameter
workflowAction
Type java.lang.String
Description the workflow action to be executed
Mandatory no

Method Parameter
acceptedOverrideList
Type java.util.List [java.lang.Long]
Description the accepted validation override ids
Mandatory no

Method Parameter
restrictionLinkId
Type java.math.BigDecimal
Description the restriction link identifier
Mandatory yes

Method Parameter
restrictionAcknowledgementId
Type InvestmentPolicyStatementRestrictionAcknowledgementIdentifierTO
Description the restriction acknowledgment identifier
Mandatory yes

1.15.18 addInvestmentPolicyStatementAssetAcknowledgement
Adds an asset acknowledgement.

Return Value
Type InvestmentPolicyStatementOrderOutputTO
Description the investment policy statement order details.

Method Parameter
userContext
Type UserContextTO
Description Holding general information about the user
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 82 of 424


AFP Interface Specification

Method Parameter
investmentPolicyStatementOrderId
Type java.lang.Long
Description the investment policy statement order id
Mandatory yes

Method Parameter
workflowAction
Type java.lang.String
Description the workflow action to be executed
Mandatory no

Method Parameter
acceptedOverrideList
Type java.util.List [java.lang.Long]
Description the accepted validation override ids
Mandatory no

Method Parameter
assetAcknowledgement
Type AddInvestmentPolicyStatementAssetAcknowledgementTO
Description the acknowledgement for an asset link
Mandatory yes

1.15.19 modifyInvestmentPolicyStatementAssetAcknowledgement
Modifies an asset acknowledgement.

Return Value
Type InvestmentPolicyStatementOrderOutputTO
Description the investment policy statement order details.

Method Parameter
userContext
Type UserContextTO
Description Holding general information about the user
Mandatory yes

Method Parameter
investmentPolicyStatementOrderId
Type java.lang.Long
Description the investment policy statement order id
Mandatory yes

Method Parameter
workflowAction
Type java.lang.String
Description the workflow action to be executed
Mandatory no

Copyright 201, Avaloq Evolution AG Page 83 of 424


AFP Interface Specification

Method Parameter
acceptedOverrideList
Type java.util.List [java.lang.Long]
Description the accepted validation override ids
Mandatory no

Method Parameter
assetAcknowledgementId
Type InvestmentPolicyStatementAssetAcknowledgementIdentifierTO
Description the asset acknowledge identifier
Mandatory yes

Method Parameter
assetAcknowledgement
Type ModifyInvestmentPolicyStatementAssetAcknowledgementTO
Description the acknowledgement for an asset link
Mandatory yes

1.15.20 removeInvestmentPolicyStatementAssetAcknowledgement
Removes an asset acknowledgement.

Return Value
Type InvestmentPolicyStatementOrderOutputTO
Description the investment policy statement order details.

Method Parameter
userContext
Type UserContextTO
Description Holding general information about the user
Mandatory yes

Method Parameter
investmentPolicyStatementOrderId
Type java.lang.Long
Description the investment policy statement order id
Mandatory yes

Method Parameter
workflowAction
Type java.lang.String
Description the workflow action to be executed
Mandatory no

Method Parameter
acceptedOverrideList
Type java.util.List [java.lang.Long]
Description the accepted validation override ids
Mandatory no

Copyright 201, Avaloq Evolution AG Page 84 of 424


AFP Interface Specification

Method Parameter
assetAcknowledgementId
Type InvestmentPolicyStatementAssetAcknowledgementIdentifierTO
Description the asset acknowledge identifier
Mandatory yes

1.15.21 addInvestmentPolicyStatementContainerLink
Adds a container link to the investment policy statement.

Return Value
Type InvestmentPolicyStatementOrderOutputTO
Description the investment policy statement order details.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user
Mandatory yes

Method Parameter
investmentPolicyStatementOrderId
Type java.lang.Long
Description the investment policy statement order id
Mandatory yes

Method Parameter
workflowAction
Type java.lang.String
Description the workflow action to be executed after the container link has been added
Mandatory no

Method Parameter
acceptedOverrideList
Type java.util.List [java.lang.Long]
Description the accepted validation override ids
Mandatory no

Method Parameter
containerLink
Type AddInvestmentPolicyStatementContainerLinkTO
Description the container link that must be added
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 85 of 424


AFP Interface Specification

1.15.22 modifyInvestmentPolicyStatementContainerLink
Modifies a container link.

Return Value
Type InvestmentPolicyStatementOrderOutputTO
Description the investment policy statement order details.

Method Parameter
userContext
Type UserContextTO
Description Holding general information about the user
Mandatory yes

Method Parameter
investmentPolicyStatementOrderId
Type java.lang.Long
Description the investment policy statement order id
Mandatory yes

Method Parameter
workflowAction
Type java.lang.String
Description the workflow action to be executed after the container link has been modified
Mandatory no

Method Parameter
acceptedOverrideList
Type java.util.List [java.lang.Long]
Description the accepted validation override ids
Mandatory no

Method Parameter
containerLinkId
Type InvestmentPolicyStatementContainerLinkIdentifierTO
Description the container link identifier
Mandatory yes

Method Parameter
containerLink
Type ModifyInvestmentPolicyStatementContainerLinkTO
Description the container link details that must be modified
Mandatory yes

1.15.23 removeInvestmentPolicyStatementContainerLink
Removes a container link.

Return Value
Type InvestmentPolicyStatementOrderOutputTO
Description the investment policy statement order details.

Copyright 201, Avaloq Evolution AG Page 86 of 424


AFP Interface Specification

Method Parameter
userContext
Type UserContextTO
Description Holding general information about the user
Mandatory yes

Method Parameter
investmentPolicyStatementOrderId
Type java.lang.Long
Description the investment policy statement order id
Mandatory yes

Method Parameter
workflowAction
Type java.lang.String
Description the workflow action to be executed after the container link has been removed
Mandatory no

Method Parameter
acceptedOverrideList
Type java.util.List [java.lang.Long]
Description the accepted validation override ids
Mandatory no

Method Parameter
containerLinkId
Type InvestmentPolicyStatementContainerLinkIdentifierTO
Description the container link identifier
Mandatory yes

1.15.24 getEfficientFrontierAnalytics
Gets the raw analytics data provided by SwissQuant for a given efficient frontier and currency.

Return Value
Type EfficientFrontierAnalyticsOutputTO
Description A response object which holds the raw response text of the efficient frontier analytics
request
Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
query
Type EfficientFrontierAnalyticsQueryTO
Description EfficientFrontierAnalyticsQueryTO providing additional parameters. Cannot be null.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 87 of 424


AFP Interface Specification

1.15.25 getStrategicAssetAllocationAnalytics
Gets the raw analytics data provided by SwissQuant for a given strategic asset allocation.

Return Value
Type StrategicAssetAllocationAnalyticsOutputTO
Description A response object which holds the raw response text of the strategic asset allocation
analytics request
Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
query
Type StrategicAssetAllocationAnalyticsQueryTO
Description StrategicAssetAllocationAnalyticsQueryTO providing additional parameters. Cannot be null.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 88 of 424


AFP Interface Specification

1.16 BaseBankData
The web service to retrieve static data.

1.16.1 getCurrencyList
Returns currencies in a default representation.

Return Value
Type CurrencyListOutputTO
Description Currencies in a default representation.

Method Parameter
userContext
Type UserContextTO
Description Holding general information about the user.
Mandatory yes

Method Parameter
currencyIdList
Type java.util.List [java.lang.Long]
Description A list of currencies internal references. The method returns only this currencies. If the list is
null or empty returns all currencies.
Mandatory no

1.16.2 getBusinessUnitDefaultCurrency
Returns the business unit's default currency.

Return Value
Type CurrencyOutputTO
Description business unit's default currency

Method Parameter
userContext
Type UserContextTO
Description Holding general information about the user.
Mandatory yes

1.16.3 getBusinessUnitBankDate
Returns the business unit's bank date.

Return Value
Type DateOutputTO
Description business unit's bank date

Copyright 201, Avaloq Evolution AG Page 89 of 424


AFP Interface Specification

Method Parameter
userContext
Type UserContextTO
Description Holding general information about the user.
Mandatory yes

1.16.4 getBusinessUnitHolidayList
Returns the business unit's holiday list.

Return Value
Type HolidayListOutputTO
Description business unit's holiday list

Method Parameter
userContext
Type UserContextTO
Description Holding general information about the user.
Mandatory yes

1.16.5 getCountryList
Retrieves countries in a default representation.

Return Value
Type CountryListOutputTO
Description The country information for the provided identifiers. If the input list is null or empty, then all
countries are retrieved.
Method Parameter
userContext
Type UserContextTO
Description Holding general information about the user.
Mandatory yes

Method Parameter
countryIdList
Type java.util.List [java.lang.Long]
Description a list of country identifiers
Mandatory no

Copyright 201, Avaloq Evolution AG Page 90 of 424


AFP Interface Specification

1.16.6 getCommonCountryList
Retrieves common countries in a default representation.
Common countries are defined in application configuration and in this context it means countries that are commonly used.

Return Value
Type IdListOutputTO
Description List of common countries in a default representation.

Method Parameter
userContext
Type UserContextTO
Description Holding general information about the user.
Mandatory yes

1.16.7 getBusinessUnitCountry
Retrieves the country of the business unit of the current user.

Return Value
Type CountryOutputTO
Description the country information

Method Parameter
userContext
Type UserContextTO
Description holds general information about the current user
Mandatory yes

1.16.8 getCurrencyById
Retrieves the currency for the given id.

Return Value
Type CurrencyOutputTO
Description the currency found with the given id.

Method Parameter
userContext
Type UserContextTO
Description Holding general information about the user.
Mandatory yes

Method Parameter
currencyId
Type long
Description the id used to retrieve the currency.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 91 of 424


AFP Interface Specification

1.16.9 getCurrencyConversion
Currency conversion of list of values.

Return Value
Type CurrencyConversionOutputTO
Description CurrencyConversionOutputTO

Method Parameter
userContext
Type UserContextTO
Description Holding general information about the user.
Mandatory yes

Method Parameter
parameters
Type CurrencyConversionParametersTO
Description currency conversion parameters
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 92 of 424


AFP Interface Specification

1.17 AttentionItemCounter
Web service implementation holding methods for retrieving various counters that need attention of the end user.

1.17.1 retrieveCounters
Retrieve attention items counters configured in the system. If a filter is provided only the provided subset will be calculated.

Return Value
Type AttentionItemCounterOutputTO
Description response object holding the number of occurrences for each counter.

Method Parameter
userContext
Type UserContextTO
Description Holding general information about the user.
Mandatory yes

Method Parameter
counterQuery
Type AttentionItemCounterQueryTO
Description a filter to limit the counters to be retrieved.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 93 of 424


AFP Interface Specification

1.18 AppointmentService
Appointment web service to create/read/update/delete CRM issue appointments with BBS.

1.18.1 createAppointment
Create a new appointment.

Return Value
Type AppointmentOutputTO
Description A response object with the appointment if everything is correct or otherwise a list of
notifications.
Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
requestHead
Type com.avaloq.bbs.common.NewReqHead
Description The request head.
Mandatory yes

Method Parameter
appointment
Type com.avaloq.bbs.crm_issue.Appointment
Description The appointment.
Mandatory yes

1.18.2 modifyAppointment
Modify an existing appointment.

Return Value
Type AppointmentOutputTO
Description A response object with the appointment if everything is correct or otherwise a list of
notifications.
Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
requestHead
Type com.avaloq.bbs.common.MdfReqHead
Description The request head.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 94 of 424


AFP Interface Specification

Method Parameter
appointment
Type com.avaloq.bbs.crm_issue.Appointment
Description The appointment.
Mandatory yes

1.18.3 getAppointment
Retrieve an existing appointment.

Return Value
Type AppointmentOutputTO
Description A response object with the appointment if everything is correct or otherwise a list of
notifications.
Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
requestHead
Type com.avaloq.bbs.common.GetReqHead
Description The request head.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 95 of 424


AFP Interface Specification

1.19 ClientData
Web service implementation holding methods for the client data service.

1.19.1 getPortfolioList
Returns container portfolios in a default representation.

Return Value
Type PortfolioListOutputTO
Description Container portfolios in a default representation.

Method Parameter
userContext
Type UserContextTO
Description Holding general information about the user.
Mandatory yes

Method Parameter
portfolioQueryTo
Type PortfolioQueryTO
Description A query object containing a list of portfolio internal references. The method returns only this
container portfolios. If the list is null or empty returns all container portfolios.
Mandatory yes

Method Parameter
parameters
Type PortfolioParametersTO
Description A parameters object that specify different ways the method can work
Mandatory yes

1.19.2 getIpsList
Returns IPS in a default representation.

Return Value
Type IpsListOutputTO
Description IPSs in a default representation

Method Parameter
userContext
Type UserContextTO
Description Holding general information about the user.
Mandatory yes

Method Parameter
ipsQueryTo
Type IpsQueryTO
Description A query object containing a list of IPS internal references. The method returns only this IPS. If
the list is null or empty returns all IPSs.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 96 of 424


AFP Interface Specification

Method Parameter
parameters
Type IpsParametersTO
Description A parameters object that specify different ways the method can work
Mandatory yes

1.19.3 getBusinessPartnerList
Returns business partners in a default representation.

Return Value
Type BusinessPartnerListOutputTO
Description Business partners in a default representation.

Method Parameter
userContext
Type UserContextTO
Description Holding general information about the user.
Mandatory yes

Method Parameter
businessPartnerQueryTo
Type BusinessPartnerQueryTO
Description A query object containing a list of business partner internal references. The method returns
only this business partners. If the list is null or empty returns all business partners.
Mandatory yes

1.19.4 getBusinessPartnerAddressList
Returns domicile address b of the person which belongs to the given business partner.

Return Value
Type java.util.List
Description List of BusinessPartnerAddress for business partner which has a Domicile address.

Method Parameter
userContext
Type UserContextTO
Description Holding general information about the user.
Mandatory yes

Method Parameter
businessPartnerAddressQueryTo
Type BusinessPartnerAddressQueryTO
Description A query object a list of business partner id's.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 97 of 424


AFP Interface Specification

Copyright 201, Avaloq Evolution AG Page 98 of 424


AFP Interface Specification

1.20 Position
Web service for position data.

1.20.1 getPositionList
Returns list of positions (can include money accounts). The parameter PositionQueryTO can be used to set query criteria.
If no criteria is specified in the query object, all positions to which the user has access to will be returned.

Return Value
Type PositionListOutputTO
Description PositionListOutputTO containing list of positions matching the query criteria.

Method Parameter
userContext
Type UserContextTO
Description User context. Cannot be null.
Mandatory yes

Method Parameter
query
Type PositionQueryTO
Description PositionQueryTO object containing query criteria. Cannot be null.
Mandatory yes

Method Parameter
parameters
Type PositionParametersTO
Description PositionParametersTO providing additional parameters. Cannot be null.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 99 of 424


AFP Interface Specification

1.21 AssetAllocation
Web service implementation holding methods for the asset allocation service.

1.21.1 getAssetAllocationTreeList
Get a full list of available asset allocation trees.

Return Value
Type AssetAllocationTreeListOutputTO
Description tree list containing references to asset allocation trees.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
query
Type AssetAllocationTreeQueryTO
Description Query object containing a list of asset allocation ids to get the trees for (empty in order to
retrieve all)
Mandatory yes

1.21.2 getAssetAllocationNodeMappingList
Get a full list of available asset allocation node mappings.

Return Value
Type AssetAllocationNodeMappingListOutputTO
Description mapping list containing references to asset allocation node mappings.

Method Parameter
userContext
Type UserContextTO
Description user context
Mandatory yes

Method Parameter
query
Type AssetAllocationNodeMappingQueryTO
Description Query object containing a list of asset allocation ids and / or a list of asset ids
Mandatory yes

Method Parameter
parameters
Type AssetAllocationNodeMappingParametersTO
Description Internal control parameters
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 100 of 424


AFP Interface Specification

Copyright 201, Avaloq Evolution AG Page 101 of 424


AFP Interface Specification

1.22 UserManagementService
Service used by authentication service (Medusa) to register and update (portal) users.

1.22.1 createUser
Service to perform self registration of users.

Return Value
Type com.avaloq.bbs.user_mngt.UserRegResult
Description The login the user will be able to use along with the roles to be used in the authentication
server as well as the portal.
Method Parameter
userBusinessUnitId
Type java.lang.Long
Description business unit in which the new user will be created.
Mandatory yes

Method Parameter
userReg
Type com.avaloq.bbs.user_mngt.UserReg
Description Contains the information entered by the user in medusa
Mandatory yes

1.22.2 updateUser
Service to update select properties of afs users.

Return Value
Type void
Description No return value

Method Parameter
userBusinessUnitId
Type java.lang.Long
Description business unit in which the user lives.
Mandatory yes

Method Parameter
userUpd
Type com.avaloq.bbs.user_mngt.UserUpd
Description Contains the information to be updated.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 102 of 424


AFP Interface Specification

1.23 PaymentOverview
The WebService holding methods for fetching and reading payment information, but now directly providing facilities for
making modifications to these payments.

1.23.1 getPaymentOrderOverviewList
Finds a list of payment orders according to the specified criteria.
The nature of the results may vary according to the input parameters used.

Return Value
Type PaymentOrderOverviewListOutputTO
Description A list of payment order.

Method Parameter
userContext
Type UserContextTO
Description Holding general information about the user.
Mandatory yes

Method Parameter
paymentOrderOverviewQuery
Type PaymentOrderOverviewQueryTO
Description The query parameters for the payment order overview search.
Mandatory yes

1.23.2 getPaymentOrder
Returns a specific payment order.

Return Value
Type BasePaymentOrderOutputTO
Description The actual version of a specific payment order.

Method Parameter
userContext
Type UserContextTO
Description Holding general information about the user.
Mandatory yes

Method Parameter
paymentOrderId
Type long
Description The internal reference of the payment order.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 103 of 424


AFP Interface Specification

1.23.3 getPaymentCordOrder
Returns a specific cord payment order.

Return Value
Type PaymentCordOrderOutputTO
Description The actual version of a specific payment cord order.

Method Parameter
userContext
Type UserContextTO
Description Holding general information about the user.
Mandatory yes

Method Parameter
paymentCordOrderId
Type long
Description The internal reference of the payment cord order.
Mandatory yes

Method Parameter
paymentCordQuery
Type PaymentCordQueryTO
Description The query to find payments in a cord order.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 104 of 424


AFP Interface Specification

1.24 ServerInfo
Web service to retrieve information about the ACP availability as well as server and its status.

1.24.1 getServerInfo
Service to retrieve the current server version.

Return Value
Type ServerInfoTO
Description serverInfoTO with the server information

Method Parameter
userContext
Type UserContextTO
Description the user context.
Mandatory yes

1.24.2 isAcpAvailable
Retrieve the availability status of ACP.

Return Value
Type AcpAvailabilityOutputTO
Description A response object holding availability status of ACP and error notification in case of
unavailability.
Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 105 of 424


AFP Interface Specification

1.25 Signature
Dedicated service to upload/download/delete signature images.

1.25.1 uploadSignature
Uploads a signature.

Return Value
Type UploadSignatureOutputTO
Description wrapper for the key to access the new signature

Method Parameter
userContext
Type UserContextTO
Description Current user context.
Mandatory yes

Method Parameter
input
Type UploadSignatureInputTO
Description Wrapper for content type, content and filename
Mandatory yes

1.25.2 downloadSignature
Downloads a signature.

Return Value
Type DownloadSignatureOutputTO
Description a wrapper for value with mime-type

Method Parameter
userContext
Type UserContextTO
Description Current user context
Mandatory yes

Method Parameter
input
Type DownloadSignatureInputTO
Description Wraps the key of the signature to be downloaded
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 106 of 424


AFP Interface Specification

1.25.3 deleteSignature
Deletes an existing signature.

Return Value
Type DeleteSignatureOutputTO
Description basically void

Method Parameter
userContext
Type UserContextTO
Description Current user context
Mandatory yes

Method Parameter
input
Type DeleteSignatureInputTO
Description Wrapper for the key of the signature to be deleted
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 107 of 424


AFP Interface Specification

1.26 NotificationSubscription
Service providing operations to manage subscriptions for the currently authenticated user.

Subscriptions allow users to request to be notified when an event is published of the correct type and whose properties match
the filtering criteria defined on the subscription. Users can also express delivery preferences for matched notifications through
a set of linked delivery channel metadata.

When Avaloq Core is offline, subscriptions can be read but not modified using this service. Attempts to do so will result in a
timeout.

1.26.1 createNotificationSubscription
Creates a new notification subscription for the currently authenticated user.

Return Value
Type NotificationSubscriptionOutputTO
Description The details of the created subscription, including the id, or an error response

Method Parameter
userContext
Type UserContextTO
Description The general request parameters, not currently used by this operation.
Mandatory yes

Method Parameter
subscriptionTO
Type NotificationSubscriptionTO
Description The details of the requested subscription. The id field will be ignored.
Mandatory yes

1.26.2 updateNotificationSubscription
Updates a notification subscription associated with the currently authenticated user.

Return Value
Type NotificationSubscriptionOutputTO
Description The details of the updated subscription, or an error response

Method Parameter
userContext
Type UserContextTO
Description The general request parameters, not currently used by this operation.
Mandatory yes

Method Parameter
subscriptionTO
Type NotificationSubscriptionTO
Description The details of the requested update. The id field must be set to the id of an existing
subscription of the authenticated user. If a field is not set in this object, the corresponding
field in the subscription will be cleared.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 108 of 424


AFP Interface Specification

1.26.3 deleteNotificationSubscription
Deletes a notification subscription associated with the currently authenticated user.

Return Value
Type NotificationSubscriptionOutputTO
Description An empty response on success, or an error response if the deletion failed.

Method Parameter
userContext
Type UserContextTO
Description The general request parameters, not currently used by this operation.
Mandatory yes

Method Parameter
subscriptionId
Type java.lang.Long
Description The id of the notification subscription to be removed.
Mandatory yes

1.26.4 getNotificationSubscriptionList
Queries the notification subscriptions of the current user.

This method can be executed when Avaloq Core is offline.

Return Value
Type NotificationSubscriptionListOutputTO
Description The details of the requested subscriptions, or an error response.

Method Parameter
userContext
Type UserContextTO
Description The general input parameters, not currently used by this operation.
Mandatory yes

Method Parameter
query
Type NotificationSubscriptionQueryTO
Description The query conditions to match when searching for subscriptions.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 109 of 424


AFP Interface Specification

1.26.5 getPresentationData
Queries for event types which are subscribable by the current user.

This method can be executed when Avaloq Core is offline.

Return Value
Type NotificationFrameworkPresentationDataOutputTO
Description The details of event types available for subscription, or an error response.

Method Parameter
userContext
Type UserContextTO
Description The general input parameters; language is used to provide internationalised strings.
Mandatory yes

1.26.6 getDeliveryChannelList
Queries for all delivery channels which can be requested by the current user.

This method can be executed when Avaloq Core is offline.

Return Value
Type NotificationDeliveryChannelListOutputTO
Description The details of available delivery channels, or an error response.

Method Parameter
userContext
Type UserContextTO
Description The general input parameters; language is used to provide internationalised strings.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 110 of 424


AFP Interface Specification

1.27 Collaboration
The web service to work with collaboration issues and to retrieve collaboration meta data and issues.

1.27.1 getCollaborationIssueMetaData
Returns the meta data relevant for collaboration issues.

Return Value
Type CollaborationIssueMetaDataOutputTO
Description A response object which holds the meta data relevant to collaboration issues with
notification messages.
Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

1.27.2 createCollaborationIssue
Creates a new issue. Sets default values on the issue in case no values were provided, verifies the issue and saves it on the
database.

Return Value
Type CollaborationIssueOutputTO
Description A response object which holds the stored issue if everything is correct or otherwise a list of
notifications.
Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
issue
Type CollaborationIssueCreationTO
Description The new issue to create.
Mandatory yes

1.27.3 getCollaborationIssueList
Returns a list of issues that match the query conditions. If the id is set on the query all other query conditions are ignored.

Return Value
Type CollaborationIssueListOutputTO
Description A response object which holds a list of issues that match the query conditions if everything
is correct or otherwise a list of notifications.

Copyright 201, Avaloq Evolution AG Page 111 of 424


AFP Interface Specification

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
query
Type CollaborationIssueQueryTO
Description The query conditions to match when searching for issues.
Mandatory yes

Method Parameter
parameters
Type CollaborationParametersTO
Description the query parameters
Mandatory no

1.27.4 addComment
Returns a list of issues that match the query conditions. If the id is set on the query all other query conditions are ignored.

Return Value
Type OutputTO
Description A response object which holds a list of notifications.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
comment
Type CollaborationIssueCommentTO
Description collaboration comment
Mandatory yes

1.27.5 closeCollaborationIssues
Close a list of issues. Checks that mandatory fields are set and that the values are valid.

Return Value
Type OutputTO
Description A response object which is empty if everything is correct or otherwise holds a list of
notifications.

Copyright 201, Avaloq Evolution AG Page 112 of 424


AFP Interface Specification

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
issueIdList
Type java.util.List [java.lang.Long]
Description List of internal references of issues that should be closed.
Mandatory yes

1.27.6 getCollaborationIssueAttachment
Retrieve a specific attachment.

Return Value
Type DocumentOutputTO
Description A response object which holds the document data if everything is correct or otherwise a list
of notifications.
Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
key
Type java.lang.String
Description the key of the attachment
Mandatory yes

1.27.7 addCollaborationIssueAttachment
Add a specific attachment.

Return Value
Type DocumentKeyOutputTO
Description A response object which holds the key to later retrieve the stored document case everything
is correct, otherwise a list of error notifications.
Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 113 of 424


AFP Interface Specification

Method Parameter
attachment
Type DocumentInputTO
Description the attachment data
Mandatory yes

1.27.8 getUnreadIssuesCount
Retrieve the count of unread issues.

Return Value
Type LongOutputTO
Description A response object which contains the count of unread issues in the attribute resultValue.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

1.27.9 getNotificationEventType
Retrieve the CodeTO of the notification event type for collaboration.

Return Value
Type CodeOutputTO
Description A response object which contains the notification event type GUID in the attribute
resultValue.
Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 114 of 424


AFP Interface Specification

1.28 Performance
The Performance web service provides access to performance figures.

1.28.1 getBusinessObjectsPerformance
Returns performance figures for the query objects.

Return Value
Type PerformanceListOutputTO
Description PerformanceListOutputTO containing performance figures.

Method Parameter
userContext
Type UserContextTO
Description Current user context.
Mandatory yes

Method Parameter
query
Type PerformanceQueryTO
Description the query parameters.
Mandatory yes

1.28.2 getBusinessObjectsHistoricalPerformance
Returns historical performance figures for the query objects.

Return Value
Type PerformanceListOutputTO
Description PerformanceListOutputTO containing performance figures.

Method Parameter
userContext
Type UserContextTO
Description Current user context.
Mandatory yes

Method Parameter
query
Type HistoricalPerformanceQueryTO
Description the query parameters.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 115 of 424


AFP Interface Specification

1.29 TaskService
Task web service to create/read/update/delete CRM issue tasks with BBS.

1.29.1 createTask
Create a new task.

Return Value
Type TaskOutputTO
Description A response object with the task if everything is correct or otherwise a list of notifications.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
requestHead
Type com.avaloq.bbs.common.NewReqHead
Description The request head.
Mandatory yes

Method Parameter
task
Type com.avaloq.bbs.crm_issue.Task
Description The task.
Mandatory yes

1.29.2 modifyTask
Modify an existing task.

Return Value
Type TaskOutputTO
Description A response object with the task if everything is correct or otherwise a list of notifications.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
requestHead
Type com.avaloq.bbs.common.MdfReqHead
Description The request head.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 116 of 424


AFP Interface Specification

Method Parameter
task
Type com.avaloq.bbs.crm_issue.Task
Description The task.
Mandatory yes

1.29.3 getTask
Retrieve an existing task.

Return Value
Type TaskOutputTO
Description A response object with the task if everything is correct or otherwise a list of notifications.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

Method Parameter
requestHead
Type com.avaloq.bbs.common.GetReqHead
Description The request head.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 117 of 424


AFP Interface Specification

1.30 UserInfo
Web service to retrieve information about and related to the authenticated user.

1.30.1 getUser
Retrieve the authenticated user.

Return Value
Type UserOutputTO
Description A response object holding the user or a list of notifications in case of an error.

Method Parameter
userContext
Type UserContextTO
Description Object holding general information about the user.
Mandatory yes

1.30.2 getContactInformationList
Retrieve the list of contact information (ACP addresses) for the logged in user and contact medium.

Return Value
Type ContactInformationListOutputTO
Description A response object holding the list of contact information (ACP addresses)

Method Parameter
userContext
Type UserContextTO
Description object holding general information about the user
Mandatory yes

Method Parameter
contactMedium
Type com.avaloq.afs.server.database.enumeration.UserContactInformationMedium
Description the contact medium, eg corresponding to email or mobile
Mandatory yes

1.30.3 getFunctionalAccessCodeList
Retrieve the list of functional access codes for the logged in user.

Return Value
Type FunctionalAccessCodeListOutputTO
Description A response object holding the list of functional access codes.

Copyright 201, Avaloq Evolution AG Page 118 of 424


AFP Interface Specification

Method Parameter
userContext
Type UserContextTO
Description object holding general information about the user
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 119 of 424


AFP Interface Specification

2. Avaloq Web Parameter Description

2.1 com.avaloq.afs.server.bsp.ws.to.advisorycollection
2.1.0 AdvisoryOutputTO
This class represents a general response (transfer object) message. It's the base class used for all responses to the web
service client. It contains the servers date and a general list of notification.
The full name
com.avaloq.afs.server.bsp.ws.to.advisorycollection.AdvisoryOutputTO
Parameters
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.1.1 AdvisoryCollectionTO
This class represents a base collection.

The full name


com.avaloq.afs.server.bsp.ws.to.advisorycollection.AdvisoryCollectionTO
Parameters
collectionItemType
Type BusinessObjectType
Description The type of the item objects supported by the collection
Mandatory yes
startDate
Type java.util.Date
Description Contains the start date of the collection object.
Mandatory yes
closeDate
Type java.util.Date
Description Contains the close date of the collection object.
Mandatory yes
name
Type java.lang.String
Description Collection name.
Mandatory no
max Length 200
Example Schweizer Kunden
temporary
Type boolean
Description True, if the collection is a temporary collection. Default value is false.
Mandatory yes
editable
Type boolean
Description True, if the collection is editable. Default value is false.
Mandatory yes
delegationsEditable
Type boolean
Description True, if the collection is delegations editable. Default value is false.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 120 of 424


AFP Interface Specification

Parameters
defaultCollection
Type boolean
Description True, if the collection is the default collection. Default value is false.
Mandatory yes
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.1.2 AdvisoryCollectionOutputTO
The advisory collection output TO.

The full name


com.avaloq.afs.server.bsp.ws.to.advisorycollection.AdvisoryCollectionOutputTO
Parameters
collection
Type AdvisoryCollectionTO
Description Advisory Collection TO
Mandatory yes
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 121 of 424


AFP Interface Specification

2.2 com.avaloq.afs.server.bsp.ws.to.afscollection
2.2.0 CollectionListOutputTO
The list of collections.

The full name


com.avaloq.afs.server.bsp.ws.to.afscollection.CollectionListOutputTO
Parameters
resultList
Type java.util.List [CollectionTO]
Description The list of collections.
Mandatory yes
pagingResult
Type PagingResultTO
Description The paging result. Only used for paged queries.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.2.1 CollectionTO
This class represents a base collection.

The full name


com.avaloq.afs.server.bsp.ws.to.afscollection.CollectionTO
Parameters
collectionItemType
Type BusinessObjectType
Description The type of the item objects supported by the collection
Mandatory yes
startDate
Type java.util.Date
Description Contains the start date of the collection object.
Mandatory yes
closeDate
Type java.util.Date
Description Contains the close date of the collection object.
Mandatory yes
name
Type java.lang.String
Description Collection name.
Mandatory no
max Length 200
Example Schweizer Kunden
temporary
Type boolean
Description True, if the collection is a temporary collection. Default value is false.
Mandatory yes
editable
Type boolean
Description True, if the collection is editable. Default value is false.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 122 of 424


AFP Interface Specification

Parameters
delegationsEditable
Type boolean
Description True, if the collection is delegations editable. Default value is false.
Mandatory yes
defaultCollection
Type boolean
Description True, if the collection is the default collection. Default value is false.
Mandatory yes
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 123 of 424


AFP Interface Specification

2.3 com.avaloq.afs.server.bsp.ws.to.asset
2.3.0 AssetListItemTO
Transports the data of an asset.

The full name


com.avaloq.afs.server.bsp.ws.to.asset.AssetListItemTO
Parameters
name
Type java.lang.String
Description The name.
Mandatory no
nominalCurrency
Type SimpleBusinessObjectTO
Description The nominal currency.
Mandatory yes
keys
Type java.util.List [SimpleKeyTO]
Description The asset keys.
Mandatory yes
classes
Type java.util.List [SimpleClassTO]
Description The asset classes.
Mandatory yes
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.3.1 AssetTypeListOutputTO
Asset type list.

The full name


com.avaloq.afs.server.bsp.ws.to.asset.AssetTypeListOutputTO
Parameters
resultList
Type java.util.List [ObjectClassTypeTO]
Description The list of assets types.
Mandatory yes
pagingResult
Type PagingResultTO
Description The paging result. Only used for paged queries.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 124 of 424


AFP Interface Specification

2.3.2 AssetSearchQueryTO
The query to search for tradeable assets.

The full name


com.avaloq.afs.server.bsp.ws.to.asset.AssetSearchQueryTO
Parameters
search
Type java.lang.String
Description The search term.
Mandatory no
Example CH0012221716
searchField
Type AssetSearchField
Description The field to search in.
Mandatory yes
classTypeIds
Type java.util.List [java.lang.Long]
Description a list of class type IDs types to look up.
Mandatory yes
maximumResultSize
Type java.lang.Integer
Description The maximum number of assets to return.
Mandatory no
sortedBy
Type java.util.List [QuerySortTO]
Description The query sorting.
Mandatory yes
objectExtensionQuery
Type ObjectExtensionQueryTO
Description The object extension query.
Mandatory yes

2.3.3 ListingTO

The full name


com.avaloq.afs.server.bsp.ws.to.asset.ListingTO
Parameters
currencyId
Type java.lang.Long
Description The currency internal id
Mandatory yes
marketCountryId
Type java.lang.Long
Description The internal id of the country on the market
Mandatory yes
marketId
Type java.lang.Long
Description The market internal id.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 125 of 424


AFP Interface Specification

Parameters
marketCode
Type java.lang.String
Description The marketCode
Mandatory yes
marketName
Type java.lang.String
Description The marketName
Mandatory yes
quantityDrivenTradingUnit
Type java.math.BigDecimal
Description The quantityDrivenTradingUnit
Mandatory no
quantityDrivenMinimumTradingUnit
Type java.math.BigDecimal
Description The minimQtyDrivenTradingUnit
Mandatory no
moneyDrivenTradingUnit
Type java.math.BigDecimal
Description The moneyDrivenTradingUnit
Mandatory no
moneyDrivenMinimumTradingUnit
Type java.math.BigDecimal
Description The moneyDrivenMinimumTradingUnit
Mandatory no
isBestExec
Type boolean
Description is best execution
Mandatory yes
isTradePlace
Type boolean
Description is trade place
Mandatory yes
tradable
Type boolean
Description
Mandatory yes
getPrice
Type boolean
Description is get price enabled on this listing.
Mandatory yes
lastPrice
Type java.math.BigDecimal
Description last price on that listing.
Mandatory no
lastPriceDate
Type java.util.Date
Description last price date on that listing.
Mandatory no
priority
Type java.lang.Long
Description the priority of that listing.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 126 of 424


AFP Interface Specification

2.3.4 SimpleListingTO
Simple Listing TO. Contains only some important fields of a Listing.

The full name


com.avaloq.afs.server.bsp.ws.to.asset.SimpleListingTO
Parameters
marketName
Type java.lang.String
Description
Mandatory yes
currencyId
Type java.lang.Long
Description
Mandatory yes
marketId
Type java.lang.Long
Description
Mandatory yes
marketCode
Type java.lang.String
Description
Mandatory yes
marketCountryId
Type java.lang.Long
Description
Mandatory yes

2.3.5 AssetParametersTO
Asset parameters TO.

The full name


com.avaloq.afs.server.bsp.ws.to.asset.AssetParametersTO
Parameters
includeDocumentsInfo
Type java.lang.Boolean
Description Include asset documentations into the response.
Mandatory yes

2.3.6 ListingListOutputTO
OutputTO for listings.

The full name


com.avaloq.afs.server.bsp.ws.to.asset.ListingListOutputTO
Parameters
resultList
Type java.util.List [ListingTO]
Description The list of listings.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 127 of 424


AFP Interface Specification

Parameters
pagingResult
Type PagingResultTO
Description The paging result. Only used for paged queries.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.3.7 AssetListOutputTO
Assets list.

The full name


com.avaloq.afs.server.bsp.ws.to.asset.AssetListOutputTO
Parameters
resultList
Type java.util.List [AssetTO]
Description The list of assets.
Mandatory yes
pagingResult
Type PagingResultTO
Description The paging result. Only used for paged queries.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.3.8 AssetTO
Transports the data of an asset.

The full name


com.avaloq.afs.server.bsp.ws.to.asset.AssetTO
Parameters
name
Type java.lang.String
Description The name of the asset
Mandatory no
symbol
Type java.lang.String
Description The asset's telekurs symbol (eg "UBSN")
Mandatory no
valor
Type java.lang.String
Description The asset's telekurs valor number (eg "24476758")
Mandatory no
isin
Type java.lang.String
Description The asset's ISIN (eg "CH0244767585")
Mandatory no

Copyright 201, Avaloq Evolution AG Page 128 of 424


AFP Interface Specification

Parameters
rating
Type java.lang.String
Description
Mandatory no
max Length 10
Example AAA
listedIn
Type AssetListedInTypeCodeEnum
Description Specifies how the asset is listed (percent, money, points, yield or simple discount).
Mandatory no
objectExtension
Type ObjectExtensionTO
Description The object extension.
Mandatory yes
linkedEDocumentInfoList
Type java.util.List [DocumentInfoTO]
Description List of linked asset EDocuments. This attribute is only initialized when the AssetQueryTO
Mandatory no
bookKeepingMethod
Type AssetBookKeepingMethodTypeCodeEnum
Description Specifies how bookKeeping is done for this asset (piece, nominal, contract, contract future,
contract future nominal).
Mandatory no
maturityDate
Type java.util.Date
Description The maturityDate
Mandatory no
residualMaturity
Type java.lang.Integer
Description The residual maturity = maturityDate - bankDate (in days).
Mandatory no
quantityUnitScale
Type java.math.BigDecimal
Description The default trading unit in the case of a quantity driven trade. Will be used for reports to
show the value with the appropriate decimal precision.
Mandatory no
isMoneyDrivenTradingCapable
Type boolean
Description The flag indicating whether the asset has support for money driven trading
Mandatory yes
defaultListing
Type SimpleListingTO
Description The default listing.
Mandatory no
classTypes
Type java.util.List [ObjectClassTypeTO]
Description List of Asset ObjectClassTypes.
Mandatory no
nominalCurrencyId
Type java.lang.Long
Description The nominal currency id.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 129 of 424


AFP Interface Specification

Parameters
riskCurrencyId
Type java.lang.Long
Description The risk currency id.
Mandatory yes
withdrawalLimit
Type java.math.BigDecimal
Description The withdrawal limit.
Mandatory no
withdrawalNoticePeriod
Type java.lang.Long
Description The withdrawal notice period.
Mandatory no
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.3.9 AssetListItemOutputTO
Assets list.

The full name


com.avaloq.afs.server.bsp.ws.to.asset.AssetListItemOutputTO
Parameters
resultList
Type java.util.List [AssetListItemTO]
Description The list of assets.
Mandatory yes
pagingResult
Type PagingResultTO
Description The paging result. Only used for paged queries.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.3.10 AssetOutputTO
Represents an asset.

The full name


com.avaloq.afs.server.bsp.ws.to.asset.AssetOutputTO
Parameters
asset
Type AssetTO
Description The asset.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 130 of 424


AFP Interface Specification

Parameters
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.3.11 DocumentInfoTO
Transfer object of a AssetEDocumentBO.

The full name


com.avaloq.afs.server.bsp.ws.to.asset.DocumentInfoTO
Parameters
documentId
Type java.lang.Long
Description Id of the EdoumentMetaData record.
Mandatory yes
displayName
Type java.lang.String
Description display name of the document.
Mandatory yes
max Length 200

Copyright 201, Avaloq Evolution AG Page 131 of 424


AFP Interface Specification

2.4 com.avaloq.afs.server.bsp.ws.to.assetallocation
2.4.0 AssetAllocationTreeQueryTO
Query object for the asset allocations.

The full name


com.avaloq.afs.server.bsp.ws.to.assetallocation.AssetAllocationTreeQueryTO
Parameters
assetAllocationIdList
Type java.util.List [java.lang.Long]
Description The asset allocations id list.
Mandatory yes
keys
Type java.util.List [java.lang.String]
Description The list of keys.
Mandatory yes

2.4.1 AssetAllocationNodeMappingEntryTO
This class represents an asset allocation.

The full name


com.avaloq.afs.server.bsp.ws.to.assetallocation.AssetAllocationNodeMappingEntryTO
Parameters
assetId
Type java.lang.Long
Description Asset id.
Mandatory yes
assetAllocationNodeId
Type java.lang.Long
Description Asset allocation node id.
Mandatory yes

2.4.2 AssetAllocationNodeMappingListOutputTO
The list of asset allocation node mappings.

The full name


com.avaloq.afs.server.bsp.ws.to.assetallocation.AssetAllocationNodeMappingListOutputTO
Parameters
assetAllocationNodeMappingList
Type java.util.List [AssetAllocationNodeMappingTO]
Description The list of asset allocation node mappings.
Mandatory yes
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 132 of 424


AFP Interface Specification

2.4.3 AssetAllocationNodeMappingParametersTO
Parameters to control the output of asset allocation node mapping operation.

The full name


com.avaloq.afs.server.bsp.ws.to.assetallocation.AssetAllocationNodeMappingParametersTO
Parameters
structuringAssetAllocationIdList
Type java.util.List [java.lang.Long]
Description Asset allocations used to structure the selected assets.
Mandatory yes

2.4.4 AssetAllocationNodeMappingTO
This class represents an asset allocation.

The full name


com.avaloq.afs.server.bsp.ws.to.assetallocation.AssetAllocationNodeMappingTO
Parameters
assetAllocationId
Type java.lang.Long
Description The asset allocation id.
Mandatory yes
mappings
Type java.util.List [AssetAllocationNodeMappingEntryTO]
Description Maps an asset id to an asset allocation tree node.
Mandatory yes

2.4.5 AssetAllocationNodeTO
This class represents an asset allocation tree node.

The full name


com.avaloq.afs.server.bsp.ws.to.assetallocation.AssetAllocationNodeTO
Parameters
name
Type java.lang.String
Description The name.
Mandatory yes
level
Type java.lang.Integer
Description The level number.
Mandatory yes
sequence
Type java.lang.Integer
Description The sequence number.
Mandatory yes
groupingType
Type AssetAllocationNodeGroupingType
Description The grouping type.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 133 of 424


AFP Interface Specification

Parameters
subNodes
Type java.util.List [AssetAllocationNodeTO]
Description The sub asset allocation nodes.
Mandatory yes
sortAlpha
Type java.lang.String
Description The key used for filtering nodes according to their types.
Mandatory yes
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.4.6 AssetAllocationTreeListOutputTO
The list of asset allocation tress.

The full name


com.avaloq.afs.server.bsp.ws.to.assetallocation.AssetAllocationTreeListOutputTO
Parameters
assetAllocationTreeList
Type java.util.List [AssetAllocationTreeTO]
Description The list of asset allocation trees.
Mandatory yes
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.4.7 AssetAllocationTreeTO
This class represents an asset allocation.

The full name


com.avaloq.afs.server.bsp.ws.to.assetallocation.AssetAllocationTreeTO
Parameters
name
Type java.lang.String
Description The name of the asset allocation.
Mandatory yes
max Length 200
key
Type java.lang.String
Description The key of the asset allocation.
Mandatory yes
max Length 60

Copyright 201, Avaloq Evolution AG Page 134 of 424


AFP Interface Specification

Parameters
orderByType
Type java.lang.String
Description Order by type.
Mandatory yes
rootNode
Type AssetAllocationNodeTO
Description The root asset allocation node.
Mandatory yes
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.4.8 AssetAllocationNodeMappingQueryTO
Query object for the asset allocations.

The full name


com.avaloq.afs.server.bsp.ws.to.assetallocation.AssetAllocationNodeMappingQueryTO
Parameters
selectingAssetAllocationNodeIdList
Type java.util.List [java.lang.Long]
Description Consider only assets that are mapped to the provided asset allocation nodes (from all
positions the user has access to, or only from positions of specific portfolios if the
portfolioId list is also set).
Mandatory yes
portfolioIdList
Type java.util.List [java.lang.Long]
Description Consider only assets of positions in these portfolios.
Mandatory yes
assetIdList
Type java.util.List [java.lang.Long]
Description The asset id list.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 135 of 424


AFP Interface Specification

2.5 com.avaloq.afs.server.bsp.ws.to.attentionitemcounter
2.5.0 AttentionItemCounterQueryTO
A query object used to restrict the counter types that will be retrieved.

The full name


com.avaloq.afs.server.bsp.ws.to.attentionitemcounter.AttentionItemCounterQueryTO
Parameters
counters
Type java.util.List [AttentionItemCounterType]
Description
Mandatory no

2.5.1 AttentionItemCounterResultTO
Class holding the counter value for a counter type.

The full name


com.avaloq.afs.server.bsp.ws.to.attentionitemcounter.AttentionItemCounterResultTO
Parameters
counterType
Type AttentionItemCounterType
Description The counter type
Mandatory yes
value
Type java.lang.Long
Description The value of the counter
Mandatory yes

2.5.2 AttentionItemCounterOutputTO
Response object containing the counter results.

The full name


com.avaloq.afs.server.bsp.ws.to.attentionitemcounter.AttentionItemCounterOutputTO
Parameters
counters
Type java.util.List [AttentionItemCounterResultTO]
Description List containing the counter result.
Mandatory yes
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 136 of 424


AFP Interface Specification

2.6 com.avaloq.afs.server.bsp.ws.to.basebankdata
2.6.0 BusinessPartnerListOutputTO
The list of business partners.

The full name


com.avaloq.afs.server.bsp.ws.to.basebankdata.BusinessPartnerListOutputTO
Parameters
resultList
Type java.util.List [BusinessPartnerTO]
Description The list of business partners.
Mandatory yes
pagingResult
Type PagingResultTO
Description The paging result. Only used for paged queries.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.6.1 AddressListOutputTO

The full name


com.avaloq.afs.server.bsp.ws.to.basebankdata.AddressListOutputTO
Parameters
resultList
Type java.util.List [AddressTO]
Description The list of addresses.
Mandatory yes
pagingResult
Type PagingResultTO
Description The paging result. Only used for paged queries.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.6.2 CurrencyConversionParametersTO
Container for currency conversion parameters.

The full name


com.avaloq.afs.server.bsp.ws.to.basebankdata.CurrencyConversionParametersTO
Parameters
currencyFrom
Type java.lang.String
Description currency of values to convert, from which conversion occurs
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 137 of 424


AFP Interface Specification

Parameters
currencyTo
Type java.lang.String
Description currency to which conversion occurs
Mandatory yes
valuesToConvert
Type java.util.List [java.math.BigDecimal]
Description list of values to be converted
Mandatory yes

2.6.3 HolidayListOutputTO
The list of holidays.

The full name


com.avaloq.afs.server.bsp.ws.to.basebankdata.HolidayListOutputTO
Parameters
businessUnitHolidayList
Type java.util.List [java.util.Date]
Description The list of holidays in the actual business unit.
Mandatory yes
countryId
Type java.lang.Long
Description The country id This field is only added in order not to break the API for the consumer of the
rest services. Will be removed if all consumers are updated.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.6.4 AddressTO
An address.

The full name


com.avaloq.afs.server.bsp.ws.to.basebankdata.AddressTO
Parameters
relationType
Type java.lang.String
Description The relation (usage) type of the address.
Mandatory no
max Length 240
Example afs_portal_email
priority
Type java.lang.String
Description The priority of the address.
Mandatory no
max Length 10
Example 1
type
Type java.lang.String
Description The type of the address.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 138 of 424


AFP Interface Specification

Parameters
max Length 4000
Example Postal address
salutation
Type java.lang.String
Description The salutation.
Mandatory no
max Length 120
Example Mr.
firstName
Type java.lang.String
Description The first name.
Mandatory no
max Length 80
Example John
lastName
Type java.lang.String
Description The last name.
Mandatory no
max Length 80
Example Doe
address
Type java.lang.String
Description The address.
Mandatory no
max Length 1500
Example Mr. John Doe ...
street
Type java.lang.String
Description The street.
Mandatory no
max Length 50
Example Allmendstrasse
streetNumber
Type java.lang.String
Description The street number.
Mandatory no
max Length 50
Example 140
zip
Type java.lang.String
Description The zip code.
Mandatory no
max Length 50
Example 8027
city
Type java.lang.String
Description The city.
Mandatory no
max Length 50
Example Zurich
country
Type java.lang.String
Description The country name.
Mandatory no
max Length 4000
Example Switzerland

Copyright 201, Avaloq Evolution AG Page 139 of 424


AFP Interface Specification

Parameters
electronicAddress
Type java.lang.String
Description The electronic address.
Mandatory no
max Length 200
Example john.doe@avaloq.com
addressOwningRelationshipType
Type AddressOwningRelationshipType
Description The owning relationship with the address of the current user
Mandatory no
Example OWNED
countryData
Type CountryTO
Description
Mandatory no
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.6.5 BankingObjectListOutputTO

The full name


com.avaloq.afs.server.bsp.ws.to.basebankdata.BankingObjectListOutputTO
Parameters
resultList
Type java.util.List [BaseBankingObjectTO]
Description The list of objects.
Mandatory yes
pagingResult
Type PagingResultTO
Description The paging result. Only used for paged queries.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.6.6 BusinessPartnerTO
This class represents a base business partner.

The full name


com.avaloq.afs.server.bsp.ws.to.basebankdata.BusinessPartnerTO
Parameters

Copyright 201, Avaloq Evolution AG Page 140 of 424


AFP Interface Specification

Parameters
name
Type java.lang.String
Description The name.
Mandatory yes
max Length 200
numericSort
Type java.lang.String
Description The business partner numeric sort (ABS).
Mandatory no
sortAlpha
Type java.lang.String
Description The business partner sort alpha (ABS).
Mandatory no
max Length 50
currencyId
Type java.lang.Long
Description The reference currency id.
Mandatory yes
domicileId
Type java.lang.Long
Description The domicile country id.
Mandatory no
nationalityId
Type java.lang.Long
Description The nationality country id.
Mandatory no
registeredOwnerPersonId
Type java.lang.Long
Description The registered owner person id.
Mandatory no
registeredOwnerPersonName
Type java.lang.String
Description The registered owner person name.
Mandatory no
max Length 255
personTypeId
Type java.lang.Long
Description
Mandatory no
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.6.7 PersonListOutputTO
The list of persons.

The full name


com.avaloq.afs.server.bsp.ws.to.basebankdata.PersonListOutputTO

Copyright 201, Avaloq Evolution AG Page 141 of 424


AFP Interface Specification

Parameters
resultList
Type java.util.List [PersonTO]
Description The list of persons.
Mandatory yes
pagingResult
Type PagingResultTO
Description The paging result. Only used for paged queries.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 142 of 424


AFP Interface Specification

2.7 com.avaloq.afs.server.bsp.ws.to.bbs.crm_issue
2.7.0 TaskOutputTO
A response object for task.

The full name


com.avaloq.afs.server.bsp.ws.to.bbs.crm_issue.TaskOutputTO
Parameters
responseHead
Type com.avaloq.bbs.common.RspHead
Description The response head.
Mandatory no
task
Type com.avaloq.bbs.crm_issue.Task
Description The task.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.7.1 AppointmentOutputTO
A response object for appointment.

The full name


com.avaloq.afs.server.bsp.ws.to.bbs.crm_issue.AppointmentOutputTO
Parameters
responseHead
Type com.avaloq.bbs.common.RspHead
Description The response head.
Mandatory no
appointment
Type com.avaloq.bbs.crm_issue.Appointment
Description The appointment.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.7.2 CrmIssueBBSOutputTO
A response object for CRM issue.

The full name


com.avaloq.afs.server.bsp.ws.to.bbs.crm_issue.CrmIssueBBSOutputTO
Parameters
responseHead
Type com.avaloq.bbs.common.RspHead
Description The response head.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 143 of 424


AFP Interface Specification

Parameters
crmIssueBase
Type com.avaloq.bbs.crm_issue.CrmIssueBase
Description The CRM issue.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 144 of 424


AFP Interface Specification

2.8 com.avaloq.afs.server.bsp.ws.to.booking
2.8.0 BookingPaymentCordOrderTO
This class represents a booking payment cord order.

The full name


com.avaloq.afs.server.bsp.ws.to.booking.BookingPaymentCordOrderTO
Parameters
bookingPaymentOrderList
Type java.util.List [BookingPaymentOrderTO]
Description The payment details for this payment order.
Mandatory yes
hasMorePayments
Type java.lang.Boolean
Description Flag indicating whether the order has more payments associated
Mandatory yes
totalPayments
Type java.lang.Integer
Description Total amount of payments associated to the cord order
Mandatory yes
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.8.1 BookingTradingOrderTO
Trading Order Booking Details TO. For more information, see: SD-REP-17 Transaction Journal.

The full name


com.avaloq.afs.server.bsp.ws.to.booking.BookingTradingOrderTO
Parameters
tradingPlace
Type java.lang.String
Description the trading place (market) of an order, like for example SWL
Mandatory yes
valor
Type java.lang.String
Description Number of valor / TKN (example: 123456)
Mandatory yes
isin
Type java.lang.String
Description Isin number (example: CH0038863350)
Mandatory yes
quantity
Type java.math.BigDecimal
Description Quantity of a STEX transaction (e.g. 10.00)
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 145 of 424


AFP Interface Specification

Parameters
clientPrice
Type java.math.BigDecimal
Description Client price of a STEX in pos. currency
Mandatory yes
transactionValueNet
Type java.math.BigDecimal
Description net value of STEX transaction in pos. currency
Mandatory yes
transactionValueGross
Type java.math.BigDecimal
Description gross value of STEX transaction in pos. currency
Mandatory yes
id
Type java.lang.Long
Description internal id
Mandatory yes
priceNet
Type java.math.BigDecimal
Description The price calculated using the transactionValueNet/quantity.
Mandatory yes
priceGross
Type java.math.BigDecimal
Description The price calculated using the transactionValueGross/quantity.
Mandatory yes
hasFunctionalRights
Type java.lang.Boolean
Description Indicates whether the user has functional rights to create stex orders
Mandatory yes

2.8.2 BookingPaymentQueryTO
Transfer object with the booking payment selection criteria.

The full name


com.avaloq.afs.server.bsp.ws.to.booking.BookingPaymentQueryTO
Parameters
cordPaymentOrderId
Type java.lang.Long
Description The cord payment order id.
Mandatory yes
paging
Type PagingTO
Description The paging context
Mandatory no

2.8.3 BookingListOutputTO
This class represents a booking list.

The full name


com.avaloq.afs.server.bsp.ws.to.booking.BookingListOutputTO
Parameters

Copyright 201, Avaloq Evolution AG Page 146 of 424


AFP Interface Specification

Parameters
initialBalance
Type java.math.BigDecimal
Description The balance at the start date .
Mandatory no
finalBalance
Type java.math.BigDecimal
Description The balance at the end date.
Mandatory no
totalCredits
Type java.math.BigDecimal
Description The total credit.
Mandatory no
totalDebits
Type java.math.BigDecimal
Description The total debit.
Mandatory no
bookingList
Type java.util.List [BookingTO]
Description The list of bookings.
Mandatory yes
pagingResult
Type PagingResultTO
Description The paging result. Only used for paged queries.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.8.4 BookingTO
This class represents a booking performed on a position.

The full name


com.avaloq.afs.server.bsp.ws.to.booking.BookingTO

See also
- BookingOrderBusinessType
Parameters
orderNumber
Type java.lang.Long
Description The order number (it can be also interpreted as the order id which generated this booking).
Mandatory yes
orderType
Type java.lang.String
Description The order type name.
Mandatory yes
orderBusinessType
Type BookingOrderBusinessType
Description The order business type.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 147 of 424


AFP Interface Specification

Parameters
text
Type java.lang.String
Description The booking text.
Mandatory yes
max Length 4000
intraDaySequenceNumber
Type java.math.BigDecimal
Description The intra day sequence number. <p/> This sequence is important to keep the booking
ordered within the same day.
Mandatory yes
assetId
Type java.lang.Long
Description The asset linked to the position having this booking.
Mandatory yes
positionId
Type java.lang.Long
Description The associated position on which this booking has been performed.
Mandatory yes
currencyId
Type java.lang.Long
Description The associated position currency.
Mandatory yes
transactionValue
Type java.math.BigDecimal
Description The value of this booking.
Mandatory yes
valueDate
Type java.util.Date
Description Value Date of booking.
Mandatory no
transactionDate
Type java.util.Date
Description The date when the transaction was executed.
Mandatory no
verificationDate
Type java.util.Date
Description The verification date of this booking.
Mandatory no
quantity
Type java.math.BigDecimal
Description The current amount of asset units represented by this booking. <p/> This is relevant for
bookings on non money account positions, when the quantity represents the certain amount
of asset while the transaction value is calculated based on the amount of asset units as well
the position currency. <p/>
Mandatory no
balanceAtVerificationDate
Type java.math.BigDecimal
Description The position balance at the verification date.
Mandatory no
adviceDocumentId
Type java.lang.Long
Description The advice document id, if any got generated.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 148 of 424


AFP Interface Specification

Parameters
bookingOrderDetail
Type BookingOrderDetailTO
Description The details of the order which generated this booking. <p/> This information is set
depending on the flags available in the service.
Mandatory no
transactionValueInReferenceCurrency
Type java.math.BigDecimal
Description The transaction value in reference currency of this booking.
Mandatory no
referenceCurrencyId
Type java.lang.Long
Description The reference currency used in the calculation of booking value in reference currency. <p/>
It should be the same as the portfolio currency, otherwise the business unit currency is used
as fallback.
Mandatory no
portfolioId
Type java.lang.Long
Description The portfolio id which belongs the booking.
Mandatory yes
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.8.5 BookingPaymentListOutputTO
Represents a list of booking details of payment orders.

The full name


com.avaloq.afs.server.bsp.ws.to.booking.BookingPaymentListOutputTO
Parameters
bookingPaymentList
Type java.util.List [BookingPaymentOrderTO]
Description The list of booking payments.
Mandatory yes
pagingResult
Type PagingResultTO
Description The paging result. Only used for paged queries.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 149 of 424


AFP Interface Specification

2.8.6 BookingQueryTO
Transfer object with the booking selection criteria.

The full name


com.avaloq.afs.server.bsp.ws.to.booking.BookingQueryTO

See also
- BookingQuerySortType
Parameters
positionTypeIntlIdList
Type java.util.List [PositionType]
Description The position type.
Mandatory yes
sortedBy
Type java.util.List [QuerySortTO]
Description The query sorting.
Mandatory no
positionId
Type java.lang.Long
Description The position id.
Mandatory no
portfolioId
Type java.lang.Long
Description The portfolio id.
Mandatory no
fromDate
Type java.util.Date
Description The fromDate.
Mandatory no
toDate
Type java.util.Date
Description The toDate.
Mandatory no
bookingDateType
Type BookingDateType
Description The bookingDateType
Mandatory no
fromTransactionValue
Type java.math.BigDecimal
Description The fromAmount
Mandatory no
toTransactionValue
Type java.math.BigDecimal
Description The toAmount
Mandatory no
fromQuantity
Type java.math.BigDecimal
Description The fromQuantity
Mandatory no
toQuantity
Type java.math.BigDecimal
Description The toQuantity
Mandatory no

Copyright 201, Avaloq Evolution AG Page 150 of 424


AFP Interface Specification

Parameters
bookingType
Type BookingType
Description The bookingType
Mandatory no
bookingIdList
Type java.util.List [java.lang.Long]
Description The booking id list.
Mandatory no
textSearchFieldList
Type java.util.List [com.avaloq.afs.server.database.enumeration.BookingListTextSearchField]
Description The list of fields for the text search.
Mandatory no
businessTypeIntlIdList
Type java.util.List [java.lang.String]
Description The list of intl_id business types to be used as filter in the search.
Mandatory yes
text
Type java.lang.String
Description The text search.
Mandatory no
paging
Type PagingTO
Description The paging context
Mandatory no

2.8.7 BookingParametersTO
Transfer object with the booking details loading flags.

The full name


com.avaloq.afs.server.bsp.ws.to.booking.BookingParametersTO
Parameters
includeTradingOrderDetails
Type java.lang.Boolean
Description Include (STEX) trading order details
Mandatory no
includePaymentOrderDetails
Type java.lang.Boolean
Description Include payment order details
Mandatory no
includePaymentCordOrderDetails
Type java.lang.Boolean
Description Include payment cord order details
Mandatory no

2.8.8 BookingPaymentOrderTO
This class represents a booking payment order.

The full name


com.avaloq.afs.server.bsp.ws.to.booking.BookingPaymentOrderTO
Parameters

Copyright 201, Avaloq Evolution AG Page 151 of 424


AFP Interface Specification

Parameters
dtaFileName
Type java.lang.String
Description DTA file name.
Mandatory no
max Length 300
Example all_pay_types2.dta
beneficiary
Type java.lang.String
Description Beneficiary.
Mandatory no
max Length 300
Example John Doe
paymentType
Type PaymentType
Description payment type
Mandatory yes
paymentReason
Type java.lang.String
Description Reason for the payment
Mandatory no
max Length 143
Example Flat rent
beneficiaryCity
Type java.lang.String
Description City for the beneficiary
Mandatory no
max Length 50
Example Zürich
beneficiaryPostalCode
Type java.lang.String
Description Postal code for the beneficiary
Mandatory no
max Length 25
Example 8004
currencyId
Type java.lang.Long
Description The currency ID.
Mandatory no
Example 1002
amount
Type java.math.BigDecimal
Description The amount for the payment
Mandatory no
Example 105.2
debitReference
Type java.lang.String
Description The text set for account statement in the payment order
Mandatory no
max Length 200
Example Vergütung
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 152 of 424


AFP Interface Specification

Parameters
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.8.9 BookingOrderDetailTO
This class aggregates details of the order which generated the booking.

The full name


com.avaloq.afs.server.bsp.ws.to.booking.BookingOrderDetailTO
Parameters
bookingOrderDetailType
Type BookingOrderDetailType
Description The type of order details defining which of the next fields is set.
Mandatory yes
bookingPaymentOrder
Type BookingPaymentOrderTO
Description Payment order details.
Mandatory no
bookingPaymentCordOrder
Type BookingPaymentCordOrderTO
Description Payment collective order details.
Mandatory no
bookingTradingOrder
Type BookingTradingOrderTO
Description STEX order details.
Mandatory no
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 153 of 424


AFP Interface Specification

2.9 com.avaloq.afs.server.bsp.ws.to.businessobject
2.9.0 SimpleBusinessObjectTO
TO representing only the most basic business object details.

The full name


com.avaloq.afs.server.bsp.ws.to.businessobject.SimpleBusinessObjectTO
Parameters
id
Type java.lang.Long
Description
Mandatory yes
name
Type java.lang.String
Description
Mandatory yes
keys
Type java.util.Set
Description
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 154 of 424


AFP Interface Specification

2.10 com.avaloq.afs.server.bsp.ws.to.clientadvisor
2.10.0 ClientAdvisorTO
A response object which holds client advisor information.

The full name


com.avaloq.afs.server.bsp.ws.to.clientadvisor.ClientAdvisorTO
Parameters
id
Type java.lang.Long
Description The id of the OrganisationalEntityPC.
Mandatory yes
name
Type java.lang.String
Description The fully formatted name of the client advisor.
Mandatory no
max Length 255
phone
Type java.lang.String
Description The phone number of the client advisor.
Mandatory no
max Length 200
fax
Type java.lang.String
Description The fax number of the client advisor.
Mandatory no
max Length 200
email
Type java.lang.String
Description The email of the client advisor.
Mandatory no
max Length 200
photoRefKey
Type java.lang.String
Description The photo reference key of the client advisor.
Mandatory no
max Length 400
businessObjectSubType
Type BusinessObjectSubTypeCode
Description The client advisor sub type (i.e. job or organisational entity).
Mandatory yes
responsibleRole
Type CodeTO
Description The responsibility role of the client advisor.
Mandatory yes
priority
Type java.lang.Integer
Description The priority of the relation.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 155 of 424


AFP Interface Specification

2.10.1 ClientAdvisorQueryTO
Client advisor query TO.

The full name


com.avaloq.afs.server.bsp.ws.to.clientadvisor.ClientAdvisorQueryTO
Parameters
responsibleRoleContextList
Type java.util.List [com.avaloq.afs.server.database.pc.fwom.code.oe.ResponsibleRoleContextCode]
Description A list of responsible role contexts.
Mandatory no
contextBusinessObjectIdList
Type java.util.List [java.lang.Long]
Description A list of context business object ids.
Mandatory no

2.10.2 ClientAdvisorListOutputTO
A response object which holds a list of client advisor information.

The full name


com.avaloq.afs.server.bsp.ws.to.clientadvisor.ClientAdvisorListOutputTO
Parameters
clientAdvisorList
Type java.util.List [ClientAdvisorTO]
Description The list of client advisors.
Mandatory yes
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 156 of 424


AFP Interface Specification

2.11 com.avaloq.afs.server.bsp.ws.to.clientdata
2.11.0 IpsParametersTO
Parameters object for the IPS's.

The full name


com.avaloq.afs.server.bsp.ws.to.clientdata.IpsParametersTO
Parameters
calculateCurrentValue
Type java.lang.Boolean
Description Flag to calculate the current value
Mandatory yes

2.11.1 PortfolioTO
This class represents a base business partner.

The full name


com.avaloq.afs.server.bsp.ws.to.clientdata.PortfolioTO
Parameters
name
Type java.lang.String
Description The name.
Mandatory yes
max Length 200
businessPartnerName
Type java.lang.String
Description The business partner name.
Mandatory no
max Length 200
businessPartnerId
Type java.lang.Long
Description The business partner id.
Mandatory no
referenceCurrencyId
Type java.lang.Long
Description The internal reference of the currency.
Mandatory yes
currentValue
Type java.math.BigDecimal
Description The current value.
Mandatory no
accruedInterest
Type java.math.BigDecimal
Description The accrued interest.
Mandatory no
reportingCurrencyId
Type java.lang.Long
Description The internal reference of the currency.
Mandatory no
currentValueWithoutAccruedInterestInReportingCurrency
Type java.math.BigDecimal
Description The current value without accrued interest converted according to the reporting currency.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 157 of 424


AFP Interface Specification

Parameters
accruedInterestInReportingCurrency
Type java.math.BigDecimal
Description The accrued interest converted according to the reporting currency.
Mandatory no
currentValueWithAccruedInterestInReportingCurrency
Type java.math.BigDecimal
Description The current value with accrued interest converted according to the reporting currency.
Mandatory no
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.11.2 BusinessPartnerQueryTO
Query object for the BusinessPartner.

The full name


com.avaloq.afs.server.bsp.ws.to.clientdata.BusinessPartnerQueryTO
Parameters
businessPartnerIdList
Type java.util.List [java.lang.Long]
Description The BusinessPartner id list.
Mandatory yes

2.11.3 IpsQueryTO
Query object for the IPS.

The full name


com.avaloq.afs.server.bsp.ws.to.clientdata.IpsQueryTO
Parameters
ipsIdList
Type java.util.List [java.lang.Long]
Description The IPS id list.
Mandatory yes

2.11.4 PortfolioListOutputTO
The list of container portfolios.

The full name


com.avaloq.afs.server.bsp.ws.to.clientdata.PortfolioListOutputTO
Parameters
totalValueWithAccruedInterest
Type java.math.BigDecimal
Description The total value including the accrued interest for the resulting portfolio list.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 158 of 424


AFP Interface Specification

Parameters
totalValueWithoutAccruedInterest
Type java.math.BigDecimal
Description The total value excluding the accrued interest for the resulting portfolio list.
Mandatory no
totalValueCurrencyId
Type java.lang.Long
Description The Id of the currency refering to the total values.
Mandatory no
totalValueDate
Type java.util.Date
Description The Id of the currency refering to the total values.
Mandatory no
portfolioList
Type java.util.List [PortfolioTO]
Description The list of container portfolios.
Mandatory yes
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.11.5 BusinessPartnerAddressQueryTO
BusinessPartnerAddressQueryTO is the filter criteria to query the business partner person address.

The full name


com.avaloq.afs.server.bsp.ws.to.clientdata.BusinessPartnerAddressQueryTO
Parameters
businessPartnerIdList
Type java.util.List [java.lang.Long]
Description The BusinessPartner id list.
Mandatory yes

2.11.6 PortfolioQueryTO
Query object for the portfolios.

The full name


com.avaloq.afs.server.bsp.ws.to.clientdata.PortfolioQueryTO
Parameters
portfolioIdList
Type java.util.List [java.lang.Long]
Description The portfolio id list
Mandatory yes
authorityRestriction
Type PortfolioAuthorityRestriction
Description The portfolio authority restriction.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 159 of 424


AFP Interface Specification

2.11.7 PortfolioParametersTO
Parameters object for the portfolios.

The full name


com.avaloq.afs.server.bsp.ws.to.clientdata.PortfolioParametersTO
Parameters
reportingCurrencyId
Type java.lang.Long
Description Reference currency ID.
Mandatory no
calculateCurrentValue
Type java.lang.Boolean
Description Flag to calculate the current value
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 160 of 424


AFP Interface Specification

2.12 com.avaloq.afs.server.bsp.ws.to.code
2.12.0 SimpleClassTO
TO representing only the most basic class details.

The full name


com.avaloq.afs.server.bsp.ws.to.code.SimpleClassTO
Parameters
classificationInternalId
Type java.lang.String
Description
Mandatory yes
id
Type java.lang.Long
Description
Mandatory yes
internalId
Type java.lang.String
Description
Mandatory yes
name
Type java.lang.String
Description
Mandatory yes

2.12.1 CodeOutputTO
Wrapper TO carrying a single CodeTO.

The full name


com.avaloq.afs.server.bsp.ws.to.code.CodeOutputTO
Parameters
codeTO
Type CodeTO
Description
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.12.2 CodeTO
A response object which holds a code table entry.

The full name


com.avaloq.afs.server.bsp.ws.to.code.CodeTO
Parameters
guid
Type java.lang.Long
Description The guid.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 161 of 424


AFP Interface Specification

Parameters
internalId
Type java.lang.String
Description The internal id.
Mandatory yes
name
Type java.lang.String
Description The name.
Mandatory yes
active
Type java.lang.Boolean
Description Is active.
Mandatory yes
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.12.3 SimpleCodeTO
TO representing only the most basic code details.

The full name


com.avaloq.afs.server.bsp.ws.to.code.SimpleCodeTO
Parameters
id
Type java.lang.Long
Description
Mandatory yes
internalId
Type java.lang.String
Description
Mandatory yes
name
Type java.lang.String
Description
Mandatory yes

2.12.4 CodeListOutputTO
Transfer object to represent retrieving a list of code table entries from the database.

The full name


com.avaloq.afs.server.bsp.ws.to.code.CodeListOutputTO
Parameters
codeTableName
Type java.lang.String
Description Code table name.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 162 of 424


AFP Interface Specification

Parameters
max Length 80
resultList
Type java.util.List [CodeTO]
Description The CodeTO list.
Mandatory yes
pagingResult
Type PagingResultTO
Description The paging result. Only used for paged queries.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 163 of 424


AFP Interface Specification

2.13 com.avaloq.afs.server.bsp.ws.to.code.notification
2.13.0 NotificationDeliveryChannelCodeTO
A delivery channel defined in the framework through Core code table CODE_NTFCN_DLV_CHAN. A delivery channel is a
means of communicating with the recipient user e.g. through an inbox entry, an email or a text message.

The full name


com.avaloq.afs.server.bsp.ws.to.code.notification.NotificationDeliveryChannelCodeTO
Parameters
contactInformationMedium
Type UserContactInformationMedium
Description The contact information medium for this delivery channel.
Mandatory yes
guid
Type java.lang.Long
Description The guid.
Mandatory yes
internalId
Type java.lang.String
Description The internal id.
Mandatory yes
name
Type java.lang.String
Description The name.
Mandatory yes
active
Type java.lang.Boolean
Description Is active.
Mandatory yes
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.13.1 NotificationEventTypeCodeTO
An event type defined in the framework through Core code table CODE_NTFCN_EVT_TYPE. An event type is similar to a
topic in typical publish/subscribe systems.
The full name
com.avaloq.afs.server.bsp.ws.to.code.notification.NotificationEventTypeCodeTO
Parameters
triggeringObjectTypeId
Type java.lang.Long
Description ID of the Avaloq object type associated with this event type.
Mandatory yes
scopeType
Type java.lang.String
Description The name of the scope type bound to this event type.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 164 of 424


AFP Interface Specification

Parameters
triggerTypeId
Type java.lang.Long
Description The ID of the trigger type associated with this event type.
Mandatory no
guid
Type java.lang.Long
Description The guid.
Mandatory yes
internalId
Type java.lang.String
Description The internal id.
Mandatory yes
name
Type java.lang.String
Description The name.
Mandatory yes
active
Type java.lang.Boolean
Description Is active.
Mandatory yes
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.13.2 NotificationTriggerCodeTO

The full name


com.avaloq.afs.server.bsp.ws.to.code.notification.NotificationTriggerCodeTO
Parameters
triggerTypeId
Type java.lang.Long
Description
Mandatory yes
guid
Type java.lang.Long
Description The guid.
Mandatory yes
internalId
Type java.lang.String
Description The internal id.
Mandatory yes
name
Type java.lang.String
Description The name.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 165 of 424


AFP Interface Specification

Parameters
active
Type java.lang.Boolean
Description Is active.
Mandatory yes
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 166 of 424


AFP Interface Specification

2.14 com.avaloq.afs.server.bsp.ws.to.collaboration
2.14.0 CollaborationIssueQueryTO
The query conditions to search Collaboration issues.

The full name


com.avaloq.afs.server.bsp.ws.to.collaboration.CollaborationIssueQueryTO
Parameters
ids
Type java.util.List [java.lang.Long]
Description The internal database reference. This is a unique ids.
Mandatory no
type
Type CollaborationIssueType
Description The type of the issue.
Mandatory no
searchText
Type java.lang.String
Description The text to search in the subject and description of the issue.
Mandatory no
max Length 255
Example portfolio
appointmentDateFrom
Type java.util.Date
Description Filter for appointments after this date.
Mandatory no
appointmentDateTo
Type java.util.Date
Description Filter for appointments before this date.
Mandatory no
lastUpdateDateFrom
Type java.util.Date
Description Filter for last update after this date.
Mandatory no
lastUpdateDateTo
Type java.util.Date
Description Filter for last update before this date.
Mandatory no
withAttachments
Type java.lang.Boolean
Description Filter for attachments true: include only collaboration issues with attachments false: include
only collaboration issues with no attachments null: ignore this flag
Mandatory no
searchReadStatus
Type CollaborationIssueSearchReadStatus
Description Filter for issues with read status.
Mandatory no

2.14.1 CollaborationIssueOutputTO
A response object which holds the updated issue if it was saved successfully.

The full name


com.avaloq.afs.server.bsp.ws.to.collaboration.CollaborationIssueOutputTO
Parameters

Copyright 201, Avaloq Evolution AG Page 167 of 424


AFP Interface Specification

Parameters
collaborationIssue
Type CollaborationIssueTO
Description The Collaboration issue.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.14.2 CollaborationIssueCommentTO
Representation of a comment on a Collaboration issue.

The full name


com.avaloq.afs.server.bsp.ws.to.collaboration.CollaborationIssueCommentTO
Parameters
collaborationIssueId
Type java.lang.Long
Description The id of the collaboration issue
Mandatory yes
timestamp
Type java.util.Date
Description The timestamp when the comment was created
Mandatory no
insertedBy
Type java.lang.String
Description The information who inserted the comment.
Mandatory no
comment
Type java.lang.String
Description The comment.
Mandatory yes
max Length 4000
actionType
Type CollaborationIssueDescriptionActionType
Description The action type of the comment (who created the comment).
Mandatory yes

2.14.3 CollaborationIssueMetaDataOutputTO
A response object which holds Collaboration issue meta data.

The full name


com.avaloq.afs.server.bsp.ws.to.collaboration.CollaborationIssueMetaDataOutputTO
Parameters
issueTypeList
Type java.util.List [CollaborationIssueType]
Description The list of issue types.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 168 of 424


AFP Interface Specification

Parameters
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.14.4 CollaborationParametersTO
Parameters for the com.avaloq.afs.server.bsp.ws.services.Collaboration service.

The full name


com.avaloq.afs.server.bsp.ws.to.collaboration.CollaborationParametersTO
Parameters
retrieveAttachmentMetaData
Type boolean
Description flag for retrieving attachment metadata
Mandatory yes
loadComments
Type boolean
Description flag for retrieving the comments
Mandatory yes
markAsRead
Type boolean
Description flag to mark retrieved issue as read
Mandatory yes

2.14.5 CollaborationIssueTO
Representation of a Collaboration issue.

The full name


com.avaloq.afs.server.bsp.ws.to.collaboration.CollaborationIssueTO
Parameters
type
Type CollaborationIssueType
Description The type of the issue.
Mandatory yes
lastUpdateDate
Type java.util.Date
Description The last update date of the issue.
Mandatory no
openDate
Type java.util.Date
Description The open date of the issue.
Mandatory no
dueDate
Type java.util.Date
Description The due date of the issue.
Mandatory no
responsibleBusinessPartnerId
Type java.lang.Long
Description The id of the responsible business partner (client advisor).
Mandatory no

Copyright 201, Avaloq Evolution AG Page 169 of 424


AFP Interface Specification

Parameters
contractId
Type java.lang.Long
Description (subject) The id of the contract the issue was created by/for.
Mandatory no
personId
Type java.lang.Long
Description (subject) The id of the person the issue was created by/for.
Mandatory no
businessPartnerId
Type java.lang.Long
Description (object) The id of the business partner the issue is concerned about.
Mandatory no
businessPartnerName
Type java.lang.String
Description The name of the business partner the issue was created for.
Mandatory no
subject
Type java.lang.String
Description The subject of the issue.
Mandatory yes
max Length 250
Example Improve performance
appointmentStartDate
Type java.util.Date
Description The start date of the appointment.
Mandatory no
appointmentEndDate
Type java.util.Date
Description The end date of the appointment.
Mandatory no
appointmentLocation
Type java.lang.String
Description The location of the appointment.
Mandatory no
max Length 255
Example Zurich HQ
read
Type boolean
Description The flag indicating if issue was read.
Mandatory yes
updated
Type boolean
Description The flag indicating if issue was updated (i.e. update on issue that is new to the user).
Mandatory yes
commentList
Type java.util.List [CollaborationIssueCommentTO]
Description The comments related to the issue.
Mandatory no
attachmentList
Type java.util.List [DocumentMetaDataTO]
Description The attachments.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 170 of 424


AFP Interface Specification

Parameters
hasAttachment
Type java.lang.Boolean
Description has attachment.
Mandatory no
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.14.6 CollaborationIssueListOutputTO
A response object which holds a list of Collaboration issues.

The full name


com.avaloq.afs.server.bsp.ws.to.collaboration.CollaborationIssueListOutputTO
Parameters
resultList
Type java.util.List [CollaborationIssueTO]
Description The list of issues.
Mandatory yes
pagingResult
Type PagingResultTO
Description The paging result. Only used for paged queries.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.14.7 CollaborationIssueCreationTO
Transfer object to create a collaboration issue.

The full name


com.avaloq.afs.server.bsp.ws.to.collaboration.CollaborationIssueCreationTO
Parameters
type
Type CollaborationIssueType
Description The type of the issue.
Mandatory yes
appointmentStartDate
Type java.util.Date
Description The start date of the appointment.
Mandatory no
appointmentEndDate
Type java.util.Date
Description The end date of the appointment.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 171 of 424


AFP Interface Specification

Parameters
appointmentLocation
Type java.lang.String
Description The location of the appointment.
Mandatory no
max Length 255
Example Zurich HQ
subject
Type java.lang.String
Description The subject of the issue.
Mandatory yes
max Length 250
Example Improve performance
comment
Type java.lang.String
Description The comment of the issue.
Mandatory no
max Length 4000
actionType
Type CollaborationIssueDescriptionActionType
Description The action type of the comment (who created the comment).
Mandatory no
attachmentList
Type java.util.List [DocumentInputTO]
Description The action type of the comment (who created the comment).
Mandatory no

Copyright 201, Avaloq Evolution AG Page 172 of 424


AFP Interface Specification

2.15 com.avaloq.afs.server.bsp.ws.to.dms
2.15.0 DocumentMetaDataTO
Document meta data to show information about a document without retrieving the actual document data.

The full name


com.avaloq.afs.server.bsp.ws.to.dms.DocumentMetaDataTO
Parameters
documentKey
Type java.lang.String
Description The identifier of the document.
Mandatory yes
name
Type java.lang.String
Description The name of the document.
Mandatory yes
contentType
Type java.lang.String
Description The MIME type of the content.
Mandatory yes
uploadDate
Type java.util.Date
Description The date the document was uploaded.
Mandatory yes
uploadedByUserId
Type java.lang.String
Description The id of the user who uploaded the document.
Mandatory yes
uploadedByName
Type java.lang.String
Description The name of the user who uploaded the document.
Mandatory yes

2.15.1 DocumentKeyOutputTO
A transfer object holding the document key.

The full name


com.avaloq.afs.server.bsp.ws.to.dms.DocumentKeyOutputTO
Parameters
documentKey
Type java.lang.String
Description Identifier for the document.
Mandatory yes
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 173 of 424


AFP Interface Specification

2.15.2 DocumentInputTO
A transfer object holding the document data.

The full name


com.avaloq.afs.server.bsp.ws.to.dms.DocumentInputTO
Parameters
dataHandler
Type javax.activation.DataHandler
Description Data handler for document data.
Mandatory yes
name
Type java.lang.String
Description The name of the document.
Mandatory yes
max Length 255
Example statement.pdf
contentType
Type java.lang.String
Description The content type of the document.
Mandatory yes
max Length 255
Example application/pdf
orderId
Type java.lang.Long
Description The order id of the document.
Mandatory yes

2.15.3 DocumentOutputTO
A transfer object holding the document data.

The full name


com.avaloq.afs.server.bsp.ws.to.dms.DocumentOutputTO
Parameters
dataHandler
Type javax.activation.DataHandler
Description Data handler for document data.
Mandatory yes
documentKey
Type java.lang.String
Description Identifier for the document.
Mandatory yes
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 174 of 424


AFP Interface Specification

2.16 com.avaloq.afs.server.bsp.ws.to.extension
2.16.0 ObjectExtensionQueryTO

The full name


com.avaloq.afs.server.bsp.ws.to.extension.ObjectExtensionQueryTO
Parameters
keyTypes
Type java.util.List [KeyExtensionKeyTypeTO]
Description a list of internal id of key types to look up.
Mandatory yes
classTypes
Type java.util.List [java.lang.String]
Description a list of internal id of classes types to look up.
Mandatory yes

2.16.1 ObjectClassExtensionTO
The list of extensions entries for single object. Each entry will have the type and the value of the extension. This will be used
for Keys and classes.
The full name
com.avaloq.afs.server.bsp.ws.to.extension.ObjectClassExtensionTO
Parameters
extensionEntries
Type java.util.List [ObjectClassExtensionEntryTO]
Description The list of extension entries for this specific object defined by id.
Mandatory yes
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.16.2 ObjectClassExtensionListOutputTO
Output object for the class extension service.

The full name


com.avaloq.afs.server.bsp.ws.to.extension.ObjectClassExtensionListOutputTO
Parameters
objectClasses
Type java.util.List [ObjectClassExtensionTO]
Description a list of class extensions for a list of objects.
Mandatory yes
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 175 of 424


AFP Interface Specification

2.16.3 KeyExtensionValueTO
The Class KeyExtensionValueTO.

The full name


com.avaloq.afs.server.bsp.ws.to.extension.KeyExtensionValueTO
Parameters
value
Type java.lang.String
Description The value.
Mandatory yes
max Length 4000
Example DE00003710000
referenceObjectId
Type java.lang.Long
Description The reference object id.
Mandatory no

2.16.4 ObjectClassExtensionEntryTO
Represents a pair of type and value for the extension. Will be used to represent an extension type (classification type intl_id,
or key type intl_id) and the class name or key value.
The full name
com.avaloq.afs.server.bsp.ws.to.extension.ObjectClassExtensionEntryTO
Parameters
extensionType
Type java.lang.String
Description guid of the class.
Mandatory yes
max Length 240
Example ass_pay_type
extensionValues
Type java.util.List [ClassExtensionValueTO]
Description the class of the object class type.
Mandatory no

2.16.5 KeyExtensionQueryTO
Query TO for key extensions.

The full name


com.avaloq.afs.server.bsp.ws.to.extension.KeyExtensionQueryTO
Parameters
businessObjectType
Type BusinessObjectType
Description Business object type to search for.
Mandatory yes
keyType
Type java.lang.String
Description IntlId of the key type to search for.
Mandatory yes
max Length 240

Copyright 201, Avaloq Evolution AG Page 176 of 424


AFP Interface Specification

Parameters
keyValueList
Type java.util.List [java.lang.String]
Description A list of key values to search for.
Mandatory yes
max Length 200

2.16.6 ObjectKeyExtensionTO

The full name


com.avaloq.afs.server.bsp.ws.to.extension.ObjectKeyExtensionTO
Parameters
extensionEntries
Type java.util.List [ObjectKeyExtensionEntryTO]
Description The list of extension entries for this specific object defined by id.
Mandatory yes
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.16.7 ClassExtensionValueTO

The full name


com.avaloq.afs.server.bsp.ws.to.extension.ClassExtensionValueTO
Parameters
name
Type java.lang.String
Description The value.
Mandatory yes
max Length 4000
Example Bank note (currency)
id
Type java.lang.Long
Description The id.
Mandatory yes
internalId
Type java.lang.String
Description The internal id.
Mandatory yes
max Length 240
Example bnot

Copyright 201, Avaloq Evolution AG Page 177 of 424


AFP Interface Specification

2.16.8 ObjectKeyExtensionListOutputTO
Output object for the key extension service.

The full name


com.avaloq.afs.server.bsp.ws.to.extension.ObjectKeyExtensionListOutputTO
Parameters
objectKeys
Type java.util.List [ObjectKeyExtensionTO]
Description a list of key extensions for a list of objects.
Mandatory yes
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.16.9 ObjectKeyExtensionQueryTO
Extension query for keys.

The full name


com.avaloq.afs.server.bsp.ws.to.extension.ObjectKeyExtensionQueryTO
Parameters
objectIds
Type java.util.List [java.lang.Long]
Description internal ids of objects of concern.
Mandatory yes
keyTypes
Type java.util.List [KeyExtensionKeyTypeTO]
Description a list of internal id of keys type to look up.
Mandatory yes

2.16.10 ObjectClassExtensionQueryTO
Extension query for classes.

The full name


com.avaloq.afs.server.bsp.ws.to.extension.ObjectClassExtensionQueryTO
Parameters
objectIds
Type java.util.List [java.lang.Long]
Description internal ids of objects of concern.
Mandatory yes
classificationTypes
Type java.util.List [java.lang.String]
Description a list of internal id of classification type to look up.
Mandatory yes

2.16.11 ObjectKeyExtensionEntryTO

The full name


com.avaloq.afs.server.bsp.ws.to.extension.ObjectKeyExtensionEntryTO

Copyright 201, Avaloq Evolution AG Page 178 of 424


AFP Interface Specification

Parameters
extensionType
Type java.lang.String
Description guid of the class.
Mandatory yes
max Length 240
Example ass_pay_type
extensionValues
Type java.util.List [KeyExtensionValueTO]
Description the class of the object class type.
Mandatory no

2.16.12 KeyExtensionKeyTypeTO
Represents a pair of type and reference object for the extension query. Will be used to represent an key extension request
type (key type intl_id and/or a object reference).
The full name
com.avaloq.afs.server.bsp.ws.to.extension.KeyExtensionKeyTypeTO
Parameters
keyType
Type java.lang.String
Description The key type internal identifier.
Mandatory yes
max Length 240
Example ass_type
referenceObjectId
Type java.lang.Long
Description The reference object id.
Mandatory no

2.16.13 ObjectExtensionTO
The object extension of all objects (asset, address, etc.).

The full name


com.avaloq.afs.server.bsp.ws.to.extension.ObjectExtensionTO
Parameters
keyExtensionEntries
Type java.util.List [ObjectKeyExtensionEntryTO]
Description The list of extension entries for this specific object defined by id.
Mandatory yes
classExtensionEntries
Type java.util.List [ObjectClassExtensionEntryTO]
Description The list of extension entries for this specific object defined by id.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 179 of 424


AFP Interface Specification

2.17 com.avaloq.afs.server.bsp.ws.to.impl
2.17.0 EditableCodeTO
A CodeTO editable value.

The full name


com.avaloq.afs.server.bsp.ws.to.impl.EditableCodeTO
Parameters
value
Type CodeTO
Description the value that could be editable.
Mandatory yes
editable
Type java.lang.Boolean
Description flag that indicates if the value is editable or not.
Mandatory yes

2.17.1 EditableDateTO
A Date editable value.

The full name


com.avaloq.afs.server.bsp.ws.to.impl.EditableDateTO
Parameters
value
Type java.util.Date
Description the value that could be editable.
Mandatory yes
editable
Type java.lang.Boolean
Description flag that indicates if the value is editable or not.
Mandatory yes

2.17.2 ObjTO
General transfer object holding overview data.

The full name


com.avaloq.afs.server.bsp.ws.to.impl.ObjTO
Parameters
name
Type java.lang.String
Description The name of the obj.
Mandatory no
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 180 of 424


AFP Interface Specification

2.17.3 PagingResultTO
Class which holds paging result information.

The full name


com.avaloq.afs.server.bsp.ws.to.impl.PagingResultTO
Parameters
snapshotId
Type java.math.BigDecimal
Description The snapshot id. Used for consistent paging. See PagingTO
Mandatory yes
hasMoreResults
Type boolean
Description Flag to indicate if there are more results.
Mandatory yes
resultsFrom
Type int
Description Results are presented from this index.
Mandatory yes
resultsSize
Type int
Description Results size.
Mandatory yes
resultsTotal
Type java.lang.Long
Description Total count of results available. May be null. Only not null if implemented by servive.
Mandatory yes

2.17.4 OutputTO
This class represents a general response (transfer object) message. It's the base class used for all responses to the web
service client. It contains the servers date and a general list of notification.
The full name
com.avaloq.afs.server.bsp.ws.to.impl.OutputTO
Parameters
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.17.5 IdOutputTO
Holder for object internal reference in the response.

The full name


com.avaloq.afs.server.bsp.ws.to.impl.IdOutputTO
Parameters
id
Type long
Description The internal references of a object.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 181 of 424


AFP Interface Specification

Parameters
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.17.6 LongOutputTO
Holder for a long value in the response.

The full name


com.avaloq.afs.server.bsp.ws.to.impl.LongOutputTO
Parameters
resultValue
Type java.lang.Long
Description The result of the service.
Mandatory yes
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.17.7 NotificationTO
Notifications are additional informations, warnings or error the request and response objects.
Objects of this class are immutable and can therefore be cached.
The full name
com.avaloq.afs.server.bsp.ws.to.impl.NotificationTO
Parameters
validationResult
Type com.avaloq.front.common.util.validation.ValidationResult
Description The validation result. This object contains
• unique (error) code
• field name to reference the relevant parameter
• severity: ERROR, WARNING, INFO
• translation key
• list of parameter for the translation
Mandatory yes
firstListIndex
Type java.lang.Integer
Description The index of the list in which the bean property is part of (LOCAL). Used for simple list of
bean properties. This assumes that the receiver of this item knows the property of the list. If
the base bean has no list, or the validation is on the bean level (GLOBAL) this index is set to
null.
Mandatory no
secondListIndex
Type java.lang.Integer
Description The index of the list in which the bean property is part of (LOCAL). Used for simple list of
bean properties. This assumes that the receiver of this item knows the property of the list. If
the base bean has no list, or the validation is on the bean level (GLOBAL) this index is set to
null.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 182 of 424


AFP Interface Specification

2.17.8 EditableBigDecimalTO
A BigDecimal editable value.

The full name


com.avaloq.afs.server.bsp.ws.to.impl.EditableBigDecimalTO
Parameters
value
Type java.math.BigDecimal
Description the value that could be editable.
Mandatory yes
editable
Type java.lang.Boolean
Description flag that indicates if the value is editable or not.
Mandatory yes

2.17.9 UserContextTO
This object represents general input parameters which are passed on every request.

The full name


com.avaloq.afs.server.bsp.ws.to.impl.UserContextTO
Parameters
language
Type java.lang.String
Description The actual user language.
Mandatory yes
max Length 200
Example en
businessUnitIdList
Type java.util.List [java.lang.Long]
Description The list of business units ids to filter. The list of bu id's is handled special for now.
- Only one bu is supported in the list. If there is more than one an exception will be thrown.
- If the bu list is empty, the bu from the SAML will be taken. If the SAML bu is empty the one
from the LoginPC's list will be taken. If the LoginPC's list has more than one bu, an exception
will be thrown.
Mandatory no
objectAccessFilter
Type ObjectAccessFilterTO
Description The object access filter. Can be null if no filter needed.
Mandatory no
channel
Type ChannelType
Description The channel.
Mandatory yes
restrictedAdvisorMode
Type java.lang.Boolean
Description The restricted advisor mode.
Mandatory no
authorizationUser
Type java.lang.String
Description The authorization user.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 183 of 424


AFP Interface Specification

Parameters
acpSessionId
Type java.lang.String
Description The ACP session id.
Mandatory yes

2.17.10 ServerInfoTO
TO to transfer the server version.

The full name


com.avaloq.afs.server.bsp.ws.to.impl.ServerInfoTO
Parameters
serverVersion
Type java.lang.String
Description Server version.
Mandatory yes
max Length 50
Example 3.2.0
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.17.11 TransactionSigningRequestTO
A representation of a transaction signing request.

The full name


com.avaloq.afs.server.bsp.ws.to.impl.TransactionSigningRequestTO
Parameters
image
Type byte
Description An image as byte array. Needed for the flicker transaction signing.
Mandatory no
max Length 4000
challenge
Type java.lang.String
Description A challenge request for the transaction signing.
Mandatory no
max Length 4000
Example CH02 0026 92 XX XXXX 7449 0
messageKey
Type java.lang.String
Description The message key to display the text on the GUI.
Mandatory no
max Length 200
Example transactionsigning.confirm.document
operation
Type TransactionSigningOperation
Description The reference for a transaction signing type.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 184 of 424


AFP Interface Specification

Parameters
transactionSigningObjectType
Type TransactionSigningObjectType
Description The transaction signing object type.
Mandatory yes
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.17.12 DateOutputTO
Transfer object used for representing a Date payload.

The full name


com.avaloq.afs.server.bsp.ws.to.impl.DateOutputTO
Parameters
content
Type java.util.Date
Description wrapped date content.
Mandatory yes
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.17.13 EditableObjTO
A ObjTO editable value.

The full name


com.avaloq.afs.server.bsp.ws.to.impl.EditableObjTO
Parameters
value
Type ObjTO
Description the value that could be editable.
Mandatory yes
editable
Type java.lang.Boolean
Description flag that indicates if the value is editable or not.
Mandatory yes

2.17.14 AddOrderPostItTO
Representation of a input order postIt.

The full name


com.avaloq.afs.server.bsp.ws.to.impl.AddOrderPostItTO
Parameters

Copyright 201, Avaloq Evolution AG Page 185 of 424


AFP Interface Specification

Parameters
typeId
Type java.lang.Long
Description The type id.
Mandatory no
subTypeId
Type java.lang.Long
Description The subtype id.
Mandatory no
topic
Type java.lang.String
Description The topic.
Mandatory yes
max Length 400
text
Type java.lang.String
Description The text.
Mandatory no
max Length 4000

2.17.15 IdListOutputTO
A response object which holds a list of internal references.

The full name


com.avaloq.afs.server.bsp.ws.to.impl.IdListOutputTO
Parameters
idList
Type java.util.List [java.lang.Long]
Description The list of internal references.
Mandatory yes
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.17.16 ValidationOverrideTO
Validation override object. Used to set the override notification sent from BBS when a trading order is validated.

The full name


com.avaloq.afs.server.bsp.ws.to.impl.ValidationOverrideTO
Parameters
id
Type java.lang.Long
Description Override id.
Mandatory yes
description
Type java.lang.String
Description Override description.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 186 of 424


AFP Interface Specification

Parameters
tradingTransactionId
Type java.lang.Long
Description Trading transaction id.
Mandatory yes

2.17.17 BaseBankingObjectTO
The base object of all banking objects.
This object identifies exact one banking object in a specific version.
The full name
com.avaloq.afs.server.bsp.ws.to.impl.BaseBankingObjectTO
Parameters
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.17.18 EditableStringTO
A String editable value.

The full name


com.avaloq.afs.server.bsp.ws.to.impl.EditableStringTO
Parameters
value
Type java.lang.String
Description the value that could be editable.
Mandatory yes
editable
Type java.lang.Boolean
Description flag that indicates if the value is editable or not.
Mandatory yes

2.17.19 OrderPostItTO
Representation of a order post it.

The full name


com.avaloq.afs.server.bsp.ws.to.impl.OrderPostItTO
Parameters
typeId
Type java.lang.Long
Description The type id.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 187 of 424


AFP Interface Specification

Parameters
subTypeId
Type java.lang.Long
Description The subtype id.
Mandatory no
topic
Type java.lang.String
Description The topic.
Mandatory yes
max Length 400
text
Type java.lang.String
Description The text.
Mandatory no
max Length 4000

2.17.20 QuerySortTO
Represents query sorting.

The full name


com.avaloq.afs.server.bsp.ws.to.impl.QuerySortTO
Parameters
field
Type java.lang.String
Description The field by which the result should be sorted.
Mandatory yes
order
Type QueryOrderingSpecification
Description The sorting order.
Mandatory no
translationMap
Type java.util.Map
Description Optionally translates the fields to the direct values provided here, in the given order.
Mandatory no

2.17.21 PagingTO
Class to use if query result should be pagable. If this class is used the query is performed in a snapshot context (uses oracle
flashback). This will assure a consistent paging. In the initial query call the snapshotId is set to null. For further paging
requests the snapshotId should be taken which is returned in the intials Query PagingOutputTO

The full name


com.avaloq.afs.server.bsp.ws.to.impl.PagingTO
Parameters
limit
Type java.lang.Integer
Description The maximum number of results. If there are more results the PagingResultTO.
isHasMoreResults() is set.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 188 of 424


AFP Interface Specification

Parameters
offset
Type java.lang.Integer
Description The result offset.
Mandatory no
snapshotId
Type java.math.BigDecimal
Description The snapshot id. Should be null for the first call. Not null for paged snapshot calls.
Mandatory yes

2.17.22 ObjectAccessFilterTO
The set of response data for a request can be reduced with this filter.
Accessible objects are the ones related to the objects in the filter by a [grand]parent/[grand]child relationship relative to the
business object type hierarchy.
If all parameters are empty no filter is set so that the response contains all accessible object.
e.g. Accessible objects: BP1[1]{CONT11[11]{MACC111[111], MACC112[112]}, CONT12[12]{MACC121[121]}}
Filter: no, response: BP1{CONT11{MACC111, MACC112}, CONT12{MACC121}}
Filter: containerIdList[11], response: BP1{CONT11{MACC111, MACC112}}
The full name
com.avaloq.afs.server.bsp.ws.to.impl.ObjectAccessFilterTO
Parameters
bpIdList
Type java.util.List [java.lang.Long]
Description The list of business partner to filter.
Mandatory no
ipsIdList
Type java.util.List [java.lang.Long]
Description The list of ips ids to filter.
Mandatory no
personIdList
Type java.util.List [java.lang.Long]
Description The list of person ids to filter.
Mandatory no
containerIdList
Type java.util.List [java.lang.Long]
Description The list of container ids to filter.
Mandatory no
collectionId
Type java.lang.Long
Description The collection ID (e.g. used by services calling through the FDK)
Mandatory no

2.17.23 EditableBooleanTO
A Boolean editable value.

The full name


com.avaloq.afs.server.bsp.ws.to.impl.EditableBooleanTO
Parameters

Copyright 201, Avaloq Evolution AG Page 189 of 424


AFP Interface Specification

Parameters
value
Type java.lang.Boolean
Description the value that could be editable.
Mandatory yes
editable
Type java.lang.Boolean
Description flag that indicates if the value is editable or not.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 190 of 424


AFP Interface Specification

2.18 com.avaloq.afs.server.bsp.ws.to.investmentpolicystatement
2.18.0 ModifyInvestmentPolicyStatementAssetAcknowledgementTO
Parameter object for asset acknowledgements.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentpolicystatement.ModifyInvestmentPolicyStatementAssetAcknowledgementTO

Parameters
assetId
Type java.lang.Long
Description The id of the linked asset.
Mandatory no
validFrom
Type java.util.Date
Description The date an acknowledgement is valid from.
Mandatory no
validTo
Type java.util.Date
Description The date an acknowledgement is valid to.
Mandatory no
acknowledgementReasonId
Type java.lang.Long
Description The id of the reason for this acknowledgement.
Mandatory no
acknowledgementReason
Type java.lang.String
Description Additional text to specify the acknowledgement reason.
Mandatory no
acknowledgementPersonId
Type java.lang.Long
Description The id of the person who did the acknowledgement.
Mandatory no

2.18.1 AddInvestmentPolicyStatementAssetAllocationLinkTO
Parameter object to add a new asset allocation link to a investment policy statement object.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentpolicystatement.AddInvestmentPolicyStatementAssetAllocationLinkTO
Parameters
assetAllocationLinkTypeId
Type java.lang.Long
Description The asset allocation link type id.
Mandatory yes
strategicAssetAllocationId
Type java.lang.Long
Description The strategic asset allocation id.
Mandatory no
tacticalAssetAllocationId
Type java.lang.Long
Description The tactical asset allocation id.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 191 of 424


AFP Interface Specification

Parameters
benchmarkId
Type java.lang.Long
Description The benchmark id.
Mandatory no
efficientFrontierId
Type java.lang.Long
Description The efficient frontier id.
Mandatory no
compensationCashNodeId
Type java.lang.Long
Description The cash node for compensation id.
Mandatory no
priority
Type java.math.BigDecimal
Description The priority.
Mandatory no
validFrom
Type java.util.Date
Description The valid from date.
Mandatory no
validTo
Type java.util.Date
Description The valid to date.
Mandatory no
surveyStrategicAssetAllocation
Type java.lang.Boolean
Description The survey strategic asset allocation flag.
Mandatory no
surveyTacticalAssetAllocation
Type java.lang.Boolean
Description The survey tactical asset allocation flag.
Mandatory no
profiledStrategicAssetAllocationId
Type java.lang.Long
Description The profiled strategic asset allocation id.
Mandatory no
assetAllocationChangeInitiatorId
Type java.lang.Long
Description The asset allocation change initiator id.
Mandatory no
assetAllocationChangeReason
Type java.lang.String
Description The reason for the asset allocation change.
Mandatory no
assetAllocationAdjustmentReason
Type java.lang.String
Description The reason for the asset allocation adjustment.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 192 of 424


AFP Interface Specification

2.18.2 ModifyInvestmentPolicyStatementContainerLinkTO
Parameter object to modify an existing container link on an investment policy statement object.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentpolicystatement.ModifyInvestmentPolicyStatementContainerLinkTO
Parameters
containerLinkTypeId
Type java.lang.Long
Description The container link type id.
Mandatory no
containerId
Type java.lang.Long
Description The container id.
Mandatory no
validFrom
Type java.util.Date
Description The valid from date.
Mandatory no
validTo
Type java.util.Date
Description The valid to date.
Mandatory no

2.18.3 InvestmentPolicyStatementRestrictionAcknowledgementTO
The investment policy statement restriction acknowledgement transfer object.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentpolicystatement.InvestmentPolicyStatementRestrictionAcknowledgementTO

Parameters
groupingObject
Type ObjTO
Description The grouping object.
Mandatory yes
groupingClass
Type CodeTO
Description The grouping class.
Mandatory yes
groupingText
Type java.lang.String
Description The name of the grouping text.
Mandatory yes
validFrom
Type java.util.Date
Description The date an acknowledgement is valid from.
Mandatory yes
validTo
Type java.util.Date
Description The date an acknowledgement is valid to.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 193 of 424


AFP Interface Specification

Parameters
acknowledgementReason
Type CodeTO
Description The reason for this acknowledgement.
Mandatory yes
acknowledgementReasonText
Type java.lang.String
Description Additional text to specify the acknowledgement reason.
Mandatory yes
acknowledgementByPerson
Type ObjTO
Description The person who did the acknowledgement.
Mandatory yes

2.18.4 ModifyInvestmentPolicyStatementRestrictionAcknowledgementTO
Parameter object for restriction acknowledgements.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentpolicystatement.ModifyInvestmentPolicyStatementRestrictionAcknowledgementT
O
Parameters
groupingObjectId
Type java.lang.Long
Description The id of the grouping object.
Mandatory no
groupingClassId
Type java.lang.Long
Description The id of the grouping class.
Mandatory no
groupingText
Type java.lang.String
Description The name of the grouping element.
Mandatory no
validFrom
Type java.util.Date
Description The date an acknowledgement is valid from.
Mandatory no
validTo
Type java.util.Date
Description The date an acknowledgement is valid to.
Mandatory no
acknowledgementReasonId
Type java.lang.Long
Description The id of the reason for this acknowledgement.
Mandatory no
acknowledgementReason
Type java.lang.String
Description Additional text to specify the acknowledgement reason.
Mandatory no
acknowledgementPersonId
Type java.lang.Long
Description The id of the person who did the acknowledgement.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 194 of 424


AFP Interface Specification

2.18.5 InvestmentPolicyStatementAssetAllocationLinkIdentifierTO
Parameter object to identify a unique asset allocation link in an investment policy statement context.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentpolicystatement.InvestmentPolicyStatementAssetAllocationLinkIdentifierTO

Parameters
assetAllocationLinkTypeId
Type java.lang.Long
Description The asset allocation link type id.
Mandatory yes
priority
Type java.math.BigDecimal
Description The priority.
Mandatory no
validFrom
Type java.util.Date
Description The valid from date.
Mandatory yes

2.18.6 InvestmentPolicyStatementAssetAcknowledgementTO
The investment policy statement asset acknowledgement transfer object.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentpolicystatement.InvestmentPolicyStatementAssetAcknowledgementTO
Parameters
asset
Type ObjTO
Description The linked asset.
Mandatory yes
validFrom
Type java.util.Date
Description The date an acknowledgement is valid from.
Mandatory yes
validTo
Type java.util.Date
Description The date an acknowledgement is valid to.
Mandatory no
acknowledgementReason
Type CodeTO
Description The reason for this acknowledgement.
Mandatory yes
acknowledgementReasonText
Type java.lang.String
Description Additional text to specify the acknowledgement reason.
Mandatory no
acknowledgementByPerson
Type ObjTO
Description The person who did the acknowledgement.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 195 of 424


AFP Interface Specification

2.18.7 InvestmentPolicyStatementAssetAcknowledgementIdentifierTO
Parameter object to identify a unique asset acknowledgement in an investment policy statement context.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentpolicystatement.InvestmentPolicyStatementAssetAcknowledgementIdentifierTO

Parameters
assetId
Type java.lang.Long
Description The asset id
Mandatory yes
validFrom
Type java.util.Date
Description The valid from date.
Mandatory yes

2.18.8 EfficientFrontierAnalyticsOutputTO
This class represents a general response (transfer object) message. It's the base class used for all responses to the web
service client. It contains the servers date and a general list of notification.
The full name
com.avaloq.afs.server.bsp.ws.to.investmentpolicystatement.EfficientFrontierAnalyticsOutputTO
Parameters
rawData
Type java.lang.String
Description The raw data.
Mandatory yes
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.18.9 NewInvestmentPolicyStatementTO
Parameter object to create a new investment policy statement object

The full name


com.avaloq.afs.server.bsp.ws.to.investmentpolicystatement.NewInvestmentPolicyStatementTO
Parameters
initialWorkflowAction
Type java.lang.String
Description The workflow action to be used to initialize the order. Expecting the intl_id of code_bbs_wfa.
Mandatory yes
name
Type java.lang.String
Description The name.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 196 of 424


AFP Interface Specification

Parameters
openDate
Type java.util.Date
Description The open date.
Mandatory yes
closeDate
Type java.util.Date
Description The close date.
Mandatory no
effectiveDate
Type java.util.Date
Description The effective date.
Mandatory yes
remark
Type java.lang.String
Description The remark.
Mandatory no
statusId
Type java.lang.Long
Description The id of the status.
Mandatory no
calculatePerformance
Type java.lang.Boolean
Description Trigger performance calculation.
Mandatory no
recalculatePerformance
Type java.lang.Boolean
Description Trigger performance recalculation.
Mandatory no
recalculatePerformanceFrom
Type java.util.Date
Description The performance recalculation date.
Mandatory no
referenceCurrencyId
Type java.lang.Long
Description The id of the reference currency.
Mandatory no
blockId
Type java.lang.Long
Description The id of the reference currency.
Mandatory no

2.18.10 ModifyInvestmentPolicyStatementRestrictionLinkTO
Parameter object to modify an existing restriction link.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentpolicystatement.ModifyInvestmentPolicyStatementRestrictionLinkTO
Parameters
validFrom
Type java.util.Date
Description The date a restriction link is valid from.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 197 of 424


AFP Interface Specification

Parameters
validTo
Type java.util.Date
Description The date a restriction link is valid to.
Mandatory no
batchEvaluation
Type java.lang.Boolean
Description Flag to mark restriction link for batch evaluation.
Mandatory no
preDealCheck
Type java.lang.Boolean
Description Flag to mark restriction link for pre-deal check.
Mandatory no

2.18.11 StrategicAssetAllocationAnalyticsQueryTO
This object holds the parameters required for strategic asset allocation analytics request.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentpolicystatement.StrategicAssetAllocationAnalyticsQueryTO
Parameters
strategicAssetAllocationId
Type java.lang.Long
Description The id of the strategic asset allocation.
Mandatory yes
efficientFrontierId
Type java.lang.Long
Description The id of the efficient frontier.
Mandatory yes
currencyId
Type java.lang.Long
Description The id of the reference currency.
Mandatory yes
rawDataFormat
Type AdvisoryRawDataFormat
Description The format of the raw data response.
Mandatory yes

2.18.12 AddInvestmentPolicyStatementRestrictionAcknowledgementTO
Parameter object for restriction acknowledgements.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentpolicystatement.AddInvestmentPolicyStatementRestrictionAcknowledgementTO

Parameters
groupingObjectId
Type java.lang.Long
Description The id of the grouping object.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 198 of 424


AFP Interface Specification

Parameters
groupingClassId
Type java.lang.Long
Description The id of the grouping class.
Mandatory no
groupingText
Type java.lang.String
Description The name of the grouping element.
Mandatory no
validFrom
Type java.util.Date
Description The date an acknowledgement is valid from.
Mandatory yes
validTo
Type java.util.Date
Description The date an acknowledgement is valid to.
Mandatory no
acknowledgementReasonId
Type java.lang.Long
Description The id of the reason for this acknowledgement.
Mandatory yes
acknowledgementReason
Type java.lang.String
Description Additional text to specify the acknowledgement reason.
Mandatory no
acknowledgementPersonId
Type java.lang.Long
Description The id of the person who did the acknowledgement.
Mandatory yes

2.18.13 StrategicAssetAllocationAnalyticsOutputTO
This class represents a general response (transfer object) message. It's the base class used for all responses to the web
service client. It contains the servers date and a general list of notification.
The full name
com.avaloq.afs.server.bsp.ws.to.investmentpolicystatement.StrategicAssetAllocationAnalyticsOutputTO
Parameters
rawData
Type java.lang.String
Description The raw data.
Mandatory yes
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.18.14 InvestmentPolicyStatementContainerLinkIdentifierTO
Parameter object to identify a unique container link in an investment policy statement context.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentpolicystatement.InvestmentPolicyStatementContainerLinkIdentifierTO

Copyright 201, Avaloq Evolution AG Page 199 of 424


AFP Interface Specification

Parameters
containerId
Type java.lang.Long
Description The container id.
Mandatory yes
validFrom
Type java.util.Date
Description The valid from date.
Mandatory yes

2.18.15 AddInvestmentPolicyStatementContainerLinkTO
Parameter object to add a new container link to an investment policy statement object.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentpolicystatement.AddInvestmentPolicyStatementContainerLinkTO
Parameters
containerTypeId
Type java.lang.Long
Description The container type id.
Mandatory yes
containerId
Type java.lang.Long
Description The container id.
Mandatory no
validFrom
Type java.util.Date
Description The valid from date.
Mandatory no
validTo
Type java.util.Date
Description The valid to date.
Mandatory no

2.18.16 SetInvestmentPolicyStatementAssetAllocationLinkOverrideTO
Parameter object to set an asset allocation link override.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentpolicystatement.SetInvestmentPolicyStatementAssetAllocationLinkOverrideTO

Parameters
hobsId
Type java.lang.Long
Description Defines the hobs id for which the override should be applied.
Mandatory yes
validFrom
Type java.util.Date
Description Defines from when the override is valid.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 200 of 424


AFP Interface Specification

Parameters
validTo
Type java.util.Date
Description Defines until when the override is valid.
Mandatory no
minimumOverride
Type java.math.BigDecimal
Description Defines minimum of the override.
Mandatory no
optimumOverride
Type java.math.BigDecimal
Description Defines optimum of the override.
Mandatory no
maximumOverride
Type java.math.BigDecimal
Description Defines maximum of the override.
Mandatory no
remark
Type java.lang.String
Description Defines remark of the the override.
Mandatory no

2.18.17 InvestmentPolicyStatementAssetAllocationLinkPeriodOverrideTO
Parameter object to identify an investment policy statement period override transfer object.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentpolicystatement.InvestmentPolicyStatementAssetAllocationLinkPeriodOverrideT
O
Parameters
validFrom
Type java.util.Date
Description The valid from date.
Mandatory yes
validTo
Type java.util.Date
Description The valid to date.
Mandatory yes
overrideResultList
Type java.util.List [InvestmentPolicyStatementAssetAllocationLinkOverrideResultTO]
Description The override result list.
Mandatory yes

2.18.18 ModifyInvestmentPolicyStatementTO
Parameter object to create a new investment policy statement order

The full name


com.avaloq.afs.server.bsp.ws.to.investmentpolicystatement.ModifyInvestmentPolicyStatementTO
Parameters

Copyright 201, Avaloq Evolution AG Page 201 of 424


AFP Interface Specification

Parameters
initialWorkflowAction
Type java.lang.String
Description The workflow action to be used to initialize the order. Expecting the intl_id of code_bbs_wfa.
Mandatory yes
investmentPolicyStatementId
Type java.lang.Long
Description The investment policy statement to be used for this order.
Mandatory yes

2.18.19 InvestmentPolicyStatementAssetAllocationLinkTO
The investment policy statement asset allocation link transfer object.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentpolicystatement.InvestmentPolicyStatementAssetAllocationLinkTO
Parameters
type
Type EditableCodeTO
Description The asset allocation link type.
Mandatory yes
strategicAssetAllocation
Type EditableObjTO
Description The strategic asset allocation.
Mandatory no
tacticalAssetAllocation
Type EditableObjTO
Description The tactical asset allocation.
Mandatory no
efficientFrontier
Type EditableObjTO
Description The efficient frontier.
Mandatory no
benchmark
Type EditableObjTO
Description The benchmark.
Mandatory no
cashCompensationNode
Type EditableObjTO
Description The cash compensation node.
Mandatory no
priority
Type EditableBigDecimalTO
Description The priority.
Mandatory no
validFrom
Type EditableDateTO
Description The valid from date of the asset allocation link.
Mandatory yes
validTo
Type EditableDateTO
Description The valid to date of the asset allocation link.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 202 of 424


AFP Interface Specification

Parameters
surveyStrategicAssetAllocation
Type EditableBooleanTO
Description The survey strategic asset allocation flag.
Mandatory no
surveyTacticalAssetAllocation
Type EditableBooleanTO
Description The survey tactical asset allocation flag.
Mandatory no
profiledStrategicAssetAllocation
Type EditableObjTO
Description The profied strategic asset allocation.
Mandatory no
assetAllocationChangeInitiator
Type EditableCodeTO
Description The asset allocation change initiator.
Mandatory no
assetAllocationChangeReason
Type EditableStringTO
Description The reason for the asset allocation change.
Mandatory no
assetAllocationAdjustmentReason
Type EditableStringTO
Description The reason for the asset allocation adjustment.
Mandatory no
overrideList
Type java.util.List [InvestmentPolicyStatementAssetAllocationLinkOverrideTO]
Description The override list.
Mandatory yes
periodOverrideList
Type java.util.List [InvestmentPolicyStatementAssetAllocationLinkPeriodOverrideTO]
Description The period override list.
Mandatory yes

2.18.20 ModifyInvestmentPolicyStatementBasicDataTO
Parameter object to modify the basic data of an investment policy statement object.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentpolicystatement.ModifyInvestmentPolicyStatementBasicDataTO
Parameters
name
Type java.lang.String
Description The name.
Mandatory no
openDate
Type java.util.Date
Description The open date.
Mandatory no
closeDate
Type java.util.Date
Description The close date.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 203 of 424


AFP Interface Specification

Parameters
effectiveDate
Type java.util.Date
Description The effective date.
Mandatory no
remark
Type java.lang.String
Description The remark.
Mandatory no
statusId
Type java.lang.Long
Description The id of the status.
Mandatory no
calculatePerformance
Type java.lang.Boolean
Description Trigger performance calculation.
Mandatory no
recalculatePerformance
Type java.lang.Boolean
Description Trigger performance recalculation.
Mandatory no
recalculatePerformanceFrom
Type java.util.Date
Description The performance recalculation date.
Mandatory no
referenceCurrencyId
Type java.lang.Long
Description The id of the reference currency.
Mandatory no
blockId
Type java.lang.Long
Description The id of the reference currency.
Mandatory no

2.18.21 InvestmentPolicyStatementContainerLinkTO
The investment policy statement container link transfer object.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentpolicystatement.InvestmentPolicyStatementContainerLinkTO
Parameters
type
Type CodeTO
Description The container link type.
Mandatory yes
container
Type ObjTO
Description The container.
Mandatory yes
validFrom
Type java.util.Date
Description Valid from date.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 204 of 424


AFP Interface Specification

Parameters
validTo
Type java.util.Date
Description Valid to date.
Mandatory yes

2.18.22 InvestmentPolicyStatementAssetAllocationLinkOverrideTO
Parameter object to identify an investment policy statement override transfer object.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentpolicystatement.InvestmentPolicyStatementAssetAllocationLinkOverrideTO

Parameters
hobs
Type ObjTO
Description The hobs node.
Mandatory no
validFrom
Type java.util.Date
Description The valid from date.
Mandatory no
validTo
Type java.util.Date
Description The valid to date.
Mandatory no
minimumOverride
Type java.math.BigDecimal
Description The minimum override.
Mandatory no
optimumOverride
Type java.math.BigDecimal
Description The optimum override.
Mandatory no
maximumOverride
Type java.math.BigDecimal
Description The maximum override.
Mandatory no
originalMinimumWeight
Type java.math.BigDecimal
Description The original minimum weight.
Mandatory no
originalOptimumWeight
Type java.math.BigDecimal
Description The original optimum weight.
Mandatory no
originalMaximumWeight
Type java.math.BigDecimal
Description The original maximum weight.
Mandatory no
remark
Type java.lang.String
Description The remark.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 205 of 424


AFP Interface Specification

2.18.23 EfficientFrontierAnalyticsQueryTO
This object holds the parameters required for efficient frontier analytics request.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentpolicystatement.EfficientFrontierAnalyticsQueryTO
Parameters
efficientFrontierId
Type java.lang.Long
Description The id of the efficient frontier.
Mandatory yes
currencyId
Type java.lang.Long
Description The id of the reference currency.
Mandatory yes
rawDataFormat
Type AdvisoryRawDataFormat
Description The format of the raw data response.
Mandatory yes

2.18.24 InvestmentPolicyStatementOrderQueryTO
Query object for investment policy statement orders.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentpolicystatement.InvestmentPolicyStatementOrderQueryTO
Parameters
dateFrom
Type java.util.Date
Description from date filter
Mandatory no
dateTo
Type java.util.Date
Description to date filter
Mandatory no
transactionDateFrom
Type java.util.Date
Description transaction from date filter
Mandatory no
transactionDateTo
Type java.util.Date
Description transaction to date filter
Mandatory no
maxResultSize
Type java.lang.Integer
Description maximal number of results
Mandatory no

Copyright 201, Avaloq Evolution AG Page 206 of 424


AFP Interface Specification

2.18.25 InvestmentPolicyStatementRestrictionAcknowledgementIdentifierTO
Parameter object to identify restriction acknowledgements.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentpolicystatement.InvestmentPolicyStatementRestrictionAcknowledgementIdentifier
TO
Parameters
groupingObjectId
Type java.lang.Long
Description The id of the grouping object.
Mandatory no
groupingClassId
Type java.lang.Long
Description The id of the grouping class.
Mandatory no
groupingText
Type java.lang.String
Description The name of the grouping element.
Mandatory no
validFrom
Type java.util.Date
Description The date an acknowledgement is valid from.
Mandatory yes

2.18.26 InvestmentPolicyStatementRestrictionLinkTO
The investment policy statement restriction link transfer object.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentpolicystatement.InvestmentPolicyStatementRestrictionLinkTO
Parameters
restrictionLinkId
Type java.math.BigDecimal
Description The sequence number.
Mandatory yes
restriction
Type ObjTO
Description The restriction.
Mandatory yes
validFrom
Type java.util.Date
Description The date a restriction link is valid from.
Mandatory yes
validTo
Type java.util.Date
Description The date a restriction link is valid to.
Mandatory yes
type
Type CodeTO
Description The type of the restriction link.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 207 of 424


AFP Interface Specification

Parameters
remark
Type java.lang.String
Description The remark on the restriction link.
Mandatory yes
batchEvaluation
Type java.lang.Boolean
Description Flag to mark restriction link for batch evaluation.
Mandatory yes
preDealCheck
Type java.lang.Boolean
Description Flag to mark restriction link for pre-deal check.
Mandatory yes
restrictionAcknowledgementList
Type java.util.List [InvestmentPolicyStatementRestrictionAcknowledgementTO]
Description The restriction acknowledgements.
Mandatory yes

2.18.27 InvestmentPolicyStatementOrderOutputTO
The investment policy statement order transfer object containing all the investment policy statement order details.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentpolicystatement.InvestmentPolicyStatementOrderOutputTO
Parameters
investmentPolicyStatement
Type ObjTO
Description The investment policy statement.
Mandatory yes
name
Type EditableStringTO
Description The name of the investment policy statement.
Mandatory no
remark
Type EditableStringTO
Description The remark of the investment policy statement.
Mandatory no
referenceCurrency
Type EditableObjTO
Description The reference currency of the investment policy statement.
Mandatory yes
openDate
Type EditableDateTO
Description The open date of the investment policy statement.
Mandatory no
effectiveDate
Type EditableDateTO
Description The effective date of the investment policy statement.
Mandatory no
closeDate
Type EditableDateTO
Description The close date of the investment policy statement.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 208 of 424


AFP Interface Specification

Parameters
status
Type EditableCodeTO
Description The status of the investment policy statement.
Mandatory no
block
Type EditableCodeTO
Description The block of the investment policy statement.
Mandatory no
calculatePerformance
Type EditableBooleanTO
Description The calculate performance flag.
Mandatory no
recalculatePerformance
Type EditableBooleanTO
Description The recalculate performance flag.
Mandatory no
recalculatePerformanceFrom
Type EditableDateTO
Description The recalculate performance from date of the investment policy statement.
Mandatory no
assetAllocationLinkList
Type java.util.List [InvestmentPolicyStatementAssetAllocationLinkTO]
Description The asset allocation link list of the investment policy statement.
Mandatory yes
containerLinkList
Type java.util.List [InvestmentPolicyStatementContainerLinkTO]
Description The list of linked containers of this investment policy statement.
Mandatory yes
assetAcknowledgementList
Type java.util.List [InvestmentPolicyStatementAssetAcknowledgementTO]
Description The list of asset acknowledgements.
Mandatory yes
restrictionLinkList
Type java.util.List [InvestmentPolicyStatementRestrictionLinkTO]
Description The restriction link list of the investment policy statement.
Mandatory yes
workflowActionList
Type java.util.List [CodeTO]
Description The workflow action list.
Mandatory yes
id
Type java.lang.Long
Description The id of the order
Mandatory yes
workflowState
Type CodeTO
Description The workflow status of the order
Mandatory yes
orderDate
Type java.util.Date
Description The date the order was created
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 209 of 424


AFP Interface Specification

Parameters
editable
Type java.lang.Boolean
Description Is the order editable
Mandatory yes
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.18.28 ModifyInvestmentPolicyStatementAssetAllocationLinkTO
Parameter object to modify an existing asset allocation link.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentpolicystatement.ModifyInvestmentPolicyStatementAssetAllocationLinkTO

Parameters
assetAllocationLinkTypeId
Type java.lang.Long
Description The asset allocation link type id.
Mandatory no
strategicAssetAllocationId
Type java.lang.Long
Description The strategic asset allocation id.
Mandatory no
tacticalAssetAllocationId
Type java.lang.Long
Description The tactical asset allocation id.
Mandatory no
benchmarkId
Type java.lang.Long
Description The benchmark id.
Mandatory no
efficientFrontierId
Type java.lang.Long
Description The efficient frontier id.
Mandatory no
compensationCashNodeId
Type java.lang.Long
Description The cash node for compensation id.
Mandatory no
priority
Type java.math.BigDecimal
Description The priority.
Mandatory no
validFrom
Type java.util.Date
Description The valid from date.
Mandatory no
validTo
Type java.util.Date
Description The valid to date.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 210 of 424


AFP Interface Specification

Parameters
surveyStrategicAssetAllocation
Type java.lang.Boolean
Description The survey strategic asset allocation flag.
Mandatory no
surveyTacticalAssetAllocation
Type java.lang.Boolean
Description The survey tactical asset allocation flag.
Mandatory no
profiledStrategicAssetAllocationId
Type java.lang.Long
Description The profiled strategic asset allocation id.
Mandatory no
assetAllocationChangeInitiatorId
Type java.lang.Long
Description The asset allocation change initiator id.
Mandatory no
assetAllocationChangeReason
Type java.lang.String
Description The reason for the asset allocation change.
Mandatory no
assetAllocationAdjustmentReason
Type java.lang.String
Description The reason for the asset allocation adjustment.
Mandatory no

2.18.29 AddInvestmentPolicyStatementAssetAcknowledgementTO
Parameter object for asset acknowledgements.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentpolicystatement.AddInvestmentPolicyStatementAssetAcknowledgementTO

Parameters
assetId
Type java.lang.Long
Description The id of the linked asset.
Mandatory yes
validFrom
Type java.util.Date
Description The date an acknowledgement is valid from.
Mandatory yes
validTo
Type java.util.Date
Description The date an acknowledgement is valid to.
Mandatory no
acknowledgementReasonId
Type java.lang.Long
Description The id of the reason for this acknowledgement.
Mandatory yes
acknowledgementReason
Type java.lang.String
Description Additional text to specify the acknowledgement reason.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 211 of 424


AFP Interface Specification

Parameters
acknowledgementByPersonId
Type java.lang.Long
Description The id of the person who did the acknowledgement.
Mandatory yes

2.18.30 InvestmentPolicyStatementAssetAllocationLinkOverrideResultTO
Parameter object to identify an investment policy statement override result transfer object.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentpolicystatement.InvestmentPolicyStatementAssetAllocationLinkOverrideResultTO

Parameters
hobs
Type ObjTO
Description The hobs node.
Mandatory no
minimumWeight
Type java.math.BigDecimal
Description The minimum weight.
Mandatory no
optimumWeight
Type java.math.BigDecimal
Description The optimum weight.
Mandatory no
maximumWeight
Type java.math.BigDecimal
Description The maximum weight.
Mandatory no
originalMinimumWeight
Type java.math.BigDecimal
Description The original minimum weight.
Mandatory no
originalOptimumWeight
Type java.math.BigDecimal
Description The original optimum weight.
Mandatory no
originalMaximumWeight
Type java.math.BigDecimal
Description The original maximum weight.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 212 of 424


AFP Interface Specification

2.19 com.avaloq.afs.server.bsp.ws.to.investmentproposition
2.19.0 InvestmentPropositionForeignExchangeTradeTO
The investment proposition fx trade transfer object.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentproposition.InvestmentPropositionForeignExchangeTradeTO
Parameters
asset
Type ObjTO
Description The asset.
Mandatory yes
position
Type ObjTO
Description The position.
Mandatory no
buyMarketValue
Type java.math.BigDecimal
Description The buy market value.
Mandatory no
buyCurrency
Type ObjTO
Description The buy currency.
Mandatory yes
buyMoneyAccount
Type ObjTO
Description The buy money account.
Mandatory yes
sellMarketValue
Type java.math.BigDecimal
Description The sell amount.
Mandatory no
sellCurrency
Type ObjTO
Description The sell currency.
Mandatory yes
sellMoneyAccount
Type ObjTO
Description The sell money account.
Mandatory yes
exchangeRate
Type java.math.BigDecimal
Description The exchange rate.
Mandatory yes
maturityDate
Type java.util.Date
Description The date of this fx trade.
Mandatory no
generateTrade
Type java.lang.Boolean
Description Representation of the do_gen flag.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 213 of 424


AFP Interface Specification

2.19.1 InvestmentPropositionRiskAnalyticsOutputTO
The investment proposition risk analytics output transfer object.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentproposition.InvestmentPropositionRiskAnalyticsOutputTO
Parameters
investmentPropositionRiskAnalytics
Type InvestmentPropositionRiskAnalyticsTO
Description The investment proposition risk data.
Mandatory yes
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.19.2 InvestmentPropositionPopulateInstructionTO
Parameters to perform an Investment Proposition response list population.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentproposition.InvestmentPropositionPopulateInstructionTO
Parameters
populatePositionTree
Type java.lang.Boolean
Description Defines whether the response needs to contain the position tree.
Mandatory no
populateTradeList
Type java.lang.Boolean
Description Defines whether the response needs to contain the trade list.
Mandatory no
populateForeignExchangeTradeList
Type java.lang.Boolean
Description Defines whether the response needs to contain the foreign exchange trade list.
Mandatory no
populateMoneyTransferList
Type java.lang.Boolean
Description Defines whether the response needs to contain the money transfer list.
Mandatory no
populateUnsupportedTradeList
Type java.lang.Boolean
Description Defines whether the response needs to contain the unsupported trade list.
Mandatory no
populateRestrictionViolationList
Type java.lang.Boolean
Description Defines whether the response needs to contain the restriction list.
Mandatory no
minimumRestrictionEvaluationResultId
Type java.lang.Long
Description The minimum restriction evaluation result id for the populated restrictions.
Mandatory no
populateInvestmentAmountList
Type java.lang.Boolean
Description Defines whether the response needs to contain the investment amount list.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 214 of 424


AFP Interface Specification

Parameters
populateAdditionalContainerList
Type java.lang.Boolean
Description Defines whether the response needs to contain the add_conts list.
Mandatory no
populateRecommendationList
Type java.lang.Boolean
Description Defines whether the response needs to contain the recommendation list.
Mandatory no

2.19.3 AddInvestmentPropositionPositionTO
The transfer object holding the new investment proposition position data.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentproposition.AddInvestmentPropositionPositionTO
Parameters
marketValue
Type java.math.BigDecimal
Description The market value.
Mandatory no
percentage
Type java.math.BigDecimal
Description The percentage.
Mandatory no
quantity
Type java.math.BigDecimal
Description The quantity.
Mandatory no
optimizerInstruction
Type java.lang.String
Description The optimizer instruction internal id.
Mandatory no
remark
Type java.lang.String
Description The remark.
Mandatory no

2.19.4 InvestmentPropositionHobsNodeTO
The investment proposition hobs node object.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentproposition.InvestmentPropositionHobsNodeTO
Parameters
hobs
Type ObjTO
Description The hobs node.
Mandatory yes
recommendationList
Type java.util.List [ObjTO]
Description The recommendation list.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 215 of 424


AFP Interface Specification

Parameters
id
Type java.lang.String
Description The id of the node.
Mandatory yes
candidateMarketValue
Type EditableBigDecimalTO
Description The candidate market value.
Mandatory yes
candidateAccruals
Type java.math.BigDecimal
Description The candidate accruals.
Mandatory yes
candidatePercentage
Type EditableBigDecimalTO
Description The candidate percentage.
Mandatory yes
diagnostics
Type java.lang.String
Description The diagnostic.
Mandatory no
parent
Type InvestmentPropositionNodeTO
Description The parent node.
Mandatory no
childrenList
Type java.util.List [InvestmentPropositionNodeTO]
Description The list of children.
Mandatory yes

2.19.5 InvestmentPropositionTradeTO
The investment proposition trade transfer object.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentproposition.InvestmentPropositionTradeTO
Parameters
asset
Type ObjTO
Description The asset.
Mandatory yes
position
Type ObjTO
Description The position.
Mandatory yes
currency
Type ObjTO
Description The currency of this trade.
Mandatory yes
market
Type ObjTO
Description The market of this trade.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 216 of 424


AFP Interface Specification

Parameters
moneyAccount
Type ObjTO
Description The money account of this trade.
Mandatory yes
quantity
Type java.math.BigDecimal
Description The trade quantity.
Mandatory yes
amountInTradeCurrency
Type java.math.BigDecimal
Description The trade amount in trade currency.
Mandatory yes
amountInReferenceCurrency
Type java.math.BigDecimal
Description The trade amount in the order's reference currency.
Mandatory yes
priceInTradeCurrency
Type java.math.BigDecimal
Description The price of the asset in trade currency.
Mandatory yes
totalCostInTradeCurrency
Type java.math.BigDecimal
Description The cost in trade currency.
Mandatory no
totalCostInReferenceCurrency
Type java.math.BigDecimal
Description The cost in reference currency.
Mandatory no
generateTrade
Type java.lang.Boolean
Description Representation of the do_gen flag.
Mandatory no

2.19.6 ModifyInvestmentPropositionBasicDataTO
Parameter object to modify the basic data of an investment proposition.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentproposition.ModifyInvestmentPropositionBasicDataTO
Parameters
name
Type java.lang.String
Description The name of the investment proposition.
Mandatory no
max Length 200
displayAssetAllocationId
Type java.lang.Long
Description The asset allocation to be used for displaying the positions in hierarchical fashion.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 217 of 424


AFP Interface Specification

2.19.7 InvestmentPropositionInvestmentAmountTO
The investment proposition investment amount.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentproposition.InvestmentPropositionInvestmentAmountTO
Parameters
typeId
Type java.lang.Long
Description The type of the investment amount.
Mandatory yes
amount
Type java.math.BigDecimal
Description The investment amount.
Mandatory yes
currency
Type ObjTO
Description The currency of the investment amount.
Mandatory yes
moneyAccount
Type ObjTO
Description The money account of the investment amount.
Mandatory yes

2.19.8 InvestmentPropositionRestrictionViolationTO
The investment proposition restriction violation transfer object.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentproposition.InvestmentPropositionRestrictionViolationTO
Parameters
restriction
Type ObjTO
Description The restriction.
Mandatory yes
remark
Type java.lang.String
Description The remark.
Mandatory no
host
Type ObjTO
Description The host.
Mandatory yes
violatingReference
Type ObjTO
Description The violating reference.
Mandatory no
violatingPosition
Type ObjTO
Description The violating position.
Mandatory no
violatingText
Type java.lang.String
Description The violating text.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 218 of 424


AFP Interface Specification

Parameters
violatingClassId
Type java.lang.Long
Description The violating class id.
Mandatory no
assetAllocation
Type ObjTO
Description The asset allocation.
Mandatory no
violatingValue
Type java.math.BigDecimal
Description The violating value.
Mandatory no
valueFrom
Type java.math.BigDecimal
Description The minimum value.
Mandatory no
valueTo
Type java.math.BigDecimal
Description The maximum value.
Mandatory no
restrictionEvaluationId
Type java.lang.Long
Description The restriction evaluation id.
Mandatory yes
priorityId
Type java.lang.Long
Description The priority id.
Mandatory no
overridden
Type java.lang.Boolean
Description The overridden flag.
Mandatory yes
overridable
Type java.lang.Boolean
Description The overridable flag.
Mandatory yes
justification
Type java.lang.String
Description The justification.
Mandatory no

2.19.9 InvestmentPropositionOptimizationInstructionTO
Parameters to perform an Optimization.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentproposition.InvestmentPropositionOptimizationInstructionTO
Parameters
maximumPortfolioTurnover
Type java.math.BigDecimal
Description Defines how much of the portfolio can be turned over. Must be a number between 0 and
100.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 219 of 424


AFP Interface Specification

Parameters
minimumPositionValue
Type java.math.BigDecimal
Description Defines the minimum market value of a position after the optimization. This is used so that
you don't end up with a a very small positions. Imagine a scenario where you have a position
worth 1001 Currency. Your minimum trade volume is 1000. In this scenario it would be
possible to end up with a position worth 1 Currency. The minimum position value prevents
such a scenario.
Mandatory yes
minimumTradeValue
Type java.math.BigDecimal
Description The minimum market value of a trade.
Mandatory yes

2.19.10 InvestmentPropositionPositionTO
The transfer object holding the editable investment proposition position data.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentproposition.InvestmentPropositionPositionTO
Parameters
marketValue
Type java.math.BigDecimal
Description The market value.
Mandatory no
percentage
Type java.math.BigDecimal
Description The percentage.
Mandatory no
quantity
Type java.math.BigDecimal
Description The quantity.
Mandatory no
optimizerInstruction
Type java.lang.String
Description The optimizer instruction internal id.
Mandatory no
remark
Type java.lang.String
Description The remark.
Mandatory no

2.19.11 InvestmentPropositionMoneyTransferTO
The investment proposition money transfer transfer object.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentproposition.InvestmentPropositionMoneyTransferTO
Parameters
currency
Type ObjTO
Description The currency.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 220 of 424


AFP Interface Specification

Parameters
marketValue
Type java.math.BigDecimal
Description The money transfer marketValue.
Mandatory yes
debitMoneyAccount
Type ObjTO
Description The money transfer debit account.
Mandatory yes
creditMoneyAccount
Type ObjTO
Description The money transfer credit account.
Mandatory yes
generateTrade
Type java.lang.Boolean
Description Representation of the do_gen flag.
Mandatory no

2.19.12 ModifyInvestorProtectionDiscussedPositionTO
The transfer object holding the editable investor protection position data.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentproposition.ModifyInvestorProtectionDiscussedPositionTO
Parameters
solicitationTypeId
Type java.lang.Long
Description The id of the solicitation type.
Mandatory no
riskDisclosureDocumentRequired
Type java.lang.Boolean
Description The risk disclosure document required flag.
Mandatory no

2.19.13 InvestmentPropositionQueryTO
Query object for investment proposition orders.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentproposition.InvestmentPropositionQueryTO
Parameters
businessPartnerIdList
Type java.util.List [java.lang.Long]
Description A list of business partner ids (GUIDs) to search for.
Mandatory yes
investmentPolicyStatementIdList
Type java.util.List [java.lang.Long]
Description A list of investment policy statement ids (GUIDs) to search for.
Mandatory yes
containerIdList
Type java.util.List [java.lang.Long]
Description A list of container ids (GUIDs) to search for.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 221 of 424


AFP Interface Specification

Parameters
maxResultSize
Type java.lang.Integer
Description
Mandatory no

2.19.14 InvestmentPropositionPositionNodeTO
The investment proposition position node object.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentproposition.InvestmentPropositionPositionNodeTO
Parameters
asset
Type ObjTO
Description The asset.
Mandatory yes
position
Type ObjTO
Description The position.
Mandatory yes
sourceMarketValue
Type java.math.BigDecimal
Description The source market value.
Mandatory yes
sourceAccruals
Type java.math.BigDecimal
Description The source accruals.
Mandatory yes
sourcePercentage
Type java.math.BigDecimal
Description The source percentage.
Mandatory yes
sourceQuantity
Type java.math.BigDecimal
Description The source quantity.
Mandatory yes
candidateQuantity
Type EditableBigDecimalTO
Description The candidate quantity.
Mandatory yes
sourcePrice
Type java.math.BigDecimal
Description The source price.
Mandatory yes
sourcePriceCurrency
Type ObjTO
Description The source price currency.
Mandatory yes
candidateRemark
Type EditableStringTO
Description The candidate remark.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 222 of 424


AFP Interface Specification

Parameters
candidateOptimizerInstruction
Type EditableCodeTO
Description The candidate optimizer instruction id.
Mandatory yes
id
Type java.lang.String
Description The id of the node.
Mandatory yes
candidateMarketValue
Type EditableBigDecimalTO
Description The candidate market value.
Mandatory yes
candidateAccruals
Type java.math.BigDecimal
Description The candidate accruals.
Mandatory yes
candidatePercentage
Type EditableBigDecimalTO
Description The candidate percentage.
Mandatory yes
diagnostics
Type java.lang.String
Description The diagnostic.
Mandatory no
parent
Type InvestmentPropositionNodeTO
Description The parent node.
Mandatory no
childrenList
Type java.util.List [InvestmentPropositionNodeTO]
Description The list of children.
Mandatory yes

2.19.15 NewInvestmentPropositionTO
Parameter object to create a new InvestmentProposition.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentproposition.NewInvestmentPropositionTO
Parameters
initialWorkflowAction
Type java.lang.String
Description The workflow action to be used to initialize the order. Expecting the intl_id of code_bbs_wfa.
Mandatory yes
name
Type java.lang.String
Description The name of the investment proposition.
Mandatory yes
max Length 200
displayAssetAllocationId
Type java.lang.Long
Description The asset allocation to be used for displaying the positions in hierarchical fashion.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 223 of 424


AFP Interface Specification

Parameters
investmentPolicyStatementId
Type java.lang.Long
Description The investment policy statement to be used for this order.
Mandatory yes
containerId
Type java.lang.Long
Description The container to be used for this order.
Mandatory no
additionalContainerIdList
Type java.util.List [java.lang.Long]
Description The additional container id list.
Mandatory no
doOptimization
Type java.lang.Boolean
Description Defines whether an optimization should be performed.
Mandatory no
advisorySituationDetail
Type InvestorProtectionAdvisorySituationDetailTO
Description Defines the advisory situation parameters.
Mandatory no
optimizationInstruction
Type InvestmentPropositionOptimizationInstructionTO
Description Defines the parameters to be used in the optimization.
Mandatory no

2.19.16 InvestmentPropositionRiskAnalyticsTO
The investment proposition risk analytics transfer object.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentproposition.InvestmentPropositionRiskAnalyticsTO
Parameters
rawData
Type java.lang.String
Description The raw data.
Mandatory yes

2.19.17 InvestmentPropositionUnsupportedTradeTO
The investment proposition trade transfer object.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentproposition.InvestmentPropositionUnsupportedTradeTO
Parameters
asset
Type ObjTO
Description The asset.
Mandatory yes
position
Type ObjTO
Description The position.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 224 of 424


AFP Interface Specification

Parameters
currency
Type ObjTO
Description The currency of this trade.
Mandatory yes
moneyAccount
Type ObjTO
Description The money account of this trade.
Mandatory yes
quantity
Type java.math.BigDecimal
Description The quantity.
Mandatory yes
marketValue
Type java.math.BigDecimal
Description The market value.
Mandatory yes
price
Type java.math.BigDecimal
Description The price.
Mandatory yes
generateTrade
Type java.lang.Boolean
Description Representation of the do_gen flag.
Mandatory no

2.19.18 ModifyInvestmentPropositionPositionTO
The transfer object holding the modify investment proposition position data.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentproposition.ModifyInvestmentPropositionPositionTO
Parameters
positionId
Type java.lang.Long
Description the existing investment proposition position id.
Mandatory yes
position
Type InvestmentPropositionPositionTO
Description the investment proposition position to be updated.
Mandatory yes

2.19.19 ModifyInvestmentPropositionInvestmentAmountDetailTO
The transfer object holding the investment proposition investment amount data.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentproposition.ModifyInvestmentPropositionInvestmentAmountDetailTO
Parameters
typeId
Type java.lang.Long
Description The investment amount type id.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 225 of 424


AFP Interface Specification

Parameters
amount
Type java.math.BigDecimal
Description The investment amount.
Mandatory no
currencyId
Type java.lang.Long
Description The investment amount currency id.
Mandatory no
moneyAccountId
Type java.lang.Long
Description The investment money account id.
Mandatory no

2.19.20 InvestmentPropositionOutputTO
The investment proposition transfer object containing all the investment proposition details.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentproposition.InvestmentPropositionOutputTO
Parameters
name
Type java.lang.String
Description The name of the investment proposition.
Mandatory no
referenceCurrency
Type ObjTO
Description The reference currency of the investment proposition.
Mandatory yes
investmentPolicyStatement
Type ObjTO
Description The investment policy statement of the investment proposition.
Mandatory yes
displayAssetAllocation
Type ObjTO
Description The display asset allocation of the investment proposition.
Mandatory yes
workflowActionList
Type java.util.List [CodeTO]
Description The workflow action list.
Mandatory yes
postItList
Type java.util.List [OrderPostItTO]
Description The postIt list.
Mandatory yes
investmentAmountList
Type java.util.List [InvestmentPropositionInvestmentAmountTO]
Description The investment amount list.
Mandatory yes
tradeList
Type java.util.List [InvestmentPropositionTradeTO]
Description The trade list of the investment proposition.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 226 of 424


AFP Interface Specification

Parameters
foreignExchangeTradeList
Type java.util.List [InvestmentPropositionForeignExchangeTradeTO]
Description The fx trade list of this investment proposition.
Mandatory yes
moneyTransferList
Type java.util.List [InvestmentPropositionMoneyTransferTO]
Description The money transfer list of this investment proposition.
Mandatory yes
unsupportedTradeList
Type java.util.List [InvestmentPropositionUnsupportedTradeTO]
Description The unsupported trade list of the investment proposition.
Mandatory yes
restrictionViolationList
Type java.util.List [InvestmentPropositionRestrictionViolationTO]
Description The restriction violation list of the investment proposition.
Mandatory yes
positionTreeRootNode
Type InvestmentPropositionNodeTO
Description The investment proposition position tree root node.
Mandatory yes
investorProtection
Type InvestorProtectionTO
Description The investor protection.
Mandatory no
container
Type ObjTO
Description The container.
Mandatory no
additionalContainerList
Type java.util.List [ObjTO]
Description The additional container list.
Mandatory yes
id
Type java.lang.Long
Description The id of the order
Mandatory yes
workflowState
Type CodeTO
Description The workflow status of the order
Mandatory yes
orderDate
Type java.util.Date
Description The date the order was created
Mandatory yes
editable
Type java.lang.Boolean
Description Is the order editable
Mandatory yes
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 227 of 424


AFP Interface Specification

2.19.21 InvestmentPropositionNodeTO
The investment proposition node object.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentproposition.InvestmentPropositionNodeTO

See also
- InvestmentPropositionHobsNodeTO
- InvestmentPropositionPositionNodeTO
Parameters
id
Type java.lang.String
Description The id of the node.
Mandatory yes
candidateMarketValue
Type EditableBigDecimalTO
Description The candidate market value.
Mandatory yes
candidateAccruals
Type java.math.BigDecimal
Description The candidate accruals.
Mandatory yes
candidatePercentage
Type EditableBigDecimalTO
Description The candidate percentage.
Mandatory yes
diagnostics
Type java.lang.String
Description The diagnostic.
Mandatory no
parent
Type InvestmentPropositionNodeTO
Description The parent node.
Mandatory no
childrenList
Type java.util.List [InvestmentPropositionNodeTO]
Description The list of children.
Mandatory yes

2.19.22 AddInvestmentPropositionInvestmentAmountTO
The transfer object holding the investment proposition investment amount data.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentproposition.AddInvestmentPropositionInvestmentAmountTO
Parameters
typeId
Type java.lang.Long
Description The investment amount type id.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 228 of 424


AFP Interface Specification

Parameters
amount
Type java.math.BigDecimal
Description The investment amount.
Mandatory no
currencyId
Type java.lang.Long
Description The investment amount currency id.
Mandatory no
moneyAccountId
Type java.lang.Long
Description The investment money account id.
Mandatory no

2.19.23 ModifyInvestmentPropositionInvestmentAmountTO
The transfer object holding the editable investment proposition investment amount data.

The full name


com.avaloq.afs.server.bsp.ws.to.investmentproposition.ModifyInvestmentPropositionInvestmentAmountTO
Parameters
existingCurrencyId
Type java.lang.Long
Description The existing investment amount currency id.
Mandatory yes
existingMoneyAccountId
Type java.lang.Long
Description The existing investment money account id.
Mandatory yes
investmentAmountDetail
Type ModifyInvestmentPropositionInvestmentAmountDetailTO
Description The investment amount detail.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 229 of 424


AFP Interface Specification

2.20 com.avaloq.afs.server.bsp.ws.to.investorprotection
2.20.0 InvestorProtectionTO
The Investor Protection part data.

The full name


com.avaloq.afs.server.bsp.ws.to.investorprotection.InvestorProtectionTO
Parameters
advisorySituation
Type InvestorProtectionAdvisorySituationTO
Description
Mandatory no
positionList
Type java.util.List [InvestorProtectionPositionTO]
Description
Mandatory yes

2.20.1 InvestorProtectionAdvisorySituationDetailTO
The Advisory Situation <em>request</em> Transfer Object.

The full name


com.avaloq.afs.server.bsp.ws.to.investorprotection.InvestorProtectionAdvisorySituationDetailTO
Parameters
clientList
Type java.util.List [java.lang.Long]
Description
Mandatory yes
clientLocationId
Type java.lang.Long
Description
Mandatory no
advisorId
Type java.lang.Long
Description
Mandatory no
advisorLocationId
Type java.lang.Long
Description
Mandatory no
initiativeId
Type java.lang.Long
Description
Mandatory no
serviceTypeId
Type java.lang.Long
Description
Mandatory no
mediumId
Type java.lang.Long
Description
Mandatory no

Copyright 201, Avaloq Evolution AG Page 230 of 424


AFP Interface Specification

2.20.2 InvestorProtectionClientTO
The Client Transfer Object.

The full name


com.avaloq.afs.server.bsp.ws.to.investorprotection.InvestorProtectionClientTO
Parameters
person
Type EditableObjTO
Description
Mandatory yes
legalNormList
Type java.util.List [CodeTO]
Description
Mandatory yes

2.20.3 InvestorProtectionAdvisorySituationTO
The Advisory Situation Transfer Object.

The full name


com.avaloq.afs.server.bsp.ws.to.investorprotection.InvestorProtectionAdvisorySituationTO
Parameters
clientList
Type java.util.List [InvestorProtectionClientTO]
Description
Mandatory yes
clientLocation
Type EditableObjTO
Description
Mandatory no
advisor
Type EditableObjTO
Description
Mandatory no
advisorLocation
Type EditableObjTO
Description
Mandatory no
initiative
Type EditableCodeTO
Description
Mandatory no
serviceType
Type EditableCodeTO
Description
Mandatory no
medium
Type EditableCodeTO
Description
Mandatory no

Copyright 201, Avaloq Evolution AG Page 231 of 424


AFP Interface Specification

2.20.4 InvestorProtectionPositionTO
The investor protection discussed position transfer object.

The full name


com.avaloq.afs.server.bsp.ws.to.investorprotection.InvestorProtectionPositionTO
Parameters
position
Type ObjTO
Description The position.
Mandatory yes
asset
Type ObjTO
Description The asset.
Mandatory yes
quantity
Type java.math.BigDecimal
Description The quantity.
Mandatory yes
solicitationType
Type CodeTO
Description The solicitation type.
Mandatory no
riskDisclosureDocumentRequired
Type java.lang.Boolean
Description The risk disclosure document required flag.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 232 of 424


AFP Interface Specification

2.21 com.avaloq.afs.server.bsp.ws.to.key
2.21.0 SimpleKeyTO
TO representing only the most basic key details - the internal id and value.

The full name


com.avaloq.afs.server.bsp.ws.to.key.SimpleKeyTO
Parameters
internalId
Type java.lang.String
Description
Mandatory yes
value
Type java.lang.String
Description
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 233 of 424


AFP Interface Specification

2.22 com.avaloq.afs.server.bsp.ws.to.lookup
2.22.0 LookupSearchCriteriaOrganisationalEntityTO
This class represents the search criteria for the Organisational Entity lookup.

The full name


com.avaloq.afs.server.bsp.ws.to.lookup.LookupSearchCriteriaOrganisationalEntityTO
Parameters
organisationalEntityList
Type java.util.List [java.lang.Long]
Description The list of organisational entities.
Mandatory yes
roleList
Type java.util.List [java.lang.Long]
Description the list of roles
Mandatory yes
resolveOrganisationalEntity
Type java.lang.Boolean
Description resolve organisational entity flag
Mandatory no

2.22.1 LookupAddressSearchCriteriaTO
This class represents the search criteria for the address lookup.

The full name


com.avaloq.afs.server.bsp.ws.to.lookup.LookupAddressSearchCriteriaTO
Parameters
maxResultSize
Type java.lang.Integer
Description the max. rowcount for the result
Mandatory no
isHistorized
Type java.lang.Boolean
Description also search historized values?
Mandatory no
fullAddress
Type java.lang.String
Description Full address text
Mandatory no
max Length 255
addressTypeId
Type java.lang.Long
Description address type
Mandatory no
ownerObjectId
Type java.lang.Long
Description owner (business partner or person)
Mandatory no
restrictToRelatedPersons
Type java.lang.Boolean
Description restrict owner to related persons.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 234 of 424


AFP Interface Specification

Parameters
languageInclIdList
Type java.util.List [java.lang.Long]
Description Language (include list)
Mandatory no
languageExclIdList
Type java.util.List [java.lang.Long]
Description Language (exclude list)
Mandatory no
firm
Type java.lang.String
Description firm
Mandatory no
max Length 80
department
Type java.lang.String
Description firm
Mandatory no
max Length 50
firstName
Type java.lang.String
Description first name
Mandatory no
max Length 80
middleName
Type java.lang.String
Description middle name
Mandatory no
max Length 80
lastName
Type java.lang.String
Description last name
Mandatory no
max Length 80
additionalName
Type java.lang.String
Description last name
Mandatory no
max Length 140
crof
Type java.lang.String
Description c/o
Mandatory no
max Length 60
residency
Type java.lang.String
Description residency
Mandatory no
max Length 50
attentionOf
Type java.lang.String
Description attention of
Mandatory no
max Length 60

Copyright 201, Avaloq Evolution AG Page 235 of 424


AFP Interface Specification

Parameters
street
Type java.lang.String
Description street
Mandatory no
max Length 50
streetNumber
Type java.lang.String
Description street number
Mandatory no
max Length 50
poBox
Type java.lang.String
Description po box
Mandatory no
max Length 50
streetAddition
Type java.lang.String
Description addition street
Mandatory no
max Length 50
zip
Type java.lang.String
Description zip
Mandatory no
max Length 50
city
Type java.lang.String
Description city
Mandatory no
max Length 50
stateId
Type java.lang.Long
Description state (object)
Mandatory no
state
Type java.lang.String
Description state (text)
Mandatory no
max Length 50
countryId
Type java.lang.Long
Description country
Mandatory no
addressMediumId
Type java.lang.Long
Description address medium
Mandatory no
addressKindId
Type java.lang.Long
Description address kind
Mandatory no

Copyright 201, Avaloq Evolution AG Page 236 of 424


AFP Interface Specification

Parameters
electronicAddress
Type java.lang.String
Description electronic address
Mandatory no
max Length 200
countryCallingCodeId
Type java.lang.Long
Description country calling code
Mandatory no
phoneAreaCode
Type java.lang.String
Description phone area code
Mandatory no
phoneLocalNumber
Type java.lang.String
Description phone local number
Mandatory no
phoneExtension
Type java.lang.String
Description phone extension
Mandatory no
buId
Type java.lang.Long
Description The business unit.
Mandatory no
objectIdList
Type java.util.List [java.lang.Long]
Description Object id list.
Mandatory no
keyCriteria
Type LookupSearchCriteriaKeyTO
Description the search criteria for the object key
Mandatory no
histNameCriteria
Type LookupSearchCriteriaHistNameTO
Description the search criteria for the object name
Mandatory no
relation1Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (1)
Mandatory no
relation2Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (2)
Mandatory no
relation3Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (3)
Mandatory no
openDateFrom
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no

Copyright 201, Avaloq Evolution AG Page 237 of 424


AFP Interface Specification

Parameters
openDateTo
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no
closeDateFrom
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
closeDateTo
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
status
Type Status
Description Active / inactive flag.
Mandatory no
class1InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 1st search criteria for the class lookup
Mandatory no
class2InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 2nd search criteria for the class lookup
Mandatory no
class3InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 3rd search criteria for the class lookup
Mandatory no
class4InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 4th search criteria for the class lookup
Mandatory no
class5InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 5th search criteria for the class lookup
Mandatory no
lookupScope
Type LookupScope
Description The LookupScope of the current SearchCriteria.
Mandatory yes

2.22.2 LookupContainerCRMSearchCriteriaTO
This class represents the CRM search criteria for the container lookup.

The full name


com.avaloq.afs.server.bsp.ws.to.lookup.LookupContainerCRMSearchCriteriaTO
Parameters
organisationalEntityCriteria
Type LookupSearchCriteriaOrganisationalEntityTO
Description the search criteria for the organisational entity
Mandatory no

Copyright 201, Avaloq Evolution AG Page 238 of 424


AFP Interface Specification

Parameters
collectionCriteria
Type LookupSearchCriteriaCollectionTO
Description the search criteria for the collection
Mandatory no
branchBpClassCriteria
Type LookupSearchCriteriaClassifTO
Description the search criteria for the branch BP class
Mandatory no
personElectronicalAddress
Type java.lang.String
Description Electronical address of a person.
Mandatory no
max Length 200
personNationalityIdList
Type java.util.List [java.lang.Long]
Description Nationality of a person.
Mandatory no
personDomicileCountryIdList
Type java.util.List [java.lang.Long]
Description Domicilie country of a person.
Mandatory no
personDomicileZip
Type java.lang.String
Description Domicile zip code of a person.
Mandatory no
max Length 50
personDomicileCity
Type java.lang.String
Description Domicile city of a person.
Mandatory no
max Length 50
totalValueFrom
Type java.math.BigDecimal
Description Total Value From
Mandatory no
totalValueTo
Type java.math.BigDecimal
Description Total Value To
Mandatory no
totalCashValueFrom
Type java.math.BigDecimal
Description Total Cash Value From
Mandatory no
totalCashValueTo
Type java.math.BigDecimal
Description Total Value To
Mandatory no
reportingCurrencyId
Type java.lang.Long
Description Total Values Reporting Currency
Mandatory no

Copyright 201, Avaloq Evolution AG Page 239 of 424


AFP Interface Specification

Parameters
calculateTotalValues
Type java.lang.Boolean
Description Calculate Total Values
Mandatory no
includeAccrualsForTotalValues
Type java.lang.Boolean
Description Include accruals for Total Values
Mandatory no
assetId
Type java.lang.Long
Description Asset
Mandatory no
personBirthDate
Type java.util.Date
Description Birthdate of a person. <p> You can either use <style size="9" pdfFontName="Courier"> .
personBirthDate</style> or <style size="9" pdfFontName="Courier"> .
personBirthDateFrom</style> and <style size="9" pdfFontName="Courier"> .
personBirthDateTo</style>. Using both will raise an exception. </p>
Mandatory no
personBirthDateFrom
Type java.util.Date
Description Birthdate of a person. <p> Use in combination with <style size="9" pdfFontName="Courier"
> .personBirthDateTo</style>. </p> <p> You can either use <style size="9"
pdfFontName="Courier"> .personBirthDate</style> or <style size="9" pdfFontName="
Courier"> .personBirthDateFrom</style> and <style size="9" pdfFontName="Courier"> .
personBirthDateTo</style>. Using both will raise an exception. </p>
Mandatory no
personBirthDateTo
Type java.util.Date
Description Birthdate of a person. <p> Use in combination with <style size="9" pdfFontName="Courier"
> .personBirthDateFrom</style>. </p> <p> You can either use <style size="9"
pdfFontName="Courier"> .personBirthDate</style> or <style size="9" pdfFontName="
Courier"> .personBirthDateFrom</style> and <style size="9" pdfFontName="Courier"> .
personBirthDateTo</style>. Using both will raise an exception. </p>
Mandatory no
advisoryTypeContClassId
Type java.lang.Long
Description Advisory type container class id.
Mandatory no
assetKeyCriteria
Type LookupSearchCriteriaKeyTO
Description the search criteria for the asset key
Mandatory no
strategyCollectionId
Type java.lang.Long
Description Strategy collection id.
Mandatory no
mandateIpsClassId
Type java.lang.Long
Description Mandate Ips class id.
Mandatory no
personNameCriteria
Type LookupSearchCriteriaHistNameTO
Description the search criteria for the person name
Mandatory no

Copyright 201, Avaloq Evolution AG Page 240 of 424


AFP Interface Specification

Parameters
personKeyCriteria
Type LookupSearchCriteriaKeyTO
Description the search criteria for the person key
Mandatory no
bpPersonRelationTypeCriteria
Type LookupSearchCriteriaBpPersonRelationTypeTO
Description the search criteria for the bp person relation type
Mandatory no
assetAllocationIdList
Type java.util.List [java.lang.Long]
Description Asset allocation id list.
Mandatory no
modelPortfolioIdList
Type java.util.List [java.lang.Long]
Description Model portfolio id list.
Mandatory no
businessPartnerIdList
Type java.util.List [java.lang.Long]
Description business partner id list
Mandatory no
personIdList
Type java.util.List [java.lang.Long]
Description person id list
Mandatory no
ownershipTypeId
Type java.lang.Long
Description ownership type
Mandatory no
referenceCurrencyIdList
Type java.util.List [java.lang.Long]
Description reference currency
Mandatory no
maxResultSize
Type java.lang.Integer
Description Maximum count of rows.
Mandatory no
containerWithPositionId
Type java.lang.Long
Description Cont. with Pos. (incl, excl, restr)
Mandatory no
hasPositionWithAssetId
Type java.lang.Long
Description Has Pos of Asset
Mandatory no
subBusinessUnitId
Type java.lang.Long
Description SBU
Mandatory no
buId
Type java.lang.Long
Description The business unit.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 241 of 424


AFP Interface Specification

Parameters
objectIdList
Type java.util.List [java.lang.Long]
Description Object id list.
Mandatory no
keyCriteria
Type LookupSearchCriteriaKeyTO
Description the search criteria for the object key
Mandatory no
histNameCriteria
Type LookupSearchCriteriaHistNameTO
Description the search criteria for the object name
Mandatory no
relation1Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (1)
Mandatory no
relation2Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (2)
Mandatory no
relation3Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (3)
Mandatory no
openDateFrom
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no
openDateTo
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no
closeDateFrom
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
closeDateTo
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
status
Type Status
Description Active / inactive flag.
Mandatory no
class1InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 1st search criteria for the class lookup
Mandatory no
class2InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 2nd search criteria for the class lookup
Mandatory no

Copyright 201, Avaloq Evolution AG Page 242 of 424


AFP Interface Specification

Parameters
class3InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 3rd search criteria for the class lookup
Mandatory no
class4InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 4th search criteria for the class lookup
Mandatory no
class5InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 5th search criteria for the class lookup
Mandatory no
lookupScope
Type LookupScope
Description The LookupScope of the current SearchCriteria.
Mandatory yes

2.22.3 LookupCurrencySearchCriteriaTO
This class represents the search criteria for the currency lookup.

The full name


com.avaloq.afs.server.bsp.ws.to.lookup.LookupCurrencySearchCriteriaTO
Parameters
buId
Type java.lang.Long
Description The business unit.
Mandatory no
maxResultSize
Type java.lang.Integer
Description
Mandatory no
lookupScope
Type LookupScope
Description The LookupScope of the current SearchCriteria.
Mandatory yes

2.22.4 LookupAssetSearchCriteriaTO
This class represents the search criteria for the asset lookup.

The full name


com.avaloq.afs.server.bsp.ws.to.lookup.LookupAssetSearchCriteriaTO
Parameters
businessObjectSubTypeId
Type java.lang.Long
Description the object sub type
Mandatory no
issuerIdList
Type java.util.List [java.lang.Long]
Description issuer list
Mandatory no

Copyright 201, Avaloq Evolution AG Page 243 of 424


AFP Interface Specification

Parameters
marketplaceIdList
Type java.util.List [java.lang.Long]
Description marketplace list
Mandatory no
nominalCurrencyIdList
Type java.util.List [java.lang.Long]
Description nominal currency list
Mandatory no
defaultTradeCurrencyIdList
Type java.util.List [java.lang.Long]
Description default trade currency list
Mandatory no
underlyingAssetIdList
Type java.util.List [java.lang.Long]
Description underlying asset list
Mandatory no
domicileCountryIdList
Type java.util.List [java.lang.Long]
Description domicile country list
Mandatory no
strikeDateFrom
Type java.util.Date
Description strike date (from)
Mandatory no
strikeDateTo
Type java.util.Date
Description strike date (to)
Mandatory no
exerciseRightTypeId
Type java.lang.Long
Description exercise right type
Mandatory no
optionStyleId
Type java.lang.Long
Description option style
Mandatory no
interestRateFrom
Type java.math.BigDecimal
Description interest rate (from)
Mandatory no
interestRateTo
Type java.math.BigDecimal
Description interest rate (to)
Mandatory no
basketAssetIdList
Type java.util.List [java.lang.Long]
Description Asset(s) Contained In Basket list
Mandatory no
slbcTypeId
Type java.lang.Long
Description SLBC type
Mandatory no

Copyright 201, Avaloq Evolution AG Page 244 of 424


AFP Interface Specification

Parameters
counterpartyContainerId
Type java.lang.Long
Description counterparty container
Mandatory no
repoContractTypeId
Type java.lang.Long
Description repo contract type
Mandatory no
maxResultSize
Type java.lang.Integer
Description Maximum count of rows.
Mandatory no
blockingCodeInclId
Type java.lang.Long
Description blocking code (incl.)
Mandatory no
blockingCodeExclId
Type java.lang.Long
Description blocking code (excl.)
Mandatory no
productIdList
Type java.util.List [java.lang.Long]
Description product
Mandatory no
includeSubsidiaries
Type java.lang.Boolean
Description Incl. Subsidiaries
Mandatory no
issueDateFrom
Type java.util.Date
Description issue date (from)
Mandatory no
issueDateTo
Type java.util.Date
Description issue date (to)
Mandatory no
maturityDateFrom
Type java.util.Date
Description maturity date (from)
Mandatory no
maturityDateTo
Type java.util.Date
Description maturity date (to)
Mandatory no
couponDateFrom
Type java.util.Date
Description coupon date (from)
Mandatory no
couponDateTo
Type java.util.Date
Description coupon date (to)
Mandatory no

Copyright 201, Avaloq Evolution AG Page 245 of 424


AFP Interface Specification

Parameters
couponReferenceDateFrom
Type java.util.Date
Description coupon reference date (from)
Mandatory no
couponReferenceDateTo
Type java.util.Date
Description coupon reference date (to)
Mandatory no
buId
Type java.lang.Long
Description The business unit.
Mandatory no
objectIdList
Type java.util.List [java.lang.Long]
Description Object id list.
Mandatory no
keyCriteria
Type LookupSearchCriteriaKeyTO
Description the search criteria for the object key
Mandatory no
histNameCriteria
Type LookupSearchCriteriaHistNameTO
Description the search criteria for the object name
Mandatory no
relation1Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (1)
Mandatory no
relation2Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (2)
Mandatory no
relation3Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (3)
Mandatory no
openDateFrom
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no
openDateTo
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no
closeDateFrom
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
closeDateTo
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no

Copyright 201, Avaloq Evolution AG Page 246 of 424


AFP Interface Specification

Parameters
status
Type Status
Description Active / inactive flag.
Mandatory no
class1InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 1st search criteria for the class lookup
Mandatory no
class2InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 2nd search criteria for the class lookup
Mandatory no
class3InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 3rd search criteria for the class lookup
Mandatory no
class4InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 4th search criteria for the class lookup
Mandatory no
class5InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 5th search criteria for the class lookup
Mandatory no
lookupScope
Type LookupScope
Description The LookupScope of the current SearchCriteria.
Mandatory yes

2.22.5 LookupSearchCriteriaCollectionTO
This class represents the search criteria for the collection lookup.

The full name


com.avaloq.afs.server.bsp.ws.to.lookup.LookupSearchCriteriaCollectionTO
Parameters
collectionList
Type java.util.List [java.lang.Long]
Description
Mandatory yes

2.22.6 LookupPersonSearchCriteriaTO
This class represents the search criteria for the person lookup.

The full name


com.avaloq.afs.server.bsp.ws.to.lookup.LookupPersonSearchCriteriaTO
Parameters
personTypeInclIdList
Type java.util.List [java.lang.Long]
Description List of person type ids (include list).
Mandatory no

Copyright 201, Avaloq Evolution AG Page 247 of 424


AFP Interface Specification

Parameters
personTypeExclIdList
Type java.util.List [java.lang.Long]
Description List of person type ids (exclude list).
Mandatory no
languageInclIdList
Type java.util.List [java.lang.Long]
Description Language of a natural person (include list).
Mandatory no
languageExclIdList
Type java.util.List [java.lang.Long]
Description Language of a natural person (exclude list).
Mandatory no
genderId
Type java.lang.Long
Description Gender of a natural person.
Mandatory no
maritalStatusInclIdList
Type java.util.List [java.lang.Long]
Description Marital status of a natural person (include list).
Mandatory no
maritalStatusExclIdList
Type java.util.List [java.lang.Long]
Description Marital status of a natural person (exclude list).
Mandatory no
domicileAddressInclIdList
Type java.util.List [java.lang.Long]
Description domicile address (include list).
Mandatory no
domicileAddressExclIdList
Type java.util.List [java.lang.Long]
Description domicile address (exclude list).
Mandatory no
domicileCountryIdList
Type java.util.List [java.lang.Long]
Description domicile country.
Mandatory no
nationalityInclIdList
Type java.util.List [java.lang.Long]
Description nationality country (include list).
Mandatory no
nationalityExclIdList
Type java.util.List [java.lang.Long]
Description nationality country (exclude list).
Mandatory no
accountOwnerBusinessPartnerIdList
Type java.util.List [java.lang.Long]
Description List of 'is acc./reg. owner of'.
Mandatory no
authorityBusinessPartnerIdList
Type java.util.List [java.lang.Long]
Description Authority of a person.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 248 of 424


AFP Interface Specification

Parameters
beneficialOwnerBusinessPartnerIdList
Type java.util.List [java.lang.Long]
Description Beneficial owner of a person.
Mandatory no
beneficialOwnerTrustIdList
Type java.util.List [java.lang.Long]
Description Beneficial owner of a person.
Mandatory no
authorityAtDate
Type java.util.Date
Description The valid-at date for all BP-Person relation types.
Mandatory no
identificationTypeId
Type java.lang.Long
Description Identification type of a person.
Mandatory no
identificationNumber
Type java.lang.String
Description Identification number of a person.
Mandatory no
max Length 80
clientStatusIdList
Type java.util.List [java.lang.Long]
Description Client status of a person.
Mandatory no
legalFormId
Type java.lang.Long
Description Legal form of a person.
Mandatory no
firstName
Type java.lang.String
Description First name of a person.
Mandatory no
max Length 80
middleName
Type java.lang.String
Description Middle name of a person.
Mandatory no
max Length 80
lastName
Type java.lang.String
Description Last name of a person.
Mandatory no
max Length 80
secondLastName
Type java.lang.String
Description 2nd last name of a person.
Mandatory no
max Length 80
birthName
Type java.lang.String
Description Birth name of a person.
Mandatory no
max Length 80

Copyright 201, Avaloq Evolution AG Page 249 of 424


AFP Interface Specification

Parameters
artistName
Type java.lang.String
Description Artist name of a person.
Mandatory no
max Length 80
alternativeTitle
Type java.lang.String
Description Alternative title of a person.
Mandatory no
max Length 60
titleInclIdList
Type java.util.List [java.lang.Long]
Description Title of a person (include list).
Mandatory no
titleExclIdList
Type java.util.List [java.lang.Long]
Description Title of a person (exclude list).
Mandatory no
addressStreet
Type java.lang.String
Description The street. Part of the address criteria of the person lookup.
Mandatory no
max Length 50
addressStreetNumber
Type java.lang.String
Description The street number. Part of the address criteria of the person lookup.
Mandatory no
max Length 50
addressZip
Type java.lang.String
Description The zip. Part of the address criteria of the person lookup.
Mandatory no
max Length 50
addressCity
Type java.lang.String
Description The city. Part of the address criteria of the person lookup.
Mandatory no
max Length 50
addressCountryIdList
Type java.util.List [java.lang.Long]
Description The country. Part of the address criteria of the person lookup.
Mandatory no
electronicalAddress
Type java.lang.String
Description Electronical address of a person.
Mandatory no
max Length 200
birthDate
Type java.util.Date
Description Birthdate of a person. <p> You can either use <style size="9" pdfFontName="Courier"> .
birthDate</style> or <style size="9" pdfFontName="Courier"> .birthDateFrom</style> and
<style size="9" pdfFontName="Courier"> .birthDateTo</style>. Using both will raise an
exception. </p>
Mandatory no

Copyright 201, Avaloq Evolution AG Page 250 of 424


AFP Interface Specification

Parameters
birthDateFrom
Type java.util.Date
Description Birthdate of a person. <p> Use in combination with <style size="9" pdfFontName="Courier"
> .birthDateTo</style>. </p> <p> You can either use <style size="9" pdfFontName="
Courier"> .birthDate</style> or <style size="9" pdfFontName="Courier"> .
birthDateFrom</style> and <style size="9" pdfFontName="Courier"> .birthDateTo</style>.
Using both will raise an exception. </p>
Mandatory no
birthDateTo
Type java.util.Date
Description Birthdate of a person. <p> Use in combination with <style size="9" pdfFontName="Courier"
> .birthDateFrom</style>. </p> <p> You can either use <style size="9" pdfFontName="
Courier"> .birthDate</style> or <style size="9" pdfFontName="Courier"> .
birthDateFrom</style> and <style size="9" pdfFontName="Courier"> .birthDateTo</style>.
Using both will raise an exception. </p>
Mandatory no
establishDate
Type java.util.Date
Description Establishment date of a legal person. <p> You can either use <style size="9"
pdfFontName="Courier"> .establishDate</style> or <style size="9" pdfFontName="Courier"
> .establishDateFrom</style> and <style size="9" pdfFontName="Courier"> .
establishDateTo</style>. Using both will raise an exception. </p>
Mandatory no
establishDateFrom
Type java.util.Date
Description Establishment date of a legal person. <p> Use in combination with <style size="9"
pdfFontName="Courier"> .establishDateTo</style>. </p> <p> You can either use <style
size="9" pdfFontName="Courier"> .establishDate</style> or <style size="9"
pdfFontName="Courier"> .establishDateFrom</style> and <style size="9" pdfFontName="
Courier"> .establishDateTo</style>. Using both will raise an exception. </p>
Mandatory no
establishDateTo
Type java.util.Date
Description Establishment date of a legal person. <p> Use in combination with <style size="9"
pdfFontName="Courier"> .establishDateFrom</style>. </p> <p> You can either use <style
size="9" pdfFontName="Courier"> .establishDate</style> or <style size="9"
pdfFontName="Courier"> .establishDateFrom</style> and <style size="9" pdfFontName="
Courier"> .establishDateTo</style>. Using both will raise an exception. </p>
Mandatory no
jobTypeId
Type java.lang.Long
Description Job Type.
Mandatory no
jobUserTypeId
Type java.lang.Long
Description Job User Type.
Mandatory no
maxResultSize
Type java.lang.Integer
Description Maximum count of rows.
Mandatory no
buId
Type java.lang.Long
Description The business unit.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 251 of 424


AFP Interface Specification

Parameters
objectIdList
Type java.util.List [java.lang.Long]
Description Object id list.
Mandatory no
keyCriteria
Type LookupSearchCriteriaKeyTO
Description the search criteria for the object key
Mandatory no
histNameCriteria
Type LookupSearchCriteriaHistNameTO
Description the search criteria for the object name
Mandatory no
relation1Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (1)
Mandatory no
relation2Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (2)
Mandatory no
relation3Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (3)
Mandatory no
openDateFrom
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no
openDateTo
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no
closeDateFrom
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
closeDateTo
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
status
Type Status
Description Active / inactive flag.
Mandatory no
class1InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 1st search criteria for the class lookup
Mandatory no
class2InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 2nd search criteria for the class lookup
Mandatory no

Copyright 201, Avaloq Evolution AG Page 252 of 424


AFP Interface Specification

Parameters
class3InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 3rd search criteria for the class lookup
Mandatory no
class4InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 4th search criteria for the class lookup
Mandatory no
class5InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 5th search criteria for the class lookup
Mandatory no
lookupScope
Type LookupScope
Description The LookupScope of the current SearchCriteria.
Mandatory yes

2.22.7 LookupSafeDepositBoxContractSearchCriteriaTO
This class represents the search criteria for the safe deposit box contract lookup.

The full name


com.avaloq.afs.server.bsp.ws.to.lookup.LookupSafeDepositBoxContractSearchCriteriaTO
Parameters
vaultIdList
Type java.util.List [java.lang.Long]
Description Vault
Mandatory no
hirerBusinessPartnerIdList
Type java.util.List [java.lang.Long]
Description hirer business partner
Mandatory no
payerMoneyAccountIdList
Type java.util.List [java.lang.Long]
Description payer money account
Mandatory no
maxResultSize
Type java.lang.Integer
Description Maximum count of rows.
Mandatory no
buId
Type java.lang.Long
Description The business unit.
Mandatory no
objectIdList
Type java.util.List [java.lang.Long]
Description Object id list.
Mandatory no
keyCriteria
Type LookupSearchCriteriaKeyTO
Description the search criteria for the object key
Mandatory no

Copyright 201, Avaloq Evolution AG Page 253 of 424


AFP Interface Specification

Parameters
histNameCriteria
Type LookupSearchCriteriaHistNameTO
Description the search criteria for the object name
Mandatory no
relation1Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (1)
Mandatory no
relation2Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (2)
Mandatory no
relation3Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (3)
Mandatory no
openDateFrom
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no
openDateTo
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no
closeDateFrom
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
closeDateTo
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
status
Type Status
Description Active / inactive flag.
Mandatory no
class1InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 1st search criteria for the class lookup
Mandatory no
class2InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 2nd search criteria for the class lookup
Mandatory no
class3InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 3rd search criteria for the class lookup
Mandatory no
class4InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 4th search criteria for the class lookup
Mandatory no

Copyright 201, Avaloq Evolution AG Page 254 of 424


AFP Interface Specification

Parameters
class5InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 5th search criteria for the class lookup
Mandatory no
lookupScope
Type LookupScope
Description The LookupScope of the current SearchCriteria.
Mandatory yes

2.22.8 LookupPositionSearchCriteriaTO
This class represents the search criteria for the position lookup.

The full name


com.avaloq.afs.server.bsp.ws.to.lookup.LookupPositionSearchCriteriaTO
Parameters
businessObjectSubTypeId
Type java.lang.Long
Description the object sub type
Mandatory no
personId
Type java.lang.Long
Description person
Mandatory no
bpPersonRelationTypeCriteria
Type LookupSearchCriteriaBpPersonRelationTypeTO
Description the search criteria for the bp person relation type
Mandatory no
businessPartnerId
Type java.lang.Long
Description business partner
Mandatory no
containerId
Type java.lang.Long
Description container
Mandatory no
collectionId
Type java.lang.Long
Description collection
Mandatory no
currencyId
Type java.lang.Long
Description currency
Mandatory no
assetId
Type java.lang.Long
Description asset
Mandatory no
productId
Type java.lang.Long
Description product
Mandatory no

Copyright 201, Avaloq Evolution AG Page 255 of 424


AFP Interface Specification

Parameters
custodianId
Type java.lang.Long
Description custodian
Mandatory no
subBusinessUnitId
Type java.lang.Long
Description SBU
Mandatory no
customerAccountingId
Type java.lang.Long
Description CUA
Mandatory no
balanceAccountId
Type java.lang.Long
Description Balance Account
Mandatory no
custodyAccountAtCustodyInstituteId
Type java.lang.Long
Description Custody account at custody institute
Mandatory no
collateralAgreementId
Type java.lang.Long
Description Collateral Agreement
Mandatory no
referenceUserId
Type java.lang.Long
Description reference user
Mandatory no
blockCodeId
Type java.lang.Long
Description block code
Mandatory no
advancedBlockCodeId
Type java.lang.Long
Description advanced block code
Mandatory no
blockLotTypeId
Type java.lang.Long
Description block lot type
Mandatory no
blockStartDate
Type java.util.Date
Description Valid from.
Mandatory no
blockEndDate
Type java.util.Date
Description Valid to.
Mandatory no
sign
Type Sign
Description sign (short/long)
Mandatory no

Copyright 201, Avaloq Evolution AG Page 256 of 424


AFP Interface Specification

Parameters
placeOfSafekeepingId
Type java.lang.Long
Description Place of safekeeping
Mandatory no
positionTypeId
Type java.lang.Long
Description position type
Mandatory no
reconciliationLotTypeId
Type java.lang.Long
Description Reconciliation Lot Type
Mandatory no
noPlaceOfSafekeeping
Type java.lang.Boolean
Description No Place of safekeeping.
Mandatory no
includeEmptyPositions
Type java.lang.Boolean
Description Include Empty Positions.
Mandatory no
hasSLBLendingAgreement
Type java.lang.Boolean
Description Has SLB Lending Agreement.
Mandatory no
restrictTemplateObject
Type java.lang.Boolean
Description Show templates.
Mandatory no
maxResultSize
Type java.lang.Integer
Description the max. rowcount for the result
Mandatory no
buId
Type java.lang.Long
Description The business unit.
Mandatory no
objectIdList
Type java.util.List [java.lang.Long]
Description Object id list.
Mandatory no
keyCriteria
Type LookupSearchCriteriaKeyTO
Description the search criteria for the object key
Mandatory no
histNameCriteria
Type LookupSearchCriteriaHistNameTO
Description the search criteria for the object name
Mandatory no
relation1Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (1)
Mandatory no

Copyright 201, Avaloq Evolution AG Page 257 of 424


AFP Interface Specification

Parameters
relation2Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (2)
Mandatory no
relation3Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (3)
Mandatory no
openDateFrom
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no
openDateTo
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no
closeDateFrom
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
closeDateTo
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
status
Type Status
Description Active / inactive flag.
Mandatory no
class1InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 1st search criteria for the class lookup
Mandatory no
class2InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 2nd search criteria for the class lookup
Mandatory no
class3InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 3rd search criteria for the class lookup
Mandatory no
class4InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 4th search criteria for the class lookup
Mandatory no
class5InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 5th search criteria for the class lookup
Mandatory no
lookupScope
Type LookupScope
Description The LookupScope of the current SearchCriteria.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 258 of 424


AFP Interface Specification

2.22.9 LookupBenchmarkSearchCriteriaTO
This class represents the search criteria for the benchmark lookup.

The full name


com.avaloq.afs.server.bsp.ws.to.lookup.LookupBenchmarkSearchCriteriaTO
Parameters
buId
Type java.lang.Long
Description The business unit.
Mandatory no
maxResultSize
Type java.lang.Integer
Description
Mandatory no
lookupScope
Type LookupScope
Description The LookupScope of the current SearchCriteria.
Mandatory yes

2.22.10 LookupModelPortfolioSearchCriteriaTO
This class represents the search criteria for the model portfolio lookup.

The full name


com.avaloq.afs.server.bsp.ws.to.lookup.LookupModelPortfolioSearchCriteriaTO
Parameters
buId
Type java.lang.Long
Description The business unit.
Mandatory no
maxResultSize
Type java.lang.Integer
Description
Mandatory no
lookupScope
Type LookupScope
Description The LookupScope of the current SearchCriteria.
Mandatory yes

2.22.11 LookupRestrictionSearchCriteriaTO
This class represents the search criteria for the restriction lookup.

The full name


com.avaloq.afs.server.bsp.ws.to.lookup.LookupRestrictionSearchCriteriaTO
Parameters
objSubTypeId
Type java.lang.Long
Description the object sub type.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 259 of 424


AFP Interface Specification

Parameters
maxResultSize
Type java.lang.Integer
Description Maximum count of rows.
Mandatory no
buId
Type java.lang.Long
Description The business unit.
Mandatory no
objectIdList
Type java.util.List [java.lang.Long]
Description Object id list.
Mandatory no
keyCriteria
Type LookupSearchCriteriaKeyTO
Description the search criteria for the object key
Mandatory no
histNameCriteria
Type LookupSearchCriteriaHistNameTO
Description the search criteria for the object name
Mandatory no
relation1Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (1)
Mandatory no
relation2Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (2)
Mandatory no
relation3Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (3)
Mandatory no
openDateFrom
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no
openDateTo
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no
closeDateFrom
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
closeDateTo
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
status
Type Status
Description Active / inactive flag.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 260 of 424


AFP Interface Specification

Parameters
class1InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 1st search criteria for the class lookup
Mandatory no
class2InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 2nd search criteria for the class lookup
Mandatory no
class3InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 3rd search criteria for the class lookup
Mandatory no
class4InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 4th search criteria for the class lookup
Mandatory no
class5InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 5th search criteria for the class lookup
Mandatory no
lookupScope
Type LookupScope
Description The LookupScope of the current SearchCriteria.
Mandatory yes

2.22.12 LookupAssetAllocationSearchCriteriaTO
This class represents the search criteria for the asset allocation lookup.

The full name


com.avaloq.afs.server.bsp.ws.to.lookup.LookupAssetAllocationSearchCriteriaTO
Parameters
buId
Type java.lang.Long
Description The business unit.
Mandatory no
maxResultSize
Type java.lang.Integer
Description
Mandatory no
lookupScope
Type LookupScope
Description The LookupScope of the current SearchCriteria.
Mandatory yes

2.22.13 LookupIpsCRMSearchCriteriaTO
This class represents the CRM search criteria for the ips lookup.

The full name


com.avaloq.afs.server.bsp.ws.to.lookup.LookupIpsCRMSearchCriteriaTO
Parameters

Copyright 201, Avaloq Evolution AG Page 261 of 424


AFP Interface Specification

Parameters
organisationalEntityCriteria
Type LookupSearchCriteriaOrganisationalEntityTO
Description the search criteria for the organisational entity
Mandatory no
collectionCriteria
Type LookupSearchCriteriaCollectionTO
Description the search criteria for the collection
Mandatory no
branchBpClassCriteria
Type LookupSearchCriteriaClassifTO
Description the search criteria for the branch BP class
Mandatory no
personElectronicalAddress
Type java.lang.String
Description Electronical address of a person.
Mandatory no
max Length 200
personNationalityIdList
Type java.util.List [java.lang.Long]
Description Nationality of a person.
Mandatory no
personDomicileCountryIdList
Type java.util.List [java.lang.Long]
Description Domicilie country of a person.
Mandatory no
personDomicileZip
Type java.lang.String
Description Domicile zip code of a person.
Mandatory no
max Length 50
personDomicileCity
Type java.lang.String
Description Domicile city of a person.
Mandatory no
max Length 50
personBirthDate
Type java.util.Date
Description Birthdate of a person. <p> You can either use <style size="9" pdfFontName="Courier"> .
personBirthDate</style> or <style size="9" pdfFontName="Courier"> .
personBirthDateFrom</style> and <style size="9" pdfFontName="Courier"> .
personBirthDateTo</style>. Using both will raise an exception. </p>
Mandatory no
personBirthDateFrom
Type java.util.Date
Description Birthdate of a person. <p> Use in combination with <style size="9" pdfFontName="Courier"
> .personBirthDateTo</style>. </p> <p> You can either use <style size="9"
pdfFontName="Courier"> .personBirthDate</style> or <style size="9" pdfFontName="
Courier"> .personBirthDateFrom</style> and <style size="9" pdfFontName="Courier"> .
personBirthDateTo</style>. Using both will raise an exception. </p>
Mandatory no
personBirthDateTo
Type java.util.Date
Description Birthdate of a person. <p> Use in combination with <style size="9" pdfFontName="Courier"
> .personBirthDateFrom</style>. </p> <p> You can either use <style size="9"
pdfFontName="Courier"> .personBirthDate</style> or <style size="9" pdfFontName="

Copyright 201, Avaloq Evolution AG Page 262 of 424


AFP Interface Specification

Parameters
Courier"> .personBirthDateFrom</style> and <style size="9" pdfFontName="Courier"> .
personBirthDateTo</style>. Using both will raise an exception. </p>
Mandatory no
assetKeyCriteria
Type LookupSearchCriteriaKeyTO
Description the search criteria for the asset key
Mandatory no
strategyCollectionId
Type java.lang.Long
Description Strategy collection id.
Mandatory no
mandateIpsClassId
Type java.lang.Long
Description Mandate Ips class id.
Mandatory no
personNameCriteria
Type LookupSearchCriteriaHistNameTO
Description the search criteria for the person name
Mandatory no
personKeyCriteria
Type LookupSearchCriteriaKeyTO
Description the search criteria for the person key
Mandatory no
bpPersonRelationTypeCriteria
Type LookupSearchCriteriaBpPersonRelationTypeTO
Description the search criteria for the bp person relation type
Mandatory no
assetAllocationIdList
Type java.util.List [java.lang.Long]
Description Asset allocation id list.
Mandatory no
modelPortfolioIdList
Type java.util.List [java.lang.Long]
Description Model portfolio id list.
Mandatory no
maxResultSize
Type java.lang.Integer
Description Maximum count of rows.
Mandatory no
buId
Type java.lang.Long
Description The business unit.
Mandatory no
objectIdList
Type java.util.List [java.lang.Long]
Description Object id list.
Mandatory no
keyCriteria
Type LookupSearchCriteriaKeyTO
Description the search criteria for the object key
Mandatory no

Copyright 201, Avaloq Evolution AG Page 263 of 424


AFP Interface Specification

Parameters
histNameCriteria
Type LookupSearchCriteriaHistNameTO
Description the search criteria for the object name
Mandatory no
relation1Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (1)
Mandatory no
relation2Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (2)
Mandatory no
relation3Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (3)
Mandatory no
openDateFrom
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no
openDateTo
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no
closeDateFrom
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
closeDateTo
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
status
Type Status
Description Active / inactive flag.
Mandatory no
class1InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 1st search criteria for the class lookup
Mandatory no
class2InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 2nd search criteria for the class lookup
Mandatory no
class3InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 3rd search criteria for the class lookup
Mandatory no
class4InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 4th search criteria for the class lookup
Mandatory no

Copyright 201, Avaloq Evolution AG Page 264 of 424


AFP Interface Specification

Parameters
class5InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 5th search criteria for the class lookup
Mandatory no
lookupScope
Type LookupScope
Description The LookupScope of the current SearchCriteria.
Mandatory yes

2.22.14 LookupDocumentSearchCriteriaTO
This class represents the search criteria for the document lookup.

The full name


com.avaloq.afs.server.bsp.ws.to.lookup.LookupDocumentSearchCriteriaTO
Parameters
businessObjectSubTypeId
Type java.lang.Long
Description the object sub type
Mandatory no
ownerObjectIdList
Type java.util.List [java.lang.Long]
Description the owner
Mandatory no
questionnaireTypeIdList
Type java.util.List [java.lang.Long]
Description Questionnaire Type
Mandatory no
productIdList
Type java.util.List [java.lang.Long]
Description Product
Mandatory no
targetObjectIdList
Type java.util.List [java.lang.Long]
Description Target Object
Mandatory no
maxResultSize
Type java.lang.Integer
Description Maximum count of rows.
Mandatory no
buId
Type java.lang.Long
Description The business unit.
Mandatory no
objectIdList
Type java.util.List [java.lang.Long]
Description Object id list.
Mandatory no
keyCriteria
Type LookupSearchCriteriaKeyTO
Description the search criteria for the object key
Mandatory no

Copyright 201, Avaloq Evolution AG Page 265 of 424


AFP Interface Specification

Parameters
histNameCriteria
Type LookupSearchCriteriaHistNameTO
Description the search criteria for the object name
Mandatory no
relation1Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (1)
Mandatory no
relation2Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (2)
Mandatory no
relation3Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (3)
Mandatory no
openDateFrom
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no
openDateTo
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no
closeDateFrom
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
closeDateTo
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
status
Type Status
Description Active / inactive flag.
Mandatory no
class1InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 1st search criteria for the class lookup
Mandatory no
class2InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 2nd search criteria for the class lookup
Mandatory no
class3InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 3rd search criteria for the class lookup
Mandatory no
class4InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 4th search criteria for the class lookup
Mandatory no

Copyright 201, Avaloq Evolution AG Page 266 of 424


AFP Interface Specification

Parameters
class5InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 5th search criteria for the class lookup
Mandatory no
lookupScope
Type LookupScope
Description The LookupScope of the current SearchCriteria.
Mandatory yes

2.22.15 LookupQuestionnaireSearchCriteriaTO
This class represents the search criteria for the questionnaire lookup.

The full name


com.avaloq.afs.server.bsp.ws.to.lookup.LookupQuestionnaireSearchCriteriaTO
Parameters
questionnaireTypeIdList
Type java.util.List [java.lang.Long]
Description Questionnaire Type
Mandatory no
intervieweeIdList
Type java.util.List [java.lang.Long]
Description Interviewee (BP / Person)
Mandatory no
targetObjectIdList
Type java.util.List [java.lang.Long]
Description Target Object
Mandatory no
maxResultSize
Type java.lang.Integer
Description Maximum count of rows.
Mandatory no
buId
Type java.lang.Long
Description The business unit.
Mandatory no
objectIdList
Type java.util.List [java.lang.Long]
Description Object id list.
Mandatory no
keyCriteria
Type LookupSearchCriteriaKeyTO
Description the search criteria for the object key
Mandatory no
histNameCriteria
Type LookupSearchCriteriaHistNameTO
Description the search criteria for the object name
Mandatory no
relation1Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (1)
Mandatory no

Copyright 201, Avaloq Evolution AG Page 267 of 424


AFP Interface Specification

Parameters
relation2Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (2)
Mandatory no
relation3Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (3)
Mandatory no
openDateFrom
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no
openDateTo
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no
closeDateFrom
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
closeDateTo
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
status
Type Status
Description Active / inactive flag.
Mandatory no
class1InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 1st search criteria for the class lookup
Mandatory no
class2InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 2nd search criteria for the class lookup
Mandatory no
class3InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 3rd search criteria for the class lookup
Mandatory no
class4InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 4th search criteria for the class lookup
Mandatory no
class5InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 5th search criteria for the class lookup
Mandatory no
lookupScope
Type LookupScope
Description The LookupScope of the current SearchCriteria.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 268 of 424


AFP Interface Specification

2.22.16 LookupChequeBookProfileSearchCriteriaTO
This class represents the search criteria for the cheque book profile lookup.

The full name


com.avaloq.afs.server.bsp.ws.to.lookup.LookupChequeBookProfileSearchCriteriaTO
Parameters
maxResultSize
Type java.lang.Integer
Description Maximum count of rows.
Mandatory no
moneyAccountList
Type java.util.List [java.lang.Long]
Description money account
Mandatory no
personList
Type java.util.List [java.lang.Long]
Description person
Mandatory no
buId
Type java.lang.Long
Description The business unit.
Mandatory no
objectIdList
Type java.util.List [java.lang.Long]
Description Object id list.
Mandatory no
keyCriteria
Type LookupSearchCriteriaKeyTO
Description the search criteria for the object key
Mandatory no
histNameCriteria
Type LookupSearchCriteriaHistNameTO
Description the search criteria for the object name
Mandatory no
relation1Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (1)
Mandatory no
relation2Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (2)
Mandatory no
relation3Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (3)
Mandatory no
openDateFrom
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no

Copyright 201, Avaloq Evolution AG Page 269 of 424


AFP Interface Specification

Parameters
openDateTo
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no
closeDateFrom
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
closeDateTo
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
status
Type Status
Description Active / inactive flag.
Mandatory no
class1InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 1st search criteria for the class lookup
Mandatory no
class2InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 2nd search criteria for the class lookup
Mandatory no
class3InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 3rd search criteria for the class lookup
Mandatory no
class4InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 4th search criteria for the class lookup
Mandatory no
class5InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 5th search criteria for the class lookup
Mandatory no
lookupScope
Type LookupScope
Description The LookupScope of the current SearchCriteria.
Mandatory yes

2.22.17 LookupBusinessOrderSearchCriteriaTO
This class represents the search criteria for the business order lookup.

The full name


com.avaloq.afs.server.bsp.ws.to.lookup.LookupBusinessOrderSearchCriteriaTO
Parameters
businessOrderIdList
Type java.util.List [java.lang.Long]
Description A list of business order ids (GUIDs) to search for.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 270 of 424


AFP Interface Specification

Parameters
lookupScope
Type LookupScope
Description The LookupScope of the current SearchCriteria.
Mandatory yes

2.22.18 LookupCodeSearchCriteriaTO
This class represents the search criteria for the code values lookup.

The full name


com.avaloq.afs.server.bsp.ws.to.lookup.LookupCodeSearchCriteriaTO
Parameters
exportTableId
Type java.lang.Long
Description Export table id (ABS: code_exp_tab).
Mandatory no
lookupScope
Type LookupScope
Description The LookupScope of the current SearchCriteria.
Mandatory yes

2.22.19 LookupMoneyAccountSearchCriteriaTO
This class represents the search criteria for the money account lookup.

The full name


com.avaloq.afs.server.bsp.ws.to.lookup.LookupMoneyAccountSearchCriteriaTO
Parameters
personId
Type java.lang.Long
Description person
Mandatory no
bpPersonRelationTypeCriteria
Type LookupSearchCriteriaBpPersonRelationTypeTO
Description the search criteria for the bp person relation type
Mandatory no
businessPartnerId
Type java.lang.Long
Description business partner
Mandatory no
containerId
Type java.lang.Long
Description container
Mandatory no
collectionId
Type java.lang.Long
Description collection
Mandatory no
currencyId
Type java.lang.Long
Description currency
Mandatory no

Copyright 201, Avaloq Evolution AG Page 271 of 424


AFP Interface Specification

Parameters
assetId
Type java.lang.Long
Description asset
Mandatory no
custodianId
Type java.lang.Long
Description custodian
Mandatory no
subBusinessUnitId
Type java.lang.Long
Description SBU
Mandatory no
customerAccountingId
Type java.lang.Long
Description CUA
Mandatory no
custodyAccountAtCustodyInstituteId
Type java.lang.Long
Description Custody account at custody institute
Mandatory no
collateralAgreementId
Type java.lang.Long
Description Collateral Agreement
Mandatory no
referenceUserId
Type java.lang.Long
Description reference user
Mandatory no
blockCodeId
Type java.lang.Long
Description block code
Mandatory no
advancedBlockCodeId
Type java.lang.Long
Description advanced block code
Mandatory no
blockLotTypeId
Type java.lang.Long
Description block lot type
Mandatory no
sign
Type Sign
Description sign (short/long)
Mandatory no
placeOfSafekeepingId
Type java.lang.Long
Description Place of safekeeping
Mandatory no
positionTypeId
Type java.lang.Long
Description position type
Mandatory no

Copyright 201, Avaloq Evolution AG Page 272 of 424


AFP Interface Specification

Parameters
reconciliationLotTypeId
Type java.lang.Long
Description Reconciliation Lot Type
Mandatory no
restrictTemplateObject
Type java.lang.Boolean
Description Show templates.
Mandatory no
maxResultSize
Type java.lang.Integer
Description the max. rowcount for the result
Mandatory no
buId
Type java.lang.Long
Description The business unit.
Mandatory no
objectIdList
Type java.util.List [java.lang.Long]
Description Object id list.
Mandatory no
keyCriteria
Type LookupSearchCriteriaKeyTO
Description the search criteria for the object key
Mandatory no
histNameCriteria
Type LookupSearchCriteriaHistNameTO
Description the search criteria for the object name
Mandatory no
relation1Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (1)
Mandatory no
relation2Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (2)
Mandatory no
relation3Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (3)
Mandatory no
openDateFrom
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no
openDateTo
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no
closeDateFrom
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no

Copyright 201, Avaloq Evolution AG Page 273 of 424


AFP Interface Specification

Parameters
closeDateTo
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
status
Type Status
Description Active / inactive flag.
Mandatory no
class1InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 1st search criteria for the class lookup
Mandatory no
class2InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 2nd search criteria for the class lookup
Mandatory no
class3InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 3rd search criteria for the class lookup
Mandatory no
class4InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 4th search criteria for the class lookup
Mandatory no
class5InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 5th search criteria for the class lookup
Mandatory no
lookupScope
Type LookupScope
Description The LookupScope of the current SearchCriteria.
Mandatory yes

2.22.20 LookupIpsSearchCriteriaTO
This class represents the search criteria for the ips lookup.

The full name


com.avaloq.afs.server.bsp.ws.to.lookup.LookupIpsSearchCriteriaTO
Parameters
businessObjectSubTypeId
Type java.lang.Long
Description the object sub type.
Mandatory no
referenceCurrencyIdList
Type java.util.List [java.lang.Long]
Description reference currency.
Mandatory no
containerId
Type java.lang.Long
Description container.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 274 of 424


AFP Interface Specification

Parameters
assetAllocationId
Type java.lang.Long
Description asset allocation.
Mandatory no
ipsAssetAllocationTypeId
Type java.lang.Long
Description type.
Mandatory no
modelPortfolioId
Type java.lang.Long
Description model portfolio.
Mandatory no
restrictTemplateObject
Type java.lang.Boolean
Description Show templates.
Mandatory no
maxResultSize
Type java.lang.Integer
Description Maximum count of rows.
Mandatory no
buId
Type java.lang.Long
Description The business unit.
Mandatory no
objectIdList
Type java.util.List [java.lang.Long]
Description Object id list.
Mandatory no
keyCriteria
Type LookupSearchCriteriaKeyTO
Description the search criteria for the object key
Mandatory no
histNameCriteria
Type LookupSearchCriteriaHistNameTO
Description the search criteria for the object name
Mandatory no
relation1Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (1)
Mandatory no
relation2Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (2)
Mandatory no
relation3Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (3)
Mandatory no
openDateFrom
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no

Copyright 201, Avaloq Evolution AG Page 275 of 424


AFP Interface Specification

Parameters
openDateTo
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no
closeDateFrom
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
closeDateTo
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
status
Type Status
Description Active / inactive flag.
Mandatory no
class1InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 1st search criteria for the class lookup
Mandatory no
class2InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 2nd search criteria for the class lookup
Mandatory no
class3InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 3rd search criteria for the class lookup
Mandatory no
class4InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 4th search criteria for the class lookup
Mandatory no
class5InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 5th search criteria for the class lookup
Mandatory no
lookupScope
Type LookupScope
Description The LookupScope of the current SearchCriteria.
Mandatory yes

2.22.21 LookupBusinessPartnerCRMSearchCriteriaTO
This class represents the CRM search criteria for the business partner lookup.

The full name


com.avaloq.afs.server.bsp.ws.to.lookup.LookupBusinessPartnerCRMSearchCriteriaTO
Parameters
organisationalEntityCriteria
Type LookupSearchCriteriaOrganisationalEntityTO
Description the search criteria for the organisational entity
Mandatory no

Copyright 201, Avaloq Evolution AG Page 276 of 424


AFP Interface Specification

Parameters
collectionCriteria
Type LookupSearchCriteriaCollectionTO
Description the search criteria for the collection
Mandatory no
maxResultSize
Type java.lang.Integer
Description Maximum count of rows.
Mandatory no
branchBpClassCriteria
Type LookupSearchCriteriaClassifTO
Description the search criteria for the branch BP class
Mandatory no
personElectronicalAddress
Type java.lang.String
Description Electronical address of a person.
Mandatory no
max Length 200
personNationalityIdList
Type java.util.List [java.lang.Long]
Description Nationality of a person.
Mandatory no
personDomicileCountryIdList
Type java.util.List [java.lang.Long]
Description Domicilie country of a person.
Mandatory no
personDomicileZip
Type java.lang.String
Description Domicile zip code of a person.
Mandatory no
max Length 50
personDomicileCity
Type java.lang.String
Description Domicile city of a person.
Mandatory no
max Length 50
personBirthDate
Type java.util.Date
Description Birthdate of a person. <p> You can either use <style size="9" pdfFontName="Courier"> .
personBirthDate</style> or <style size="9" pdfFontName="Courier"> .
personBirthDateFrom</style> and <style size="9" pdfFontName="Courier"> .
personBirthDateTo</style>. Using both will raise an exception. </p>
Mandatory no
personBirthDateFrom
Type java.util.Date
Description Birthdate of a person. <p> Use in combination with <style size="9" pdfFontName="Courier"
> .personBirthDateTo</style>. </p> <p> You can either use <style size="9"
pdfFontName="Courier"> .personBirthDate</style> or <style size="9" pdfFontName="
Courier"> .personBirthDateFrom</style> and <style size="9" pdfFontName="Courier"> .
personBirthDateTo</style>. Using both will raise an exception. </p>
Mandatory no
personBirthDateTo
Type java.util.Date
Description Birthdate of a person. <p> Use in combination with <style size="9" pdfFontName="Courier"
> .personBirthDateFrom</style>. </p> <p> You can either use <style size="9"
pdfFontName="Courier"> .personBirthDate</style> or <style size="9" pdfFontName="

Copyright 201, Avaloq Evolution AG Page 277 of 424


AFP Interface Specification

Parameters
Courier"> .personBirthDateFrom</style> and <style size="9" pdfFontName="Courier"> .
personBirthDateTo</style>. Using both will raise an exception. </p>
Mandatory no
assetKeyCriteria
Type LookupSearchCriteriaKeyTO
Description the search criteria for the asset key
Mandatory no
strategyCollectionId
Type java.lang.Long
Description Strategy collection id.
Mandatory no
mandateIpsClassId
Type java.lang.Long
Description Mandate Ips class id.
Mandatory no
personNameCriteria
Type LookupSearchCriteriaHistNameTO
Description the search criteria for the person name
Mandatory no
personKeyCriteria
Type LookupSearchCriteriaKeyTO
Description the search criteria for the person key
Mandatory no
bpPersonRelationTypeCriteria
Type LookupSearchCriteriaBpPersonRelationTypeTO
Description the search criteria for the bp person relation type
Mandatory no
assetAllocationIdList
Type java.util.List [java.lang.Long]
Description Asset allocation id list.
Mandatory no
referenceCurrencyIdList
Type java.util.List [java.lang.Long]
Description reference currency
Mandatory no
languageIdList
Type java.util.List [java.lang.Long]
Description language
Mandatory no
nationalityIdList
Type java.util.List [java.lang.Long]
Description Nationality
Mandatory no
domicileCountryIdList
Type java.util.List [java.lang.Long]
Description Domicilie
Mandatory no
accountOwnerPersonId
Type java.lang.Long
Description has ... as acc./reg. owner
Mandatory no

Copyright 201, Avaloq Evolution AG Page 278 of 424


AFP Interface Specification

Parameters
authorityPersonId
Type java.lang.Long
Description has ... as authority
Mandatory no
beneficialOwnerPersonId
Type java.lang.Long
Description has ... as beneficial owner
Mandatory no
authorityAtDate
Type java.util.Date
Description The valid-at date for all BP-Person relation types.
Mandatory no
primaryContactPersonId
Type java.lang.Long
Description Primary contact person
Mandatory no
accountTypeId
Type java.lang.Long
Description Account Type
Mandatory no
modelPortfolioIdList
Type java.util.List [java.lang.Long]
Description Model portfolio id list.
Mandatory no
buId
Type java.lang.Long
Description The business unit.
Mandatory no
objectIdList
Type java.util.List [java.lang.Long]
Description Object id list.
Mandatory no
keyCriteria
Type LookupSearchCriteriaKeyTO
Description the search criteria for the object key
Mandatory no
histNameCriteria
Type LookupSearchCriteriaHistNameTO
Description the search criteria for the object name
Mandatory no
relation1Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (1)
Mandatory no
relation2Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (2)
Mandatory no
relation3Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (3)
Mandatory no

Copyright 201, Avaloq Evolution AG Page 279 of 424


AFP Interface Specification

Parameters
openDateFrom
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no
openDateTo
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no
closeDateFrom
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
closeDateTo
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
status
Type Status
Description Active / inactive flag.
Mandatory no
class1InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 1st search criteria for the class lookup
Mandatory no
class2InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 2nd search criteria for the class lookup
Mandatory no
class3InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 3rd search criteria for the class lookup
Mandatory no
class4InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 4th search criteria for the class lookup
Mandatory no
class5InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 5th search criteria for the class lookup
Mandatory no
lookupScope
Type LookupScope
Description The LookupScope of the current SearchCriteria.
Mandatory yes

2.22.22 LookupSearchCriteriaKeyTO
Search criteria for the key lookup.

The full name


com.avaloq.afs.server.bsp.ws.to.lookup.LookupSearchCriteriaKeyTO
Parameters

Copyright 201, Avaloq Evolution AG Page 280 of 424


AFP Interface Specification

Parameters
keyVal
Type java.lang.String
Description The key value.
Mandatory yes
max Length 255
keyTypeIdList
Type java.util.List [java.lang.Long]
Description The type of the key.
Mandatory no

2.22.23 LookupBusinessPartnerSearchCriteriaTO
This class represents the search criteria for the business partner lookup.

The full name


com.avaloq.afs.server.bsp.ws.to.lookup.LookupBusinessPartnerSearchCriteriaTO
Parameters
referenceCurrencyInclIdList
Type java.util.List [java.lang.Long]
Description reference currency (include list).
Mandatory no
referenceCurrencyExclIdList
Type java.util.List [java.lang.Long]
Description reference currency (exclude list).
Mandatory no
languageInclIdList
Type java.util.List [java.lang.Long]
Description Language (include list).
Mandatory no
languageExclIdList
Type java.util.List [java.lang.Long]
Description Language (exclude list).
Mandatory no
domicileCountryInclIdList
Type java.util.List [java.lang.Long]
Description domicile country (include list).
Mandatory no
domicileCountryExclIdList
Type java.util.List [java.lang.Long]
Description domicile country (exclude list).
Mandatory no
nationalityInclIdList
Type java.util.List [java.lang.Long]
Description nationality country (include list).
Mandatory no
nationalityExclIdList
Type java.util.List [java.lang.Long]
Description nationality country (exclude list).
Mandatory no
accountOwnerPersonId
Type java.lang.Long
Description has ... as acc./reg. owner
Mandatory no

Copyright 201, Avaloq Evolution AG Page 281 of 424


AFP Interface Specification

Parameters
authorityPersonId
Type java.lang.Long
Description has ... as authority
Mandatory no
beneficialOwnerPersonId
Type java.lang.Long
Description has ... as beneficial owner
Mandatory no
authorityAtDate
Type java.util.Date
Description The valid-at date for all BP-Person relation types.
Mandatory no
primaryContactPersonId
Type java.lang.Long
Description Primary contact person
Mandatory no
accountTypeId
Type java.lang.Long
Description Account Type
Mandatory no
restrictTemplateObject
Type java.lang.Boolean
Description Show templates.
Mandatory no
includeCorrelatedPersons
Type java.lang.Boolean
Description Incl. correlated persons.
Mandatory no
maxResultSize
Type java.lang.Integer
Description Maximum count of rows.
Mandatory no
buId
Type java.lang.Long
Description The business unit.
Mandatory no
objectIdList
Type java.util.List [java.lang.Long]
Description Object id list.
Mandatory no
keyCriteria
Type LookupSearchCriteriaKeyTO
Description the search criteria for the object key
Mandatory no
histNameCriteria
Type LookupSearchCriteriaHistNameTO
Description the search criteria for the object name
Mandatory no
relation1Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (1)
Mandatory no

Copyright 201, Avaloq Evolution AG Page 282 of 424


AFP Interface Specification

Parameters
relation2Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (2)
Mandatory no
relation3Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (3)
Mandatory no
openDateFrom
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no
openDateTo
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no
closeDateFrom
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
closeDateTo
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
status
Type Status
Description Active / inactive flag.
Mandatory no
class1InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 1st search criteria for the class lookup
Mandatory no
class2InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 2nd search criteria for the class lookup
Mandatory no
class3InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 3rd search criteria for the class lookup
Mandatory no
class4InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 4th search criteria for the class lookup
Mandatory no
class5InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 5th search criteria for the class lookup
Mandatory no
lookupScope
Type LookupScope
Description The LookupScope of the current SearchCriteria.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 283 of 424


AFP Interface Specification

2.22.24 LookupDirectDebitSearchCriteriaTO
This class represents the search criteria for the direct debit lookup.

The full name


com.avaloq.afs.server.bsp.ws.to.lookup.LookupDirectDebitSearchCriteriaTO
Parameters
businessObjectSubTypeId
Type java.lang.Long
Description the object sub type
Mandatory no
maxResultSize
Type java.lang.Integer
Description Maximum count of rows.
Mandatory no
buId
Type java.lang.Long
Description The business unit.
Mandatory no
objectIdList
Type java.util.List [java.lang.Long]
Description Object id list.
Mandatory no
keyCriteria
Type LookupSearchCriteriaKeyTO
Description the search criteria for the object key
Mandatory no
histNameCriteria
Type LookupSearchCriteriaHistNameTO
Description the search criteria for the object name
Mandatory no
relation1Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (1)
Mandatory no
relation2Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (2)
Mandatory no
relation3Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (3)
Mandatory no
openDateFrom
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no
openDateTo
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no

Copyright 201, Avaloq Evolution AG Page 284 of 424


AFP Interface Specification

Parameters
closeDateFrom
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
closeDateTo
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
status
Type Status
Description Active / inactive flag.
Mandatory no
class1InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 1st search criteria for the class lookup
Mandatory no
class2InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 2nd search criteria for the class lookup
Mandatory no
class3InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 3rd search criteria for the class lookup
Mandatory no
class4InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 4th search criteria for the class lookup
Mandatory no
class5InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 5th search criteria for the class lookup
Mandatory no
lookupScope
Type LookupScope
Description The LookupScope of the current SearchCriteria.
Mandatory yes

2.22.25 LookupSearchCriteriaHistNameTO
This class represents the search criteria for the Historized name lookup.

The full name


com.avaloq.afs.server.bsp.ws.to.lookup.LookupSearchCriteriaHistNameTO
Parameters
nameVal
Type java.lang.String
Description the value of the Name
Mandatory yes
max Length 255

Copyright 201, Avaloq Evolution AG Page 285 of 424


AFP Interface Specification

2.22.26 LookupSearchCriteriaRelationTO
This class represents the search criteria for the Relation lookup.

The full name


com.avaloq.afs.server.bsp.ws.to.lookup.LookupSearchCriteriaRelationTO
Parameters
relationSubTypeId
Type java.lang.Long
Description Relation subtype.
Mandatory no
relationTargetInclList
Type java.util.List [java.lang.Long]
Description List of relation targets (include list).
Mandatory no
relationTargetExclList
Type java.util.List [java.lang.Long]
Description List of relation targets (exclude list).
Mandatory no
relationPriorityList
Type java.util.List [java.lang.Long]
Description List of relation priorities.
Mandatory no

2.22.27 LookupOrganisationalEntitySearchCriteriaTO
This class represents the search criteria for the organisational entity lookup.

The full name


com.avaloq.afs.server.bsp.ws.to.lookup.LookupOrganisationalEntitySearchCriteriaTO
Parameters
lookupScope
Type LookupScope
Description The LookupScope of the current SearchCriteria.
Mandatory yes

2.22.28 LookupEfficientFrontierSearchCriteriaTO
This class represents the search criteria for the EfficientFrontier lookup.

The full name


com.avaloq.afs.server.bsp.ws.to.lookup.LookupEfficientFrontierSearchCriteriaTO
Parameters
buId
Type java.lang.Long
Description The business unit.
Mandatory no
maxResultSize
Type java.lang.Integer
Description
Mandatory no

Copyright 201, Avaloq Evolution AG Page 286 of 424


AFP Interface Specification

Parameters
buId
Type java.lang.Long
Description The business unit.
Mandatory no
objectIdList
Type java.util.List [java.lang.Long]
Description Object id list.
Mandatory no
keyCriteria
Type LookupSearchCriteriaKeyTO
Description the search criteria for the object key
Mandatory no
histNameCriteria
Type LookupSearchCriteriaHistNameTO
Description the search criteria for the object name
Mandatory no
relation1Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (1)
Mandatory no
relation2Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (2)
Mandatory no
relation3Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (3)
Mandatory no
openDateFrom
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no
openDateTo
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no
closeDateFrom
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
closeDateTo
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
status
Type Status
Description Active / inactive flag.
Mandatory no
class1InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 1st search criteria for the class lookup
Mandatory no

Copyright 201, Avaloq Evolution AG Page 287 of 424


AFP Interface Specification

Parameters
class2InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 2nd search criteria for the class lookup
Mandatory no
class3InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 3rd search criteria for the class lookup
Mandatory no
class4InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 4th search criteria for the class lookup
Mandatory no
class5InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 5th search criteria for the class lookup
Mandatory no
lookupScope
Type LookupScope
Description The LookupScope of the current SearchCriteria.
Mandatory yes

2.22.29 LookupCardSearchCriteriaTO
This class represents the search criteria for the card lookup.

The full name


com.avaloq.afs.server.bsp.ws.to.lookup.LookupCardSearchCriteriaTO
Parameters
isBlocked
Type java.lang.Boolean
Description Defines whether the card is blocked. <p> <style size="9" pdfFontName="Courier">
true</style> restricts to blocked cards, <style size="9" pdfFontName="Courier">
false</style> to only non-blocked cards and <style size="9" pdfFontName="Courier">
null</style> does not restrict the result by the isBlocked flag. </p>
Mandatory no
cardOrderStatusList
Type java.util.List [java.lang.Long]
Description the order status of the card.
Mandatory no
cardTypeList
Type java.util.List [java.lang.Long]
Description the type of the card.
Mandatory no
cardSubTypeList
Type java.util.List [java.lang.Long]
Description the subtype of the card.
Mandatory no
currencyList
Type java.util.List [java.lang.Long]
Description the currency of the card.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 288 of 424


AFP Interface Specification

Parameters
isAssigneeCard
Type java.lang.Boolean
Description Defines whether the card is an assignee card.
Mandatory no
businessPartnerList
Type java.util.List [java.lang.Long]
Description business partner (money account owner)
Mandatory no
moneyAccountList
Type java.util.List [java.lang.Long]
Description money account
Mandatory no
ownerObjectList
Type java.util.List [java.lang.Long]
Description card owner (business partner or person)
Mandatory no
maxResultSize
Type java.lang.Integer
Description Maximum count of rows.
Mandatory no
buId
Type java.lang.Long
Description The business unit.
Mandatory no
objectIdList
Type java.util.List [java.lang.Long]
Description Object id list.
Mandatory no
keyCriteria
Type LookupSearchCriteriaKeyTO
Description the search criteria for the object key
Mandatory no
histNameCriteria
Type LookupSearchCriteriaHistNameTO
Description the search criteria for the object name
Mandatory no
relation1Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (1)
Mandatory no
relation2Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (2)
Mandatory no
relation3Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (3)
Mandatory no
openDateFrom
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no

Copyright 201, Avaloq Evolution AG Page 289 of 424


AFP Interface Specification

Parameters
openDateTo
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no
closeDateFrom
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
closeDateTo
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
status
Type Status
Description Active / inactive flag.
Mandatory no
class1InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 1st search criteria for the class lookup
Mandatory no
class2InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 2nd search criteria for the class lookup
Mandatory no
class3InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 3rd search criteria for the class lookup
Mandatory no
class4InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 4th search criteria for the class lookup
Mandatory no
class5InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 5th search criteria for the class lookup
Mandatory no
lookupScope
Type LookupScope
Description The LookupScope of the current SearchCriteria.
Mandatory yes

2.22.30 LookupSearchCriteriaBpPersonRelationTypeTO
This class represents the search criteria for the bp person relation type lookup.

The full name


com.avaloq.afs.server.bsp.ws.to.lookup.LookupSearchCriteriaBpPersonRelationTypeTO
Parameters
bpPersonRelationTypeIdList
Type java.util.List [java.lang.Long]
Description The list of bp person relation types.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 290 of 424


AFP Interface Specification

2.22.31 LookupSearchCriteriaClassifTO
This class represents the search criteria for the classification lookup.

The full name


com.avaloq.afs.server.bsp.ws.to.lookup.LookupSearchCriteriaClassifTO
Parameters
classList
Type java.util.List [java.lang.Long]
Description the classList
Mandatory yes

2.22.32 LookupGenericObjectSearchCriteriaTO
This class represents the search criteria for the generic object lookup.

The full name


com.avaloq.afs.server.bsp.ws.to.lookup.LookupGenericObjectSearchCriteriaTO
Parameters
businessObjectTypeId
Type java.lang.Long
Description the object type
Mandatory no
businessObjectSubTypeId
Type java.lang.Long
Description the object sub type
Mandatory no
maxResultSize
Type java.lang.Integer
Description Maximum count of rows.
Mandatory no
buId
Type java.lang.Long
Description The business unit.
Mandatory no
objectIdList
Type java.util.List [java.lang.Long]
Description Object id list.
Mandatory no
keyCriteria
Type LookupSearchCriteriaKeyTO
Description the search criteria for the object key
Mandatory no
histNameCriteria
Type LookupSearchCriteriaHistNameTO
Description the search criteria for the object name
Mandatory no
relation1Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (1)
Mandatory no

Copyright 201, Avaloq Evolution AG Page 291 of 424


AFP Interface Specification

Parameters
relation2Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (2)
Mandatory no
relation3Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (3)
Mandatory no
openDateFrom
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no
openDateTo
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no
closeDateFrom
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
closeDateTo
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
status
Type Status
Description Active / inactive flag.
Mandatory no
class1InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 1st search criteria for the class lookup
Mandatory no
class2InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 2nd search criteria for the class lookup
Mandatory no
class3InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 3rd search criteria for the class lookup
Mandatory no
class4InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 4th search criteria for the class lookup
Mandatory no
class5InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 5th search criteria for the class lookup
Mandatory no
lookupScope
Type LookupScope
Description The LookupScope of the current SearchCriteria.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 292 of 424


AFP Interface Specification

2.22.33 LookupContainerSearchCriteriaTO
This class represents the search criteria for the container lookup.

The full name


com.avaloq.afs.server.bsp.ws.to.lookup.LookupContainerSearchCriteriaTO
Parameters
sbuId
Type java.lang.Long
Description The sub business unit.
Mandatory no
businessPartnerIdList
Type java.util.List [java.lang.Long]
Description business partner.
Mandatory no
ownershipTypeId
Type java.lang.Long
Description container ownership type.
Mandatory no
referenceCurrencyInclIdList
Type java.util.List [java.lang.Long]
Description reference currency (include list).
Mandatory no
referenceCurrencyExclIdList
Type java.util.List [java.lang.Long]
Description reference currency (exclude list).
Mandatory no
containerWithPosition
Type SelectionMethod
Description Cont. with Pos.
Mandatory no
hasPositionOfAssetId
Type java.lang.Long
Description Has Position of Asset.
Mandatory no
customerAccountingIdList
Type java.util.List [java.lang.Long]
Description Customer Accounting.
Mandatory no
bpPersonRelationTypeCriteria
Type LookupSearchCriteriaBpPersonRelationTypeTO
Description Include Container partner(s) of given person(s) (based on account ownership).
Mandatory no
personInclIdList
Type java.util.List [java.lang.Long]
Description Include container(s) of given person(s) (based on account ownership).
Mandatory no
personExclIdList
Type java.util.List [java.lang.Long]
Description Exclude container(s) of given person(s) (based on account ownership).
Mandatory no

Copyright 201, Avaloq Evolution AG Page 293 of 424


AFP Interface Specification

Parameters
ipsIdList
Type java.util.List [java.lang.Long]
Description IPS List.
Mandatory no
restrictTemplateObject
Type java.lang.Boolean
Description Show templates.
Mandatory no
maxResultSize
Type java.lang.Integer
Description Maximum count of rows.
Mandatory no
buId
Type java.lang.Long
Description The business unit.
Mandatory no
objectIdList
Type java.util.List [java.lang.Long]
Description Object id list.
Mandatory no
keyCriteria
Type LookupSearchCriteriaKeyTO
Description the search criteria for the object key
Mandatory no
histNameCriteria
Type LookupSearchCriteriaHistNameTO
Description the search criteria for the object name
Mandatory no
relation1Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (1)
Mandatory no
relation2Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (2)
Mandatory no
relation3Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (3)
Mandatory no
openDateFrom
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no
openDateTo
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no
closeDateFrom
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no

Copyright 201, Avaloq Evolution AG Page 294 of 424


AFP Interface Specification

Parameters
closeDateTo
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
status
Type Status
Description Active / inactive flag.
Mandatory no
class1InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 1st search criteria for the class lookup
Mandatory no
class2InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 2nd search criteria for the class lookup
Mandatory no
class3InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 3rd search criteria for the class lookup
Mandatory no
class4InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 4th search criteria for the class lookup
Mandatory no
class5InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 5th search criteria for the class lookup
Mandatory no
lookupScope
Type LookupScope
Description The LookupScope of the current SearchCriteria.
Mandatory yes

2.22.34 LookupPersonCRMSearchCriteriaTO
This class represents the CRM search criteria for the person lookup.

The full name


com.avaloq.afs.server.bsp.ws.to.lookup.LookupPersonCRMSearchCriteriaTO
Parameters
personTypeIdList
Type java.util.List [java.lang.Long]
Description List of person type ids.
Mandatory no
organisationalEntityCriteria
Type LookupSearchCriteriaOrganisationalEntityTO
Description the search criteria for the organisational entity
Mandatory no
collectionCriteria
Type LookupSearchCriteriaCollectionTO
Description the search criteria for the collection
Mandatory no

Copyright 201, Avaloq Evolution AG Page 295 of 424


AFP Interface Specification

Parameters
branchBpClassCriteria
Type LookupSearchCriteriaClassifTO
Description the search criteria for the branch BP class
Mandatory no
electronicalAddress
Type java.lang.String
Description Electronical address of a person.
Mandatory no
max Length 200
nationalityIdList
Type java.util.List [java.lang.Long]
Description Nationality of a person.
Mandatory no
domicileCountryIdList
Type java.util.List [java.lang.Long]
Description Domicile country of a person.
Mandatory no
domicileZip
Type java.lang.String
Description Domicile zip code of a person.
Mandatory no
max Length 50
domicileCity
Type java.lang.String
Description Domicile city of a person.
Mandatory no
max Length 50
birthDate
Type java.util.Date
Description Birthdate of a person. <p> You can either use <style size="9" pdfFontName="Courier"> .
birthDate</style> or <style size="9" pdfFontName="Courier"> .birthDateFrom</style> and
<style size="9" pdfFontName="Courier"> .birthDateTo</style>. Using both will raise an
exception. </p>
Mandatory no
birthDateFrom
Type java.util.Date
Description Birthdate of a person. <p> Use in combination with <style size="9" pdfFontName="Courier"
> .birthDateTo</style>. </p> <p> You can either use <style size="9" pdfFontName="
Courier"> .birthDate</style> or <style size="9" pdfFontName="Courier"> .
birthDateFrom</style> and <style size="9" pdfFontName="Courier"> .birthDateTo</style>.
Using both will raise an exception. </p>
Mandatory no
birthDateTo
Type java.util.Date
Description Birthdate of a person. <p> Use in combination with <style size="9" pdfFontName="Courier"
> .birthDateFrom</style>. </p> <p> You can either use <style size="9" pdfFontName="
Courier"> .birthDate</style> or <style size="9" pdfFontName="Courier"> .
birthDateFrom</style> and <style size="9" pdfFontName="Courier"> .birthDateTo</style>.
Using both will raise an exception. </p>
Mandatory no
firstName
Type java.lang.String
Description First name of a person.
Mandatory no
max Length 80

Copyright 201, Avaloq Evolution AG Page 296 of 424


AFP Interface Specification

Parameters
middleName
Type java.lang.String
Description Middle name of a person.
Mandatory no
max Length 80
lastName
Type java.lang.String
Description Last name of a person.
Mandatory no
max Length 80
secondLastName
Type java.lang.String
Description 2nd last name of a person.
Mandatory no
max Length 80
birthName
Type java.lang.String
Description Birth name of a person.
Mandatory no
max Length 80
artistName
Type java.lang.String
Description Artist name of a person.
Mandatory no
max Length 80
legalFormId
Type java.lang.Long
Description Legal form of a person.
Mandatory no
titleInclIdList
Type java.util.List [java.lang.Long]
Description Title of a person (include list).
Mandatory no
titleExclIdList
Type java.util.List [java.lang.Long]
Description Title of a person (exclude list).
Mandatory no
alternativeTitle
Type java.lang.String
Description Alternative title of a person.
Mandatory no
max Length 60
genderId
Type java.lang.Long
Description Gender of a natural person.
Mandatory no
maritalStatusInclIdList
Type java.util.List [java.lang.Long]
Description Marital status of a natural person (include list).
Mandatory no
maritalStatusExclIdList
Type java.util.List [java.lang.Long]
Description Marital status of a natural person (exclude list).
Mandatory no

Copyright 201, Avaloq Evolution AG Page 297 of 424


AFP Interface Specification

Parameters
establishDate
Type java.util.Date
Description Establishment date of a legal person.
Mandatory no
languageInclIdList
Type java.util.List [java.lang.Long]
Description Language of a natural person (include list).
Mandatory no
languageExclIdList
Type java.util.List [java.lang.Long]
Description Language of a natural person (exclude list).
Mandatory no
identificationTypeId
Type java.lang.Long
Description Identification type of a person.
Mandatory no
identificationNumber
Type java.lang.String
Description Identification number of a person.
Mandatory no
max Length 80
clientStatusIdList
Type java.util.List [java.lang.Long]
Description Client status of a person.
Mandatory no
accountOwnerBusinessPartnerIdList
Type java.util.List [java.lang.Long]
Description Account owner of a person.
Mandatory no
authorityBusinessPartnerIdList
Type java.util.List [java.lang.Long]
Description Authority of a person.
Mandatory no
beneficialOwnerBusinessPartnerIdList
Type java.util.List [java.lang.Long]
Description Beneficial owner of a person.
Mandatory no
beneficialOwnerTrustIdList
Type java.util.List [java.lang.Long]
Description Beneficial owner of a person.
Mandatory no
authorityAtDate
Type java.util.Date
Description The valid-at date for all BP-Person relation types.
Mandatory no
addressStreet
Type java.lang.String
Description The street. Part of the address criteria of the person lookup.
Mandatory no
max Length 50
addressStreetNumber
Type java.lang.String
Description The street number. Part of the address criteria of the person lookup.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 298 of 424


AFP Interface Specification

Parameters
max Length 50
addressZip
Type java.lang.String
Description The zip. Part of the address criteria of the person lookup.
Mandatory no
max Length 50
addressCity
Type java.lang.String
Description The city. Part of the address criteria of the person lookup.
Mandatory no
max Length 50
addressCountryIdList
Type java.util.List [java.lang.Long]
Description The country. Part of the address criteria of the person lookup.
Mandatory no
maxResultSize
Type java.lang.Integer
Description Maximum count of rows.
Mandatory no
buId
Type java.lang.Long
Description The business unit.
Mandatory no
objectIdList
Type java.util.List [java.lang.Long]
Description Object id list.
Mandatory no
keyCriteria
Type LookupSearchCriteriaKeyTO
Description the search criteria for the object key
Mandatory no
histNameCriteria
Type LookupSearchCriteriaHistNameTO
Description the search criteria for the object name
Mandatory no
relation1Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (1)
Mandatory no
relation2Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (2)
Mandatory no
relation3Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (3)
Mandatory no
openDateFrom
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no

Copyright 201, Avaloq Evolution AG Page 299 of 424


AFP Interface Specification

Parameters
openDateTo
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no
closeDateFrom
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
closeDateTo
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
status
Type Status
Description Active / inactive flag.
Mandatory no
class1InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 1st search criteria for the class lookup
Mandatory no
class2InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 2nd search criteria for the class lookup
Mandatory no
class3InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 3rd search criteria for the class lookup
Mandatory no
class4InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 4th search criteria for the class lookup
Mandatory no
class5InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 5th search criteria for the class lookup
Mandatory no
lookupScope
Type LookupScope
Description The LookupScope of the current SearchCriteria.
Mandatory yes

2.22.35 LookupFinancingSearchCriteriaTO
This class represents the search criteria for the financing lookup.

The full name


com.avaloq.afs.server.bsp.ws.to.lookup.LookupFinancingSearchCriteriaTO
Parameters
businessObjectSubTypeId
Type java.lang.Long
Description the object sub type
Mandatory no

Copyright 201, Avaloq Evolution AG Page 300 of 424


AFP Interface Specification

Parameters
ownerBusinessPartnerId
Type java.lang.Long
Description Financing Owner BP
Mandatory no
relatedBusinessPartnerIdList
Type java.util.List [java.lang.Long]
Description Financing with related BP
Mandatory no
financingItemBusinessPartnerOrContainerIdList
Type java.util.List [java.lang.Long]
Description Financing Item BP/Cont
Mandatory no
financingItemPositionIdList
Type java.util.List [java.lang.Long]
Description Financing Item Position
Mandatory no
agreementTypeId
Type java.lang.Long
Description Agreement Type
Mandatory no
maxResultSize
Type java.lang.Integer
Description Maximum count of rows.
Mandatory no
buId
Type java.lang.Long
Description The business unit.
Mandatory no
objectIdList
Type java.util.List [java.lang.Long]
Description Object id list.
Mandatory no
keyCriteria
Type LookupSearchCriteriaKeyTO
Description the search criteria for the object key
Mandatory no
histNameCriteria
Type LookupSearchCriteriaHistNameTO
Description the search criteria for the object name
Mandatory no
relation1Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (1)
Mandatory no
relation2Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (2)
Mandatory no
relation3Criteria
Type LookupSearchCriteriaRelationTO
Description the search criteria for the object relation (3)
Mandatory no

Copyright 201, Avaloq Evolution AG Page 301 of 424


AFP Interface Specification

Parameters
openDateFrom
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no
openDateTo
Type java.util.Date
Description used to restrict the open date of the object from .openDateFrom to .openDateTo
Mandatory no
closeDateFrom
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
closeDateTo
Type java.util.Date
Description used to restrict the close date of the object from .closeDateFrom to .closeDateTo
Mandatory no
status
Type Status
Description Active / inactive flag.
Mandatory no
class1InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 1st search criteria for the class lookup
Mandatory no
class2InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 2nd search criteria for the class lookup
Mandatory no
class3InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 3rd search criteria for the class lookup
Mandatory no
class4InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 4th search criteria for the class lookup
Mandatory no
class5InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 5th search criteria for the class lookup
Mandatory no
lookupScope
Type LookupScope
Description The LookupScope of the current SearchCriteria.
Mandatory yes

2.22.36 LookupCollectionSearchCriteriaTO
This class represents the search criteria for the collection lookup.

The full name


com.avaloq.afs.server.bsp.ws.to.lookup.LookupCollectionSearchCriteriaTO
Parameters

Copyright 201, Avaloq Evolution AG Page 302 of 424


AFP Interface Specification

Parameters
class1InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 1st search criteria for the class lookup
Mandatory no
class2InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 2nd search criteria for the class lookup
Mandatory no
class3InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 3rd search criteria for the class lookup
Mandatory no
class4InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 4th search criteria for the class lookup
Mandatory no
class5InclCriteria
Type LookupSearchCriteriaClassifTO
Description the 5th search criteria for the class lookup
Mandatory no
maxResultSize
Type java.lang.Integer
Description
Mandatory no
lookupScope
Type LookupScope
Description The LookupScope of the current SearchCriteria.
Mandatory yes

2.22.37 LookupCountrySearchCriteriaTO
This class represents the search criteria for the country lookup.

The full name


com.avaloq.afs.server.bsp.ws.to.lookup.LookupCountrySearchCriteriaTO
Parameters
maxResultSize
Type java.lang.Integer
Description
Mandatory no
lookupScope
Type LookupScope
Description The LookupScope of the current SearchCriteria.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 303 of 424


AFP Interface Specification

2.23 com.avaloq.afs.server.bsp.ws.to.notification
2.23.0 NotificationFrameworkPresentationDataOutputTO
Contains information required by the presentation layers. For example names of code table rows.

The full name


com.avaloq.afs.server.bsp.ws.to.notification.NotificationFrameworkPresentationDataOutputTO
Parameters
eventTypes
Type java.util.List [NotificationEventTypeCodeTO]
Description The list of event types
Mandatory yes
triggers
Type java.util.List [NotificationTriggerCodeTO]
Description The list of triggers (eg could be periodicity related)
Mandatory yes
messageTypes
Type java.util.List [CodeTO]
Description The list of message types
Mandatory yes
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 304 of 424


AFP Interface Specification

2.24 com.avaloq.afs.server.bsp.ws.to.notification.event
2.24.0 EventValueTO
Single value associated with this event.

The full name


com.avaloq.afs.server.bsp.ws.to.notification.event.EventValueTO
Parameters
thresholdValue
Type java.math.BigDecimal
Description Value of this event. The threshold is limited to a precision of 19 digits and a scale of 2
digits.
Mandatory yes

2.24.1 XmlEventContextTO
Used by event publisher to submit an arbitrary event context structure (which is then available for matching and formatting).

The full name


com.avaloq.afs.server.bsp.ws.to.notification.event.XmlEventContextTO
Parameters
scope
Type java.lang.Object
Description An arbitrary XML fragment specifying more information about the event.
Mandatory yes

2.24.2 EventTaggingTO
Contains the list of tags associated with this event. Events which are tagged will only be matched to subscriptions which also
specify one or more of the event tags.
The full name
com.avaloq.afs.server.bsp.ws.to.notification.event.EventTaggingTO
Parameters
tagList
Type java.util.List [NotificationTagTO]
Description List of tags associated with this event.
Mandatory yes

2.24.3 EventValueTransitionTO
Before and after values for an event.

The full name


com.avaloq.afs.server.bsp.ws.to.notification.event.EventValueTransitionTO
Parameters
valueBefore
Type java.math.BigDecimal
Description The initial value associated with this event. The threshold is limited to a precision of 19
digits and a scale of 2 digits.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 305 of 424


AFP Interface Specification

Parameters
valueAfter
Type java.math.BigDecimal
Description The final value associated with this event. The threshold is limited to a precision of 19 digits
and a scale of 2 digits.
Mandatory yes

2.24.4 EventTO
An event to be published to the notification framework.

The full name


com.avaloq.afs.server.bsp.ws.to.notification.event.EventTO
Parameters
timestamp
Type java.util.Date
Description The timestamp this event occurred.
Mandatory yes
eventTypeInternalId
Type java.lang.String
Description The internal id of the type of this event.
Mandatory yes
eventContext
Type AbstractEventContextTO
Description The addtional context of the event.

Event context should be specified by one of the concrete event context implementations.
• ValueEventContextTO
• XmlEventContextTO
Mandatory no

2.24.6 ValueEventContextTO
Event context information which can be matched by the framework to subscriber specified object, threshold and tag
predicates.
The full name
com.avaloq.afs.server.bsp.ws.to.notification.event.ValueEventContextTO
Parameters
triggeringObject
Type BaseBankingObjectTO
Description The triggering object associated with this event.
Mandatory no
threshold
Type EventValueTO
Description The threshold value for a single valued event type.
Mandatory no
limitThreshold
Type EventValueTransitionTO
Description The before and after values for a limit thresholded event type.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 306 of 424


AFP Interface Specification

Parameters
tagging
Type EventTaggingTO
Description The tags associated with this event.
Mandatory no
scope
Type java.lang.Object
Description An arbitrary XML fragment specifying more information about the event.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 307 of 424


AFP Interface Specification

2.25 com.avaloq.afs.server.bsp.ws.to.notification.subscription
2.25.0 NotificationTagTO
A single tag.

The full name


com.avaloq.afs.server.bsp.ws.to.notification.subscription.NotificationTagTO
Parameters
tag
Type java.lang.String
Description The tag. Must be lower case and not contain any commas.
Mandatory yes
max Length 100

2.25.1 NotificationSubscriptionQueryTO
Query to search notification subscriptions.

The full name


com.avaloq.afs.server.bsp.ws.to.notification.subscription.NotificationSubscriptionQueryTO
Parameters
id
Type java.lang.Long
Description The id of a subscription to retrieve. If set, retrieve only specified subscription.
Mandatory no
eventTypeId
Type java.lang.Long
Description Query for subscriptions to the specified event type.
Mandatory no
isActive
Type java.lang.Boolean
Description Query for only active or inactive subscriptions.
Mandatory no
triggeringObjectAlias
Type java.lang.String
Description Query for subscriptions matching the given descriptive text.
Mandatory no
objectId
Type java.lang.Long
Description Query for subscriptions to the given Avaloq object.
Mandatory no

2.25.2 NotificationSubscriptionListOutputTO
A response object which holds a list of notification subscriptions.

The full name


com.avaloq.afs.server.bsp.ws.to.notification.subscription.NotificationSubscriptionListOutputTO
Parameters
resultList
Type java.util.List [NotificationSubscriptionTO]
Description The list of subscriptions.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 308 of 424


AFP Interface Specification

Parameters
pagingResult
Type PagingResultTO
Description The paging result. Only used for paged queries.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.25.3 NotificationSubscriptionTO
A notification subscription.

The full name


com.avaloq.afs.server.bsp.ws.to.notification.subscription.NotificationSubscriptionTO
Parameters
active
Type boolean
Description Flag indicating if the subscription is active.
Mandatory yes
eventTypeId
Type java.lang.Long
Description The id of the event type.
Mandatory yes
filterPredicate
Type java.lang.String
Description Not currently used.
Mandatory no
objectId
Type java.lang.Long
Description The id of the object for which the event is subscribed.
Mandatory no
triggeringObjectAlias
Type java.lang.String
Description A user friendly string describing the subscription.
Mandatory no
max Length 200
Example John's Account
triggerId
Type java.lang.Long
Description The id of the trigger associated with this subscription.
Mandatory no
threshold
Type java.math.BigDecimal
Description The threshold value to match to subscriptions. Maximum precision is 19 digits and
maximum scale is 2 digits.
Mandatory no
validUntil
Type java.util.Date
Description The date until when subscription is valid. After this date the subscription will no longer be
matched.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 309 of 424


AFP Interface Specification

Parameters
recipientList
Type java.util.List [NotificationSubscriptionRecipientTO]
Description The recipients to which notifications should be delivered.
Mandatory yes
tagList
Type java.util.List [NotificationTagTO]
Description The tags to be associated with this subscription.
Mandatory yes
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.25.4 NotificationSubscriptionOutputTO
A response object which holds a single subscription.

The full name


com.avaloq.afs.server.bsp.ws.to.notification.subscription.NotificationSubscriptionOutputTO
Parameters
notificationSubscription
Type NotificationSubscriptionTO
Description The subscription.
Mandatory yes
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.25.5 NotificationDeliveryChannelListOutputTO
Response containing a list of notification delivery channels.

The full name


com.avaloq.afs.server.bsp.ws.to.notification.subscription.NotificationDeliveryChannelListOutputTO
Parameters
deliveryChannels
Type java.util.List [NotificationDeliveryChannelCodeTO]
Description The list of delivery channels.
Mandatory yes
pagingResult
Type PagingResultTO
Description The paging result. Only used for paged queries.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 310 of 424


AFP Interface Specification

2.25.6 NotificationSubscriptionRecipientTO
A delivery preference expressing how a notification should be delivered for the linked subscription.

The full name


com.avaloq.afs.server.bsp.ws.to.notification.subscription.NotificationSubscriptionRecipientTO
Parameters
subscriptionId
Type java.lang.Long
Description The id of the subscription.
Mandatory no
channelId
Type java.lang.Long
Description The id of the channel over which the notification should be delivered.
Mandatory no
recipientAddress
Type java.lang.String
Description Delivery information relevant to the requested delivery channel e.g. an email address, mobile
phone number or Avaloq Address object reference.
Mandatory no
max Length 200
Example john.doe@example.com
messageTypeId
Type java.lang.Long
Description The message type requested by the recipient
Mandatory no

Copyright 201, Avaloq Evolution AG Page 311 of 424


AFP Interface Specification

2.26 com.avaloq.afs.server.bsp.ws.to.notifications
2.26.0 EmailNotificationAddressTO
Contains email address and name of the address owner.

The full name


com.avaloq.afs.server.bsp.ws.to.notifications.EmailNotificationAddressTO
Parameters
address
Type java.lang.String
Description The email address.
Mandatory yes
max Length 254
Example jane.doe@example.com
name
Type java.lang.String
Description The email address owner's name.
Mandatory no
max Length 150
Example Jane Doe

2.26.1 EmailNotificationTO
A notification that should be sent as an email.

The full name


com.avaloq.afs.server.bsp.ws.to.notifications.EmailNotificationTO
Parameters
text
Type java.lang.String
Description The message text.
Mandatory yes
Example This is a test notification.
subject
Type java.lang.String
Description The subject.
Mandatory yes
max Length 254
Example Special Offer
recipients
Type EmailNotificationAddressListTO
Description The recipients' email addresses.
Mandatory yes
sender
Type EmailNotificationAddressTO
Description The sender's email address.
Mandatory yes
replyTo
Type java.util.List [EmailNotificationAddressTO]
Description The reply-to addresses.
Mandatory no
contentType
Type MimeType
Description The content type.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 312 of 424


AFP Interface Specification

Parameters
encoding
Type CharacterEncoding
Description The character encoding.
Mandatory no

2.26.2 EmailNotificationAddressListTO
Contains lists of email recipients.

The full name


com.avaloq.afs.server.bsp.ws.to.notifications.EmailNotificationAddressListTO
Parameters
recipientToList
Type java.util.List [EmailNotificationAddressTO]
Description The recipients' TO email addresses.
Mandatory yes
recipientCcList
Type java.util.List [EmailNotificationAddressTO]
Description The recipients' CC (Carbon Copy) email addresses.
Mandatory no
recipientBccList
Type java.util.List [EmailNotificationAddressTO]
Description The recipients' BCC (Blind Carbon Copy) email addresses.
Mandatory no

2.26.3 SmsNotificationTO
A notification that should be sent via SMS.

The full name


com.avaloq.afs.server.bsp.ws.to.notifications.SmsNotificationTO
Parameters
text
Type java.lang.String
Description The message text.
Mandatory yes
max Length 160
Example This is a test notification.
recipientNumber
Type java.lang.String
Description The number of the recipient.
Mandatory yes
max Length 20
Example 0041791234567
senderNumber
Type java.lang.String
Description The number of the sender. (Fallback is default sender i.e. source address in SMPP
configuration.)
Mandatory no
max Length 20
Example 0041791234567

Copyright 201, Avaloq Evolution AG Page 313 of 424


AFP Interface Specification

2.27 com.avaloq.afs.server.bsp.ws.to.objectclass
2.27.0 ObjectClassTypeTO
Transports the data of an object class type class.

The full name


com.avaloq.afs.server.bsp.ws.to.objectclass.ObjectClassTypeTO
Parameters
objectClassificationType
Type CodeTO
Description The objectClassificationType.
Mandatory yes
guid
Type java.lang.Long
Description The guid.
Mandatory yes
internalId
Type java.lang.String
Description The internal id.
Mandatory yes
name
Type java.lang.String
Description The name.
Mandatory yes
active
Type java.lang.Boolean
Description Is active.
Mandatory yes
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 314 of 424


AFP Interface Specification

2.28 com.avaloq.afs.server.bsp.ws.to.payment
2.28.0 PaymentOrderTO
The payment order.
This object contains all order relevant parameters.
The full name
com.avaloq.afs.server.bsp.ws.to.payment.PaymentOrderTO
Parameters
paymentSearchState
Type PaymentSearchStateType
Description The actual search state of the payment.
Mandatory no
transactionDate
Type java.util.Date
Description The transaction date of this order.
On this date the bank starts to execute the transaction.
Mandatory no
originalTransactionDate
Type java.util.Date
Description The original transaction date of this order.
Mandatory no
paymentCordOrderId
Type java.lang.Long
Description The internal reference of the payment cord order.
null if this is a single order.
Mandatory no
dtaFileName
Type java.lang.String
Description The dta filename if dta is true.
Mandatory no
max Length 255
Example salary.dta
billPid
Type java.lang.String
Description The paynet bill id if this payment is created from a paynet bill.
Mandatory no
max Length 29
Example 12 44355 23134 34356
contractPid
Type java.lang.String
Description The paynet contract id who created this payment.
Mandatory no
max Length 17
Example 34 56355 23134 76923
paynetAmountEditable
Type boolean
Description true if the payment is a paynet payment and the amount can be edited.
Mandatory yes
dtaReferenceNumber
Type java.lang.String
Description The dta reference number.
Mandatory no
max Length 16
Example 1325476769121546

Copyright 201, Avaloq Evolution AG Page 315 of 424


AFP Interface Specification

Parameters
fraudDetection
Type PaymentFraudDetectionTO
Description Information used for fraud detection.
Mandatory no
paymentSource
Type PaymentOrderSource
Description The source of the payment order.
Possible values:
• PaymentOrderSource.SINGLE_PAYMENT
• PaymentOrderSource.DTA_ORDER
• PaymentOrderSource.PAIN001_ORDER
• PaymentOrderSource.STANDING_ORDER
• PaymentOrderSource.E_BILL
Mandatory no
payment
Type BasePaymentTO
Description The real payment on this order.
Mandatory yes
paymentExternalOrderId
Type java.lang.Long
Description The external order Id of the payment.
Mandatory no
paymentState
Type PaymentStateType
Description The actual state of the payment.
Mandatory no
paymentActionTypes
Type java.util.Set
Description The action state of the payment.
Specifies what a user can do with this order.
Mandatory no
creationDate
Type java.util.Date
Description The date when the payment was created in the database.
Mandatory no
paymentLogList
Type java.util.List [PaymentLogTO]
Description The list of log events of this order.
Mandatory no
transactionSigningObjectType
Type TransactionSigningObjectType
Description The transaction singing type.
Mandatory no
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 316 of 424


AFP Interface Specification

2.28.1 PaymentOrderOverviewListOutputTO
Holder for a list of payment orders for the overview screen in the response object.

The full name


com.avaloq.afs.server.bsp.ws.to.payment.PaymentOrderOverviewListOutputTO
Parameters
paymentOverviewStatistics
Type PaymentStatisticsTO
Description This object contains all statistics for all the payments related to this object.
Mandatory no
resultList
Type java.util.List [PaymentOrderOverviewTO]
Description The list of payment orders for the overview screen.
Mandatory yes
pagingResult
Type PagingResultTO
Description The paging result. Only used for paged queries.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.28.2 PaymentLogTO
A log event of a payment.

The full name


com.avaloq.afs.server.bsp.ws.to.payment.PaymentLogTO
Parameters
date
Type java.util.Date
Description The date of this payment log event.
Mandatory yes
contractName
Type java.lang.String
Description The name of the authentication object which have triggered this event.
Mandatory no
max Length 30
Example L8007735
paymentLogType
Type PaymentLogType
Description The type of this log event.
Mandatory yes
signaturePerc
Type java.lang.Double
Description The signature percentage of the single action on the payment.
Mandatory yes
totalSignaturePerc
Type java.lang.Double
Description The accumulated signature percentage on the payment.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 317 of 424


AFP Interface Specification

2.28.3 BasePaymentOrderOutputTO
Holder for a base payment order in the response object.

The full name


com.avaloq.afs.server.bsp.ws.to.payment.BasePaymentOrderOutputTO
Parameters
basePaymentOrder
Type BasePaymentOrderTO
Description The base payment order.
null if the call was not successful (notificationList) or the payment needs to be signed first.
Mandatory no
transactionSigningRequest
Type TransactionSigningRequestTO
Description A signing request for this transaction.
If a user approve a transaction but have to sign it first. In this case the other transaction
specific parameters are null.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.28.4 PaymentCordOrderOutputTO
Holder for a payment cord order in the response object.

The full name


com.avaloq.afs.server.bsp.ws.to.payment.PaymentCordOrderOutputTO
Parameters
paymentCordOrder
Type PaymentCordOrderTO
Description The payment cord order.
null if the call was not successful (notificationList) or the payment needs to be signed first.
Mandatory no
transactionSigningRequest
Type TransactionSigningRequestTO
Description A signing request for this transaction.
If a user approve a transaction but have to sign it first. In this case the other transaction
specific parameters are null.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.28.5 PaymentCordOrderTO
Represent a payment cord order. This cord order contains a list of normal payment orders.
Every order has to have the same
• currency
• debit money account
• transaction or valuta date
The full name
com.avaloq.afs.server.bsp.ws.to.payment.PaymentCordOrderTO

Copyright 201, Avaloq Evolution AG Page 318 of 424


AFP Interface Specification

Parameters
paymentSearchState
Type PaymentSearchStateType
Description The actual search state of the payment.
Mandatory no
paymentOrderList
Type java.util.List [PaymentOrderTO]
Description The list of payment orders.
Mandatory yes
transactionDate
Type java.util.Date
Description The transaction date of this order.
On this date the bank starts to execute the transaction.
Mandatory no
originalTransactionDate
Type java.util.Date
Description The original transaction date of this order.
Mandatory no
amount
Type java.math.BigDecimal
Description The amount of the payment. Only not mandatory in the error file upload case.
Mandatory no
Example 120.25
currencyId
Type java.lang.Long
Description The internal reference of the currency object. Only not mandatory in the error file upload
case.
Mandatory no
debitMoneyAccountId
Type java.lang.Long
Description The internal reference of the debit money account. Only not mandatory in the error file
upload case.
Mandatory no
numberOfPayment
Type java.lang.Long
Description The number of payments in this cord payment.
Mandatory no
salary
Type boolean
Description If this cord payment contains salary payments.
Mandatory yes
paymentExternalOrderId
Type java.lang.Long
Description The external order Id of the payment.
Mandatory no
paymentState
Type PaymentStateType
Description The actual state of the payment.
Mandatory no
paymentActionTypes
Type java.util.Set
Description The action state of the payment.
Specifies what a user can do with this order.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 319 of 424


AFP Interface Specification

Parameters
creationDate
Type java.util.Date
Description The date when the payment was created in the database.
Mandatory no
paymentLogList
Type java.util.List [PaymentLogTO]
Description The list of log events of this order.
Mandatory no
transactionSigningObjectType
Type TransactionSigningObjectType
Description The transaction singing type.
Mandatory no
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.28.6 AbstractStandingOrderTO
The abstract standing order.
This object contains all order relevant parameters.
The full name
com.avaloq.afs.server.bsp.ws.to.payment.AbstractStandingOrderTO

See also
- StandingOrderTO
- BalanceManagerTO
Parameters
standingOrderSearchStateType
Type StandingOrderSearchStateType
Description The actual search state of the standing order.
Mandatory no
periodStart
Type java.util.Date
Description The date time when the execution period of this standing order starts.
Mandatory no
endDate
Type java.util.Date
Description The date time when the execution of this standing order should be stopped. If booth the
endDate and the maxPeriodCnt are null the standing order will be executed forever.
Mandatory no
endOfMonth
Type java.lang.Boolean
Description The flag for end of month It's mandatory for standing orders and optional for balance
manager.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 320 of 424


AFP Interface Specification

Parameters
maxPeriodCnt
Type java.lang.Integer
Description The number of executions of this standing order. If booth the maxPeriodCnt and the
endDate are null the standing order will be executed forever.
Mandatory no
beforeHoliday
Type java.lang.Boolean
Description If the execution date is on a holiday or weekend this parameter decide if the standing order
will be executed before or after this date.
Mandatory yes
deactivated
Type boolean
Description true if the standing order is deactivated.
Mandatory yes
lastExecutionDate
Type java.util.Date
Description The date of the last successful execution of this standing order.
Mandatory no
nextExecutionDate
Type java.util.Date
Description The date of the next possible execution of this standing order.
Mandatory no
numberOfExecutions
Type java.lang.Integer
Description The actual number of successful executions of this standing order.
Mandatory no
standingOrderPeriodId
Type java.lang.Long
Description The internal reference of the desired standing order period. It's mandatory for standing
orders and optional for balance manager.
Mandatory no
fraudDetectionTO
Type PaymentFraudDetectionTO
Description Fraud detection info
Mandatory no
payment
Type BasePaymentTO
Description The real payment on this order.
Mandatory yes
paymentExternalOrderId
Type java.lang.Long
Description The external order Id of the payment.
Mandatory no
paymentState
Type PaymentStateType
Description The actual state of the payment.
Mandatory no
paymentActionTypes
Type java.util.Set
Description The action state of the payment.
Specifies what a user can do with this order.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 321 of 424


AFP Interface Specification

Parameters
creationDate
Type java.util.Date
Description The date when the payment was created in the database.
Mandatory no
paymentLogList
Type java.util.List [PaymentLogTO]
Description The list of log events of this order.
Mandatory no
transactionSigningObjectType
Type TransactionSigningObjectType
Description The transaction singing type.
Mandatory no
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.28.7 PaymentStatisticsTO
This is a generic class that can be used to store and transfer total amounts and amounts per currency. The Entered
Payments section on the web displays the payments for the client, each payment can be in one of many states as well as in
one of many currencies. The total amount set in this object is calculated in the base currency for the client and it is the total of
all the payments irrespective of their state. The Details button on the Entered Payments section also displays the payments
per currency, these entries are again irrespective of the payment states' This class can be used to store the details for a
group of transactions i.e. a group of payments to be approved, in which case the Total amount would be the calculated total
for all the payments to be approved and the list of payments per currency can be the payments to be approved in that
currency. This allows for the full information to be displayed to the client, i.e. the total amount of payments to be approved,
the amounts per currency and so on. The same concept can also be used for payments to be deleted.

The full name


com.avaloq.afs.server.bsp.ws.to.payment.PaymentStatisticsTO
Parameters
totalAmount
Type TotalAmountTO
Description The the total amount in one currency. Only null in the full reload.
Mandatory no
totalAmountPerCurrencyList
Type java.util.List [TotalAmountTO]
Description This list contains the total amounts per currency for all of the payments that need to be
approved. This allows the user to know how much they are approving for each currency.
Mandatory yes

2.28.8 TotalAmountTO
total amount object.

The full name


com.avaloq.afs.server.bsp.ws.to.payment.TotalAmountTO
Parameters

Copyright 201, Avaloq Evolution AG Page 322 of 424


AFP Interface Specification

Parameters
numberOfRecords
Type java.lang.Integer
Description The number of records affected the total amount.
Mandatory yes
amount
Type java.math.BigDecimal
Description The total amount of all recored in one currency.
Mandatory yes
Example 120.25
currency
Type CurrencyTO
Description The internal reference of the currency object.
Mandatory yes

2.28.9 PaymentCordQueryTO
A query object to search for payments in a cord order.

The full name


com.avaloq.afs.server.bsp.ws.to.payment.PaymentCordQueryTO
Parameters
beneficiary
Type java.lang.String
Description The beneficiary or a sub part of them. Searches in the beneficiary fields one to four. Returns
only payment orders.
Mandatory no
max Length 35
Example Hans Mu
debitReference
Type java.lang.String
Description The debit reference or a sub part of them. Searches in the debit reference field.
Mandatory no
max Length 200
Example Africa Holidays
paymentReason
Type java.lang.String
Description The payment reason or a sub part of them. Searches in the payment reason fields one to
four. Returns only payment orders.
Mandatory no
max Length 35
Example Payment for WWF
fromAmount
Type java.math.BigDecimal
Description The lower bound of the amount to find.
Has to be smaller than toAmount. Returns only payment orders.
Mandatory no
Example 100.00
toAmount
Type java.math.BigDecimal
Description The upper bound of the amount to find.
Has to be greater than fromAmount. Returns only payment orders.
Mandatory no
Example 150.00

Copyright 201, Avaloq Evolution AG Page 323 of 424


AFP Interface Specification

Parameters
paymentTypeList
Type java.util.List [PaymentType]
Description The list of types of the payments to find. Returns only payment orders.
Mandatory no
paymentSearchStateType
Type PaymentSearchStateType
Description The state of the payments to find.
Mandatory no
inclusiveUserOnlyPayments
Type boolean
Description If true return also private (user only) payments. Used for the file upload.
Mandatory yes

2.28.10 BasePaymentOrderTO
A base payment order is the common object for PaymentOrderTO, StandingOrderTO and PaymentTemplateTO.
This object contains all order relevant parameters.
The full name
com.avaloq.afs.server.bsp.ws.to.payment.BasePaymentOrderTO

See also
- PaymentOrderTO
- AbstractStandingOrderTO
- PaymentTemplateTO
Parameters
payment
Type BasePaymentTO
Description The real payment on this order.
Mandatory yes
paymentExternalOrderId
Type java.lang.Long
Description The external order Id of the payment.
Mandatory no
paymentState
Type PaymentStateType
Description The actual state of the payment.
Mandatory no
paymentActionTypes
Type java.util.Set
Description The action state of the payment.
Specifies what a user can do with this order.
Mandatory no
creationDate
Type java.util.Date
Description The date when the payment was created in the database.
Mandatory no
paymentLogList
Type java.util.List [PaymentLogTO]
Description The list of log events of this order.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 324 of 424


AFP Interface Specification

Parameters
transactionSigningObjectType
Type TransactionSigningObjectType
Description The transaction singing type.
Mandatory no
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.28.11 PaymentOrderOverviewTO
A payment order object for the overview screen. This can be a single or collective order.

The full name


com.avaloq.afs.server.bsp.ws.to.payment.PaymentOrderOverviewTO
Parameters
externalOrderId
Type java.lang.Long
Description The external order Id of the collectiv order.
Mandatory no
amount
Type java.math.BigDecimal
Description The amount of the single payment or the total amount of the collectiv order.
Mandatory yes
Example 120.25
currency
Type CurrencyTO
Description The payments currency.
Mandatory no
currencyIsMixed
Type java.lang.Boolean
Description Defines whether the payments contain mixed currencies. Only relevant for DTA groups.
Mandatory no
numberOfMissingXrate
Type java.lang.Long
Description Used to check and report missing xrates for the currencies involved in the payments. Only
relevant for DTA groups.
Mandatory no
amountInReferenceCurrency
Type java.math.BigDecimal
Description The amount in the reference currency.
Mandatory no
debitMoneyAccountId
Type java.lang.Long
Description The internal reference of the debit money account.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 325 of 424


AFP Interface Specification

Parameters
debitMoneyAccountIsMixed
Type java.lang.Boolean
Description Defines whether the debit account field contains mixed values. Only relevant for DTA
groups.
Mandatory no
debitReference
Type java.lang.String
Description This text is shown in the booking after the execution of the payment.
Mandatory no
max Length 200
Example Steuern 2012
paymentReasonOrEsrReference
Type java.lang.String
Description The payment reason or the ESR reference for swiss orange payment slips.
Mandatory no
max Length 35
Example Payment to the
creditMoneyAccountId
Type java.lang.Long
Description The internal reference of the credit money account for account transfer.
Mandatory no
creditMoneyAccountIban
Type java.lang.String
Description The iban of the credit money account. Used if the user has no access to the credit money
account.
Mandatory no
max Length 35
Example CH5200778162903242000
beneficiary
Type java.lang.String
Description The first line of the beneficiary address if exists.
Mandatory no
max Length 35
Example Hans Muster
transactionDate
Type java.util.Date
Description The transaction date of this order.
On this date the bank starts to execute the transaction.
Mandatory no
transactionDateIsMixed
Type java.lang.Boolean
Description Defines whether the transaction date field contains mixed values. Only relevant for DTA
groups.
Mandatory no
originalTransactionDate
Type java.util.Date
Description The original transaction date of this order.
Mandatory no
originalTransactionDateIsMixed
Type java.lang.Boolean
Description Defines whether the original transaction date field contains mixed values. Only relevant for
DTA groups.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 326 of 424


AFP Interface Specification

Parameters
creationDate
Type java.util.Date
Description The date when this payment was created.
Mandatory no
creationDateIsMixed
Type java.lang.Boolean
Description Defines whether the creation date contains mixed values. Only relevant for DTA groups.
Mandatory no
orderDate
Type java.util.Date
Description The date when this payment was full approved.
Mandatory no
orderDateIsMixed
Type java.lang.Boolean
Description Defines whether the order date field contains mixed values. Only relevant for DTA groups.
Mandatory no
valutaDate
Type java.util.Date
Description The valuta date of this this payment.
Mandatory no
valutaDateIsMixed
Type java.lang.Boolean
Description Defines whether the value date field contains mixed values. Only relevant for DTA groups.
Mandatory no
paymentType
Type PaymentType
Description The type of the payment.
Mandatory yes
paymentGroupType
Type PaymentGroupType
Description The group type of the payment.
Mandatory yes
paymentState
Type PaymentStateType
Description The actual state of the payment.
Mandatory no
paymentActionTypes
Type java.util.Set
Description The action state of the payment.
Specifies what a user can do with this order.
Mandatory no
paymentSearchState
Type PaymentSearchStateType
Description The actual search state of the payment.
Mandatory no
cordPaymentOrderId
Type java.lang.Long
Description The internal reference of the cord payment order if this is a single order of a cord oder.
Mandatory no
numberOfPayment
Type java.lang.Long
Description The number of payments in this cord payment. Only filled if this is really a cord payment
overview.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 327 of 424


AFP Interface Specification

Parameters
inWork
Type java.lang.Boolean
Description Defines whether the order is in work or not.
Mandatory no
dtaFileName
Type java.lang.String
Description In case the order was created by a DTA file this field stores the corresponding file name.
Mandatory no
advices
Type java.util.List [java.lang.Long]
Description The list of advice ids.
Mandatory yes
paymentSource
Type PaymentOrderSource
Description The source of the payment.
Possible values:
• PaymentOrderSource.SINGLE_PAYMENT
• PaymentOrderSource.DTA_ORDER
• PaymentOrderSource.PAIN001_ORDER
• PaymentOrderSource.STANDING_ORDER
• PaymentOrderSource.E_BILL
• PaymentOrderSource.COLLECTIVE_PAYMENT
Mandatory no
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.28.12 StandingOrderTO
The standing order.
This object contains all order relevant parameters.
The full name
com.avaloq.afs.server.bsp.ws.to.payment.StandingOrderTO
Parameters
standingOrderSearchStateType
Type StandingOrderSearchStateType
Description The actual search state of the standing order.
Mandatory no
periodStart
Type java.util.Date
Description The date time when the execution period of this standing order starts.
Mandatory no
endDate
Type java.util.Date
Description The date time when the execution of this standing order should be stopped. If booth the
endDate and the maxPeriodCnt are null the standing order will be executed forever.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 328 of 424


AFP Interface Specification

Parameters
endOfMonth
Type java.lang.Boolean
Description The flag for end of month It's mandatory for standing orders and optional for balance
manager.
Mandatory no
maxPeriodCnt
Type java.lang.Integer
Description The number of executions of this standing order. If booth the maxPeriodCnt and the
endDate are null the standing order will be executed forever.
Mandatory no
beforeHoliday
Type java.lang.Boolean
Description If the execution date is on a holiday or weekend this parameter decide if the standing order
will be executed before or after this date.
Mandatory yes
deactivated
Type boolean
Description true if the standing order is deactivated.
Mandatory yes
lastExecutionDate
Type java.util.Date
Description The date of the last successful execution of this standing order.
Mandatory no
nextExecutionDate
Type java.util.Date
Description The date of the next possible execution of this standing order.
Mandatory no
numberOfExecutions
Type java.lang.Integer
Description The actual number of successful executions of this standing order.
Mandatory no
standingOrderPeriodId
Type java.lang.Long
Description The internal reference of the desired standing order period. It's mandatory for standing
orders and optional for balance manager.
Mandatory no
fraudDetectionTO
Type PaymentFraudDetectionTO
Description Fraud detection info
Mandatory no
payment
Type BasePaymentTO
Description The real payment on this order.
Mandatory yes
paymentExternalOrderId
Type java.lang.Long
Description The external order Id of the payment.
Mandatory no
paymentState
Type PaymentStateType
Description The actual state of the payment.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 329 of 424


AFP Interface Specification

Parameters
paymentActionTypes
Type java.util.Set
Description The action state of the payment.
Specifies what a user can do with this order.
Mandatory no
creationDate
Type java.util.Date
Description The date when the payment was created in the database.
Mandatory no
paymentLogList
Type java.util.List [PaymentLogTO]
Description The list of log events of this order.
Mandatory no
transactionSigningObjectType
Type TransactionSigningObjectType
Description The transaction singing type.
Mandatory no
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.28.13 BalanceManagerTO
TO object for account sweeping.

The full name


com.avaloq.afs.server.bsp.ws.to.payment.BalanceManagerTO
Parameters
methodType
Type BalanceMethodType
Description Method type (surplus, deficit, ...).
Mandatory yes
limit
Type java.math.BigDecimal
Description Limit after which the sweeping is triggered.
Mandatory no
singleOrder
Type java.lang.Boolean
Description If the BMO is executed only once, at a specified date.
Mandatory no
standingOrderSearchStateType
Type StandingOrderSearchStateType
Description The actual search state of the standing order.
Mandatory no
periodStart
Type java.util.Date
Description The date time when the execution period of this standing order starts.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 330 of 424


AFP Interface Specification

Parameters
endDate
Type java.util.Date
Description The date time when the execution of this standing order should be stopped. If booth the
endDate and the maxPeriodCnt are null the standing order will be executed forever.
Mandatory no
endOfMonth
Type java.lang.Boolean
Description The flag for end of month It's mandatory for standing orders and optional for balance
manager.
Mandatory no
maxPeriodCnt
Type java.lang.Integer
Description The number of executions of this standing order. If booth the maxPeriodCnt and the
endDate are null the standing order will be executed forever.
Mandatory no
beforeHoliday
Type java.lang.Boolean
Description If the execution date is on a holiday or weekend this parameter decide if the standing order
will be executed before or after this date.
Mandatory yes
deactivated
Type boolean
Description true if the standing order is deactivated.
Mandatory yes
lastExecutionDate
Type java.util.Date
Description The date of the last successful execution of this standing order.
Mandatory no
nextExecutionDate
Type java.util.Date
Description The date of the next possible execution of this standing order.
Mandatory no
numberOfExecutions
Type java.lang.Integer
Description The actual number of successful executions of this standing order.
Mandatory no
standingOrderPeriodId
Type java.lang.Long
Description The internal reference of the desired standing order period. It's mandatory for standing
orders and optional for balance manager.
Mandatory no
fraudDetectionTO
Type PaymentFraudDetectionTO
Description Fraud detection info
Mandatory no
payment
Type BasePaymentTO
Description The real payment on this order.
Mandatory yes
paymentExternalOrderId
Type java.lang.Long
Description The external order Id of the payment.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 331 of 424


AFP Interface Specification

Parameters
paymentState
Type PaymentStateType
Description The actual state of the payment.
Mandatory no
paymentActionTypes
Type java.util.Set
Description The action state of the payment.
Specifies what a user can do with this order.
Mandatory no
creationDate
Type java.util.Date
Description The date when the payment was created in the database.
Mandatory no
paymentLogList
Type java.util.List [PaymentLogTO]
Description The list of log events of this order.
Mandatory no
transactionSigningObjectType
Type TransactionSigningObjectType
Description The transaction singing type.
Mandatory no
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.28.14 PaymentTemplateFolderTO
This class represents the folders to aggregate payment templates logically. Each payment template can belong to zero, one
or more template folder.
The full name
com.avaloq.afs.server.bsp.ws.to.payment.PaymentTemplateFolderTO
Parameters
alias
Type java.lang.String
Description The alias of this payment template folder.
Mandatory no
max Length 100
Example Grocery Payments
totalTemplates
Type long
Description The number of this payment templates belonging to this folder.
Mandatory yes
actions
Type java.util.List [com.avaloq.afs.server.database.enumeration.PaymentActionType]
Description Actions that can be performed on this folder
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 332 of 424


AFP Interface Specification

Parameters
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.28.15 PaymentTemplateTO
The payment template.
This object contains all template relevant parameters.
The full name
com.avaloq.afs.server.bsp.ws.to.payment.PaymentTemplateTO
Parameters
alias
Type java.lang.String
Description The alias of this payment template.
Mandatory no
max Length 100
Example Geburtstag Gottimeitli
favorite
Type java.lang.Boolean
Description A flag indicating if this payment template is a favorite.
Mandatory no
folders
Type java.util.List [PaymentTemplateFolderTO]
Description The alias of this payment template folder this payment is in.
Mandatory yes
methodType
Type BalanceMethodType
Description Method type (surplus,deficit).
Mandatory no
limit
Type java.math.BigDecimal
Description Limit after which the sweeping is triggered. Is used for Balance Manager.
Mandatory no
standingOrderPeriodId
Type java.lang.Long
Description The internal reference of the desired standing order period. It's mandatory for standing
orders and optional for balance manager.
Mandatory no
endOfMonth
Type java.lang.Boolean
Description The flag for end of month. It's mandatory for standing orders and optional for balance
manager.
Mandatory no
migrated
Type boolean
Description The flag for migrated records.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 333 of 424


AFP Interface Specification

Parameters
payment
Type BasePaymentTO
Description The real payment on this order.
Mandatory yes
paymentExternalOrderId
Type java.lang.Long
Description The external order Id of the payment.
Mandatory no
paymentState
Type PaymentStateType
Description The actual state of the payment.
Mandatory no
paymentActionTypes
Type java.util.Set
Description The action state of the payment.
Specifies what a user can do with this order.
Mandatory no
creationDate
Type java.util.Date
Description The date when the payment was created in the database.
Mandatory no
paymentLogList
Type java.util.List [PaymentLogTO]
Description The list of log events of this order.
Mandatory no
transactionSigningObjectType
Type TransactionSigningObjectType
Description The transaction singing type.
Mandatory no
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.28.16 PaymentOrderOverviewQueryTO
A query object used to search for payment orders.

The full name


com.avaloq.afs.server.bsp.ws.to.payment.PaymentOrderOverviewQueryTO

See also
- PaymentQuerySortField
Parameters
sortedBy
Type java.util.List [QuerySortTO]
Description The query sorting.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 334 of 424


AFP Interface Specification

Parameters
amountFrom
Type java.math.BigDecimal
Description The lower bound of the amount to find.
Has to be smaller than amountTo. Returns only payment orders.
Mandatory no
amountTo
Type java.math.BigDecimal
Description The upper bound of the amount to find.
Has to be greater than amountFrom. Returns only payment orders.
Mandatory no
debitMoneyAccountId
Type java.lang.Long
Description The internal references to the debit money account in which the payment should be
searched.
Mandatory no
debitMoneyAccountPortfolioId
Type java.lang.Long
Description Returns only payments that are in the matching portfolio.
Mandatory no
executionDateFrom
Type java.util.Date
Description The start date in which time period this search should find the payments. The
executionDateFrom has to be earlier than the executionDateTo.
Mandatory no
executionDateTo
Type java.util.Date
Description The end date in which time period this search should find the payments. The
executionDateTo has to be later than the executionDateFrom.
Mandatory no
fileUploadId
Type java.lang.Long
Description The internal reference of a file upload. Returns only cord payments.
Mandatory no
collectiveOrderId
Type java.lang.Long
Description The internal reference of a collective order.
Mandatory no
paymentTypes
Type java.util.List [PaymentType]
Description The payments type to find. Returns only payment orders.
Mandatory no
paymentStates
Type java.util.List [PaymentSearchStateType]
Description The states of the payments to find.
Mandatory no
paymentIds
Type java.util.List [java.lang.Long]
Description The Id's to filter by.
Mandatory no
currencyId
Type java.lang.Long
Description The currency code to find.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 335 of 424


AFP Interface Specification

Parameters
text
Type java.lang.String
Description The text to find in one of the configured text fields.
Mandatory no
paymentSources
Type java.util.List [PaymentOrderSource]
Description The payment source to find.
Mandatory no
includeUserOnlyPayments
Type java.lang.Boolean
Description If true, then the results will include private/user-only payments.
Mandatory no
inWork
Type java.lang.Boolean
Description If true, then the results will include only inWork payments.
Mandatory no
groupCord
Type java.lang.Boolean
Description Whether or not Collective Orders should be grouped.
Mandatory no
groupDta
Type java.lang.Boolean
Description Whether or not payments of DTAs should be grouped.
Mandatory no
paging
Type PagingTO
Description The paging context
Mandatory no

Copyright 201, Avaloq Evolution AG Page 336 of 424


AFP Interface Specification

2.29 com.avaloq.afs.server.bsp.ws.to.payment.position.impl
2.29.0 SwissRedPaymentSlipTO
Representation of an swiss red payment slip implementation.
Used for PaymentOrderTO and StandingOrderTO.
The full name
com.avaloq.afs.server.bsp.ws.to.payment.position.impl.SwissRedPaymentSlipTO
Parameters
pcAccount
Type java.lang.String
Description The postcheck account number of this payment.
Mandatory no
max Length 35
Example 80-2977-6
paymentSubType
Type PaymentSubType
Description The sub type of this orange payment slip.
• Postcheck
• Bank
• Undefined
Mandatory no
beneficiary1
Type java.lang.String
Description The first line of the beneficiary address.
Mandatory no
max Length 35
Example Hans Muster
beneficiary2
Type java.lang.String
Description The second line of the beneficiary address.
Mandatory no
max Length 35
Example Marketgasse 3
beneficiary3
Type java.lang.String
Description The third line of the beneficiary address.
Mandatory no
max Length 35
Example 8000 Zürich
beneficiary4
Type java.lang.String
Description The fourth line of the beneficiary address.
Mandatory no
max Length 35
Example Schweiz
beneficiaryBank1
Type java.lang.String
Description The first line of the bank beneficiary address.
Mandatory no
max Length 35
Example Bank of Switzerland
beneficiaryBank2
Type java.lang.String
Description The second line of the bank beneficiary address.
Mandatory no
max Length 35
Example Bahnhofstrasse 75a

Copyright 201, Avaloq Evolution AG Page 337 of 424


AFP Interface Specification

Parameters
beneficiaryBank3
Type java.lang.String
Description The third line of the bank beneficiary address.
Mandatory no
max Length 35
Example 8050 Zürich
beneficiaryBank4
Type java.lang.String
Description The fourth line of the bank beneficiary address.
Mandatory no
max Length 35
Example Switzerland
beneficiaryIban
Type java.lang.String
Description The IBAN of the beneficiary account.
Either the beneficiaryIban or the beneficiaryAccountNo has to be not null.
Mandatory no
max Length 38
Example DE99 2032 0500 4989 1234 56
beneficiaryAccountNo
Type java.lang.String
Description The account number of the beneficiary account.
Either the beneficiaryAccountNo or the beneficiaryIban has to be not null.
Mandatory no
max Length 38
Example P95.454323.324A
paymentReason
Type java.lang.String
Description The payment reason.
Mandatory no
max Length 143
Example Payment to the
ntnl
Type java.lang.String
Description The national number of the beneficiary bank.
Mandatory no
max Length 10
Example 00729
paymentPriority
Type PaymentPriority
Description The payment priority. Can be normal or urgent.
Mandatory no
salary
Type java.lang.Boolean
Description If this payment is a salary payment.
Mandatory no
amount
Type java.math.BigDecimal
Description The amount of the payment. Only not mandatory in the error file upload case.
Mandatory no
Example 120.25
currencyId
Type java.lang.Long
Description The internal reference of the currency object. Only not mandatory in the error file upload
case.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 338 of 424


AFP Interface Specification

Parameters
debitMoneyAccountId
Type java.lang.Long
Description The internal reference of the debit money account. Only not mandatory in the error file
upload case.
Mandatory no
debitReference
Type java.lang.String
Description This text is shown in the booking after the execution of the payment.
Mandatory no
max Length 200
Example Steuern 2012
adviceOption
Type AdviceOptionType
Description The advice option of the payment.
Mandatory no
paymentType
Type PaymentType
Description The type of the payment.
Mandatory yes
advices
Type java.util.List [java.lang.Long]
Description The list of advice ids.
Mandatory yes
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.29.1 PaymentFraudDetectionTO
TO containing information which can be used for fraud detection.

The full name


com.avaloq.afs.server.bsp.ws.to.payment.position.impl.PaymentFraudDetectionTO
Parameters
browserUserAgent
Type java.lang.String
Description The beneficiary or a sub part of them. Searches in the beneficiary fields one to four. Returns
only payment orders.
Mandatory no
max Length 400
Example Mozilla/5.0 (iPhone; CPU iPhone OS 5_0 like Mac OS X) AppleWebKit/534.46 (KHTML, like
Gecko) Version/5.1 Mobile/9A334 Safari/7534.48.3
originType
Type PaymentFraudDetectionOriginTypeCodeEnum
Description The payment origin.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 339 of 424


AFP Interface Specification

Parameters
authenticationType
Type PaymentFraudDetectionAuthenticationTypeCodeEnum
Description The type of authentication used for this payment.
Mandatory no
clientType
Type PaymentFraudDetectionClientTypeCodeEnum
Description The type of authentication used for this payment.
Mandatory no
confirmationType
Type java.util.Set
Description The type of authentication used for this payment.
Mandatory no
jailbreakOrRooted
Type java.lang.Boolean
Description Whether the phone is jailbroken or rooted.
Mandatory no
frozenPayment
Type java.lang.Boolean
Description Whether the payment is frozen.
Mandatory no

2.29.2 SwissOrangePaymentSlipTO
Representation of an swiss orange payment slip implementation.
Used for com.avaloq.afs.server.bsp.ws.to.payment.PaymentOrderTO and
com.avaloq.afs.server.bsp.ws.to.payment.StandingOrderTO.
The full name
com.avaloq.afs.server.bsp.ws.to.payment.position.impl.SwissOrangePaymentSlipTO
Parameters
pcAccount
Type java.lang.String
Description The postcheck account number of this payment.
Mandatory no
max Length 35
Example 80-2977-6
paymentSubType
Type PaymentSubType
Description The sub type of this orange payment slip.
• Postcheck
• Bank
• Undefined
Mandatory no
beneficiary1
Type java.lang.String
Description The first line of the beneficiary address.
Mandatory no
max Length 35
Example Hans Muster
beneficiary2
Type java.lang.String
Description The second line of the beneficiary address.
Mandatory no
max Length 35

Copyright 201, Avaloq Evolution AG Page 340 of 424


AFP Interface Specification

Parameters
Example Marketgasse 3
beneficiary3
Type java.lang.String
Description The third line of the beneficiary address.
Mandatory no
max Length 35
Example 8000 Zürich
beneficiary4
Type java.lang.String
Description The fourth line of the beneficiary address.
Mandatory no
max Length 35
Example Schweiz
beneficiaryBank1
Type java.lang.String
Description The first line of the bank beneficiary address.
Mandatory no
max Length 35
Example Bank of Switzerland
beneficiaryBank2
Type java.lang.String
Description The second line of the bank beneficiary address.
Mandatory no
max Length 35
Example Bahnhofstrasse 75a
beneficiaryBank3
Type java.lang.String
Description The third line of the bank beneficiary address.
Mandatory no
max Length 35
Example 8050 Zürich
beneficiaryBank4
Type java.lang.String
Description The fourth line of the bank beneficiary address.
Mandatory no
max Length 35
Example Switzerland
referenceNumber
Type java.lang.String
Description The ers reference number of this payment.
Mandatory no
max Length 50
Example 5 08875 82624 05078
paymentPriority
Type PaymentPriority
Description The payment priority. Can be normal or urgent.
Mandatory no
salary
Type java.lang.Boolean
Description If this payment is a salary payment.
Mandatory no
amount
Type java.math.BigDecimal
Description The amount of the payment. Only not mandatory in the error file upload case.
Mandatory no
Example 120.25

Copyright 201, Avaloq Evolution AG Page 341 of 424


AFP Interface Specification

Parameters
currencyId
Type java.lang.Long
Description The internal reference of the currency object. Only not mandatory in the error file upload
case.
Mandatory no
debitMoneyAccountId
Type java.lang.Long
Description The internal reference of the debit money account. Only not mandatory in the error file
upload case.
Mandatory no
debitReference
Type java.lang.String
Description This text is shown in the booking after the execution of the payment.
Mandatory no
max Length 200
Example Steuern 2012
adviceOption
Type AdviceOptionType
Description The advice option of the payment.
Mandatory no
paymentType
Type PaymentType
Description The type of the payment.
Mandatory yes
advices
Type java.util.List [java.lang.Long]
Description The list of advice ids.
Mandatory yes
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.29.3 DomesticPaymentTO
Representation of an swiss domestic payment implementation.
Used for PaymentOrderTO and StandingOrderTO.
The full name
com.avaloq.afs.server.bsp.ws.to.payment.position.impl.DomesticPaymentTO
Parameters
beneficiary1
Type java.lang.String
Description The first line of the beneficiary address.
Mandatory no
max Length 35
Example Hans Muster

Copyright 201, Avaloq Evolution AG Page 342 of 424


AFP Interface Specification

Parameters
beneficiary2
Type java.lang.String
Description The second line of the beneficiary address.
Mandatory no
max Length 35
Example Marketgasse 3
beneficiary3
Type java.lang.String
Description The third line of the beneficiary address.
Mandatory no
max Length 35
Example 8000 Zürich
beneficiary4
Type java.lang.String
Description The fourth line of the beneficiary address.
Mandatory no
max Length 35
Example Schweiz
beneficiaryBank1
Type java.lang.String
Description The first line of the bank beneficiary address.
Mandatory no
max Length 35
Example Bank of Switzerland
beneficiaryBank2
Type java.lang.String
Description The second line of the bank beneficiary address.
Mandatory no
max Length 35
Example Bahnhofstrasse 75a
beneficiaryBank3
Type java.lang.String
Description The third line of the bank beneficiary address.
Mandatory no
max Length 35
Example 8050 Zürich
beneficiaryBank4
Type java.lang.String
Description The fourth line of the bank beneficiary address.
Mandatory no
max Length 35
Example Switzerland
beneficiaryIban
Type java.lang.String
Description The IBAN of the beneficiary account.
Either the beneficiaryIban or the beneficiaryAccountNo has to be not null.
Mandatory no
max Length 38
Example DE99 2032 0500 4989 1234 56
beneficiaryAccountNo
Type java.lang.String
Description The account number of the beneficiary account.
Either the beneficiaryAccountNo or the beneficiaryIban has to be not null.
Mandatory no
max Length 38
Example P95.454323.324A

Copyright 201, Avaloq Evolution AG Page 343 of 424


AFP Interface Specification

Parameters
paymentReason
Type java.lang.String
Description The payment reason.
Mandatory no
max Length 143
Example Payment to the
ntnl
Type java.lang.String
Description The national number of the beneficiary bank.
Mandatory no
max Length 10
Example 00729
chargeOption
Type ChargeOptionType
Description The charge option.
Mandatory no
paymentChannel
Type PaymentChannelType
Description The payment channel.
Mandatory no
paymentPriority
Type PaymentPriority
Description The payment priority. Can be normal or urgent.
Mandatory no
postitText
Type java.lang.String
Description The postit text.
Mandatory no
max Length 4000
Example Payment to the WWF for the Fun Run on 20/08/2013
salary
Type java.lang.Boolean
Description If this payment is a salary payment.
Mandatory no
amount
Type java.math.BigDecimal
Description The amount of the payment. Only not mandatory in the error file upload case.
Mandatory no
Example 120.25
currencyId
Type java.lang.Long
Description The internal reference of the currency object. Only not mandatory in the error file upload
case.
Mandatory no
debitMoneyAccountId
Type java.lang.Long
Description The internal reference of the debit money account. Only not mandatory in the error file
upload case.
Mandatory no
debitReference
Type java.lang.String
Description This text is shown in the booking after the execution of the payment.
Mandatory no
max Length 200
Example Steuern 2012

Copyright 201, Avaloq Evolution AG Page 344 of 424


AFP Interface Specification

Parameters
adviceOption
Type AdviceOptionType
Description The advice option of the payment.
Mandatory no
paymentType
Type PaymentType
Description The type of the payment.
Mandatory yes
advices
Type java.util.List [java.lang.Long]
Description The list of advice ids.
Mandatory yes
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.29.4 InternalPaymentTO
Representation of an internal payment implementation.

The full name


com.avaloq.afs.server.bsp.ws.to.payment.position.impl.InternalPaymentTO
Parameters
creditMoneyAccountId
Type java.lang.Long
Description The internal reference of the credit money account.Only null if a shared user has no access
to this account. In this case the creditMoneyAccoutIban should be filled.
Mandatory no
creditMoneyAccountIban
Type java.lang.String
Description The iban of the credit money account. Used if the user has no access to the credit money
account.
Mandatory no
max Length 35
Example CH5200778162903242000
paymentReason
Type java.lang.String
Description The payment reason.
Mandatory no
max Length 143
Example Payment to the
paymentPriority
Type PaymentPriority
Description The payment priority. Can be normal or urgent.
Mandatory no
beneficiary1
Type java.lang.String
Description The beneficiary.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 345 of 424


AFP Interface Specification

Parameters
max Length 70
Example Hans Muster
amount
Type java.math.BigDecimal
Description The amount of the payment. Only not mandatory in the error file upload case.
Mandatory no
Example 120.25
currencyId
Type java.lang.Long
Description The internal reference of the currency object. Only not mandatory in the error file upload
case.
Mandatory no
debitMoneyAccountId
Type java.lang.Long
Description The internal reference of the debit money account. Only not mandatory in the error file
upload case.
Mandatory no
debitReference
Type java.lang.String
Description This text is shown in the booking after the execution of the payment.
Mandatory no
max Length 200
Example Steuern 2012
adviceOption
Type AdviceOptionType
Description The advice option of the payment.
Mandatory no
paymentType
Type PaymentType
Description The type of the payment.
Mandatory yes
advices
Type java.util.List [java.lang.Long]
Description The list of advice ids.
Mandatory yes
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.29.5 InternationalPaymentTO
Representation of an international payment implementation.
Used for PaymentOrderTO and StandingOrderTO.
The full name
com.avaloq.afs.server.bsp.ws.to.payment.position.impl.InternationalPaymentTO
Parameters

Copyright 201, Avaloq Evolution AG Page 346 of 424


AFP Interface Specification

Parameters
beneficiary1
Type java.lang.String
Description The first line of the beneficiary address.
Mandatory no
max Length 35
Example Hans Muster
beneficiary2
Type java.lang.String
Description The second line of the beneficiary address.
Mandatory no
max Length 35
Example Marketgasse 3
beneficiary3
Type java.lang.String
Description The third line of the beneficiary address.
Mandatory no
max Length 35
Example 8000 Zürich
beneficiary4
Type java.lang.String
Description The fourth line of the beneficiary address.
Mandatory no
max Length 35
Example Schweiz
beneficiaryBank1
Type java.lang.String
Description The first line of the bank beneficiary address.
Mandatory no
max Length 35
Example Bank of Switzerland
beneficiaryBank2
Type java.lang.String
Description The second line of the bank beneficiary address.
Mandatory no
max Length 35
Example Bahnhofstrasse 75a
beneficiaryBank3
Type java.lang.String
Description The third line of the bank beneficiary address.
Mandatory no
max Length 35
Example 8050 Zürich
beneficiaryBank4
Type java.lang.String
Description The fourth line of the bank beneficiary address.
Mandatory no
max Length 35
Example Switzerland
beneficiaryIban
Type java.lang.String
Description The IBAN of the beneficiary account.
Either the beneficiaryIban or the beneficiaryAccountNo has to be not null.
Mandatory no
max Length 38
Example DE99 2032 0500 4989 1234 56

Copyright 201, Avaloq Evolution AG Page 347 of 424


AFP Interface Specification

Parameters
beneficiaryAccountNo
Type java.lang.String
Description The account number of the beneficiary account.
Either the beneficiaryAccountNo or the beneficiaryIban has to be not null.
Mandatory no
max Length 38
Example P95.454323.324A
paymentReason
Type java.lang.String
Description The payment reason.
Mandatory no
max Length 143
Example Payment to the
ntnl
Type java.lang.String
Description The national number of the beneficiary bank.
Mandatory no
max Length 10
Example 00729
chargeOption
Type ChargeOptionType
Description The charge option.
Mandatory no
paymentPriority
Type PaymentPriority
Description The payment priority. Can be normal or urgent.
Mandatory no
postitText
Type java.lang.String
Description The postit text.
Mandatory no
max Length 4000
Example Payment to the WWF for the Fun Run on 20/08/2013
bic
Type java.lang.String
Description The BIC number of the beneficiary bank.
Mandatory no
max Length 11
Example HYVEDEMMXXX
countryId
Type java.lang.Long
Description The internal reference of the beneficiary country.
Mandatory no
salary
Type java.lang.Boolean
Description If this payment is a salary payment.
Mandatory no
amount
Type java.math.BigDecimal
Description The amount of the payment. Only not mandatory in the error file upload case.
Mandatory no
Example 120.25

Copyright 201, Avaloq Evolution AG Page 348 of 424


AFP Interface Specification

Parameters
currencyId
Type java.lang.Long
Description The internal reference of the currency object. Only not mandatory in the error file upload
case.
Mandatory no
debitMoneyAccountId
Type java.lang.Long
Description The internal reference of the debit money account. Only not mandatory in the error file
upload case.
Mandatory no
debitReference
Type java.lang.String
Description This text is shown in the booking after the execution of the payment.
Mandatory no
max Length 200
Example Steuern 2012
adviceOption
Type AdviceOptionType
Description The advice option of the payment.
Mandatory no
paymentType
Type PaymentType
Description The type of the payment.
Mandatory yes
advices
Type java.util.List [java.lang.Long]
Description The list of advice ids.
Mandatory yes
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.29.6 SepaPaymentTO
Representation of an international payment implementation.
Used for PaymentOrderTO and StandingOrderTO.
The full name
com.avaloq.afs.server.bsp.ws.to.payment.position.impl.SepaPaymentTO
Parameters
beneficiary1
Type java.lang.String
Description The beneficiary.
Mandatory no
max Length 70
Example Hans Muster

Copyright 201, Avaloq Evolution AG Page 349 of 424


AFP Interface Specification

Parameters
beneficiaryBank1
Type java.lang.String
Description The first line of the bank beneficiary address.
Mandatory no
max Length 35
Example Bank of Switzerland
beneficiaryBank2
Type java.lang.String
Description The second line of the bank beneficiary address.
Mandatory no
max Length 35
Example Bahnhofstrasse 75a
beneficiaryBank3
Type java.lang.String
Description The third line of the bank beneficiary address.
Mandatory no
max Length 35
Example 8050 Zürich
beneficiaryBank4
Type java.lang.String
Description The fourth line of the bank beneficiary address.
Mandatory no
max Length 35
Example Switzerland
beneficiaryIban
Type java.lang.String
Description The IBAN of the beneficiary account.
Mandatory no
max Length 38
Example DE99 2032 0500 4989 1234 56
paymentReason
Type java.lang.String
Description The payment reason.
Mandatory no
max Length 143
Example Payment to the
bic
Type java.lang.String
Description The BIC number of the beneficiary bank.
Mandatory no
max Length 11
Example HYVEDEMMXXX
clientReference
Type java.lang.String
Description The client reference or end to end reference.
Mandatory no
max Length 35
Example Ebay Zahlung
salary
Type java.lang.Boolean
Description If this payment is a salary payment.
Mandatory no
amount
Type java.math.BigDecimal
Description The amount of the payment. Only not mandatory in the error file upload case.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 350 of 424


AFP Interface Specification

Parameters
Example 120.25
currencyId
Type java.lang.Long
Description The internal reference of the currency object. Only not mandatory in the error file upload
case.
Mandatory no
debitMoneyAccountId
Type java.lang.Long
Description The internal reference of the debit money account. Only not mandatory in the error file
upload case.
Mandatory no
debitReference
Type java.lang.String
Description This text is shown in the booking after the execution of the payment.
Mandatory no
max Length 200
Example Steuern 2012
adviceOption
Type AdviceOptionType
Description The advice option of the payment.
Mandatory no
paymentType
Type PaymentType
Description The type of the payment.
Mandatory yes
advices
Type java.util.List [java.lang.Long]
Description The list of advice ids.
Mandatory yes
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.29.7 SwissPaymentInstructionTO
Representation of an swiss payment instruction implementation.
Used for PaymentOrderTO and StandingOrderTO.
The full name
com.avaloq.afs.server.bsp.ws.to.payment.position.impl.SwissPaymentInstructionTO
Parameters
beneficiary1
Type java.lang.String
Description The first line of the beneficiary address.
Mandatory no
max Length 35
Example Hans Muster

Copyright 201, Avaloq Evolution AG Page 351 of 424


AFP Interface Specification

Parameters
beneficiary2
Type java.lang.String
Description The second line of the beneficiary address.
Mandatory no
max Length 35
Example Marketgasse 3
beneficiary3
Type java.lang.String
Description The third line of the beneficiary address.
Mandatory no
max Length 35
Example 8000 Zürich
paymentReason
Type java.lang.String
Description The payment reason.
Mandatory no
max Length 143
Example Payment to the
beneficiaryPostalCode
Type java.lang.String
Description The postal code of the beneficiary.
Mandatory no
max Length 25
Example 8050
beneficiaryCity
Type java.lang.String
Description The city of the beneficiary.
Mandatory no
max Length 50
Example Zurich
salary
Type java.lang.Boolean
Description If this payment is a salary payment.
Mandatory no
amount
Type java.math.BigDecimal
Description The amount of the payment. Only not mandatory in the error file upload case.
Mandatory no
Example 120.25
currencyId
Type java.lang.Long
Description The internal reference of the currency object. Only not mandatory in the error file upload
case.
Mandatory no
debitMoneyAccountId
Type java.lang.Long
Description The internal reference of the debit money account. Only not mandatory in the error file
upload case.
Mandatory no
debitReference
Type java.lang.String
Description This text is shown in the booking after the execution of the payment.
Mandatory no
max Length 200
Example Steuern 2012

Copyright 201, Avaloq Evolution AG Page 352 of 424


AFP Interface Specification

Parameters
adviceOption
Type AdviceOptionType
Description The advice option of the payment.
Mandatory no
paymentType
Type PaymentType
Description The type of the payment.
Mandatory yes
advices
Type java.util.List [java.lang.Long]
Description The list of advice ids.
Mandatory yes
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.29.8 BalanceManagerPaymentTO
Representation of an balance manager payment implementation.

The full name


com.avaloq.afs.server.bsp.ws.to.payment.position.impl.BalanceManagerPaymentTO
Parameters
creditMoneyAccountId
Type java.lang.Long
Description The internal reference of the credit money account.Only null if a shared user has no access
to this account. In this case the creditMoneyAccoutIban should be filled.
Mandatory no
creditMoneyAccountIban
Type java.lang.String
Description The iban of the credit money account. Used if the user has no access to the credit money
account.
Mandatory no
max Length 35
Example CH5200778162903242000
paymentReason
Type java.lang.String
Description The payment reason.
Mandatory no
max Length 143
Example Payment to the
paymentPriority
Type PaymentPriority
Description The payment priority. Can be normal or urgent.
Mandatory no
beneficiary1
Type java.lang.String
Description The beneficiary.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 353 of 424


AFP Interface Specification

Parameters
max Length 70
Example Hans Muster
amount
Type java.math.BigDecimal
Description The amount of the payment. Only not mandatory in the error file upload case.
Mandatory no
Example 120.25
currencyId
Type java.lang.Long
Description The internal reference of the currency object. Only not mandatory in the error file upload
case.
Mandatory no
debitMoneyAccountId
Type java.lang.Long
Description The internal reference of the debit money account. Only not mandatory in the error file
upload case.
Mandatory no
debitReference
Type java.lang.String
Description This text is shown in the booking after the execution of the payment.
Mandatory no
max Length 200
Example Steuern 2012
adviceOption
Type AdviceOptionType
Description The advice option of the payment.
Mandatory no
paymentType
Type PaymentType
Description The type of the payment.
Mandatory yes
advices
Type java.util.List [java.lang.Long]
Description The list of advice ids.
Mandatory yes
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.29.9 BasePaymentTO
A base payment is the common object for
• internal payment
• orange payment slip
• red payment slip
• swiss domestic payment
• international payment

This object contains all payment relevant parameters.

Copyright 201, Avaloq Evolution AG Page 354 of 424


AFP Interface Specification

The full name


com.avaloq.afs.server.bsp.ws.to.payment.position.impl.BasePaymentTO

See also
- InternalPaymentTO
- BalanceManagerPaymentTO
- InternationalPaymentTO
- InternationalPaymentInstructionTO
- SepaPaymentTO
- DomesticPaymentTO
- SwissOrangePaymentSlipTO
- SwissRedPaymentSlipTO
- SwissPaymentInstructionTO
Parameters
amount
Type java.math.BigDecimal
Description The amount of the payment. Only not mandatory in the error file upload case.
Mandatory no
Example 120.25
currencyId
Type java.lang.Long
Description The internal reference of the currency object. Only not mandatory in the error file upload
case.
Mandatory no
debitMoneyAccountId
Type java.lang.Long
Description The internal reference of the debit money account. Only not mandatory in the error file
upload case.
Mandatory no
debitReference
Type java.lang.String
Description This text is shown in the booking after the execution of the payment.
Mandatory no
max Length 200
Example Steuern 2012
adviceOption
Type AdviceOptionType
Description The advice option of the payment.
Mandatory no
paymentType
Type PaymentType
Description The type of the payment.
Mandatory yes
advices
Type java.util.List [java.lang.Long]
Description The list of advice ids.
Mandatory yes
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 355 of 424


AFP Interface Specification

2.29.10 InternationalPaymentInstructionTO
Representation of an international payment instruction implementation.
Used for com.avaloq.afs.server.bsp.ws.to.payment.PaymentOrderTO and
com.avaloq.afs.server.bsp.ws.to.payment.StandingOrderTO.
The full name
com.avaloq.afs.server.bsp.ws.to.payment.position.impl.InternationalPaymentInstructionTO
Parameters
beneficiary1
Type java.lang.String
Description The line of the beneficiary address.
Mandatory no
max Length 35
Example Hans Muster
beneficiaryIban
Type java.lang.String
Description The IBAN of the beneficiary account.
Either the beneficiaryIban or the beneficiaryAccountNo has to be not null.
Mandatory no
max Length 38
Example DE99 2032 0500 4989 1234 56
beneficiaryBank1
Type java.lang.String
Description The line of the bank beneficiary address.
Mandatory no
max Length 35
Example Bank of Switzerland
paymentReason
Type java.lang.String
Description The payment reason.
Mandatory no
Example Payment to the WWF
chargeOption
Type ChargeOptionType
Description The charge option.
Mandatory no
paymentPriority
Type PaymentPriority
Description The payment priority. Can be normal or urgent.
Mandatory no
form
Type InternationalPaymentInstructionFormType
Description The IPI Form.
Mandatory no
bic
Type java.lang.String
Description The BIC number of the beneficiary bank.
Mandatory no
max Length 11
Example HYVEDEMMXXX
ntnl
Type java.lang.String
Description The national number of the beneficiary bank.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 356 of 424


AFP Interface Specification

Parameters
max Length 10
Example 00729
salary
Type java.lang.Boolean
Description If this payment is a salary payment.
Mandatory no
postitText
Type java.lang.String
Description The postit text.
Mandatory no
max Length 4000
Example Payment to the WWF for the Fun Run on 20/08/2013
amount
Type java.math.BigDecimal
Description The amount of the payment. Only not mandatory in the error file upload case.
Mandatory no
Example 120.25
currencyId
Type java.lang.Long
Description The internal reference of the currency object. Only not mandatory in the error file upload
case.
Mandatory no
debitMoneyAccountId
Type java.lang.Long
Description The internal reference of the debit money account. Only not mandatory in the error file
upload case.
Mandatory no
debitReference
Type java.lang.String
Description This text is shown in the booking after the execution of the payment.
Mandatory no
max Length 200
Example Steuern 2012
adviceOption
Type AdviceOptionType
Description The advice option of the payment.
Mandatory no
paymentType
Type PaymentType
Description The type of the payment.
Mandatory yes
advices
Type java.util.List [java.lang.Long]
Description The list of advice ids.
Mandatory yes
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 357 of 424


AFP Interface Specification

2.30 com.avaloq.afs.server.bsp.ws.to.performance
2.30.0 PerformanceListOutputTO
Performance list.

The full name


com.avaloq.afs.server.bsp.ws.to.performance.PerformanceListOutputTO
Parameters
performanceList
Type java.util.List [PerformanceTO]
Description List of performance items.
Mandatory yes
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.30.1 PerformanceQueryTO
This class represents the main booking query.

The full name


com.avaloq.afs.server.bsp.ws.to.performance.PerformanceQueryTO
Parameters
businessObjectIds
Type java.util.List [java.lang.Long]
Description Business object ids to get the performance figures for.
Mandatory yes
period
Type PerformancePeriod
Description The performance period.
Mandatory yes

2.30.2 PerformanceTO
Performance TO.

The full name


com.avaloq.afs.server.bsp.ws.to.performance.PerformanceTO
Parameters
businessObjectId
Type java.lang.Long
Description The business object id.
Mandatory yes
rateOfReturn
Type java.math.BigDecimal
Description The rate of return.
Mandatory yes
startOfPeriod
Type java.util.Date
Description The start of period for performance figures.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 358 of 424


AFP Interface Specification

Parameters
startOfPeriodValueInReferenceCurrency
Type java.math.BigDecimal
Description The start of period business object value in the reference currency.
Mandatory yes
endOfPeriod
Type java.util.Date
Description The end of period for performance figures.
Mandatory yes
endOfPeriodValueInReferenceCurrency
Type java.math.BigDecimal
Description The end of period business object value in the reference currency.
Mandatory yes
referenceCurrencyId
Type java.lang.Long
Description The reference currency id of the performance figure.
Mandatory yes
netCashFlow
Type java.math.BigDecimal
Description The Net Cash Flow.
Mandatory yes
netCashFlowType
Type java.lang.String
Description The Net Cash Flow Type.
Mandatory yes

2.30.3 HistoricalPerformanceQueryTO
This class represents the historical performance query.

The full name


com.avaloq.afs.server.bsp.ws.to.performance.HistoricalPerformanceQueryTO
Parameters
businessObjectIds
Type java.util.List [java.lang.Long]
Description Business object ids to get the performance figures for.
Mandatory yes
period
Type HistoricalPerformancePeriod
Description The historical performance period.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 359 of 424


AFP Interface Specification

2.31 com.avaloq.afs.server.bsp.ws.to.position
2.31.0 PositionPaymentRightsTO
Transfer object representing a position.

The full name


com.avaloq.afs.server.bsp.ws.to.position.PositionPaymentRightsTO
Parameters
transferableFrom
Type java.lang.Boolean
Description Whether the user has the right to transfer from.
Mandatory no
transferableTo
Type java.lang.Boolean
Description Whether the user has the right to transfer to.
Mandatory no
payable
Type java.lang.Boolean
Description Whether the user has the right to create new payments.
Mandatory no
showPendingPayments
Type java.lang.Boolean
Description Whether the user has the right to show pending payments.
Mandatory no
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.31.1 PositionQueryTO
Position query object. All parameters are optional. All conditions defined in this query are connected using AND operator.

The full name


com.avaloq.afs.server.bsp.ws.to.position.PositionQueryTO
Parameters
positionIdList
Type java.util.List [java.lang.Long]
Description List of position IDs.
Mandatory no
positionTypeList
Type java.util.List [PositionType]
Description List of position types.
Mandatory no
portfolioIdList
Type java.util.List [java.lang.Long]
Description List of portfolio IDs.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 360 of 424


AFP Interface Specification

Parameters
assetIdList
Type java.util.List [java.lang.Long]
Description List of asset IDs.
Mandatory no
ipsIdList
Type java.util.List [java.lang.Long]
Description List of IPS IDs.
Mandatory no
businessPartnerIdList
Type java.util.List [java.lang.Long]
Description List of business partner IDs.
Mandatory no
assetAllocationNodeIds
Type java.util.List [java.lang.Long]
Description List of IDs corresponding to asset allocation nodes.
Mandatory no
includeClosedPositions
Type boolean
Description Whether to include or not all positions(open and closed)
Mandatory yes
withoutMaturityDate
Type java.lang.Boolean
Description Restrict to assets that don't have a maturity date.
Mandatory no
nominalCurrencyIdsWhitelist
Type java.util.List [java.lang.Long]
Description Restrict on assets that have nominal currency specified in this list.
Mandatory no
nominalCurrencyIdsBlacklist
Type java.util.List [java.lang.Long]
Description Exclude assets that have nominal currency specified in this list.
Mandatory no
maturityDateFrom
Type java.util.Date
Description The maturity date from, to filter by maturity date
Mandatory no
maturityDateTo
Type java.util.Date
Description The maturity date to, to filter by maturity date
Mandatory no
quantityType
Type PositionQuantityType
Description type of position quantity (e.g. negative)
Mandatory no

2.31.2 PositionTO
Transfer object representing a position.

The full name


com.avaloq.afs.server.bsp.ws.to.position.PositionTO
Parameters

Copyright 201, Avaloq Evolution AG Page 361 of 424


AFP Interface Specification

Parameters
name
Type java.lang.String
Description The position name.
Mandatory no
max Length 200
nameLong
Type java.lang.String
Description The long position name.
Mandatory no
max Length 200
type
Type PositionType
Description The position type.
Mandatory no
assetId
Type java.lang.Long
Description The asset id.
Mandatory yes
portfolioId
Type java.lang.Long
Description The portfolio ID.
Mandatory no
ipsIdList
Type java.util.List [java.lang.Long]
Description The list of IPS IDs.
Mandatory no
businessPartnerId
Type java.lang.Long
Description The business partner ID.
Mandatory no
reportingCurrencyId
Type java.lang.Long
Description The reporting currency ID.
Mandatory no
referenceCurrencyId
Type java.lang.Long
Description The reference currency ID.
Mandatory no
positionCurrencyId
Type java.lang.Long
Description The position currency ID.
Mandatory no
availableAmount
Type java.math.BigDecimal
Description Available amount. Applicable for money accounts only.
Mandatory no
currentPriceCurrencyId
Type java.lang.Long
Description The position price currency
Mandatory no
quantity
Type java.math.BigDecimal
Description /** The quantity.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 362 of 424


AFP Interface Specification

Parameters
quantityInReportingCurrency
Type java.math.BigDecimal
Description The quantity of the position in the reporting currency.
Mandatory no
iban
Type java.lang.String
Description The IBAN if the position is a money account.
Mandatory no
max Length 200
rubric
Type java.lang.String
Description The rubric if the position is a money account.
Mandatory no
max Length 80
costPrice
Type java.math.BigDecimal
Description The cost price in the position currency.
Mandatory no
currentPrice
Type java.math.BigDecimal
Description The current price in the position currency.
Mandatory no
costPriceExchangeRateFormatted
Type java.lang.String
Description The weighted exchange rate (for all transactions) between the position currency and the
reference currency.
Mandatory no
currentExchangeRateFormatted
Type java.lang.String
Description The exchange rate between the position currency and the reference currency.
Mandatory no
percentageInPortfolioValue
Type java.math.BigDecimal
Description The percentage of the position's current value in reference currency reported to the
portfolio's current value.
Mandatory no
currentValueInPositionCurrency
Type java.math.BigDecimal
Description The current value of the position in its position currency.
Mandatory no
currentValueInReportingCurrency
Type java.math.BigDecimal
Description The current value of the position in its reporting currency.
Mandatory no
currentValueInReferenceCurrency
Type java.math.BigDecimal
Description The current value of the position in its reference currency.
Mandatory no
accruedInterestInPositionCurrency
Type java.math.BigDecimal
Description The accrued interest in the position currency.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 363 of 424


AFP Interface Specification

Parameters
accruedInterestInReportingCurrency
Type java.math.BigDecimal
Description The accrued interest in the reporting currency.
Mandatory no
accruedInterestInReferenceCurrency
Type java.math.BigDecimal
Description The accrued interest in the reference currency.
Mandatory no
currentPriceDate
Type java.util.Date
Description Current price date.
Mandatory no
tradable
Type java.lang.Boolean
Description Whether the user has the right to trade it.
Mandatory no
hasDocumentsLinked
Type java.lang.Boolean
Description Whether position has at least one document linked.
Mandatory no
objectExtension
Type ObjectExtensionTO
Description The object extension.
Mandatory yes
yieldToMaturity
Type java.math.BigDecimal
Description Yield to maturity.
Mandatory no
yieldToMaturityPct
Type java.math.BigDecimal
Description Yield to maturity in percentage.
Mandatory no
bookValueInPositionCurrency
Type java.math.BigDecimal
Description Book value in position's risk currency.
Mandatory no
bookValueInReferenceCurrency
Type java.math.BigDecimal
Description Book value in position's reference currency.
Mandatory no
duration
Type java.math.BigDecimal
Description Duration.
Mandatory no
accountNumber
Type java.lang.String
Description Account number for positions of type Money Account.
Mandatory no
max Length 35
unrealizedProfitMarket
Type java.math.BigDecimal
Description Unrealized profit market.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 364 of 424


AFP Interface Specification

Parameters
unrealizedProfitMarketPct
Type java.math.BigDecimal
Description Unrealized profit market in percent.
Mandatory no
unrealizedProfitTotal
Type java.math.BigDecimal
Description Unrealized profit total.
Mandatory no
unrealizedProfitTotalPct
Type java.math.BigDecimal
Description Unrealized profit total in percent.
Mandatory no
unrealizedProfitCurrency
Type java.math.BigDecimal
Description Unrealized profit currency.
Mandatory no
unrealizedProfitCurrencyPct
Type java.math.BigDecimal
Description Unrealized profit currency in percent.
Mandatory no
unrealizedProfitMarketPortfolioCurrency
Type java.math.BigDecimal
Description Unrealized profit market in portfolio currency.
Mandatory no
bookValueYTDInPositionCurrency
Type java.math.BigDecimal
Description Book value YTD in position's risk currency.
Mandatory no
bookValueYTDInReferenceCurrency
Type java.math.BigDecimal
Description Book value YTD in position's reference currency.
Mandatory no
unrealizedYTDProfitMarket
Type java.math.BigDecimal
Description Unrealized YTD profit market.
Mandatory no
unrealizedYTDProfitMarketPct
Type java.math.BigDecimal
Description Unrealized YTD profit market in percent.
Mandatory no
unrealizedYTDProfitCurrency
Type java.math.BigDecimal
Description Unrealized YTD profit currency.
Mandatory no
unrealizedYTDProfitCurrencyPct
Type java.math.BigDecimal
Description Unrealized YTD profit currency in percent.
Mandatory no
unrealizedYTDProfitMarketPortfolioCurrency
Type java.math.BigDecimal
Description Unrealized YTD profit market in portfolio currency.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 365 of 424


AFP Interface Specification

Parameters
unrealizedYTDProfitTotal
Type java.math.BigDecimal
Description Unrealized YTD profit total
Mandatory no
unrealizedYTDProfitTotalPct
Type java.math.BigDecimal
Description Unrealized YTD profit total percent
Mandatory no
modifiedDuration
Type java.math.BigDecimal
Description Duration.
Mandatory no
positionPaymentRights
Type PositionPaymentRightsTO
Description Whether the user has rights related to payments.
Mandatory no
priceChange
Type java.math.BigDecimal
Description Price change. currentPrice - costPrice
Mandatory no
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.31.3 PositionListOutputTO
Position list output object.

The full name


com.avaloq.afs.server.bsp.ws.to.position.PositionListOutputTO
Parameters
resultList
Type java.util.List [PositionTO]
Description The list of positions.
Mandatory yes
pagingResult
Type PagingResultTO
Description The paging result. Only used for paged queries.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 366 of 424


AFP Interface Specification

2.31.4 PositionParametersTO
Position parameters object.

The full name


com.avaloq.afs.server.bsp.ws.to.position.PositionParametersTO
Parameters
reportingCurrencyId
Type java.lang.Long
Description Reference currency ID.
Mandatory no
evaluateWithNearRealtimePrice
Type java.lang.Boolean
Description Evaluate with near realtime price.
Mandatory no
calculateUnrealizedProfit
Type java.lang.Boolean
Description Calculate unrealized profit.
Mandatory no
calculateUnrealizedYTDProfit
Type java.lang.Boolean
Description Calculate unrealized YTD profit.
Mandatory no
calculatePercentageOfPortfolioValue
Type java.lang.Boolean
Description Calculate percentage of the portfolio value.
Mandatory no
includeAccruedInterestInPositionCurrentValues
Type java.lang.Boolean
Description Include the accrued interest in the position values.
Mandatory no
includeIsTradableInfo
Type java.lang.Boolean
Description Include info on whether the user has the rights to trade the position.
Mandatory no
checkHasDocumentsLinked
Type java.lang.Boolean
Description Include information whether the position has Documents linked or not.
Mandatory no
includePaymentInfo
Type java.lang.Boolean
Description Include info on whether the user has the rights related to payment for the position.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 367 of 424


AFP Interface Specification

2.32 com.avaloq.afs.server.bsp.ws.to.sds
2.32.0 StringFieldOutputTO
Sensitive string field. Field contains key and sensitive value

The full name


com.avaloq.afs.server.bsp.ws.to.sds.StringFieldOutputTO
Parameters
sdsKey
Type java.lang.String
Description The sds-key of the field.
Mandatory yes
Example $#$01$#$1234567890123456789
value
Type java.lang.String
Description The value of the field. Depending on context it is pseudonymized or sensitive.
Mandatory yes
Example John Doe
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.32.1 StringListOutputTO
Wrapper class for an {code List<String>} as output transfer object.

The full name


com.avaloq.afs.server.bsp.ws.to.sds.StringListOutputTO
Parameters
stringList
Type java.util.List [java.lang.String]
Description List of strings.
Mandatory yes
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.32.2 SdsDateInputTO
Wrapper class for an {code Date} as input transfer object.

The full name


com.avaloq.afs.server.bsp.ws.to.sds.SdsDateInputTO
Parameters
content
Type java.util.Date
Description wrapped date content.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 368 of 424


AFP Interface Specification

2.32.3 SdsStringOutputTO
Wrapper class for an {code String} as output transfer object.

The full name


com.avaloq.afs.server.bsp.ws.to.sds.SdsStringOutputTO
Parameters
content
Type java.lang.String
Description content of the output {code String} which is wrapped by this class.
Mandatory yes
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.32.4 ValueListInputTO
List of keys to use for resolving sensitive values.

The full name


com.avaloq.afs.server.bsp.ws.to.sds.ValueListInputTO
Parameters
stringValueList
Type java.util.List [java.lang.String]
Description List of string value.
Mandatory yes
textBinaryValueList
Type java.util.List [BinaryTextValueInputTO]
Description List of binary encode text values.
Mandatory yes
dateValueList
Type java.util.List [java.util.Date]
Description List of date values.
Mandatory yes

2.32.5 FieldListOutputTO
List of StringFieldsTO and DateFieldsTO, which can contain keys or values or key/value pairs.

The full name


com.avaloq.afs.server.bsp.ws.to.sds.FieldListOutputTO
Parameters
sdsFieldList
Type java.util.List [SdsFieldOutputTO]
Description List of sds fields
Mandatory no
stringFieldList
Type java.util.List [StringFieldOutputTO]
Description List of string fields
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 369 of 424


AFP Interface Specification

Parameters
binaryTextFieldList
Type java.util.List [SdsBinaryTextFieldOutputTO]
Description List of string fields
Mandatory yes
dateFieldList
Type java.util.List [DateFieldOutputTO]
Description List of date fields
Mandatory yes
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.32.6 SdsStringInputTO
Wrapper class for an {code String} as input transfer object.

The full name


com.avaloq.afs.server.bsp.ws.to.sds.SdsStringInputTO
Parameters
content
Type java.lang.String
Description content of the input {code String} which is wrapped by this class.
Mandatory yes
Example Jone Doe

2.32.7 DateFieldOutputTO
Sensitive date field. Field contains key, sensitive value and the format and locale of the date

The full name


com.avaloq.afs.server.bsp.ws.to.sds.DateFieldOutputTO
Parameters
dateValue
Type java.util.Date
Description The value as date
Mandatory no
format
Type java.lang.String
Description The date format.
Mandatory no
Example GGyyyy-MM-dd'T'HH:mm:ss
locale
Type java.lang.String
Description Locale as String
Mandatory no
sdsKey
Type java.lang.String
Description The sds-key of the field.
Mandatory yes
Example $#$01$#$1234567890123456789

Copyright 201, Avaloq Evolution AG Page 370 of 424


AFP Interface Specification

Parameters
value
Type java.lang.String
Description The value of the field. Depending on context it is pseudonymized or sensitive.
Mandatory yes
Example John Doe
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.32.8 SdsInOutFileInputTO
Class to specify in file name and out file name and the character set encoding of those files.

The full name


com.avaloq.afs.server.bsp.ws.to.sds.SdsInOutFileInputTO
Parameters
filenameIn
Type java.lang.String
Description Filename of the file located in the input directory given by the application properties.
Mandatory yes
Example input.txt
charset
Type java.lang.String
Description Valid java charset (the following charsets are supported: UTF-8, ISO-8859-1, ISO-8859-15
or US_ASCII)
Mandatory yes
Example UTF-8
filenameOut
Type java.lang.String
Description Filename of the file which will be written to the output directory given by the application
properties.
Mandatory yes
Example output.txt

2.32.9 SdsParseDateInputTO
Input transfer object to parse a date. The class contains the string which represents the date and the necessary information
(date pattern, locale) to parse the date string.
The full name
com.avaloq.afs.server.bsp.ws.to.sds.SdsParseDateInputTO
Parameters
dateString
Type java.lang.String
Description dateString e.g. "BC0100-11-21T23:42:15"
Mandatory yes
formatString
Type java.lang.String
Description formatString e.g. "GGyyyy-MM-dd'T'HH:mm:ss"
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 371 of 424


AFP Interface Specification

Parameters
localeString
Type java.lang.String
Description locale e.g. "en_US"
Mandatory yes

2.32.10 SdsPersonSelectorInputTO
Input transfer object to select a person.

The full name


com.avaloq.afs.server.bsp.ws.to.sds.SdsPersonSelectorInputTO
Parameters
key
Type java.lang.String
Description Unique object key within scope of specified keyId
Mandatory yes
keyTypeId
Type long
Description Unique Object Key Type Id.
Mandatory yes

2.32.11 BinaryTextValueInputTO
Sensitive string field. Field contains key and sensitive value

The full name


com.avaloq.afs.server.bsp.ws.to.sds.BinaryTextValueInputTO
Parameters
content
Type byte
Description Binary return value.
Mandatory yes
charSet
Type java.lang.String
Description ContentType value.
Mandatory yes
Example UTF-8

2.32.12 SdsDateOutputTO
Wrapper class for an {code Date} as output transfer object.

The full name


com.avaloq.afs.server.bsp.ws.to.sds.SdsDateOutputTO
Parameters
content
Type java.util.Date
Description wrapped date content.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 372 of 424


AFP Interface Specification

Parameters
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.32.13 SdsBinaryTextFieldOutputTO
Sensitive string field. Field contains key and sensitive value

The full name


com.avaloq.afs.server.bsp.ws.to.sds.SdsBinaryTextFieldOutputTO
Parameters
content
Type byte
Description Binary return value.
Mandatory yes
charSet
Type java.lang.String
Description ContentType value.
Mandatory yes
Example UTF-8
sdsKey
Type java.lang.String
Description The sds-key of the field.
Mandatory yes
Example $#$01$#$1234567890123456789
value
Type java.lang.String
Description The value of the field. Depending on context it is pseudonymized or sensitive.
Mandatory yes
Example John Doe
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.32.14 StringListInputTO
Wrapper class for an {code List<String>} as input transfer object.

The full name


com.avaloq.afs.server.bsp.ws.to.sds.StringListInputTO
Parameters
stringList
Type java.util.List [java.lang.String]
Description List of strings.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 373 of 424


AFP Interface Specification

2.32.15 BinaryTextValueOutputTO
Sensitive string field. Field contains key and sensitive value

The full name


com.avaloq.afs.server.bsp.ws.to.sds.BinaryTextValueOutputTO
Parameters
content
Type byte
Description Binary return value.
Mandatory yes
charSet
Type java.lang.String
Description ContentType value.
Mandatory yes
Example UTF-8
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.32.16 LookupArgumentTO
Lookup filter class.

The full name


com.avaloq.afs.server.bsp.ws.to.sds.LookupArgumentTO
Parameters
businessObjectTypeId
Type long
Description ID of the business object which is looking for.
Mandatory yes
searchArguments
Type java.util.List [LookupFilterAttributeTO]
Description List of search attributes.
Mandatory yes

2.32.17 SdsFieldOutputTO

The full name


com.avaloq.afs.server.bsp.ws.to.sds.SdsFieldOutputTO
Parameters
sdsKey
Type java.lang.String
Description The sds-key of the field.
Mandatory yes
Example $#$01$#$1234567890123456789
value
Type java.lang.String
Description The value of the field. Depending on context it is pseudonymized or sensitive.
Mandatory yes
Example John Doe

Copyright 201, Avaloq Evolution AG Page 374 of 424


AFP Interface Specification

Parameters
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.32.18 KeyListInputTO
List of keys to use for resolving sensitive values.

The full name


com.avaloq.afs.server.bsp.ws.to.sds.KeyListInputTO
Parameters
stringKeyList
Type java.util.List [java.lang.String]
Description List of string keys.
Mandatory yes
dateKeyList
Type java.util.List [java.lang.String]
Description List of date keys.
Mandatory yes

2.32.19 LookupFilterAttributeTO
Search criteria which is used by the sensitive data separation lookupGlobalUniqueIdentifier.

The full name


com.avaloq.afs.server.bsp.ws.to.sds.LookupFilterAttributeTO
Parameters
attributeName
Type java.lang.String
Description Name of the lookup attribute.
Mandatory yes
valueList
Type java.util.List [java.lang.String]
Description Value of the lookup attribute.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 375 of 424


AFP Interface Specification

2.33 com.avaloq.afs.server.bsp.ws.to.serverinfo
2.33.0 AcpAvailabilityOutputTO
ACP availability representation.

The full name


com.avaloq.afs.server.bsp.ws.to.serverinfo.AcpAvailabilityOutputTO
Parameters
acpAvailable
Type java.lang.Boolean
Description
Mandatory yes
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 376 of 424


AFP Interface Specification

2.34 com.avaloq.afs.server.bsp.ws.to.signature
2.34.0 UploadSignatureInputTO
Wraps input of the uploadSignature operation.

The full name


com.avaloq.afs.server.bsp.ws.to.signature.UploadSignatureInputTO
Parameters
fileName
Type java.lang.String
Description the file name
Mandatory yes
contentType
Type java.lang.String
Description the content type
Mandatory yes
content
Type byte
Description the content
Mandatory yes

2.34.1 DeleteSignatureOutputTO
Wraps output of the deleteSignature operation.

The full name


com.avaloq.afs.server.bsp.ws.to.signature.DeleteSignatureOutputTO
Parameters
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.34.2 DownloadSignatureOutputTO
Wraps output of the downloadSignature operation.

The full name


com.avaloq.afs.server.bsp.ws.to.signature.DownloadSignatureOutputTO
Parameters
contentType
Type java.lang.String
Description the content type
Mandatory yes
data
Type byte
Description the data
Mandatory yes
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 377 of 424


AFP Interface Specification

2.34.3 UploadSignatureOutputTO
Wraps output of the uploadSignature operation.

The full name


com.avaloq.afs.server.bsp.ws.to.signature.UploadSignatureOutputTO
Parameters
key
Type java.lang.String
Description the key of the signature just uploaded
Mandatory yes
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.34.4 DownloadSignatureInputTO
Wraps input of the downloadSignature operation.

The full name


com.avaloq.afs.server.bsp.ws.to.signature.DownloadSignatureInputTO
Parameters
key
Type java.lang.String
Description the key of the signature to be downloaded
Mandatory yes

2.34.5 DeleteSignatureInputTO
Wraps input of the deleteSignature operation.

The full name


com.avaloq.afs.server.bsp.ws.to.signature.DeleteSignatureInputTO
Parameters
key
Type java.lang.String
Description the key of the signature to be deleted
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 378 of 424


AFP Interface Specification

2.35 com.avaloq.afs.server.bsp.ws.to.trading
2.35.0 OrderCostTO
Representation of the order cost details.

The full name


com.avaloq.afs.server.bsp.ws.to.trading.OrderCostTO
Parameters
bookKindId
Type java.lang.Long
Description The book kind id
Mandatory yes
amount
Type java.math.BigDecimal
Description The amount
Mandatory yes
calculatedAmount
Type java.math.BigDecimal
Description The calculated amount
Mandatory yes
rate
Type java.math.BigDecimal
Description The rate
Mandatory yes
vat
Type java.math.BigDecimal
Description The value added tax
Mandatory yes
costChargeTypeId
Type java.lang.Long
Description The charge type id
Mandatory yes
costQuantityTypeId
Type java.lang.Long
Description The cost quantity type id
Mandatory yes
overrideValue
Type java.math.BigDecimal
Description The override value
Mandatory yes
overrideTypeId
Type java.lang.Long
Description The override type id
Mandatory yes
overrideMinMax
Type java.lang.Boolean
Description The override min max
Mandatory yes
overridePossible
Type java.lang.Boolean
Description The override possible flag
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 379 of 424


AFP Interface Specification

Parameters
overrideTypePossible
Type java.lang.Boolean
Description The override type possible flag
Mandatory yes

2.35.1 BilledSingleTradingOrderTO
Order object to represent an executed and billed order.

The full name


com.avaloq.afs.server.bsp.ws.to.trading.BilledSingleTradingOrderTO
Parameters
orderCore
Type TradingOrderCoreTO
Description the order base.
Mandatory yes
transaction
Type TradingTransactionTO
Description the order transaction.
Mandatory yes
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.35.2 TradingOrderCoreTO
Base order object containing all the common fields for single and collective orders.

The full name


com.avaloq.afs.server.bsp.ws.to.trading.TradingOrderCoreTO
Parameters
asset
Type SimpleBusinessObjectTO
Description
Mandatory yes
executionType
Type SimpleCodeTO
Description
Mandatory yes
expiryDate
Type java.util.Date
Description
Mandatory yes
investmentMethod
Type SimpleCodeTO
Description
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 380 of 424


AFP Interface Specification

Parameters
limitPrice
Type java.math.BigDecimal
Description
Mandatory yes
market
Type SimpleBusinessObjectTO
Description
Mandatory yes
orderTypeGroup
Type SimpleCodeTO
Description
Mandatory yes
tradeCurrency
Type SimpleBusinessObjectTO
Description
Mandatory yes
triggerPrice
Type java.math.BigDecimal
Description
Mandatory yes
validityConstraint
Type SimpleCodeTO
Description
Mandatory yes
calculatedOrderCore
Type CalculatedTradingOrderCoreTO
Description
Mandatory yes
autoMarket
Type boolean
Description
Mandatory yes
alreadyTraded
Type boolean
Description
Mandatory yes

2.35.3 TradingOrderOverviewItemListOutputTO
Output transfer object containing a list of TradingOrderOverviewItemTO objects.

The full name


com.avaloq.afs.server.bsp.ws.to.trading.TradingOrderOverviewItemListOutputTO
Parameters
tradingOrderOverviewItems
Type java.util.List [TradingOrderOverviewItemTO]
Description
Mandatory yes
pagingResult
Type PagingResultTO
Description The paging result. Only used for paged queries.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 381 of 424


AFP Interface Specification

Parameters
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.35.4 TradingOrderQueryTO
Transfer object representing a query for trading orders.

The full name


com.avaloq.afs.server.bsp.ws.to.trading.TradingOrderQueryTO
Parameters
portfolioAccessIdList
Type java.util.List [java.lang.Long]
Description
Mandatory yes
businessPartnerAccessIdList
Type java.util.List [java.lang.Long]
Description
Mandatory yes
workflowStatusIdList
Type java.util.List [java.lang.Long]
Description
Mandatory yes
absOrderIdList
Type java.util.List [java.lang.Long]
Description
Mandatory yes
assetSearchString
Type java.lang.String
Description
Mandatory no
marketSearchString
Type java.lang.String
Description
Mandatory no
transactionDateFrom
Type java.util.Date
Description
Mandatory no
transactionDateTo
Type java.util.Date
Description
Mandatory no
valueDateFrom
Type java.util.Date
Description
Mandatory no
valueDateTo
Type java.util.Date
Description
Mandatory no

Copyright 201, Avaloq Evolution AG Page 382 of 424


AFP Interface Specification

Parameters
expiryDateFrom
Type java.util.Date
Description Expiry date from.
Mandatory no
expiryDateTo
Type java.util.Date
Description
Mandatory no
orderDateFrom
Type java.util.Date
Description
Mandatory no
orderDateTo
Type java.util.Date
Description
Mandatory no
numberOfPreviousDays
Type java.lang.Integer
Description
Mandatory no
linkGroup
Type java.lang.Long
Description
Mandatory no
sortedBy
Type java.util.List [QuerySortTO]
Description
Mandatory no
paging
Type PagingTO
Description The paging context
Mandatory no

2.35.5 CalculatedTradingOrderCoreTO
Order core object containing all the calculated transaction fields for single and collective orders.

The full name


com.avaloq.afs.server.bsp.ws.to.trading.CalculatedTradingOrderCoreTO
Parameters
marketTradeCurrency
Type SimpleBusinessObjectTO
Description The market trade currency id
Mandatory yes
documentId
Type java.lang.Long
Description The document id.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 383 of 424


AFP Interface Specification

2.35.6 OrderTransitionTO
Representation of a order transition.

The full name


com.avaloq.afs.server.bsp.ws.to.trading.OrderTransitionTO
Parameters
newWorkflowStatus
Type SimpleCodeTO
Description The new workflow status id
Mandatory yes
secUserId
Type java.lang.Long
Description The sec user id
Mandatory yes
sequenceNumber
Type java.math.BigDecimal
Description The sequence number
Mandatory yes
timeStamp
Type java.util.Date
Description The time stamp
Mandatory yes

2.35.7 CalculatedTradingTransactionTO
Order transaction object containing all the calculated transaction fields for single and collective orders.

The full name


com.avaloq.afs.server.bsp.ws.to.trading.CalculatedTradingTransactionTO
Parameters
absOrderId
Type java.lang.Long
Description ABS order ID
Mandatory yes
orderType
Type SimpleCodeTO
Description Order type
Mandatory yes
linkGroup
Type java.lang.Long
Description Link group
Mandatory yes
discardReason
Type SimpleCodeTO
Description Discard reason id
Mandatory yes
orderDate
Type java.util.Date
Description order date
Mandatory yes
transactionDate
Type java.util.Date
Description transaction date
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 384 of 424


AFP Interface Specification

Parameters
workflowStatus
Type SimpleCodeTO
Description work flow status id
Mandatory yes
executedQuantity
Type java.math.BigDecimal
Description Executed quanity
Mandatory yes
originalQuantity
Type java.math.BigDecimal
Description Original quantity
Mandatory yes
calculationMethod
Type SimpleCodeTO
Description Calculation method id
Mandatory yes
executionTime
Type java.util.Date
Description Execution time
Mandatory yes
averagePrice
Type java.math.BigDecimal
Description Average price
Mandatory yes
clientPrice
Type java.math.BigDecimal
Description Client price
Mandatory yes
estimatedPrice
Type java.math.BigDecimal
Description Estimate price
Mandatory yes
accruedInterest
Type java.math.BigDecimal
Description Accrued interest
Mandatory yes
accruedInterestInMarketTradeCurrency
Type java.math.BigDecimal
Description Accrued interest in market trade currency
Mandatory yes
contractValue
Type java.math.BigDecimal
Description Contract value
Mandatory yes
gross
Type java.math.BigDecimal
Description Gross
Mandatory yes
grossInMarketTradeCurrency
Type java.math.BigDecimal
Description Gross in market trade currency
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 385 of 424


AFP Interface Specification

Parameters
interestDays
Type java.math.BigDecimal
Description Interest days
Mandatory yes
net
Type java.math.BigDecimal
Description Net
Mandatory yes
netInMoneyAccountCurrency
Type java.math.BigDecimal
Description Net in money account currency
Mandatory yes
tradeToMoneyAccountExchangeRate
Type java.math.BigDecimal
Description Exchange rate
Mandatory yes
marketToTradeExchangeRate
Type java.math.BigDecimal
Description Market exchange rate
Mandatory yes
costOverride
Type SimpleCodeTO
Description Cost override
Mandatory yes
mainCosts
Type java.math.BigDecimal
Description Main costs
Mandatory yes
marketRejectReason
Type java.lang.String
Description
Mandatory yes
tradeInformationItems
Type java.util.List [TradingOrderTradeTO]
Description Trade information list
Mandatory yes
costItems
Type java.util.List [OrderCostTO]
Description Cost item list
Mandatory yes
transitions
Type java.util.List [OrderTransitionTO]
Description Trans item list
Mandatory yes
postItItems
Type java.util.List [OrderPostItTO]
Description Post it list
Mandatory yes
valueDate
Type java.util.Date
Description Value date
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 386 of 424


AFP Interface Specification

2.35.8 SingleTradingOrderTO
Order object containing all the fields for single orders.

The full name


com.avaloq.afs.server.bsp.ws.to.trading.SingleTradingOrderTO
Parameters
openQuantity
Type java.math.BigDecimal
Description The numeric quantity value.
Mandatory yes
billedOrders
Type java.util.List [BilledSingleTradingOrderTO]
Description the billed orders.
Mandatory yes
orderCore
Type TradingOrderCoreTO
Description the order base.
Mandatory yes
transaction
Type TradingTransactionTO
Description the order transaction.
Mandatory yes
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.35.9 TradingOrderOverviewItemTO
Transfer object representing an item in the trading order overview.

The full name


com.avaloq.afs.server.bsp.ws.to.trading.TradingOrderOverviewItemTO
Parameters
id
Type java.lang.Long
Description
Mandatory yes
absOrderId
Type java.lang.Long
Description
Mandatory yes
linkGroup
Type java.lang.Long
Description
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 387 of 424


AFP Interface Specification

Parameters
orderDate
Type java.util.Date
Description
Mandatory yes
transactionDate
Type java.util.Date
Description
Mandatory yes
valueDate
Type java.util.Date
Description
Mandatory yes
expireDate
Type java.util.Date
Description
Mandatory yes
executionTime
Type java.util.Date
Description
Mandatory yes
dateAltered
Type java.util.Date
Description
Mandatory yes
quantity
Type java.math.BigDecimal
Description
Mandatory yes
limitPrice
Type java.math.BigDecimal
Description
Mandatory yes
triggerPrice
Type java.math.BigDecimal
Description
Mandatory yes
executedQuantity
Type java.math.BigDecimal
Description
Mandatory yes
executionPrice
Type java.math.BigDecimal
Description
Mandatory yes
priceUnit
Type java.lang.String
Description
Mandatory yes
lastTransition
Type java.util.Date
Description
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 388 of 424


AFP Interface Specification

Parameters
documentId
Type java.lang.Long
Description
Mandatory yes
rejectReason
Type java.lang.String
Description
Mandatory yes
orderTypeGroup
Type SimpleCodeTO
Description
Mandatory yes
executionType
Type SimpleCodeTO
Description
Mandatory yes
discardReason
Type SimpleCodeTO
Description
Mandatory yes
workflowStatus
Type SimpleCodeTO
Description
Mandatory yes
possibleWorkflowActions
Type java.util.List [SimpleCodeTO]
Description
Mandatory yes
businessPartner
Type SimpleBusinessObjectTO
Description
Mandatory yes
container
Type SimpleBusinessObjectTO
Description
Mandatory yes
moneyAccount
Type SimpleBusinessObjectTO
Description
Mandatory yes
asset
Type SimpleBusinessObjectTO
Description
Mandatory yes
market
Type SimpleBusinessObjectTO
Description
Mandatory yes
tradeCurrency
Type SimpleBusinessObjectTO
Description
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 389 of 424


AFP Interface Specification

Parameters
positionId
Type java.lang.Long
Description
Mandatory yes

2.35.10 SingleTradingOrderDetailsOutputTO
Output transfer object for single trading order details containing the SingleTradingOrderTO object and the list of
SimpleCodeTO representing the possible workflow actions.

The full name


com.avaloq.afs.server.bsp.ws.to.trading.SingleTradingOrderDetailsOutputTO
Parameters
tradingOrder
Type SingleTradingOrderTO
Description
Mandatory yes
possibleWorkflowActions
Type java.util.List [SimpleCodeTO]
Description
Mandatory yes
transactionSigningRequest
Type TransactionSigningRequestTO
Description A signing request for this transaction.
If a user approve a transaction but have to sign it first. In this case the other transaction
specific parameters are null.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.35.11 TradingOrderTradeTO
Trade information for the trading order.

The full name


com.avaloq.afs.server.bsp.ws.to.trading.TradingOrderTradeTO
Parameters
tradeOrderId
Type java.lang.Long
Description The trading order id
Mandatory yes
executionTime
Type java.util.Date
Description Execution time
Mandatory yes
market
Type SimpleBusinessObjectTO
Description Market id
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 390 of 424


AFP Interface Specification

Parameters
quantity
Type java.math.BigDecimal
Description Quantity
Mandatory yes
price
Type java.math.BigDecimal
Description Price
Mandatory yes
accruedInterest
Type java.math.BigDecimal
Description Accrued interest
Mandatory yes

2.35.12 TradingTransactionTO
Order transaction object containing all the transaction fields for single and collective orders.

The full name


com.avaloq.afs.server.bsp.ws.to.trading.TradingTransactionTO
Parameters
notifications
Type java.util.List [NotificationTO]
Description The notification list.
Mandatory yes
overrides
Type java.util.List [ValidationOverrideTO]
Description The overrides from the validation.
Mandatory yes
calculatedTransaction
Type CalculatedTradingTransactionTO
Description The calculated transaction.
Mandatory yes
id
Type java.lang.Long
Description
Mandatory no
container
Type SimpleBusinessObjectTO
Description
Mandatory yes
moneyAccount
Type SimpleBusinessObjectTO
Description
Mandatory yes
position
Type SimpleBusinessObjectTO
Description
Mandatory yes
enteredQuantityOrAmount
Type java.math.BigDecimal
Description
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 391 of 424


AFP Interface Specification

Parameters
sequenceNumber
Type java.lang.Integer
Description
Mandatory yes
autoMoneyAccount
Type boolean
Description
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 392 of 424


AFP Interface Specification

2.36 com.avaloq.afs.server.bsp.ws.to.user
2.36.0 FunctionalAccessCodeListOutputTO
TO wrapping a list of functional access codes.

The full name


com.avaloq.afs.server.bsp.ws.to.user.FunctionalAccessCodeListOutputTO
Parameters
resultList
Type java.util.List [FunctionalAccessCodeTO]
Description The list of functional access codes.
Mandatory yes
pagingResult
Type PagingResultTO
Description The paging result. Only used for paged queries.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.36.1 FunctionalAccessCodeTO
Represents a functional access code giving access to a certain functionality, e.g. to payments.

The full name


com.avaloq.afs.server.bsp.ws.to.user.FunctionalAccessCodeTO
Parameters
codeAccessIntlId
Type java.lang.String
Description The internal id of the function access code
Mandatory yes
max Length 240
Example afs_pay_trx

2.36.2 UserOutputTO
A response object which holds a user.

The full name


com.avaloq.afs.server.bsp.ws.to.user.UserOutputTO
Parameters
user
Type UserTO
Description The user.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 393 of 424


AFP Interface Specification

2.36.3 UserTO
A user.

The full name


com.avaloq.afs.server.bsp.ws.to.user.UserTO
Parameters
login
Type java.lang.String
Description The user's login.
Mandatory yes
max Length 30
Example L123456
active
Type boolean
Description Flag indicating if the user is active.
Mandatory yes
name
Type java.lang.String
Description The name of the user.
Mandatory no
max Length 200
Example John Doe
person
Type PersonTO
Description The person behind the user.
Mandatory no
addressList
Type java.util.List [AddressTO]
Description The list of addresses.
Mandatory yes
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.36.4 ContactInformationListOutputTO
TO wrapping a list of contact information (ACP addresses).

The full name


com.avaloq.afs.server.bsp.ws.to.user.ContactInformationListOutputTO
Parameters
resultList
Type java.util.List [ContactInformationTO]
Description
Mandatory yes
pagingResult
Type PagingResultTO
Description The paging result. Only used for paged queries.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 394 of 424


AFP Interface Specification

Parameters
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.36.5 ContactInformationTO
Wraps an ACP address ID and string value.

The full name


com.avaloq.afs.server.bsp.ws.to.user.ContactInformationTO
Parameters
contactInformation
Type java.lang.String
Description
Mandatory yes
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 395 of 424


AFP Interface Specification

2.37 com.avaloq.afs.server.bsp.ws.to.wealth
2.37.0 CurrencyConversionTO
This class represents conversion of original amount to new amount in currency specified.

The full name


com.avaloq.afs.server.bsp.ws.to.wealth.CurrencyConversionTO
Parameters
originalValue
Type java.math.BigDecimal
Description original value to be converted
Mandatory yes
convertedValue
Type java.math.BigDecimal
Description values that was converted
Mandatory yes

2.37.1 PortfolioIdTO
Defines a portfolio id.

The full name


com.avaloq.afs.server.bsp.ws.to.wealth.PortfolioIdTO
Parameters
id
Type java.lang.Long
Description The id.
Mandatory yes
type
Type PortfolioType
Description The type.
Mandatory yes

2.37.2 BusinessOrderListOutputTO
The list of business orders.

The full name


com.avaloq.afs.server.bsp.ws.to.wealth.BusinessOrderListOutputTO
Parameters
resultList
Type java.util.List [BusinessOrderTO]
Description List of business orders.
Mandatory yes
pagingResult
Type PagingResultTO
Description The paging result. Only used for paged queries.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 396 of 424


AFP Interface Specification

2.37.3 EfficientFrontierTO
This class represents an efficient frontier.

The full name


com.avaloq.afs.server.bsp.ws.to.wealth.EfficientFrontierTO
Parameters
name
Type java.lang.String
Description The name of the efficient frontier.
Mandatory yes
max Length 4000
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.37.4 CountryTO
This class represents a base country.

The full name


com.avaloq.afs.server.bsp.ws.to.wealth.CountryTO
Parameters
isoCode
Type java.lang.String
Description The isoCode of the currency.
Mandatory no
max Length 200
name
Type java.lang.String
Description The name of the currency.
Mandatory yes
max Length 4000
tech
Type boolean
Description If the country is just technical.
Mandatory yes
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 397 of 424


AFP Interface Specification

2.37.5 ModelPortfolioTO
This class represents a model portfolio.

The full name


com.avaloq.afs.server.bsp.ws.to.wealth.ModelPortfolioTO
Parameters
name
Type java.lang.String
Description The name of the model portfolio.
Mandatory yes
max Length 4000
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.37.6 InvestmentPolicyStatementOrderListOutputTO
The list of investment policy statement orders.

The full name


com.avaloq.afs.server.bsp.ws.to.wealth.InvestmentPolicyStatementOrderListOutputTO
Parameters
resultList
Type java.util.List [InvestmentPolicyStatementOrderTO]
Description List of investment policy statement orders.
Mandatory yes
pagingResult
Type PagingResultTO
Description The paging result. Only used for paged queries.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.37.7 CurrencyConversionOutputTO
This class represents response containing currency conversion for specified values.

The full name


com.avaloq.afs.server.bsp.ws.to.wealth.CurrencyConversionOutputTO
Parameters
currencyFrom
Type CurrencyTO
Description Currency from which conversion occurred.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 398 of 424


AFP Interface Specification

Parameters
currencyTo
Type CurrencyTO
Description Currency to which conversion occurred.
Mandatory yes
convertedValuesList
Type java.util.List [CurrencyConversionTO]
Description List of CurrencyConversionTO.
Mandatory yes
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.37.8 RestrictionListOutputTO
The list of restrictions.

The full name


com.avaloq.afs.server.bsp.ws.to.wealth.RestrictionListOutputTO
Parameters
resultList
Type java.util.List [RestrictionTO]
Description The list of restrictions.
Mandatory yes
pagingResult
Type PagingResultTO
Description The paging result. Only used for paged queries.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.37.9 EfficientFrontierListOutputTO
The list of EfficientFrontiers.

The full name


com.avaloq.afs.server.bsp.ws.to.wealth.EfficientFrontierListOutputTO
Parameters
resultList
Type java.util.List [EfficientFrontierTO]
Description The list of EfficientFrontiers.
Mandatory yes
pagingResult
Type PagingResultTO
Description The paging result. Only used for paged queries.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 399 of 424


AFP Interface Specification

2.37.10 PersonTO
This class represents a person.

The full name


com.avaloq.afs.server.bsp.ws.to.wealth.PersonTO
Parameters
fullName
Type java.lang.String
Description The full name.
Mandatory no
max Length 255
Example John Doe
title
Type java.lang.String
Description The title.
Mandatory no
max Length 40
Example Miss
firstName
Type java.lang.String
Description The first name.
Mandatory no
max Length 80
Example John
lastName
Type java.lang.String
Description The last name.
Mandatory no
max Length 80
Example Doe
numericSort
Type java.lang.String
Description The person numeric sort (ABS).
Mandatory no
sortAlpha
Type java.lang.String
Description The person sort alpha (ABS).
Mandatory no
max Length 50
personType
Type java.lang.String
Description The person type.
Mandatory no
max Length 40
gender
Type java.lang.String
Description The gender.
Mandatory no
max Length 240
birthDate
Type java.util.Date
Description The birth date.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 400 of 424


AFP Interface Specification

Parameters
domicileAddress
Type AddressTO
Description The domicile address.
Mandatory no
objectExtension
Type ObjectExtensionTO
Description The object extension.
Mandatory yes
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.37.11 IpsTO
This class represent a base country.

The full name


com.avaloq.afs.server.bsp.ws.to.wealth.IpsTO
Parameters
name
Type java.lang.String
Description The name of currency.
Mandatory no
max Length 4000
refCurrency
Type java.lang.Long
Description The position currency id.
Mandatory yes
currentValue
Type java.math.BigDecimal
Description Current value of the IPS.
Mandatory no
accruedInterest
Type java.math.BigDecimal
Description The accrued interest.
Mandatory no
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 401 of 424


AFP Interface Specification

2.37.12 MoneyAccountListOutputTO
The list of base money accounts.

The full name


com.avaloq.afs.server.bsp.ws.to.wealth.MoneyAccountListOutputTO
Parameters
resultList
Type java.util.List [MoneyAccountTO]
Description The list of base money accounts.
Mandatory yes
pagingResult
Type PagingResultTO
Description The paging result. Only used for paged queries.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.37.13 BusinessOrderTO
This class represents a business order.

The full name


com.avaloq.afs.server.bsp.ws.to.wealth.BusinessOrderTO
Parameters
businessType
Type BusinessTypeCodeEnum
Description The business type of the business order.
Mandatory yes
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.37.14 OrganisationalEntityListOutputTO
The list of organisational entities.

The full name


com.avaloq.afs.server.bsp.ws.to.wealth.OrganisationalEntityListOutputTO
Parameters
resultList
Type java.util.List [OrganisationalEntityTO]
Description The list of organisational entities.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 402 of 424


AFP Interface Specification

Parameters
pagingResult
Type PagingResultTO
Description The paging result. Only used for paged queries.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.37.15 InvestmentPropositionOrderListOutputTO
The list of investment proposition orders.

The full name


com.avaloq.afs.server.bsp.ws.to.wealth.InvestmentPropositionOrderListOutputTO
Parameters
resultList
Type java.util.List [InvestmentPropositionOrderTO]
Description List of business orders.
Mandatory yes
pagingResult
Type PagingResultTO
Description The paging result. Only used for paged queries.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.37.16 CountryListOutputTO
The list of countries.

The full name


com.avaloq.afs.server.bsp.ws.to.wealth.CountryListOutputTO
Parameters
resultList
Type java.util.List [CountryTO]
Description The list of countries.
Mandatory yes
pagingResult
Type PagingResultTO
Description The paging result. Only used for paged queries.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 403 of 424


AFP Interface Specification

2.37.17 IpsListOutputTO
The list of IPSs.

The full name


com.avaloq.afs.server.bsp.ws.to.wealth.IpsListOutputTO
Parameters
totalValueWithAccruedInterest
Type java.math.BigDecimal
Description The total value including the accrued interest for the resulting portfolio list.
Mandatory no
totalValueWithoutAccruedInterest
Type java.math.BigDecimal
Description The total value excluding the accrued interest for the resulting portfolio list.
Mandatory no
totalValueCurrencyId
Type java.lang.Long
Description The Id of the currency refering to the total values.
Mandatory no
totalValueDate
Type java.util.Date
Description The Id of the currency refering to the total values.
Mandatory no
resultList
Type java.util.List [IpsTO]
Description The list of IPSs.
Mandatory yes
pagingResult
Type PagingResultTO
Description The paging result. Only used for paged queries.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.37.18 CurrencyListOutputTO
The list of base currencies.

The full name


com.avaloq.afs.server.bsp.ws.to.wealth.CurrencyListOutputTO
Parameters
resultList
Type java.util.List [CurrencyTO]
Description The list of countries.
Mandatory yes
pagingResult
Type PagingResultTO
Description The paging result. Only used for paged queries.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 404 of 424


AFP Interface Specification

2.37.19 AssetAllocationListOutputTO
The list of asset allocations.

The full name


com.avaloq.afs.server.bsp.ws.to.wealth.AssetAllocationListOutputTO
Parameters
resultList
Type java.util.List [AssetAllocationTO]
Description The list of asset allocations.
Mandatory yes
pagingResult
Type PagingResultTO
Description The paging result. Only used for paged queries.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.37.20 AssetAllocationTO
This class represents an asset allocation.

The full name


com.avaloq.afs.server.bsp.ws.to.wealth.AssetAllocationTO
Parameters
name
Type java.lang.String
Description The name of the asset allocation.
Mandatory yes
max Length 4000
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.37.21 BenchmarkListOutputTO
The list of Benchmarks.

The full name


com.avaloq.afs.server.bsp.ws.to.wealth.BenchmarkListOutputTO
Parameters
resultList
Type java.util.List [BenchmarkTO]
Description The list of Benchmarks.
Mandatory yes

Copyright 201, Avaloq Evolution AG Page 405 of 424


AFP Interface Specification

Parameters
pagingResult
Type PagingResultTO
Description The paging result. Only used for paged queries.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.37.22 ModelPortfolioListOutputTO
The list of model portfolios.

The full name


com.avaloq.afs.server.bsp.ws.to.wealth.ModelPortfolioListOutputTO
Parameters
resultList
Type java.util.List [ModelPortfolioTO]
Description The list of model portfolios.
Mandatory yes
pagingResult
Type PagingResultTO
Description The paging result. Only used for paged queries.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.37.23 OrganisationalEntityTO
This class represents an organisational entity.

The full name


com.avaloq.afs.server.bsp.ws.to.wealth.OrganisationalEntityTO
Parameters
name
Type java.lang.String
Description The name of the organisational entity.
Mandatory yes
max Length 4000
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 406 of 424


AFP Interface Specification

2.37.24 CurrencyOutputTO
Output transfer object for the CurrencyTO.

The full name


com.avaloq.afs.server.bsp.ws.to.wealth.CurrencyOutputTO
Parameters
currency
Type CurrencyTO
Description
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.37.25 RestrictionTO
This class represents a restriction.

The full name


com.avaloq.afs.server.bsp.ws.to.wealth.RestrictionTO
Parameters
name
Type java.lang.String
Description The name of the restriction.
Mandatory yes
max Length 4000
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.37.26 InvestmentPolicyStatementOrderTO
This class represents a investment policy statement order.

The full name


com.avaloq.afs.server.bsp.ws.to.wealth.InvestmentPolicyStatementOrderTO
Parameters
name
Type java.lang.String
Description The name of the order.
Mandatory no
investmentPolicyStatementId
Type java.lang.Long
Description The id of the related investment policy statement
Mandatory no

Copyright 201, Avaloq Evolution AG Page 407 of 424


AFP Interface Specification

Parameters
investmentPolicyStatementName
Type java.lang.String
Description The name of the related investment policy statement
Mandatory no
orderDate
Type java.util.Date
Description The order date
Mandatory no
wfcStatus
Type java.lang.Long
Description The workflow status
Mandatory no
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.37.27 CountryOutputTO
Output TO for a country.

The full name


com.avaloq.afs.server.bsp.ws.to.wealth.CountryOutputTO
Parameters
country
Type CountryTO
Description
Mandatory yes
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.37.28 CurrencyTO
This class represents a default currency.

The full name


com.avaloq.afs.server.bsp.ws.to.wealth.CurrencyTO
Parameters
isoCode
Type java.lang.String
Description The isoCode of the currency.
Mandatory no
max Length 200

Copyright 201, Avaloq Evolution AG Page 408 of 424


AFP Interface Specification

Parameters
name
Type java.lang.String
Description The name of the currency.
Mandatory no
max Length 4000
midXrate
Type java.math.BigDecimal
Description The midXrate.
Mandatory no
countryId
Type long
Description The country internal reference.
Mandatory yes
tradeUnit
Type java.math.BigDecimal
Description The minimal payment trade unit.
Mandatory no
cutoff
Type int
Description The cutoff time in minutes. The actual time has to be earlier then the next day from the
valuta date at midnight minus this cutoff. ->DateUtils.addMinutes(getDayAt0000(DateUtils.
addDays(valutaDate, 1)), cutoff)
Mandatory yes
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.37.29 MoneyAccountTO
This class represents a money account.

The full name


com.avaloq.afs.server.bsp.ws.to.wealth.MoneyAccountTO
Parameters
accountNo
Type java.lang.String
Description The account number.
Mandatory yes
max Length 200
accountIban
Type java.lang.String
Description The account iban.
Mandatory yes
max Length 200
accountName
Type java.lang.String
Description The money account name to be displayed.
Mandatory yes
max Length 400

Copyright 201, Avaloq Evolution AG Page 409 of 424


AFP Interface Specification

Parameters
availableAmount
Type java.math.BigDecimal
Description The available amount.
Mandatory yes
amount
Type java.math.BigDecimal
Description The amount (without accruals).
Mandatory yes
currencyId
Type java.lang.Long
Description The currency id.
Mandatory yes
portfolioId
Type java.lang.Long
Description The internal reference of the portfolio. null if no access.
Mandatory no
businessPartnerName
Type java.lang.String
Description The businessPartnerName.
Mandatory no
max Length 200
businessPartnerId
Type java.lang.Long
Description The internal reference of the businessPartner. null if no access.
Mandatory no
alias
Type java.lang.String
Description The account alias given the by user.
Mandatory no
max Length 15
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.37.30 ContainerPortfolioTO
This class represents a base business partner.

The full name


com.avaloq.afs.server.bsp.ws.to.wealth.ContainerPortfolioTO
Parameters
name
Type java.lang.String
Description The name.
Mandatory yes
max Length 200

Copyright 201, Avaloq Evolution AG Page 410 of 424


AFP Interface Specification

Parameters
numericSort
Type java.lang.String
Description The business partner numeric sort (ABS).
Mandatory no
sortAlpha
Type java.lang.String
Description The business partner sort alpha (ABS).
Mandatory no
max Length 50
containerType
Type java.lang.String
Description The container type class.
Mandatory no
max Length 4000
businessPartnerName
Type java.lang.String
Description The business partner name.
Mandatory no
max Length 200
businessPartnerId
Type java.lang.Long
Description The business partner id.
Mandatory no
totalValue
Type java.math.BigDecimal
Description The total value.
Mandatory no
totalCashValue
Type java.math.BigDecimal
Description The total cash value.
Mandatory no
reportingCurrencyId
Type java.lang.Long
Description The reporting currency of total values.
Mandatory no
currencyId
Type long
Description The internal reference of the currency.
Mandatory yes
portfolioId
Type PortfolioIdTO
Description The portfolioId TO.
Mandatory no
objectExtension
Type ObjectExtensionTO
Description The object extension.
Mandatory yes
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 411 of 424


AFP Interface Specification

Parameters
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.37.31 ContainerPortfolioListOutputTO
The list of container portfolios.

The full name


com.avaloq.afs.server.bsp.ws.to.wealth.ContainerPortfolioListOutputTO
Parameters
resultList
Type java.util.List [ContainerPortfolioTO]
Description The list of container portfolios.
Mandatory yes
pagingResult
Type PagingResultTO
Description The paging result. Only used for paged queries.
Mandatory no
notificationList
Type java.util.List [NotificationTO]
Description The list of notifications.
Mandatory yes

2.37.32 BenchmarkTO
This class represents a benchmark.

The full name


com.avaloq.afs.server.bsp.ws.to.wealth.BenchmarkTO
Parameters
name
Type java.lang.String
Description The name of the Benchmark.
Mandatory yes
max Length 4000
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

2.37.33 InvestmentPropositionOrderTO
This class represents a investment proposition order.

The full name


com.avaloq.afs.server.bsp.ws.to.wealth.InvestmentPropositionOrderTO

Copyright 201, Avaloq Evolution AG Page 412 of 424


AFP Interface Specification

Parameters
name
Type java.lang.String
Description The name of the order.
Mandatory no
investmentPolicyStatementId
Type java.lang.Long
Description The id of the related investment policy statement
Mandatory no
investmentPolicyStatementName
Type java.lang.String
Description The name of the related investment policy statement
Mandatory no
containerId
Type java.lang.Long
Description The id of the related container
Mandatory no
containerName
Type java.lang.String
Description The name of the related container
Mandatory no
orderDate
Type java.util.Date
Description The order date
Mandatory no
wfcStatus
Type java.lang.Long
Description The workflow status
Mandatory no
id
Type java.lang.Long
Description The internal reference of this banking object on the database. This is a unique id.
Mandatory no
versionId
Type java.lang.Long
Description The version of this banking object on the database. Used to discover changes.
Mandatory no

Copyright 201, Avaloq Evolution AG Page 413 of 424


AFP Interface Specification

3. Avaloq Enumeration Description

3.1 AttentionItemCounterType
The attention item counters types supported by the system.
PAYMENTS_SCANNED Counter for number of payments scanned.
PAYMENTS_PENDING Counter for number of payments pending.
PAYMENTS_OPEN_EBILLS Counter for number of open ebills from all contracts.
PAYMENTS_TO_APPROVE Counter for number of payments to approve.
DOCUMENT_SAFE_UNREA Counter for number of unread documents in Document Safe.
D
ACCOUNTS_WITH_NEGAT Counter for the number of accounts with negative balance.
IVE_BALANCE
COLLABORATION_ISSUES Counter for the number of unread Collaboration issues.
_UNREAD
POSITIONS_MATURING_I Counter for the number of positions with maturity date in the next 30 days.
N_NEXT_30_DAYS
TRADING_CURRENT_ORD Counter for the number of current trading orders for today.
ERS_OF_TODAY
TRADING_COLLECTIVE_O Counter for the number of collective trading orders in the order outbox.
RDER_OUTBOX

3.2 PortfolioAuthorityRestriction
Portfolio authority restrictions.
TRADING Trading authority restriction.

3.3 AdvisoryRawDataFormat

XML The XML .


JSON The JSON .

3.4 BookingOrderBusinessType
Enumeration to represent supported business types on bookings order details.
STEX Stock Exchange business type.
PAYMENT Payment business type.
COLLECTIVE_PAYMENT Collective payment order business type.
OTHER Unknown.

3.5 QueryOrderingSpecification
An enum to specify the sort order of a query.
ASCENDING ascending order.
DESCENDING descending order.

3.6 TransactionSigningOperation
The different possible transaction signing types.
MTAN Transaction signing with a mobile device.

Copyright 201, Avaloq Evolution AG Page 414 of 424


AFP Interface Specification

FLICKER Transaction signing with a flicker device.


CHALLENGE Transaction signing with challenge - response.
PASSWORD Transaction signing with a password.
MATRIX Transaction signing with matrix card.
CONFIRM Transaction signing only with a confirmation (OK and cancel Button).
TOKEN Transaction signing with a token. e.g. SecurID
CRONTO Transaction signing with CrontoSign. e.g. photoTan

3.7 TransactionSigningObjectType
The object type to signing.
PAYMENT_ORDER_SUBMI A payment order transaction to submit.
T
PAYMENT_ORDER_APPRO A payment order transaction to approve.
VE
PAYMENT_ORDER_IN_FIL A payment order that is part of file upload.
EUPLOAD
STANDING_ORDER_SUBM A standing order to submit.
IT
STANDING_ORDER_APPR A standing order to approve.
OVE
BALANCE_MANAGER_SUB A balance manager to submit.
MIT
BALANCE_MANAGER_APP A balance manager to approve.
ROVE
CORD_PAYMENT_APPRO A collective payment order to approve.
VE
FILEUPLOAD A file upload transaction. e. g. dta upload.
TRADING_SINGLE_CREAT A single trading order to create.
E
TRADING_COLLECTIVE_C A collective trading order to create.
REATE
TRADING_COLLECTIVE_U A collective trading order to update.
PDATE

3.8 Sign
The sign.
LONG
SHORT

3.9 SelectionMethod
The selection method.
INCL Include.
EXCL Exclude.
RESTR Restrict to.

3.10 Status
The object status.
ACTIVE Include only Active objects.
INACTIVE Include only Inactive objects.

Copyright 201, Avaloq Evolution AG Page 415 of 424


AFP Interface Specification

ALL_STATE Include both Active and Inactive objects.

3.11 LookupScope
The lookup scope.
EWOM_LOOKUP Pure EWOM lookup.
FWOM_LOOKUP Pure FWOM lookup.
SDS_EWOM_LOOKUP SDS Lookup on EWOM (for ACP).
SDS_FWOM_LOOKUP SDS Lookup on FWOM (for AFP).

3.12 CharacterEncoding
The character encoding.
UTF_8 UTF-8.
ISO_8859_1 ISO-8859-1.

3.13 MimeType
MIME type.
TEXT_PLAIN text/plain.
TEXT_HTML text/html.

3.14 HistoricalPerformancePeriod
Performance period.
LAST_7_DAYS Last 7 days.
LAST_30_DAYS Last month.
THIS_YEAR This year.
LAST_12_MONTHS Last year.
YEARLY Yearly.

3.15 PerformancePeriod
Performance period.
YTD Year to date.

3.16 PortfolioType
The type enumeration.
IPS Ips portfolio.
CONTAINER Container portfolio.

3.17 UserContactInformationMedium
Used by clients that need to distinguish between different mediums of contact information for ABS users. For example the
user settings, and notification framework.
EMAIL
MOBILE

Copyright 201, Avaloq Evolution AG Page 416 of 424


AFP Interface Specification

3.18 StandingOrderSearchStateType
The standing order search type.
TO_BE_APPROVED All payments to approve.
• PaymentStateType.INIT
• PaymentStateType.INIT_ONLY_USER
• PaymentStateType.EDIT
• PaymentStateType.EDIT_ONLY_USER
• PaymentStateType.PARTIAL_APPROVED
• PaymentStateType.TO_SIGN
ACTIVE All full approved active standing orders.
Only for standing orders.
• PaymentStateType.APPROVED
• PaymentStateType.PROCESSING
INACTIVE All full approved inactive standing orders.
Only for standing orders.
• PaymentStateType.APPROVED
• PaymentStateType.PROCESSING
PARTIAL_APPROVED All payments which are approved by the user but not already full approved.
REJECTED All payment states which indicates that the payment was rejected by the ABS.
In the moment this is the PaymentStateType.REJECTED_ARCHIVED state.
DELETED All payment states which indicates a deleted payment.
• PaymentStateType.DELETED_ARCHIVED
• PaymentStateType.DELETED_ONLY_USER
EXPIRED All expired standing orders.
Only for standing order.
TO_SIGN Orders that require transaction signing.
IN_WORK Calculated state which defines that a payment is in work (single order only).
APPROVED Calculated state which defines that a payment is approved (single order only).
CANCEL Calculated state which defines that a payment is canceled (single order only).
PROCESSED Calculated state which defines that a payment is processed (single order only).
ERROR Calculated state which defines that a payment is in error (single order only).

3.19 PositionType
Enumeration for position type.
METAL_ACCOUNT Position type: metal account.
CONTRACT Position type: contract.
SECURITY Position type: security.
DEPOSIT_ACCOUNT Position type: deposit account.
CURRENT_ACCOUNT Position type: current account.
INTERIM_ACCOUNT Position type: interim account.

3.20 PositionQuantityType
Enumeration describing the values of position quantities (e.g. NEGATIVE).
NEGATIVE negative quantity.
NEGATIVE_OR_ZERO negative or zero.
ZERO zero.
POSITIVE positive.
POSITIVE_OR_ZERO positive or zero.

Copyright 201, Avaloq Evolution AG Page 417 of 424


AFP Interface Specification

3.21 PaymentType
Indicates the specific type of a payment.
Used in
• payment orders
• standing orders
• beneficiaries
SWISS_ORANGE_PAYMEN The orange payment slip. Only used for payments in Switzerland.
T_SLIP There are three different PaymentSubTypes of a orange payment slip.
SWISS_RED_PAYMENT_SLIThe red payment slip. Only used for payments in Switzerland.
P There are three different PaymentSubTypes of a red payment slip.
SWISS_PAYMENT_INSTRU The post payment instruction in Switzerland.
CTION
DOMESTIC_PAYMENT The domestic payment.
INTERNATIONAL_PAYME The international payment instruction IPI.
NT_INSTRUCTION
INTERNATIONAL_PAYME The international payment.
NT This can be also a sepa payment.
SEPA_PAYMENT The sepa payment.
INTERNAL_PAYMENT The internal payment.
Used to transfer money from one account to an other form the same user.
BALANCE_MANAGER_PAY The balance manager payment.
MENT Used to transfer money from one account to an other form the same user, for
account sweeping.
DTA_PAYMENTS Payments created with a DTA file upload. This is not a single payment, but a group of
payments.
COLLECTIVE_PAYMENTS Collective payments. This is not a single payment, but a group of payments.

3.22 PaymentSubType
The specific sub type of a payment if the normal PaymentType is not enough to identify them.
Used for
• swiss orange payment slip
• swiss red payment slip
POSTCHECK_ACCOUNT The account number in post check format.
BANK_ACCOUNT The account number in bank (normal) format.
BANK_UNDEFINED The undefined bank account. Used in case of the orange payment slip if the pc
account is not in the database. Or in case of a red payment slip where neither the
account no nor the iban number is set.
EMPTY An empty enum, used if no subtyp required.

3.23 PaymentStateType
The possible payment states.
INIT The payment is created and stored on the database but not approved.
This payment is not send to the ABS.
EDIT The payment is edited but not approved.
This payment is not send to the ABS. If this payment was send to the ABS before send
a BLOCK message to the ABS.
EDIT_ERROR The payment is edited but has errors.
This payment is not send to the ABS. This state is just used if generated payment
from a file with errors.
INIT_ONLY_USER The payment is created and stored on the database but not approved.
This payment can see only the user who has created the payment.
EDIT_ONLY_USER This payment can see only the user who has created the payment.
EDIT_ERROR_ONLY_USER This payment has error.
This payment can see only the user who has created the payment.
PARTIAL_APPROVED In minimum one user has approved this payment but the payment still not complete

Copyright 201, Avaloq Evolution AG Page 418 of 424


AFP Interface Specification

PARTIAL_APPROVED approved. So in minimum one user more has to approve this payment.
This payment is not send to the ABS. If this payment was send to the ABS before send
a BLOCK message to the ABS.
APPROVED This payment is complete approved. Send them to the ABS.
PROCESSING The payment was send to the ABS and is now processing there.
PROCESSED_ARCHIVED The payment is processed and everything works fine.
REJECTED_ARCHIVED The payment was rejected from the ABS. So the payment was not processed.
DELETED_ARCHIVED The payment is deleted. So the payment was not processed.
DELETED_ACP_ARCHIVED The payment was deleted in ACP. It was not processed.
CANCEL_ARCHIVED The payment is canceled. So the payment was not processed.
DELETED_ONLY_USER This payment is deleted.
It can be seen only by the user who created it in the file upload view.
EXPIRED_STANDING_ORD This standing order payment is expired.
ER This can be because the number of execution is reached or the end date is expired.
MIXED For DTA groups only: The payments contained in a DTA file have mixed payment
state types.
TO_SIGN The payment requires signing.
TERMINAL_STATES States that mark the end of a payments life cycle. No further actions are allowed on
payments with such a state.

3.24 PaymentSearchStateType
The aggregated PaymentStateType to search easily over more than one payment state.
TO_BE_APPROVED All payments to approve.
• PaymentStateType.INIT
• PaymentStateType.INIT_ONLY_USER
• PaymentStateType.EDIT
• PaymentStateType.EDIT_ONLY_USER
• PaymentStateType.PARTIAL_APPROVED
ERROR All payments with error.
Only for payment orders.
• PaymentStateType.EDIT_ERROR
• PaymentStateType.EDIT_ERROR_ONLY_USER
APPROVED All full approved payments.
Only for payment orders.
• PaymentStateType.APPROVED
• PaymentStateType.PROCESSING
PARTIAL_APPROVED All payments which are approved by the user but not already full approved.
PROCESSED All payment states which indicates that the payment was successful processed.
Only for payment orders.
REJECTED All payment states which indicates that the payment was rejected by the ABS.
In the moment this is the PaymentStateType.REJECTED_ARCHIVED state.
DELETED All payment states which indicates a deleted payment.
• PaymentStateType.DELETED_ARCHIVED
• PaymentStateType.DELETED_ONLY_USER
DELETED_ACP All payment state which indicate a payment deleted in ACP.
• PaymentStateType.ACP_DELETED_ARCHIVED
CANCEL All payment states which indicates a cancel payment.
• PaymentStateType.CANCEL_ARCHIVED
TO_SIGN Payment needs to be signed.
IN_WORK Calculated state which defines that a payment is in work.
MIXED Calculated state which defines that there are mixed states in a DTA group.

3.25 PaymentPriority
The payment priority.
NORMAL The normal priority.

Copyright 201, Avaloq Evolution AG Page 419 of 424


AFP Interface Specification

URGENT The priority is urgent. In this case no SEPA payment is possible.

3.26 PaymentOrderSource
Indicates the source of the payment order.
SINGLE_PAYMENT Originated as a standard single payment (default).
DTA_ORDER Originated from a DTA Order.
PAIN001_ORDER Originated from a PAIN001 Order.
STANDING_ORDER Originated from a standing order.
STANDING_ORDER_DIRE Is a direct standing order.
CT
BALANCE_MANAGER_DIR Is a direct balance manager order.
ECT
SINGLE_PAYMENT_TEMPL Originated as a standard single payment via mass template execution.
ATE_EXECUTION
E_BILL Originated from an e-Bill.
COLLECTIVE_PAYMENT Originated as a collective payment (i.e., Cord Order).
MIXED Calculated source which defines that there are mixed states in a DTA group.

3.27 PaymentLogType
The actions in the payment log.
This are almost the same type like in PaymentStateType.
INIT A normal payment is created and stored on the database but not approved.
This is an user action. <div class="de">Auftrag erfasst</div>
INIT_DTA A DTA payment is created and stored on the database but not approved.
This is an user action. <div class="de">Auftrag erfasst aus DTA</div>
INIT_STANDING A standing order payment is created and stored on the database but not approved.
This is an user action. <div class="de">Auftrag erfasst aus DA</div>
INIT_TEMPLATE A template payment is created and stored on the database but not approved.
This is an user action. <div class="de">Auftrag erfasst aus Vorlage</div>
EDIT The payment is edited but not approved.
This is an user action. <div class="de">Auftrag bearbeitet</div>
FORWARDING_APPROVM The user forwarded an approvment request to another user.
ENT This is an user action. <div class="de">Zum Freigeben weitergeleitet</div>
APPROVED An user has approved this payment.
This is an user action. <div class="de">freigegeben</div>
COMPLETE_APPROVED This payment is complete approved.
This is an AFS server action. <div class="de">Auftrag vollständig freigegeben</div>
TRANSMITTED This payment is transmitted to the ABS.
This is an AFS server action. <div class="de">Auftrag übermittelt</div>
DELETED An user has deleted this payment.
This is an user action. <div class="de">Auftrag gelöscht</div>
PROCESSED This payment is processed.
This is an AFS server action. <div class="de">Auftrag verarbeitet</div>
REJECTED This payment is rejected.
This is an AFS server action. <div class="de">Auftrag abgelehnt</div>
STANDING_EXPIRED This standing order payment is expired.
This can be because the number of execution is reached or the end date is expired.
This is an AFS server action. <div class="de">Dauerauftrag abgelaufen</div>
STANDING_DEACTIVATE An user has deactivated this standing order payment.
D This is an user action. <div class="de">Dauerauftrag deaktiviert</div>
STANDING_ACTIVATED An user has activated this standing order payment.
This is an user action. <div class="de">Dauerauftrag aktiviert</div>
ABS_UPDATE This payment was updated by the ABS.
This is an AFS server action. <div class="de">Auftrag von ABS aktualisiert</div>
ABS_INIT Order created by ABS.

Copyright 201, Avaloq Evolution AG Page 420 of 424


AFP Interface Specification

ABS_EDIT Order modified by ABS.


ABS_DELETED Order deleted by ABS.
ABS_EXECUTED Order executed by ABS.
ABS_ACK Order acknowledged by ABS.
ABS_CANCELLED Order cancelled by ABS.

3.28 PaymentGroupType
Indicates the specific group type of a payment(-group).
SINGLE_PAYMENT Single payments (or ungrouped CORD / DTA payments).
COLLECTIVE_ORDER Grouped collective orders.
DTA Grouped DTA payments.

3.29 PaymentChannelType
The type of the payment channel. Used in the UK domestic payment.
FASTER UK domestic faster payment.
CHAPS UK domestic chaps payment.

3.30 InternationalPaymentInstructionFormType
The form type for international payment istruction.
FORM00 The form 00.
payment reason: mandatory Structured value 20 Characters (alphanumerisch) first 2
characters check number
FORM01 The form 01.
payment reason: optional Unstructured value free text no minimal length max 35
character
FORM02 The form 02.
payment reason: mandatory Structured value 20 Characters (alphanumerisch) first 2
characters check number
FORM03 The form 03.
payment reason: optional Unstructured value free text no minimal length max 35
character
FORM04 The form 04.
payment reason: mandatory Structured value 20 Characters (alphanumerisch) first 2
characters check number
FORM05 The form 05.
payment reason: optional Unstructured value free text no minimal length max 35
character

3.31 CollaborationIssueType
An enum for Collaboration issue types.
CALL_REQUEST A call request.
APPOINTMENT An appointment.
MESSAGING A message.

3.32 CollaborationIssueSearchReadStatus
Issue read status for searching.
ALL All issues.

Copyright 201, Avaloq Evolution AG Page 421 of 424


AFP Interface Specification

READ All issues which are marked read.


UNREAD All issues which are marked unread.

3.33 CollaborationIssueDescriptionActionType
An enum for Collaboration issue description action types.
FROM_AFS Issue description from client.
TO_AFS Issue description from client advisor.

3.34 ChargeOptionType
In a PaymentType.INTERNATIONAL_PAYMENT there is the possibility the choose who pays the transfer charges.
SHA SHA (shared) means the user only pay his bank's outgoing transfer charge. We receive
your payment minus the correspondent (intermediary) bank charges.
OUR The user pay all transfer charges. We receive all the payment.
BEN BEN (beneficiary) means the user do not pay any charge. We receive your payment
minus all transfer charges.
EMPTY If no charge option is required.

3.35 ChannelType
Defines the set of channels.
ALL All channels (web and mobile).
WEB The web channel.
ADMIN The admin channel.
MOBILE The mobile channel.
OFFLINE_TOOLS The offline tools channel.

3.36 BookingOrderDetailType
The different order detail types for bookings.
PAYMENT_CORD_ORDER States that the order detail is related to a cord order.
PAYMENT_ORDER States that the order detail is related to a payment order.
TRADING_ORDER States that the order detail is related to a trading order.

3.37 BookingDateType
An enum for booking date and value date.
BOOKING The booking date.
VALUE The value date.

3.38 BalanceMethodType
Used to determine the triggering money account.
SURPLUS if money account amount exceeded a certain value.
DEFICIT if money account amount fell short of a certain value.
SURPLUS_FLAT Fixed Amount on surplus.
DEFICIT_FLAT Fixed Amount on deficit.

Copyright 201, Avaloq Evolution AG Page 422 of 424


AFP Interface Specification

3.39 AdviceOptionType
The advice of the payment in the booking.
NO_ADVICE No advice in the booking.
DETAIL_ADVICE_SINGLE Detail advice for single payment in the booking.
DETAIL_ADVICE_COLLEC Detail advice for collective payments in the booking.
TIVE
COLLECTIVE_ADVICE Only the total advice for collective payments in the booking.

3.40 AddressOwningRelationshipType
The different states of eDocuments.
OWNED States that the address is a personal address.
MANAGED States that the address is not a personal address but a managed one.

3.41 BusinessTypeCodeEnum
Mapping to internal ids for business type codes.

IMPORTANT: Internal ids on codes are not unique technically. When codes are added in kernel they are usually intended to
be unique. Since currently no mapping to a unique identifier is provided we use this class to map internal ids for codes which
we need to match when implementing business logic.
STEX Stock Exchange business type.
PAYMENT Payment business type.
COLLECTIVE_PAYMENT Collective payment order business type.
OTHER All other business types.

3.42 AssetListedInTypeCodeEnum
Listing unit for instruments.
MONEY Money.
PERCENT Percent.
POINTS Points.
YIELD Yield.
SIMPLE_DISCOUNT Simple discount.
OTHER The other.

3.43 AssetBookKeepingMethodTypeCodeEnum
Bookkeeping method for asset.
PIECE Piece.
NOMINAL Nominal.
CONTRACT Contract.
CONTRACT_FUTURE Contract (Future).
CONTRACT_FUTURE_NO Contract (Future, booked nominal).
MINAL
OTHER The other.

Copyright 201, Avaloq Evolution AG Page 423 of 424


AFP Interface Specification

3.44 PaymentFraudDetectionOriginTypeCodeEnum
Enumeration used to collect information for Fraud Detection: Where did the order originate from meaning how was it created.

PAYMENT_STANDING_OR Payment standing order.


DER
PAYMENT_SINGLE_MANU Single payment, manually opened.
ALLY
PAYMENT_LIST Payment list (bulk order created from a group of templates).
PAYMENT_FILE Payment file (uploaded bulk order, e.g. DTA).
PAYNET_STANDING_ORD Paynet standing order.
ER
PAYNET_SINGLE Single Paynet order.
BALANCE_MANAGER_STA Balance manager Standing order.
NDING_ORDER
OTHER For all other code values.

3.45 PaymentFraudDetectionClientTypeCodeEnum
Enumeration used to collect information for Fraud Detection: What kind of tool is the user using. created.
DESKTOP Desktop.
OFFLINE_TOOL Offline Tool.
MOBILE_PHONE Mobile (Phone).
OTHER For all other code values.

3.46 PaymentFraudDetectionAuthenticationTypeCodeEnum
Enumeration used to collect information for Fraud Detection: How was the user authenticated.
MATRIX_CARD Matrix card.
MTAN_SMS mTan (SMS).
SENTINEL Sentinel.
SOFT_CERTIFICATE Soft certificate.
SECURE_BROWSER Secure Browser.
MOBILE_CREDENTIALS Mobile credentials.
PASSWORD Mobile credentials.
OTHER For all other code values.

3.47 BookingType
An enum for booking type.
ALL All bookings.
CREDIT Credit bookings.
DEBIT Debit bookings.

Copyright 201, Avaloq Evolution AG Page 424 of 424