fineract-client/org.mifos.fineract.client.apis/ProductsApi

ProductsApi

Functions

abstract suspend fun createProduct(type: String, postProductsTypeRequest: PostProductsTypeRequest): PostProductsTypeResponse

Create a Share Product Creates a Share Product Mandatory Fields: name, shortName, description, currencyCode, digitsAfterDecimal,inMultiplesOf, locale, totalShares, unitPrice, nominalShares,allowDividendCalculationForInactiveClients,accountingRule Mandatory Fields for Cash based accounting (accountingRule = 2): shareReferenceId, shareSuspenseId, shareEquityId, incomeFromFeeAccountId Optional Fields: sharesIssued, minimumShares, maximumShares, minimumActivePeriodForDividends, minimumactiveperiodFrequencyType, lockinPeriodFrequency, lockinPeriodFrequencyType, marketPricePeriods, chargesSelected Responses:

handleCommands3

abstract suspend fun handleCommands3(type: String, productId: Long, command: String? = null): String

Responses:

retrieveAllProducts

abstract suspend fun retrieveAllProducts(type: String, offset: Int? = null, limit: Int? = null): GetProductsTypeResponse

List Share Products Lists Share Products Mandatory Fields: limit, offset Example Requests: shareproducts Responses:

retrieveProduct

abstract suspend fun retrieveProduct(productId: Long, type: String): GetProductsTypeProductIdResponse

Retrieve a Share Product Retrieves a Share Product Example Requests: products/share/1 products/share/1?template=true Responses:

retrieveTemplate13

abstract suspend fun retrieveTemplate13(type: String): String

Responses:

updateProduct

abstract suspend fun updateProduct(type: String, productId: Long, putProductsTypeProductIdRequest: PutProductsTypeProductIdRequest): PutProductsTypeProductIdResponse

Update a Share Product Updates a Share Product Responses: