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

UserGeneratedDocumentsApi

interface UserGeneratedDocumentsApi

Functions

Link copied to clipboard
abstract suspend fun createTemplate(postTemplatesRequest: PostTemplatesRequest): PostTemplatesResponse

Add a UGD Adds a new UGD. Mandatory Fields name Example Requests: templates/1 Responses:

Link copied to clipboard
abstract suspend fun deleteTemplate(templateId: Long): DeleteTemplatesTemplateIdResponse

Delete a UGD

Link copied to clipboard
abstract suspend fun getTemplateByTemplate(templateId: Long): String

Responses:

Link copied to clipboard
abstract suspend fun mergeTemplate(templateId: Long, body: String? = null): String

Responses:

Link copied to clipboard
abstract suspend fun retrieveAll40(typeId: Int? = -1, entityId: Int? = -1): GetTemplatesResponse

Retrieve all UGDs Example Requests: templates It is also possible to get specific UGDs by entity and type: templates?type=0&entity=0 Entity: Id client: 0, loan: 1 Type: Id Document: 0, E-Mail (not yet): 1, SMS: 2 Responses:

Link copied to clipboard
abstract suspend fun retrieveOne30(templateId: Long): GetTemplatesTemplateIdResponse

Retrieve a UGD Example Requests: templates/1 Responses:

Link copied to clipboard
abstract suspend fun saveTemplate(templateId: Long, putTemplatesTemplateIdRequest: PutTemplatesTemplateIdRequest): PutTemplatesTemplateIdResponse

Update a UGD

Link copied to clipboard
abstract suspend fun template20(): GetTemplatesTemplateResponse

Retrieve UGD Details Template This is a convenience resource. It can be useful when building maintenance user interface screens for UGDs. The UGD data returned consists of any or all of: ARGUMENTS name String entity String type String text String optional mappers Mapper optional Example Request: templates/template Responses: