Package org.apache.fineract.client.services

Interface LoanCollateralApi

public interface LoanCollateralApi

  • Method Details

    • createCollateral

      @Headers("Content-Type:application/json") @POST("v1/loans/{loanId}/collaterals") retrofit2.Call<PostLoansLoanIdCollateralsResponse> createCollateral(@Path("loanId") Long loanId, @Body LoansLoanIdCollateralsRequest loansLoanIdCollateralsRequest)
      Create a Collateral Note: Currently, Collaterals may be added only before a Loan is approved
      Parameters:
      loanId - loanId (required)
      loansLoanIdCollateralsRequest - (required)
      Returns:
      Call<PostLoansLoanIdCollateralsResponse>

    • deleteCollateral

      @DELETE("v1/loans/{loanId}/collaterals/{collateralId}") retrofit2.Call<DeleteLoansLoanIdCollateralsCollateralIdResponse> deleteCollateral(@Path("loanId") Long loanId, @Path("collateralId") Long collateralId)
      Remove a Collateral Note: A collateral can only be removed from Loans that are not yet approved.
      Parameters:
      loanId - loanId (required)
      collateralId - collateralId (required)
      Returns:
      Call<DeleteLoansLoanIdCollateralsCollateralIdResponse>

    • newCollateralTemplate

      @GET("v1/loans/{loanId}/collaterals/template") retrofit2.Call<CollateralData> newCollateralTemplate(@Path("loanId") Long loanId)
      Retrieve Collateral Details Template This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed Value Lists Example Request: loans/1/collaterals/template
      Parameters:
      loanId - loanId (required)
      Returns:
      Call<CollateralData>

    • retrieveCollateralDetails

      @GET("v1/loans/{loanId}/collaterals") retrofit2.Call<List<CollateralData>> retrieveCollateralDetails(@Path("loanId") Long loanId)
      List Loan Collaterals Example Requests: loans/1/collaterals loans/1/collaterals?fields=value,description
      Parameters:
      loanId - loanId (required)
      Returns:
      Call<List<CollateralData>>

    • retrieveCollateralDetails1

      @GET("v1/loans/{loanId}/collaterals/{collateralId}") retrofit2.Call<GetLoansLoanIdCollateralsResponse> retrieveCollateralDetails1(@Path("loanId") Long loanId, @Path("collateralId") Long collateralId)
      Retrieve a Collateral Example Requests: /loans/1/collaterals/1 /loans/1/collaterals/1?fields=description,description
      Parameters:
      loanId - loanId (required)
      collateralId - collateralId (required)
      Returns:
      Call<GetLoansLoanIdCollateralsResponse>

    • updateCollateral

      @Headers("Content-Type:application/json") @PUT("v1/loans/{loanId}/collaterals/{collateralId}") retrofit2.Call<PutLoansLoanIdCollateralsCollateralIdResponse> updateCollateral(@Path("loanId") Long loanId, @Path("collateralId") Long collateralId, @Body LoansLoandIdCollateralsCollateralIdRequest loansLoandIdCollateralsCollateralIdRequest)
      Update a Collateral
      Parameters:
      loanId - loanId (required)
      collateralId - collateralId (required)
      loansLoandIdCollateralsCollateralIdRequest - (required)
      Returns:
      Call<PutLoansLoanIdCollateralsCollateralIdResponse>

    • createCollateral

      @Headers("Content-Type:application/json") @POST("v1/loans/{loanId}/collaterals") retrofit2.Call<PostLoansLoanIdCollateralsResponse> createCollateral(@Path("loanId") Long loanId, @Body LoansLoanIdCollateralsRequest loansLoanIdCollateralsRequest, @HeaderMap Map<String,String> headers)
      Create a Collateral Note: Currently, Collaterals may be added only before a Loan is approved
      Parameters:
      loanId - loanId (required)
      loansLoanIdCollateralsRequest - (required)
      Returns:
      Call<PostLoansLoanIdCollateralsResponse>

    • deleteCollateral

      @DELETE("v1/loans/{loanId}/collaterals/{collateralId}") retrofit2.Call<DeleteLoansLoanIdCollateralsCollateralIdResponse> deleteCollateral(@Path("loanId") Long loanId, @Path("collateralId") Long collateralId, @HeaderMap Map<String,String> headers)
      Remove a Collateral Note: A collateral can only be removed from Loans that are not yet approved.
      Parameters:
      loanId - loanId (required)
      collateralId - collateralId (required)
      Returns:
      Call<DeleteLoansLoanIdCollateralsCollateralIdResponse>

    • newCollateralTemplate

      @GET("v1/loans/{loanId}/collaterals/template") retrofit2.Call<CollateralData> newCollateralTemplate(@Path("loanId") Long loanId, @HeaderMap Map<String,String> headers)
      Retrieve Collateral Details Template This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed Value Lists Example Request: loans/1/collaterals/template
      Parameters:
      loanId - loanId (required)
      Returns:
      Call<CollateralData>

    • retrieveCollateralDetails

      @GET("v1/loans/{loanId}/collaterals") retrofit2.Call<List<CollateralData>> retrieveCollateralDetails(@Path("loanId") Long loanId, @HeaderMap Map<String,String> headers)
      List Loan Collaterals Example Requests: loans/1/collaterals loans/1/collaterals?fields=value,description
      Parameters:
      loanId - loanId (required)
      Returns:
      Call<List<CollateralData>>

    • retrieveCollateralDetails1

      @GET("v1/loans/{loanId}/collaterals/{collateralId}") retrofit2.Call<GetLoansLoanIdCollateralsResponse> retrieveCollateralDetails1(@Path("loanId") Long loanId, @Path("collateralId") Long collateralId, @HeaderMap Map<String,String> headers)
      Retrieve a Collateral Example Requests: /loans/1/collaterals/1 /loans/1/collaterals/1?fields=description,description
      Parameters:
      loanId - loanId (required)
      collateralId - collateralId (required)
      Returns:
      Call<GetLoansLoanIdCollateralsResponse>

    • updateCollateral

      @Headers("Content-Type:application/json") @PUT("v1/loans/{loanId}/collaterals/{collateralId}") retrofit2.Call<PutLoansLoanIdCollateralsCollateralIdResponse> updateCollateral(@Path("loanId") Long loanId, @Path("collateralId") Long collateralId, @Body LoansLoandIdCollateralsCollateralIdRequest loansLoandIdCollateralsCollateralIdRequest, @HeaderMap Map<String,String> headers)
      Update a Collateral
      Parameters:
      loanId - loanId (required)
      collateralId - collateralId (required)
      loansLoandIdCollateralsCollateralIdRequest - (required)
      Returns:
      Call<PutLoansLoanIdCollateralsCollateralIdResponse>