Actions of Folio Payment (FSCFOLIOPAYMENT@1.1001)

ReferenceName
FSCFOLIOPAYMENT@1.1001:AssignPriceTierAssgin price tier
FSCFOLIOPAYMENT@1.1001:AssignPriceTierSelected
FSCFOLIOPAYMENT@1.1001:AttrActivePaymentModalitiesGet
FSCFOLIOPAYMENT@1.1001:AttrActiveSubscriptionGet
FSCFOLIOPAYMENT@1.1001:AttrBillDetailInformationGet
FSCFOLIOPAYMENT@1.1001:AttrBillInvoiceNoSet
FSCFOLIOPAYMENT@1.1001:AttrBillRateOfTaxationGet
FSCFOLIOPAYMENT@1.1001:AttrContractingPartnerSet
FSCFOLIOPAYMENT@1.1001:AttrDbMonthlyPriceNetGet
FSCFOLIOPAYMENT@1.1001:AttrGrLicUsageInfoSet
FSCFOLIOPAYMENT@1.1001:AttrGrPaymentPeriodsSet
FSCFOLIOPAYMENT@1.1001:AttrGrPaymentUserSet
FSCFOLIOPAYMENT@1.1001:AttrGrSolutionAreaSet
FSCFOLIOPAYMENT@1.1001:AttrGrTerminationReasonGet
FSCFOLIOPAYMENT@1.1001:AttrGrTerminationReasonSet
FSCFOLIOPAYMENT@1.1001:AttrGrTerminationSet
FSCFOLIOPAYMENT@1.1001:AttrGroupVATSettingsGet
FSCFOLIOPAYMENT@1.1001:AttrGroupVATSettingsSet
FSCFOLIOPAYMENT@1.1001:AttrLiableToVATSet
FSCFOLIOPAYMENT@1.1001:AttrOrderNumberGet
FSCFOLIOPAYMENT@1.1001:AttrOrderNumberSet
FSCFOLIOPAYMENT@1.1001:AttrOrgtGroupSet
FSCFOLIOPAYMENT@1.1001:AttrPMOrderNumberSettingsGet
FSCFOLIOPAYMENT@1.1001:AttrPeBillGet
FSCFOLIOPAYMENT@1.1001:AttrPeInstanceSet
FSCFOLIOPAYMENT@1.1001:AttrPePriceTotalGet
FSCFOLIOPAYMENT@1.1001:AttrPoDistributionItemsGet
FSCFOLIOPAYMENT@1.1001:AttrPoDocumentsSet
FSCFOLIOPAYMENT@1.1001:AttrPoPurchasedItemsGet
FSCFOLIOPAYMENT@1.1001:AttrSubContractingPartnerGet
FSCFOLIOPAYMENT@1.1001:AttrSubEndDateSet
FSCFOLIOPAYMENT@1.1001:AttrSubFollowerSubscriptionSet
FSCFOLIOPAYMENT@1.1001:AttrSubLiableToVatGet
FSCFOLIOPAYMENT@1.1001:AttrSubPaymentElementsDisp
FSCFOLIOPAYMENT@1.1001:AttrSubPaymentMethodGet
FSCFOLIOPAYMENT@1.1001:AttrSubPrimarySubTransactionsGet
FSCFOLIOPAYMENT@1.1001:AttrSubTransBusinessTypeGet
FSCFOLIOPAYMENT@1.1001:AttrSubTransSAPOrderNrSet
FSCFOLIOPAYMENT@1.1001:AttrUserPurchaserInfoGet
FSCFOLIOPAYMENT@1.1001:AttrVATInfoGet
FSCFOLIOPAYMENT@1.1001:AttrVatEntriesGet
FSCFOLIOPAYMENT@1.1001:CalcBillAmount
FSCFOLIOPAYMENT@1.1001:CalcSubscriptionTransactionId
FSCFOLIOPAYMENT@1.1001:CalcTerminationTime
FSCFOLIOPAYMENT@1.1001:CalculateCurrentEditionInfo
FSCFOLIOPAYMENT@1.1001:CalculatePaymentPeriodByInterval
FSCFOLIOPAYMENT@1.1001:CalculateSubscriptionPeriod
FSCFOLIOPAYMENT@1.1001:CalculateTaxationRate
FSCFOLIOPAYMENT@1.1001:CanPurchseAdditionalProduct
FSCFOLIOPAYMENT@1.1001:CanUpdateVATInfo
FSCFOLIOPAYMENT@1.1001:CheckAdditionalBundlePurchaseRestrictions
FSCFOLIOPAYMENT@1.1001:CheckLicensedProducts
FSCFOLIOPAYMENT@1.1001:CheckNewLicensedProducts
FSCFOLIOPAYMENT@1.1001:CheckProductsAvailableInOnlineShop
FSCFOLIOPAYMENT@1.1001:CheckVATIDRequired
FSCFOLIOPAYMENT@1.1001:CompletePurchaseOrders
FSCFOLIOPAYMENT@1.1001:ConvertTrialOrganization
FSCFOLIOPAYMENT@1.1001:CreateAppCharging
FSCFOLIOPAYMENT@1.1001:CreateBill
FSCFOLIOPAYMENT@1.1001:CreateOffer
FSCFOLIOPAYMENT@1.1001:CreateOrganizationOrder
FSCFOLIOPAYMENT@1.1001:CreatePaymentConfirmation
FSCFOLIOPAYMENT@1.1001:CreatePaymentElement
FSCFOLIOPAYMENT@1.1001:CreatePaymentObject
FSCFOLIOPAYMENT@1.1001:CreateSubTransaction
FSCFOLIOPAYMENT@1.1001:CreateSubscription
FSCFOLIOPAYMENT@1.1001:DetermineCountryCode
FSCFOLIOPAYMENT@1.1001:DetermineLicenseableProducts
FSCFOLIOPAYMENT@1.1001:DeterminePurchaserInformation
FSCFOLIOPAYMENT@1.1001:DetermineSubscriptionIntervalText
FSCFOLIOPAYMENT@1.1001:FillEventsGroupTerminations
FSCFOLIOPAYMENT@1.1001:FinalizeSubscription
FSCFOLIOPAYMENT@1.1001:FindSubscriptions
FSCFOLIOPAYMENT@1.1001:FormatCurrency
FSCFOLIOPAYMENT@1.1001:GenerateBill
FSCFOLIOPAYMENT@1.1001:GeneratePaymentPDF
FSCFOLIOPAYMENT@1.1001:GetActivityPointApp
FSCFOLIOPAYMENT@1.1001:GetAddOnDebitDays
FSCFOLIOPAYMENT@1.1001:GetAddressFormated
FSCFOLIOPAYMENT@1.1001:GetAllowedDistributionBundles
FSCFOLIOPAYMENT@1.1001:GetAllowedPaymentCurrencies
FSCFOLIOPAYMENT@1.1001:GetBankAccountDetails
FSCFOLIOPAYMENT@1.1001:GetBasePackages
FSCFOLIOPAYMENT@1.1001:GetBillingAddress
FSCFOLIOPAYMENT@1.1001:GetBillingAddressFormated
FSCFOLIOPAYMENT@1.1001:GetBillingCustomerId
FSCFOLIOPAYMENT@1.1001:GetBundlePurchaseBaseEdition
FSCFOLIOPAYMENT@1.1001:GetConfirmationProcess
FSCFOLIOPAYMENT@1.1001:GetContractingPartner
FSCFOLIOPAYMENT@1.1001:GetContractingPartnerByCountry
FSCFOLIOPAYMENT@1.1001:GetDeactivateShop
FSCFOLIOPAYMENT@1.1001:GetDefaultContractingPartner
FSCFOLIOPAYMENT@1.1001:GetDefaultStorage
FSCFOLIOPAYMENT@1.1001:GetEditionPurchaseName
FSCFOLIOPAYMENT@1.1001:GetEditionSubscription
FSCFOLIOPAYMENT@1.1001:GetFreeGroupApps
FSCFOLIOPAYMENT@1.1001:GetFurtherPurchasePrice
FSCFOLIOPAYMENT@1.1001:GetInitialPurchaseAgreement
FSCFOLIOPAYMENT@1.1001:GetLastSubscriptions
FSCFOLIOPAYMENT@1.1001:GetMinimumPurchaseAmount
FSCFOLIOPAYMENT@1.1001:GetNumeratorInitValue
FSCFOLIOPAYMENT@1.1001:GetOrderNumberSettings
FSCFOLIOPAYMENT@1.1001:GetOrderTermsConditions
FSCFOLIOPAYMENT@1.1001:GetOrgTermination
FSCFOLIOPAYMENT@1.1001:GetOrganizationVerificationProcess
FSCFOLIOPAYMENT@1.1001:GetPaymentCurrency
FSCFOLIOPAYMENT@1.1001:GetPaymentElementName
FSCFOLIOPAYMENT@1.1001:GetPaymentModalities
FSCFOLIOPAYMENT@1.1001:GetPaymentOwner
FSCFOLIOPAYMENT@1.1001:GetPaymentUserGroups
FSCFOLIOPAYMENT@1.1001:GetPrice
FSCFOLIOPAYMENT@1.1001:GetPricePerInterval
FSCFOLIOPAYMENT@1.1001:GetPriceTier
FSCFOLIOPAYMENT@1.1001:GetPriceTierAdvancedName
FSCFOLIOPAYMENT@1.1001:GetPriceTierListSorted
FSCFOLIOPAYMENT@1.1001:GetRevokeTerminateSubscriptions
FSCFOLIOPAYMENT@1.1001:GetRunningSubscriptions
FSCFOLIOPAYMENT@1.1001:GetShopStyle
FSCFOLIOPAYMENT@1.1001:GetShopURL
FSCFOLIOPAYMENT@1.1001:GetStorageEdition
FSCFOLIOPAYMENT@1.1001:GetStorageEditionSubscription
FSCFOLIOPAYMENT@1.1001:GetSubTransactionByCustid
FSCFOLIOPAYMENT@1.1001:GetSubscription
FSCFOLIOPAYMENT@1.1001:GetSubscriptionMailRecipients
FSCFOLIOPAYMENT@1.1001:GetSubscriptionPurchases
FSCFOLIOPAYMENT@1.1001:GetTrialSubscriptions
FSCFOLIOPAYMENT@1.1001:GetVATSettings
FSCFOLIOPAYMENT@1.1001:GetValidPurchaseItems
FSCFOLIOPAYMENT@1.1001:GetVatId
FSCFOLIOPAYMENT@1.1001:GrantAppLicense
FSCFOLIOPAYMENT@1.1001:HandleConfirmationResponse
FSCFOLIOPAYMENT@1.1001:IsAdditionalShopUser
FSCFOLIOPAYMENT@1.1001:IsAppPurchasedBy
FSCFOLIOPAYMENT@1.1001:IsAvailableInOnlineShop
FSCFOLIOPAYMENT@1.1001:IsBundelPurchasePossible
FSCFOLIOPAYMENT@1.1001:IsPackagePurchasedBy
FSCFOLIOPAYMENT@1.1001:IsPaymentMethodAllowed
FSCFOLIOPAYMENT@1.1001:IsPaymentUserChangeable
FSCFOLIOPAYMENT@1.1001:IsPrivilegedUser
FSCFOLIOPAYMENT@1.1001:IsProductAvailabelAsInstance
FSCFOLIOPAYMENT@1.1001:IsProductAvailabelForTrial
FSCFOLIOPAYMENT@1.1001:IsProductAvailable
FSCFOLIOPAYMENT@1.1001:IsRenewal
FSCFOLIOPAYMENT@1.1001:IsReseller
FSCFOLIOPAYMENT@1.1001:LicenseDefaultPackage
FSCFOLIOPAYMENT@1.1001:LicenseDefaultStorage
FSCFOLIOPAYMENT@1.1001:PrepareBill
FSCFOLIOPAYMENT@1.1001:PreparePaymentPDF
FSCFOLIOPAYMENT@1.1001:ReGeneratePaymentPDF
FSCFOLIOPAYMENT@1.1001:RenewPaymentElements
FSCFOLIOPAYMENT@1.1001:SavePaymentPeriod
FSCFOLIOPAYMENT@1.1001:SendPaymentTransactionMail
FSCFOLIOPAYMENT@1.1001:SendRenewalInfo
FSCFOLIOPAYMENT@1.1001:SortPaymentElements
FSCFOLIOPAYMENT@1.1001:TerminatePendingFollowers
FSCFOLIOPAYMENT@1.1001:UpdateBillingAddress
FSCFOLIOPAYMENT@1.1001:UpdateContractingPartner
FSCFOLIOPAYMENT@1.1001:UpdateGrLicUsage
FSCFOLIOPAYMENT@1.1001:UpdateGrQuotaUsage
FSCFOLIOPAYMENT@1.1001:UpdateOrderNumberSettings
FSCFOLIOPAYMENT@1.1001:UpdateOrganizationName
FSCFOLIOPAYMENT@1.1001:UpdatePaymentCurrency
FSCFOLIOPAYMENT@1.1001:UpdateRecurringPayment
FSCFOLIOPAYMENT@1.1001:UpdateSubscription
FSCFOLIOPAYMENT@1.1001:UpdateSubscriptionsLicenses
FSCFOLIOPAYMENT@1.1001:UpdateTransactionStatus
FSCFOLIOPAYMENT@1.1001:UpdateTrialEnd
FSCFOLIOPAYMENT@1.1001:UpdateVatId

FSCFOLIOPAYMENT@1.1001:AssignPriceTier (Assgin price tier)

Assign a price tier to your cloud app

Additional Information

Symbol: COODESK@1.1:SymbolPriceTier
Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:AssignPriceTierSelected

Additional Information

Call Mode for Actions on Selected Objects: CALLMODE_SELECTEDONLY
Called Action on Selected Objects: FSCFOLIOPAYMENT@1.1001:AssignPriceTier
Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:AttrActivePaymentModalitiesGet

Additional Information

Prototype: COOSYSTEM@1.1:AttrGetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:AttrActiveSubscriptionGet

Additional Information

Prototype: COOSYSTEM@1.1:AttrGetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:AttrBillDetailInformationGet

Additional Information

Prototype: COOSYSTEM@1.1:AttrGetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:AttrBillInvoiceNoSet

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:AttrBillRateOfTaxationGet

Additional Information

Prototype: COOSYSTEM@1.1:AttrGetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:AttrContractingPartnerSet

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:AttrDbMonthlyPriceNetGet

Additional Information

Prototype: COOSYSTEM@1.1:AttrGetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:AttrGrLicUsageInfoSet

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:AttrGrPaymentPeriodsSet

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:AttrGrPaymentUserSet

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:AttrGrSolutionAreaSet

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:AttrGrTerminationReasonGet

Additional Information

Prototype: COOSYSTEM@1.1:AttrGetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:AttrGrTerminationReasonSet

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:AttrGrTerminationSet

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:AttrGroupVATSettingsGet

Additional Information

Prototype: COOSYSTEM@1.1:AttrGetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:AttrGroupVATSettingsSet

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:AttrLiableToVATSet

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:AttrOrderNumberGet

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:AttrOrderNumberSet

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:AttrOrgtGroupSet

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:AttrPMOrderNumberSettingsGet

Additional Information

Prototype: COOSYSTEM@1.1:AttrGetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:AttrPeBillGet

Additional Information

Prototype: COOSYSTEM@1.1:AttrGetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:AttrPeInstanceSet

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:AttrPePriceTotalGet

Additional Information

Prototype: COOSYSTEM@1.1:AttrGetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:AttrPoDistributionItemsGet

Additional Information

Prototype: COOSYSTEM@1.1:AttrGetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:AttrPoDocumentsSet

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:AttrPoPurchasedItemsGet

Additional Information

Prototype: COOSYSTEM@1.1:AttrGetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:AttrSubContractingPartnerGet

Additional Information

Prototype: COOSYSTEM@1.1:AttrGetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:AttrSubEndDateSet

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:AttrSubFollowerSubscriptionSet

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:AttrSubLiableToVatGet

Additional Information

Prototype: COOSYSTEM@1.1:AttrGetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:AttrSubPaymentElementsDisp

Additional Information

Prototype: COOSYSTEM@1.1:AttrGetDispPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:AttrSubPaymentMethodGet

Additional Information

Prototype: COOSYSTEM@1.1:AttrGetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:AttrSubPrimarySubTransactionsGet

Additional Information

Prototype: COOSYSTEM@1.1:AttrGetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:AttrSubTransBusinessTypeGet

Additional Information

Prototype: COOSYSTEM@1.1:AttrGetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:AttrSubTransSAPOrderNrSet

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:AttrUserPurchaserInfoGet

Additional Information

Prototype: COOSYSTEM@1.1:AttrGetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:AttrVATInfoGet

Additional Information

Prototype: COOSYSTEM@1.1:AttrGetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:AttrVatEntriesGet

Additional Information

Prototype: COOSYSTEM@1.1:AttrGetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:CalcBillAmount

Calculate the total amount for a bill of a purchase in the Fabasoft Cloud Shop.
ParameterTypeIn/OutOptionalDescription
totalpriceCOOSYSTEM@1.1:Currencyout
discountCOOSYSTEM@1.1:Currencyout
totalpriceexclCOOSYSTEM@1.1:Currencyout the price of the purchse without tax
vatCOOSYSTEM@1.1:Currencyout the amount of tax
totalpriceinclCOOSYSTEM@1.1:Currencyretval the total price of the purchase

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:CalcSubscriptionTransactionId

Create a unique id for a subscription transaction
ParameterTypeIn/OutOptionalDescription
transactionidCOOSYSTEM@1.1:STRINGretval the newly created id

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:CalcTerminationTime

Calculates the time that will be shown in the FillEventsGroupTerminations. Null if the orgnization should not be terminated or tertime more than 30 days away and no tertimeeo
ParameterTypeIn/OutOptionalDescription
terminationtimeCOOSYSTEM@1.1:DATETIMEretval the termination time

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:CalculateCurrentEditionInfo

ParameterTypeIn/OutOptionalDescription
licappsCOOATTREDIT@1.1:UserAppListintrue
editioninfoFSCFOLIOPAYMENT@1.1001:GroupCurrentEditionInforetval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:CalculatePaymentPeriodByInterval

ParameterTypeIn/OutOptionalDescription
periodfromCOOSYSTEM@1.1:DATETIMEin
paymentintervalFSCFOLIOPAYMENT@1.1001:SubscriptionIntervalin
periodtoCOOSYSTEM@1.1:DATETIMEretval in/out

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:CalculateSubscriptionPeriod

ParameterTypeIn/OutOptionalDescription
subtransCOOSYSTEM@1.1:OBJECTin
statusFSCFOLIOPAYMENT@1.1001:PaymentTransactionStatusin
paymentintervalFSCFOLIOPAYMENT@1.1001:SubscriptionIntervalin
isrenewalCOOSYSTEM@1.1:BOOLEANin
startdateCOOSYSTEM@1.1:DATETIMEout
enddateCOOSYSTEM@1.1:DATETIMEout
updatelicenseCOOSYSTEM@1.1:BOOLEANretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:CalculateTaxationRate

Calculate the taxation rate for a contracting partner per taxation period
ParameterTypeIn/OutOptionalDescription
periodfromCOOSYSTEM@1.1:DATETIMEin the begin of the taxation period
periodtoCOOSYSTEM@1.1:DATETIMEintrue the end of the taxation period
intervalFSCFOLIOPAYMENT@1.1001:SubscriptionIntervalintrue the interval of the subscription
taxationrateCOOSYSTEM@1.1:FLOATretval the taxation rate

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:CanPurchseAdditionalProduct

Check if a purchase in the shop is possible
ParameterTypeIn/OutOptionalDescription
benefitrecipientCOOSYSTEM@1.1:OBJECTin the benefit recipient
usedistributionbundleCOOSYSTEM@1.1:BOOLEANintrue
allowshopCOOSYSTEM@1.1:BOOLEANretval the result

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:CanUpdateVATInfo

ParameterTypeIn/OutOptionalDescription
canupdateCOOSYSTEM@1.1:BOOLEANretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:CheckAdditionalBundlePurchaseRestrictions

Check additional restrictions on the dashboard if the purchase of a distribution bundle is possible. E.g.: if a contract has been created
ParameterTypeIn/OutOptionalDescription
targetgroupCOOSYSTEM@1.1:OBJECTin the group for which the purchase is requested
bundlebaseeditionCOOSYSTEM@1.1:OBJECTin the edition of the bundle
ispurchasepossibleCOOSYSTEM@1.1:BOOLEANretval the result

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:CheckLicensedProducts

ParameterTypeIn/OutOptionalDescription
newapplistCOOATTREDIT@1.1:UserAppListin
invalidentriesCOOSYSTEM@1.1:BOOLEANout
duplicateentriesCOOSYSTEM@1.1:BOOLEANout
validCOOSYSTEM@1.1:BOOLEANretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:CheckNewLicensedProducts

ParameterTypeIn/OutOptionalDescription
paymentownerCOOSYSTEM@1.1:OBJECTin
purchaseditemsFSCFOLIOPAYMENT@1.1001:PurchaseOrderItemin
licensedfromCOOSYSTEM@1.1:DATETIMEintrue

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:CheckProductsAvailableInOnlineShop

ParameterTypeIn/OutOptionalDescription
productsCOOSYSTEM@1.1:OBJECTLISTin
intervalFSCFOLIOPAYMENT@1.1001:SubscriptionIntervalin
trialCOOSYSTEM@1.1:BOOLEANintrue
allproductsavailableCOOSYSTEM@1.1:BOOLEANretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:CheckVATIDRequired

Check if the VAT id is required for a particular combination of contracting partner and customer country
ParameterTypeIn/OutOptionalDescription
custcountryCOOSYSTEM@1.1:OBJECTin country of customer
iseucountryCOOSYSTEM@1.1:BOOLEANout is the customer country an EU country
isvatidrequiredCOOSYSTEM@1.1:BOOLEANretval is the customer country an EU country

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:CompletePurchaseOrders

ParameterTypeIn/OutOptionalDescription
paymentinfosCOOSYSTEM@1.1:DICTIONARYintrue
createdsubsCOOSYSTEM@1.1:OBJECTLISTretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:ConvertTrialOrganization

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:CreateAppCharging

Create a charging for cloud apps.
ParameterTypeIn/OutOptionalDescription
appdeveloperCOOSYSTEM@1.1:OBJECTin the developer for whom the charging should be created
startdateCOOSYSTEM@1.1:DATETIMEin the start of the charging period
enddateCOOSYSTEM@1.1:DATETIMEin the end of the charging period
detailoverviewCOOSYSTEM@1.1:BOOLEANin defines if a detailed purchase statistic should be contained in the charging
metadataCOOSYSTEM@1.1:DICTIONARYin the metadata used for the charging
chargingobjCOOSYSTEM@1.1:OBJECTretval the created charging stored in an object

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:CreateBill

Create a bill for a purchase in the Fabasoft Cloud Shop
ParameterTypeIn/OutOptionalDescription
billdateCOOSYSTEM@1.1:DATETIMEin
paymentperiodstartdateCOOSYSTEM@1.1:DATETIMEin
paymentperiodenddateCOOSYSTEM@1.1:DATETIMEin
sendmailsCOOSYSTEM@1.1:BOOLEANin
postponepdfgenerationCOOSYSTEM@1.1:BOOLEANin
paymentmethodFSCFOLIOPAYMENT@1.1001:PaymentMethodintrue
transbillCOOSYSTEM@1.1:OBJECTretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:CreateOffer

Create an offer (order form) for a purchase in the Fabasoft Cloud Shop.
ParameterTypeIn/OutOptionalDescription
purchaserCOOSYSTEM@1.1:OBJECTin
recipientCOOSYSTEM@1.1:OBJECTin
recipientdataFSCFOLIOPAYMENT@1.1001:BillingAddressin
billingaddrFSCFOLIOPAYMENT@1.1001:BillingAddressin
vatsettingsFSCFOLIOPAYMENT@1.1001:VATSettingsin
vatidCOOSYSTEM@1.1:STRINGin
elementsCOOSYSTEM@1.1:OBJECTLISTin
contractingpartnerCOOSYSTEM@1.1:OBJECTin
discountrateCOOSYSTEM@1.1:FLOATin
affiliatemarketingidCOOSYSTEM@1.1:STRINGin
postponepdfgenerationCOOSYSTEM@1.1:BOOLEANin
tempbillCOOSYSTEM@1.1:OBJECTretval
paymentcurrencyCOOSYSTEM@1.1:CurrencySymbolintrue
ordernumberCOOSYSTEM@1.1:STRINGintrue

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:CreateOrganizationOrder

ParameterTypeIn/OutOptionalDescription
orderCOOSYSTEM@1.1:OBJECTretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:CreatePaymentConfirmation

Create a paymemt confirmation for a purchase in the Fabasoft Cloud Shop.
ParameterTypeIn/OutOptionalDescription
billdateCOOSYSTEM@1.1:DATETIMEin
paymentperiodstartdateCOOSYSTEM@1.1:DATETIMEin
paymentperiodenddateCOOSYSTEM@1.1:DATETIMEin
parameterCOOSYSTEM@1.1:DICTIONARYin
postponepdfgenerationCOOSYSTEM@1.1:BOOLEANin

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:CreatePaymentElement

Create a payment element for a subscription
ParameterTypeIn/OutOptionalDescription
paymentownerCOOSYSTEM@1.1:OBJECTin the owner (user or group) of the created payment element (if parameter not defined use current user as owner)
productCOOSYSTEM@1.1:OBJECTin the purchased product
intervalFSCFOLIOPAYMENT@1.1001:SubscriptionIntervalin the subscription interval
trialversionCOOSYSTEM@1.1:BOOLEANin the payment element is used for a trial version (no costs will be calculated)
quantityCOOSYSTEM@1.1:INTEGERin the quantity of the purchased product
paymentinfosCOOSYSTEM@1.1:DICTIONARYintrue the payment informations
elementCOOSYSTEM@1.1:OBJECTretval the created payment element

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:CreatePaymentObject

ParameterTypeIn/OutOptionalDescription
paymentobjCOOSYSTEM@1.1:OBJECTretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:CreateSubTransaction

Creates a subscription transaction for payment of a subscription in the Fabasoft Cloud Shop
ParameterTypeIn/OutOptionalDescription
transactionidCOOSYSTEM@1.1:STRINGin the unique id for payment of the subscription with MPay24
elementsCOOSYSTEM@1.1:OBJECTLISTin the payment elements of the current transaction
paymentperiodstartdateCOOSYSTEM@1.1:DATETIMEintrue the start of the payment period (only required for addon purchases)
paymentperiodenddateCOOSYSTEM@1.1:DATETIMEintrue the end of the payment period (only required for addon purchases)
subtransCOOSYSTEM@1.1:OBJECTretval the subtrans

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:CreateSubscription

Creates a subscription for a purchase in the Fabasoft Cloud Shop
ParameterTypeIn/OutOptionalDescription
licensedfromCOOSYSTEM@1.1:DATETIMEin the date when the purchase is made
intervalFSCFOLIOPAYMENT@1.1001:SubscriptionIntervalin the duration how long the purchased items are valid for the customer
newpurchasedelementsCOOSYSTEM@1.1:OBJECTLISTin the newly purchased items
benefitrecipientCOOSYSTEM@1.1:OBJECTin the user or group for whom the items are purchased
recipientdataFSCFOLIOPAYMENT@1.1001:BillingAddressin the data of the benefit recipient
paymentownerCOOSYSTEM@1.1:OBJECTin
billingaddressFSCFOLIOPAYMENT@1.1001:BillingAddressin the address of the customer (purchaser) used for bill generation
customeridCOOSYSTEM@1.1:STRINGin the unique id for the subscription used for payment with MPay24
transactionidCOOSYSTEM@1.1:STRINGin the unique id for a payment transaction with MPay24
subscrCOOSYSTEM@1.1:OBJECTretval the newly created subscription will be returned
paymentinfosCOOSYSTEM@1.1:DICTIONARYintrue

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:DetermineCountryCode

ParameterTypeIn/OutOptionalDescription
countrynameCOOSYSTEM@1.1:STRINGin
countryCOOSYSTEM@1.1:OBJECTout
eucountryCOOSYSTEM@1.1:BOOLEANout
countrycodeCOOSYSTEM@1.1:STRINGretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:DetermineLicenseableProducts

Checks the purchaseable editions and apps
ParameterTypeIn/OutOptionalDescription
checkeditionsCOOSYSTEM@1.1:BOOLEANin editions should be included
checkappsCOOSYSTEM@1.1:BOOLEANin apps should be included
onlineshopCOOSYSTEM@1.1:BOOLEANin the purchase will be performed in the online shop
intervalFSCFOLIOPAYMENT@1.1001:SubscriptionIntervalintrue the suggested subscription interval
paymentcurrencyCOOSYSTEM@1.1:CurrencySymbolintrue the suggested payment currency
licenseableproductsCOOSYSTEM@1.1:OBJECTLISTretval the result

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:DeterminePurchaserInformation

Using this action, informations about purchaser should be determined.
ParameterTypeIn/OutOptionalDescription
informationCOOSYSTEM@1.1:DICTIONARYretval the informations about the purchaser

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:DetermineSubscriptionIntervalText

ParameterTypeIn/OutOptionalDescription
intervalFSCFOLIOPAYMENT@1.1001:SubscriptionIntervalin
langCOOSYSTEM@1.1:OBJECTin
subintervalstrCOOSYSTEM@1.1:STRINGretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:FillEventsGroupTerminations

Create the termination events for the Welcome-Screen
ParameterTypeIn/OutOptionalDescription
eventsFSCVENV@1.1001:InfoListout the events
iswelcomescreenCOOSYSTEM@1.1:BOOLEANin/out the iswelcomescreen
prerequfailedCOOSYSTEM@1.1:OBJECTLISTin/out

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:FinalizeSubscription

ParameterTypeIn/OutOptionalDescription
successfulCOOSYSTEM@1.1:BOOLEANin
isrenewalCOOSYSTEM@1.1:BOOLEANin
subtransCOOSYSTEM@1.1:OBJECTin

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:FindSubscriptions

ParameterTypeIn/OutOptionalDescription
modeFSCFOLIOPAYMENT@1.1001:SubSearchModein
fromCOOSYSTEM@1.1:DATETIMEintrue
toCOOSYSTEM@1.1:DATETIMEintrue
benefitrecipientCOOSYSTEM@1.1:OBJECTintrue
purchaserCOOSYSTEM@1.1:OBJECTintrue
subscriptionsCOOSYSTEM@1.1:OBJECTLISTretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:FormatCurrency

Action to format currencies depending on the locale of the customer
ParameterTypeIn/OutOptionalDescription
targetuserCOOSYSTEM@1.1:OBJECTin the customer used for locale and language detection
currCOOSYSTEM@1.1:Currencyin the currency (value and symbol)
appendsymbolCOOSYSTEM@1.1:BOOLEANintrue defines if currency symbol appended
targetlangCOOSYSTEM@1.1:OBJECTintrue
formattedCOOSYSTEM@1.1:STRINGretval the currency formated in the correct locale for the customer
skipfreetextCOOSYSTEM@1.1:BOOLEANintrue if set to true a free prize is displayed as number

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:GenerateBill

ParameterTypeIn/OutOptionalDescription
isrenewalCOOSYSTEM@1.1:BOOLEANin
generateCOOSYSTEM@1.1:BOOLEANretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:GeneratePaymentPDF

ParameterTypeIn/OutOptionalDescription
docdefCOOSYSTEM@1.1:OBJECTin
sendmailsCOOSYSTEM@1.1:BOOLEANin
contextCOOSYSTEM@1.1:OBJECTin

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:GetActivityPointApp

Get the App of an Activity Point
ParameterTypeIn/OutOptionalDescription
apappCOOSYSTEM@1.1:OBJECTretval the App of the Activity Point

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Obsolete: true


[top]

FSCFOLIOPAYMENT@1.1001:GetAddOnDebitDays

ParameterTypeIn/OutOptionalDescription
addonpurchasedatCOOSYSTEM@1.1:DATETIMEin/out
debitdaysCOOSYSTEM@1.1:INTEGERretval
abostartdateCOOSYSTEM@1.1:DATETIMEouttrue
aboenddateCOOSYSTEM@1.1:DATETIMEouttrue

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:GetAddressFormated

ParameterTypeIn/OutOptionalDescription
addressFSCFOLIO@1.1001:Addressin
onelineCOOSYSTEM@1.1:BOOLEANintrue
extendedCOOSYSTEM@1.1:BOOLEANintrue
escapedCOOSYSTEM@1.1:BOOLEANintrue
formatedaddressCOOSYSTEM@1.1:STRINGLISTretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:GetAllowedDistributionBundles

Get the allowed distribution packages for a bundle purchase of an edition
ParameterTypeIn/OutOptionalDescription
intervalFSCFOLIOPAYMENT@1.1001:SubscriptionIntervalintrue the subscription interval for which the purchase is requested
currsymbolCOOSYSTEM@1.1:CurrencySymbolintrue the currency used for the purchase
allowedbundlesCOOSYSTEM@1.1:OBJECTLISTretval the available bundles

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:GetAllowedPaymentCurrencies

Get the allowed payment currencies for a contacting partner
ParameterTypeIn/OutOptionalDescription
contractingpartnerCOOSYSTEM@1.1:OBJECTintrue the contracting partner
allowedcurrenciesCOOSYSTEM@1.1:CurrencySymbolretval the allowed payment currencies

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:GetBankAccountDetails

ParameterTypeIn/OutOptionalDescription
paymentcurrencyCOOSYSTEM@1.1:CurrencySymbolin/out
contractingpartnerCOOSYSTEM@1.1:OBJECTintrue
ibanCOOSYSTEM@1.1:STRINGretval
bicCOOSYSTEM@1.1:STRINGout

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:GetBasePackages

ParameterTypeIn/OutOptionalDescription
basepackageCOOSYSTEM@1.1:OBJECTretval
basepackagesCOOSYSTEM@1.1:OBJECTLISTout
upgradepackagesCOOSYSTEM@1.1:OBJECTLISTout

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:GetBillingAddress

Evaluate personal informations of a purchaser. A purchaser could be an user or an organization.
ParameterTypeIn/OutOptionalDescription
topicCOOSYSTEM@1.1:OBJECTin
contactdataCOOSYSTEM@1.1:DICTIONARYretval dictionary containing contact data (return value)

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:GetBillingAddressFormated

ParameterTypeIn/OutOptionalDescription
addressFSCFOLIOPAYMENT@1.1001:BillingAddressin
onelineCOOSYSTEM@1.1:BOOLEANin
formatedaddressCOOSYSTEM@1.1:STRINGLISTretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:GetBillingCustomerId

Get a customer id for creating a subscription.
The customerid is a unique key caclulated using the user object.
ParameterTypeIn/OutOptionalDescription
customeridCOOSYSTEM@1.1:STRINGretval the unique id

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:GetBundlePurchaseBaseEdition

Action the get the base edition for a bundle purchase
ParameterTypeIn/OutOptionalDescription
requiretrialversionCOOSYSTEM@1.1:BOOLEANintrue the purchase is only possible the the benefit recipient is in trial mode
intervalFSCFOLIOPAYMENT@1.1001:SubscriptionIntervalintrue the subscription interval for which the purchase is requested
currsymbolCOOSYSTEM@1.1:CurrencySymbolintrue the currency used for the purchase
subscriptionCOOSYSTEM@1.1:OBJECTintrue the edtion should be taken from a specified subscription if the organization has no licensed edition
packageCOOSYSTEM@1.1:OBJECTretval the edition

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:GetConfirmationProcess

ParameterTypeIn/OutOptionalDescription
paymentmethodFSCFOLIOPAYMENT@1.1001:PaymentMethodin
isorganizationCOOSYSTEM@1.1:BOOLEANin
isresellerCOOSYSTEM@1.1:BOOLEANin
confirmationprocessCOOSYSTEM@1.1:OBJECTretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:GetContractingPartner

ParameterTypeIn/OutOptionalDescription
contractingpartnerCOOSYSTEM@1.1:OBJECTretval
nofallbackCOOSYSTEM@1.1:BOOLEANintrue

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:GetContractingPartnerByCountry

ParameterTypeIn/OutOptionalDescription
countrystringCOOSYSTEM@1.1:STRINGintrue
countryCOOSYSTEM@1.1:OBJECTintrue
contractingpartnerCOOSYSTEM@1.1:OBJECTretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:GetDeactivateShop

ParameterTypeIn/OutOptionalDescription
isorganizationCOOSYSTEM@1.1:BOOLEANin
isresellerCOOSYSTEM@1.1:BOOLEANin
deactivateshopCOOSYSTEM@1.1:BOOLEANretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:GetDefaultContractingPartner

Retrieve the default contracting partner
ParameterTypeIn/OutOptionalDescription
contractingpartnerCOOSYSTEM@1.1:OBJECTretval the contracting partner
istrialCOOSYSTEM@1.1:BOOLEANintrue set to true if the purchase is performed in the trial mode

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:GetDefaultStorage

ParameterTypeIn/OutOptionalDescription
defaultstorageCOOSYSTEM@1.1:OBJECTretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:GetEditionPurchaseName

Get the purchase name of an edition
ParameterTypeIn/OutOptionalDescription
requireuppercaseCOOSYSTEM@1.1:BOOLEANin
purchasenameCOOSYSTEM@1.1:STRINGretval the purchase name

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:GetEditionSubscription

ParameterTypeIn/OutOptionalDescription
benefitrecipientCOOSYSTEM@1.1:OBJECTin
licensedfromCOOSYSTEM@1.1:DATETIMEintrue
sublistCOOSYSTEM@1.1:OBJECTLISTretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:GetFreeGroupApps

Determine Free Cloud Apps of Organization
ParameterTypeIn/OutOptionalDescription
freegroupappsCOOSYSTEM@1.1:OBJECTLISTretval the result

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:GetFurtherPurchasePrice

ParameterTypeIn/OutOptionalDescription
productCOOSYSTEM@1.1:OBJECTin
intervalFSCFOLIOPAYMENT@1.1001:SubscriptionIntervalin
existingpurchasesCOOSYSTEM@1.1:OBJECTLISTintrue
pricenetCOOSYSTEM@1.1:Currencyretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:GetInitialPurchaseAgreement

ParameterTypeIn/OutOptionalDescription
contpartnerCOOSYSTEM@1.1:OBJECTin
requestlangCOOSYSTEM@1.1:OBJECTin
productCOOSYSTEM@1.1:OBJECTintrue
agreementCOOSYSTEM@1.1:STRINGretval
agreementstringCOOSYSTEM@1.1:OBJECTintrue
agreementobjCOOSYSTEM@1.1:OBJECTouttrue
linkCOOSYSTEM@1.1:STRINGouttrue

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:GetLastSubscriptions

ParameterTypeIn/OutOptionalDescription
paymentownerCOOSYSTEM@1.1:OBJECTin
subscriptionsCOOSYSTEM@1.1:OBJECTLISTretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:GetMinimumPurchaseAmount

ParameterTypeIn/OutOptionalDescription
amountCOOSYSTEM@1.1:INTEGERretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:GetNumeratorInitValue

Additional Information

Prototype: NUMERATOR@1.1001:ProtoGetInitValue
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:GetOrderNumberSettings

Retrieve the configured order number settings for the supplied context
ParameterTypeIn/OutOptionalDescription
contextCOOSYSTEM@1.1:OBJECTin the organization for which the order number settings should be retrieved
ordernumberCOOSYSTEM@1.1:STRINGretval the order number
reuseordernumberCOOSYSTEM@1.1:BOOLEANout defines if the order number should be reused for further purchases
ordernumberrequiredCOOSYSTEM@1.1:BOOLEANout

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:GetOrderTermsConditions

Get special General Terms and Conditions for an App or a Package
ParameterTypeIn/OutOptionalDescription
contractingpartnerCOOSYSTEM@1.1:OBJECTin
termsurlCOOSYSTEM@1.1:STRINGretval the friendly URL to the general terms and conditions
termsCOOSYSTEM@1.1:OBJECTout the general terms and conditions
perslangCOOSYSTEM@1.1:OBJECTintrue the language of the service agreements
nofallbackCOOSYSTEM@1.1:BOOLEANintrue if set to true only the customization point FSCFOLIOPAYMENT@1.1001:PaymentAGBs is considered

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:GetOrgTermination

Retrieve the organization termination object for the current organization
ParameterTypeIn/OutOptionalDescription
createnonexistingCOOSYSTEM@1.1:BOOLEANintrue
orgtermCOOSYSTEM@1.1:OBJECTretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:GetOrganizationVerificationProcess

ParameterTypeIn/OutOptionalDescription
procdefCOOSYSTEM@1.1:OBJECTretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:GetPaymentCurrency

Get the current payment currency of the customer
ParameterTypeIn/OutOptionalDescription
nofallbackCOOSYSTEM@1.1:BOOLEANin if the customer has no payment currency defined EUR will be used as fallback
paymentcurrencyCOOSYSTEM@1.1:CurrencySymbolretval the result

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:GetPaymentElementName

Calculates the name of an payment element
ParameterTypeIn/OutOptionalDescription
userlangCOOSYSTEM@1.1:OBJECTintrue language of the name
nameCOOSYSTEM@1.1:STRINGretval the name of the payment element

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:GetPaymentModalities

Retrieve the payment modalities for the current object
ParameterTypeIn/OutOptionalDescription
initpaymentmodalitiesCOOSYSTEM@1.1:BOOLEANin the new payment modalities will be created if no modalities exist
paymentmodalitiesCOOSYSTEM@1.1:OBJECTretval the result

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:GetPaymentOwner

ParameterTypeIn/OutOptionalDescription
paymentownerCOOSYSTEM@1.1:OBJECTretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:GetPaymentUserGroups

Retrieve all organizations for whom a user is the defined payment user or as additional shop user
ParameterTypeIn/OutOptionalDescription
paymentgroupsCOOSYSTEM@1.1:OBJECTLISTretval the payment groups
isresellerCOOSYSTEM@1.1:BOOLEANin the current user is a reseller
usedistributionbundleCOOSYSTEM@1.1:BOOLEANintrue the purchase is for a distribution package

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:GetPrice

Get the price and developer part of the price for a product.
ParameterTypeIn/OutOptionalDescription
intervalFSCFOLIOPAYMENT@1.1001:SubscriptionIntervalin the subscription interval for the price
quantityCOOSYSTEM@1.1:INTEGERintrue the quantity is used for discounts in the price
currsymbolCOOSYSTEM@1.1:CurrencySymbolin/outtrue
pricenetCOOSYSTEM@1.1:Currencyretval
developerpriceCOOSYSTEM@1.1:Currencyout the developer part of the price per month
trialCOOSYSTEM@1.1:BOOLEANout the product can be purchased as trial version
privateappCOOSYSTEM@1.1:BOOLEANout the product is private and can not be purchased in the Cloud App Store
allowinstCOOSYSTEM@1.1:BOOLEANout instances of the product can be purchased
alloworderCOOSYSTEM@1.1:BOOLEANout it is allowed to get an order form for this product
affiliatemarketingpartCOOSYSTEM@1.1:BOOLEANout
optionalappCOOSYSTEM@1.1:BOOLEANout
onlineshopCOOSYSTEM@1.1:BOOLEANout

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:GetPricePerInterval

Get the price and developer part of a product of an intveral. The price can be a pice price or a total price
ParameterTypeIn/OutOptionalDescription
intervalFSCFOLIOPAYMENT@1.1001:SubscriptionIntervalin
quantityCOOSYSTEM@1.1:INTEGERin
currsymbolCOOSYSTEM@1.1:CurrencySymbolin/outtrue
debitdaysCOOSYSTEM@1.1:INTEGERintrue
vatsettingsFSCFOLIOPAYMENT@1.1001:VATSettingsintrue
purchaseditemFSCFOLIOPAYMENT@1.1001:PurchaseOrderItemintrue
priceCOOSYSTEM@1.1:Currencyretval
pricenetCOOSYSTEM@1.1:Currencyout
developerpriceCOOSYSTEM@1.1:Currencyout
pricepermonthnetCOOSYSTEM@1.1:Currencyout
affiliatemarketingpartCOOSYSTEM@1.1:BOOLEANout
vatrateCOOSYSTEM@1.1:FLOATout

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:GetPriceTier

Get the price tier for a specified app or package
ParameterTypeIn/OutOptionalDescription
intervalFSCFOLIOPAYMENT@1.1001:SubscriptionIntervalin/outtrue the license interval for which the price tier should be retrieved
pricetierCOOSYSTEM@1.1:OBJECTretval the requested price tier

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:GetPriceTierAdvancedName

Get the advanced name for quick search for price tiers
ParameterTypeIn/OutOptionalDescription
advancednameCOOSYSTEM@1.1:STRINGretval the advanced name for a price tier

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:GetPriceTierListSorted

Get a filtered and sorted price tier list
ParameterTypeIn/OutOptionalDescription
pricetierlistCOOSYSTEM@1.1:OBJECTLISTretval the filtered and sorted pricetierlist

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:GetRevokeTerminateSubscriptions

Get all subscriptions for an user which can be revoked or terminated
ParameterTypeIn/OutOptionalDescription
revokeCOOSYSTEM@1.1:BOOLEANin the flag determines if subscriptions for revocation or termination should be retrieved
subscriptionsCOOSYSTEM@1.1:OBJECTLISTretval the retrieved subscriptions
nousersubsCOOSYSTEM@1.1:BOOLEANintrue ignores all user subscriptions if true

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:GetRunningSubscriptions

ParameterTypeIn/OutOptionalDescription
paymentownerCOOSYSTEM@1.1:OBJECTin
subscriptionsCOOSYSTEM@1.1:OBJECTLISTretval
includeterminatedCOOSYSTEM@1.1:BOOLEANintrue

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:GetShopStyle

Retrieve Style from CustomizationPoint PaymentStyles
ParameterTypeIn/OutOptionalDescription
contextCOOSYSTEM@1.1:OBJECTintrue
stylesCOOSYSTEM@1.1:DICTIONARYretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:GetShopURL

Get the url to the Fabsoft Cloud Shop for buying a special product
ParameterTypeIn/OutOptionalDescription
productCOOSYSTEM@1.1:STRINGin the product which is going to be purchased
intervalFSCFOLIOPAYMENT@1.1001:SubscriptionIntervalin the subscription interval
forotheruserCOOSYSTEM@1.1:BOOLEANintrue defines if the pruchase can be made for a different user
benefitrecipientCOOSYSTEM@1.1:STRINGintrue the user or group who receives the purchase (used for renewing subscriptions)
quantityCOOSYSTEM@1.1:STRINGintrue
trialCOOSYSTEM@1.1:BOOLEANintrue defines if it possible to buy a trial version
instanceCOOSYSTEM@1.1:STRINGintrue the for the instance which is going to be purchased
aborturlCOOSYSTEM@1.1:STRINGintrue the redirect url when aborting the purchase
confirmurlCOOSYSTEM@1.1:STRINGintrue the redirect url when confirming the purchase
fororganizationCOOSYSTEM@1.1:BOOLEANintrue defines if the purchase should be for an organization
urlCOOSYSTEM@1.1:STRINGretval in/out the url
usedistributionbundleCOOSYSTEM@1.1:BOOLEANintrue is set to true if the purchase is performed by a distribution bundle

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:GetStorageEdition

ParameterTypeIn/OutOptionalDescription
benefitrecipientCOOSYSTEM@1.1:OBJECTin
licensedfromCOOSYSTEM@1.1:DATETIMEintrue
storageeditionlistCOOSYSTEM@1.1:OBJECTLISTretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:GetStorageEditionSubscription

ParameterTypeIn/OutOptionalDescription
benefitrecipientCOOSYSTEM@1.1:OBJECTin
licensedfromCOOSYSTEM@1.1:DATETIMEintrue
subscrCOOSYSTEM@1.1:OBJECTretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:GetSubTransactionByCustid

ParameterTypeIn/OutOptionalDescription
transactionidCOOSYSTEM@1.1:STRINGin
errorexistingCOOSYSTEM@1.1:BOOLEANin
errornotexistingCOOSYSTEM@1.1:BOOLEANin
subtransCOOSYSTEM@1.1:OBJECTretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:GetSubscription

ParameterTypeIn/OutOptionalDescription
custidCOOSYSTEM@1.1:STRINGin
initpaymentmodalitiesCOOSYSTEM@1.1:BOOLEANin
paymentcurrencyCOOSYSTEM@1.1:CurrencySymbolintrue
subscrCOOSYSTEM@1.1:OBJECTretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:GetSubscriptionMailRecipients

ParameterTypeIn/OutOptionalDescription
mailaddressesCOOSYSTEM@1.1:STRINGLISTretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:GetSubscriptionPurchases

ParameterTypeIn/OutOptionalDescription
purchasesFSCFOLIOPAYMENT@1.1001:PurchaseOrderItemretval in/out
intervalFSCFOLIOPAYMENT@1.1001:SubscriptionIntervalintrue
scheduledpricecurrencyCOOSYSTEM@1.1:CurrencySymbolintrue

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:GetTrialSubscriptions

Get all subscriptions which are activated for trial
ParameterTypeIn/OutOptionalDescription
productsCOOSYSTEM@1.1:OBJECTLISTintrue
paymentownerCOOSYSTEM@1.1:OBJECTintrue
subscriptionsCOOSYSTEM@1.1:OBJECTLISTretval the subscriptions which are activated for trial

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:GetVATSettings

Get VAT settings for a particular combination of contracting partner and customer country
ParameterTypeIn/OutOptionalDescription
custcountryCOOSYSTEM@1.1:OBJECTin country of customer
vatsettingsFSCFOLIOPAYMENT@1.1001:VATSettingsretval VAT settings
periodfromCOOSYSTEM@1.1:DATETIMEin begin of the taxation period
periodtoCOOSYSTEM@1.1:DATETIMEintrue end of the taxation period
intervalFSCFOLIOPAYMENT@1.1001:SubscriptionIntervalintrue the interval of the subscription

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:GetValidPurchaseItems

Retrieve the currently purchased service packages for a contact and the bills for these purchases.
ParameterTypeIn/OutOptionalDescription
validitemsFSCFOLIOPAYMENT@1.1001:PurchaseItemretval the purchased service packages
userbillsCOOSYSTEM@1.1:OBJECTLISTout the bills for these purchases
paymentelemsCOOSYSTEM@1.1:OBJECTLISTout the payment elements of the bills
skipitemsCOOSYSTEM@1.1:BOOLEANintrue the validitems will not be calculated
skippaymentelemsCOOSYSTEM@1.1:BOOLEANintrue the payment element will not be calculated

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:GetVatId

ParameterTypeIn/OutOptionalDescription
contextCOOSYSTEM@1.1:OBJECTintrue
vatidCOOSYSTEM@1.1:STRINGretval
companynameCOOSYSTEM@1.1:STRINGout
vatidverifiedCOOSYSTEM@1.1:BOOLEANout

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:GrantAppLicense

Activate free apps for the current user
ParameterTypeIn/OutOptionalDescription
servicepackagesCOOSYSTEM@1.1:OBJECTLISTin
successfulactivationCOOSYSTEM@1.1:BOOLEANretval defines if activation completed successfully

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:HandleConfirmationResponse

ParameterTypeIn/OutOptionalDescription
customeridCOOSYSTEM@1.1:STRINGin
transactionidCOOSYSTEM@1.1:STRINGin
statusCOOSYSTEM@1.1:STRINGin
parameterCOOSYSTEM@1.1:DICTIONARYintrue

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:IsAdditionalShopUser

Action to check if the supplied user is an user who can perform purchases for a group
ParameterTypeIn/OutOptionalDescription
userCOOSYSTEM@1.1:OBJECTintrue the user
isshopuserCOOSYSTEM@1.1:BOOLEANretval the result

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:IsAppPurchasedBy

Checks if a certain app is purchased by a defined user for an user or group
ParameterTypeIn/OutOptionalDescription
paymentownerCOOSYSTEM@1.1:OBJECTin
benefitrecipientCOOSYSTEM@1.1:OBJECTin the user or group for whom the package has been purchased
targetisuserCOOSYSTEM@1.1:BOOLEANin the purchase is for an user
subscrCOOSYSTEM@1.1:OBJECTout the purchasing subscription
purchasedCOOSYSTEM@1.1:BOOLEANretval the return value if the app has been purchased

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:IsAvailableInOnlineShop

This action checks if a specific product is available in the online shop
ParameterTypeIn/OutOptionalDescription
intervalFSCFOLIOPAYMENT@1.1001:SubscriptionIntervalin/outtrue the suggested subscription interval
isavailableCOOSYSTEM@1.1:BOOLEANretval the result
privateappCOOSYSTEM@1.1:BOOLEANout
trialCOOSYSTEM@1.1:BOOLEANintrue

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:IsBundelPurchasePossible

Action to define if the bundle purchase is possbile for a specific app package
ParameterTypeIn/OutOptionalDescription
intervalFSCFOLIOPAYMENT@1.1001:SubscriptionIntervalintrue the subscription interval for which the purchase is requested
currsymbolCOOSYSTEM@1.1:CurrencySymbolintrue the currency used for the purchase
ispurchasepossibleCOOSYSTEM@1.1:BOOLEANretval the result

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:IsPackagePurchasedBy

Checks if a certain package or higher package is purchased by a defined user for an user or group
ParameterTypeIn/OutOptionalDescription
paymentownerCOOSYSTEM@1.1:OBJECTin the owner of the already performed purchases (owner of paymentmodalities)
benefitrecipientCOOSYSTEM@1.1:OBJECTin the user or group for whom the package has been purchased
targetisuserCOOSYSTEM@1.1:BOOLEANin the purchase is for an user
subscrCOOSYSTEM@1.1:OBJECTout the purchasing subscription
purchasedCOOSYSTEM@1.1:BOOLEANretval the return value if the package or a higher package has been purchased

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:IsPaymentMethodAllowed

ParameterTypeIn/OutOptionalDescription
paymentmethodFSCFOLIOPAYMENT@1.1001:PaymentMethodin
isorganizationCOOSYSTEM@1.1:BOOLEANin
isresellerCOOSYSTEM@1.1:BOOLEANin
userlangCOOSYSTEM@1.1:OBJECTin
methodnameCOOSYSTEM@1.1:STRINGout
allowedCOOSYSTEM@1.1:BOOLEANretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:IsPaymentUserChangeable

ParameterTypeIn/OutOptionalDescription
paymentuserCOOSYSTEM@1.1:OBJECTintrue
ischangeableCOOSYSTEM@1.1:BOOLEANretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:IsPrivilegedUser

ParameterTypeIn/OutOptionalDescription
sysadminCOOSYSTEM@1.1:BOOLEANintrue
approverCOOSYSTEM@1.1:BOOLEANintrue
salesCOOSYSTEM@1.1:BOOLEANintrue
supportCOOSYSTEM@1.1:BOOLEANintrue
financeCOOSYSTEM@1.1:BOOLEANintrue
paymentuserCOOSYSTEM@1.1:BOOLEANintrue
isprivilegedCOOSYSTEM@1.1:BOOLEANretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:IsProductAvailabelAsInstance

Checks if a certain product can be purchased as app instance
ParameterTypeIn/OutOptionalDescription
intervalFSCFOLIOPAYMENT@1.1001:SubscriptionIntervalin/outtrue the suggested subscription interval
instancepossibleCOOSYSTEM@1.1:BOOLEANretval the trialpossible

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:IsProductAvailabelForTrial

Checks if a certain product can be purchased as trial version
ParameterTypeIn/OutOptionalDescription
trialpossibleCOOSYSTEM@1.1:BOOLEANretval the trialpossible

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:IsProductAvailable

Check if a product can be purchased and if all prerequisites are fulfilled
ParameterTypeIn/OutOptionalDescription
benefitrecipientCOOSYSTEM@1.1:OBJECTin the user or group for whom the product should be purchased
paymentownerCOOSYSTEM@1.1:OBJECTin
instanceCOOSYSTEM@1.1:STRINGin the key of an instance of a product
licensedCOOSYSTEM@1.1:BOOLEANretval is true when the product has already been purchased
higherpackagelicensedCOOSYSTEM@1.1:BOOLEANout is true when a higher edition has already been purchased
highestpackageCOOSYSTEM@1.1:OBJECTout
purchasesubscriptionCOOSYSTEM@1.1:OBJECTout
licensedfortrialCOOSYSTEM@1.1:BOOLEANout

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:IsRenewal

ParameterTypeIn/OutOptionalDescription
isrenewalCOOSYSTEM@1.1:BOOLEANretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:IsReseller

ParameterTypeIn/OutOptionalDescription
purchaserinformationCOOSYSTEM@1.1:DICTIONARYintrue
resellerCOOSYSTEM@1.1:BOOLEANretval
resellerorganisationCOOSYSTEM@1.1:OBJECTout
discountrateCOOSYSTEM@1.1:FLOATouttrue
resellingorganizationCOOSYSTEM@1.1:OBJECTout

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:LicenseDefaultPackage

ParameterTypeIn/OutOptionalDescription
startdateCOOSYSTEM@1.1:DATETIMEin
enddateCOOSYSTEM@1.1:DATETIMEin

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:LicenseDefaultStorage

ParameterTypeIn/OutOptionalDescription
startdateCOOSYSTEM@1.1:DATETIMEin
enddateCOOSYSTEM@1.1:DATETIMEin

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:PrepareBill

ParameterTypeIn/OutOptionalDescription
billdateCOOSYSTEM@1.1:DATETIMEin
paymentperiodstartdateCOOSYSTEM@1.1:DATETIMEin
paymentperiodenddateCOOSYSTEM@1.1:DATETIMEin
paymentmethodFSCFOLIOPAYMENT@1.1001:PaymentMethodintrue
transbillCOOSYSTEM@1.1:OBJECTretval
subscrCOOSYSTEM@1.1:OBJECTout

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:PreparePaymentPDF

ParameterTypeIn/OutOptionalDescription
docdefCOOSYSTEM@1.1:OBJECTin
contractingpartnerCOOSYSTEM@1.1:OBJECTin
headerimgurlCOOSYSTEM@1.1:STRINGin
footerimgurlCOOSYSTEM@1.1:STRINGin
billdictCOOSYSTEM@1.1:DICTIONARYretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:ReGeneratePaymentPDF

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:RenewPaymentElements

Renew the payment elements of a subscription with the current price configured and the correct subsequent packages
ParameterTypeIn/OutOptionalDescription
customizedpricesFSCFOLIOPAYMENT@1.1001:PurchaseOrderItemintrue
elementsCOOSYSTEM@1.1:OBJECTLISTretval the new payment elements for subscription renewal

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:SavePaymentPeriod

ParameterTypeIn/OutOptionalDescription
fromCOOSYSTEM@1.1:DATETIMEin
toCOOSYSTEM@1.1:DATETIMEin
updateCOOSYSTEM@1.1:BOOLEANintrue

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:SendPaymentTransactionMail

Notification mails concerning the payment will be sent.
ParameterTypeIn/OutOptionalDescription
statusFSCFOLIOPAYMENT@1.1001:PaymentTransactionStatusin the current state of the subscription transaction
contextCOOSYSTEM@1.1:OBJECTin the of the payment notification
subjectCOOSYSTEM@1.1:STRINGin the subject of the notifcation mail
customeridCOOSYSTEM@1.1:STRINGin the customerid of the concerning subscription
transactionidCOOSYSTEM@1.1:STRINGin the id of the current subscription transaction
attachmentsCOOSYSTEM@1.1:OBJECTLISTin the attachments of the payment mail
selfservicebrandingCOOSYSTEM@1.1:OBJECTin
subscriptionCOOSYSTEM@1.1:OBJECTin

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:SendRenewalInfo

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:SortPaymentElements

ParameterTypeIn/OutOptionalDescription
elementsCOOSYSTEM@1.1:OBJECTLISTin
sortedelementsCOOSYSTEM@1.1:OBJECTLISTretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:TerminatePendingFollowers

Terminate the pending followers of a subscription

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:UpdateBillingAddress

Personal informations of a contact will be updated by values passed in the contactdict.
ParameterTypeIn/OutOptionalDescription
contactdataCOOSYSTEM@1.1:DICTIONARYin the dictionary supports the following values
  • firstname
  • surname
  • orgname
  • street
  • postofficebox
  • zipcode
  • city
  • country
  • topic
  • telephone

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:UpdateContractingPartner

Update the contracting partner of a customer
ParameterTypeIn/OutOptionalDescription
contractingpartnerCOOSYSTEM@1.1:OBJECTin the new contracting partner

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:UpdateGrLicUsage

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:UpdateGrQuotaUsage

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:UpdateOrderNumberSettings

Update the configured order number settings for the supplied context
ParameterTypeIn/OutOptionalDescription
contextCOOSYSTEM@1.1:OBJECTin the organization for which the order number settings should be updated
ordernumberCOOSYSTEM@1.1:STRINGin the order number
reuseordernumberCOOSYSTEM@1.1:BOOLEANin defines if the order number should be reused for further purchases
ordernumberrequiredCOOSYSTEM@1.1:BOOLEANintrue

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:UpdateOrganizationName

ParameterTypeIn/OutOptionalDescription
newnameCOOSYSTEM@1.1:STRINGin

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:UpdatePaymentCurrency

Update the currency of the customer
ParameterTypeIn/OutOptionalDescription
paymentcurrencyCOOSYSTEM@1.1:CurrencySymbolin the new payment currency
contractingpartnerCOOSYSTEM@1.1:OBJECTintrue the contracting partner

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:UpdateRecurringPayment

Action to renew all expiring subscriptions with recurring payment.
All expiring subscriptions without recurring payment will be notified for manual renewal.
ParameterTypeIn/OutOptionalDescription
renewalerrorsCOOSYSTEM@1.1:DICTIONARYretval
mPaySuccessCOOSYSTEM@1.1:OBJECTLISTout
mPayPendingCOOSYSTEM@1.1:OBJECTLISTout
invoiceSuccessCOOSYSTEM@1.1:OBJECTLISTout
invoiceNeedOrderNumberCOOSYSTEM@1.1:OBJECTLISTout

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOPAYMENT@1.1001:UpdateSubscription

ParameterTypeIn/OutOptionalDescription
renewCOOSYSTEM@1.1:BOOLEANin
manualCOOSYSTEM@1.1:BOOLEANin
customizedpricesFSCFOLIOPAYMENT@1.1001:PurchaseOrderItemintrue
newtransidCOOSYSTEM@1.1:STRINGintrue

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:UpdateSubscriptionsLicenses

Changes the license of apps and packages of a subscription
ParameterTypeIn/OutOptionalDescription
startdateCOOSYSTEM@1.1:DATETIMEin the date from which the apps are licensed
enddateCOOSYSTEM@1.1:DATETIMEin the date when the license expires
revokeCOOSYSTEM@1.1:BOOLEANin

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:UpdateTransactionStatus

Change the state of the subscription transaction by using response of MPay24
ParameterTypeIn/OutOptionalDescription
customeridCOOSYSTEM@1.1:STRINGin the customerid for the payment with MPay24
transactionidCOOSYSTEM@1.1:STRINGin the id of the subscription transaction used for the payment
statusFSCFOLIOPAYMENT@1.1001:PaymentTransactionStatusin the current state of the payment process supplied by MPay24
parameterCOOSYSTEM@1.1:DICTIONARYintrue the additional payment informations supplied by MPay24

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:UpdateTrialEnd

ParameterTypeIn/OutOptionalDescription
enddateCOOSYSTEM@1.1:DATETIMEintrue

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCFOLIOPAYMENT@1.1001:UpdateVatId

Update the vatid of the payment modalities
ParameterTypeIn/OutOptionalDescription
vatidCOOSYSTEM@1.1:STRINGin the vatid which should be stored
docommitCOOSYSTEM@1.1:BOOLEANin the current transaction will be commited
companynameCOOSYSTEM@1.1:STRINGintrue optional parameter for company name
vatidverifiedCOOSYSTEM@1.1:BOOLEANintrue
contextCOOSYSTEM@1.1:OBJECTintrue the group the vat id belongs to

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]