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

CodesApi

interface CodesApi

Functions

Link copied to clipboard
abstract suspend fun createCode(postCodesRequest: PostCodesRequest): PostCodesResponse

Create a Code Creates a code. Codes created through api are always 'user defined' and so system defined is marked as false. Responses:

Link copied to clipboard
abstract suspend fun deleteCode(codeId: Long): DeleteCodesResponse

Delete a Code Deletes a code if it is not system defined. Responses:

Link copied to clipboard
abstract suspend fun retrieveCode(codeId: Long): GetCodesResponse

Retrieve a Code Returns the details of a Code. Example Requests: codes/1 Responses:

Link copied to clipboard
abstract suspend fun retrieveCodes(): List<GetCodesResponse>

Retrieve Codes Returns the list of codes. Example Requests: codes Responses:

Link copied to clipboard
abstract suspend fun updateCode(codeId: Long, putCodesRequest: PutCodesRequest): PutCodesResponse

Update a Code Updates the details of a code if it is not system defined. Responses: