Package org.apache.fineract.client.services

Interface ExternalAssetOwnersApi

public interface ExternalAssetOwnersApi

  • Method Details

    • getActiveTransfer

      @GET("v1/external-asset-owners/transfers/active-transfer") retrofit2.Call<ExternalTransferData> getActiveTransfer(@Query("transferExternalId") String transferExternalId, @Query("loanId") Long loanId, @Query("loanExternalId") String loanExternalId)
      Retrieve Active Asset Owner Transfer Retrieve Active External Asset Owner Transfer by transferExternalId, loanId or loanExternalId
      Parameters:
      transferExternalId - transferExternalId (optional)
      loanId - loanId (optional)
      loanExternalId - loanExternalId (optional)
      Returns:
      Call<ExternalTransferData>

    • getJournalEntriesOfOwner

      @GET("v1/external-asset-owners/owners/external-id/{ownerExternalId}/journal-entries") retrofit2.Call<ExternalOwnerJournalEntryData> getJournalEntriesOfOwner(@Path("ownerExternalId") String ownerExternalId, @Query("offset") Integer offset, @Query("limit") Integer limit)
      Retrieve Journal Entries of Owner Retrieve Journal entries of owner by owner externalId
      Parameters:
      ownerExternalId - ownerExternalId (required)
      offset - offset (optional)
      limit - limit (optional)
      Returns:
      Call<ExternalOwnerJournalEntryData>

    • getJournalEntriesOfTransfer

      @GET("v1/external-asset-owners/transfers/{transferId}/journal-entries") retrofit2.Call<ExternalOwnerTransferJournalEntryData> getJournalEntriesOfTransfer(@Path("transferId") Long transferId, @Query("offset") Integer offset, @Query("limit") Integer limit)
      Retrieve Journal Entries of Transfer Retrieve Journal entries of transfer by transferId
      Parameters:
      transferId - transferId (required)
      offset - offset (optional)
      limit - limit (optional)
      Returns:
      Call<ExternalOwnerTransferJournalEntryData>

    • getTransfers

      @GET("v1/external-asset-owners/transfers") retrofit2.Call<PageExternalTransferData> getTransfers(@Query("transferExternalId") String transferExternalId, @Query("loanId") Long loanId, @Query("loanExternalId") String loanExternalId, @Query("offset") Integer offset, @Query("limit") Integer limit)
      Retrieve External Asset Owner Transfers Retrieve External Asset Owner Transfer items by transferExternalId, loanId or loanExternalId
      Parameters:
      transferExternalId - transferExternalId (optional)
      loanId - loanId (optional)
      loanExternalId - loanExternalId (optional)
      offset - offset (optional)
      limit - limit (optional)
      Returns:
      Call<PageExternalTransferData>

    • searchInvestorData

      @Headers("Content-Type:application/json") @POST("v1/external-asset-owners/search") retrofit2.Call<PageExternalTransferData> searchInvestorData(@Body PagedRequestExternalAssetOwnerSearchRequest pagedRequestExternalAssetOwnerSearchRequest)
      Search External Asset Owner Transfers by text or date ranges to settlement or effective dates
      Parameters:
      pagedRequestExternalAssetOwnerSearchRequest - (optional)
      Returns:
      Call<PageExternalTransferData>

    • transferRequestWithId

      @POST("v1/external-asset-owners/transfers/{id}") retrofit2.Call<PostInitiateTransferResponse> transferRequestWithId(@Path("id") Long id, @Query("command") String command)
      Parameters:
      id - (required)
      command - command (optional)
      Returns:
      Call<PostInitiateTransferResponse>

    • transferRequestWithId1

      @POST("v1/external-asset-owners/transfers/external-id/{externalId}") retrofit2.Call<PostInitiateTransferResponse> transferRequestWithId1(@Path("externalId") String externalId, @Query("command") String command)
      Parameters:
      externalId - (required)
      command - command (optional)
      Returns:
      Call<PostInitiateTransferResponse>

    • transferRequestWithLoanExternalId

      @Headers("Content-Type:application/json") @POST("v1/external-asset-owners/transfers/loans/external-id/{loanExternalId}") retrofit2.Call<PostInitiateTransferResponse> transferRequestWithLoanExternalId(@Path("loanExternalId") String loanExternalId, @Body ExternalAssetOwnerRequest externalAssetOwnerRequest, @Query("command") String command)
      Parameters:
      loanExternalId - (required)
      externalAssetOwnerRequest - (required)
      command - command (optional)
      Returns:
      Call<PostInitiateTransferResponse>

    • transferRequestWithLoanId

      @Headers("Content-Type:application/json") @POST("v1/external-asset-owners/transfers/loans/{loanId}") retrofit2.Call<PostInitiateTransferResponse> transferRequestWithLoanId(@Path("loanId") Long loanId, @Body ExternalAssetOwnerRequest externalAssetOwnerRequest, @Query("command") String command)
      Parameters:
      loanId - (required)
      externalAssetOwnerRequest - (required)
      command - command (optional)
      Returns:
      Call<PostInitiateTransferResponse>

    • searchInvestorData

      @Headers("Content-Type:application/json") @POST("v1/external-asset-owners/search") retrofit2.Call<PageExternalTransferData> searchInvestorData()
      Search External Asset Owner Transfers by text or date ranges to settlement or effective dates
      Parameters:
      pagedRequestExternalAssetOwnerSearchRequest - (optional)
      Returns:
      Call<PageExternalTransferData>

    • getActiveTransfer

      @GET("v1/external-asset-owners/transfers/active-transfer") retrofit2.Call<ExternalTransferData> getActiveTransfer(@Query("transferExternalId") String transferExternalId, @Query("loanId") Long loanId, @Query("loanExternalId") String loanExternalId, @HeaderMap Map<String,String> headers)
      Retrieve Active Asset Owner Transfer Retrieve Active External Asset Owner Transfer by transferExternalId, loanId or loanExternalId
      Parameters:
      transferExternalId - transferExternalId (optional)
      loanId - loanId (optional)
      loanExternalId - loanExternalId (optional)
      Returns:
      Call<ExternalTransferData>

    • getJournalEntriesOfOwner

      @GET("v1/external-asset-owners/owners/external-id/{ownerExternalId}/journal-entries") retrofit2.Call<ExternalOwnerJournalEntryData> getJournalEntriesOfOwner(@Path("ownerExternalId") String ownerExternalId, @Query("offset") Integer offset, @Query("limit") Integer limit, @HeaderMap Map<String,String> headers)
      Retrieve Journal Entries of Owner Retrieve Journal entries of owner by owner externalId
      Parameters:
      ownerExternalId - ownerExternalId (required)
      offset - offset (optional)
      limit - limit (optional)
      Returns:
      Call<ExternalOwnerJournalEntryData>

    • getJournalEntriesOfTransfer

      @GET("v1/external-asset-owners/transfers/{transferId}/journal-entries") retrofit2.Call<ExternalOwnerTransferJournalEntryData> getJournalEntriesOfTransfer(@Path("transferId") Long transferId, @Query("offset") Integer offset, @Query("limit") Integer limit, @HeaderMap Map<String,String> headers)
      Retrieve Journal Entries of Transfer Retrieve Journal entries of transfer by transferId
      Parameters:
      transferId - transferId (required)
      offset - offset (optional)
      limit - limit (optional)
      Returns:
      Call<ExternalOwnerTransferJournalEntryData>

    • getTransfers

      @GET("v1/external-asset-owners/transfers") retrofit2.Call<PageExternalTransferData> getTransfers(@Query("transferExternalId") String transferExternalId, @Query("loanId") Long loanId, @Query("loanExternalId") String loanExternalId, @Query("offset") Integer offset, @Query("limit") Integer limit, @HeaderMap Map<String,String> headers)
      Retrieve External Asset Owner Transfers Retrieve External Asset Owner Transfer items by transferExternalId, loanId or loanExternalId
      Parameters:
      transferExternalId - transferExternalId (optional)
      loanId - loanId (optional)
      loanExternalId - loanExternalId (optional)
      offset - offset (optional)
      limit - limit (optional)
      Returns:
      Call<PageExternalTransferData>

    • searchInvestorData

      @Headers("Content-Type:application/json") @POST("v1/external-asset-owners/search") retrofit2.Call<PageExternalTransferData> searchInvestorData(@Body PagedRequestExternalAssetOwnerSearchRequest pagedRequestExternalAssetOwnerSearchRequest, @HeaderMap Map<String,String> headers)
      Search External Asset Owner Transfers by text or date ranges to settlement or effective dates
      Parameters:
      pagedRequestExternalAssetOwnerSearchRequest - (optional)
      Returns:
      Call<PageExternalTransferData>

    • transferRequestWithId

      @POST("v1/external-asset-owners/transfers/{id}") retrofit2.Call<PostInitiateTransferResponse> transferRequestWithId(@Path("id") Long id, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Parameters:
      id - (required)
      command - command (optional)
      Returns:
      Call<PostInitiateTransferResponse>

    • transferRequestWithId1

      @POST("v1/external-asset-owners/transfers/external-id/{externalId}") retrofit2.Call<PostInitiateTransferResponse> transferRequestWithId1(@Path("externalId") String externalId, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Parameters:
      externalId - (required)
      command - command (optional)
      Returns:
      Call<PostInitiateTransferResponse>

    • transferRequestWithLoanExternalId

      @Headers("Content-Type:application/json") @POST("v1/external-asset-owners/transfers/loans/external-id/{loanExternalId}") retrofit2.Call<PostInitiateTransferResponse> transferRequestWithLoanExternalId(@Path("loanExternalId") String loanExternalId, @Body ExternalAssetOwnerRequest externalAssetOwnerRequest, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Parameters:
      loanExternalId - (required)
      externalAssetOwnerRequest - (required)
      command - command (optional)
      Returns:
      Call<PostInitiateTransferResponse>

    • transferRequestWithLoanId

      @Headers("Content-Type:application/json") @POST("v1/external-asset-owners/transfers/loans/{loanId}") retrofit2.Call<PostInitiateTransferResponse> transferRequestWithLoanId(@Path("loanId") Long loanId, @Body ExternalAssetOwnerRequest externalAssetOwnerRequest, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Parameters:
      loanId - (required)
      externalAssetOwnerRequest - (required)
      command - command (optional)
      Returns:
      Call<PostInitiateTransferResponse>

    • searchInvestorData

      @Headers("Content-Type:application/json") @POST("v1/external-asset-owners/search") retrofit2.Call<PageExternalTransferData> searchInvestorData(@HeaderMap Map<String,String> headers)
      Search External Asset Owner Transfers by text or date ranges to settlement or effective dates
      Parameters:
      pagedRequestExternalAssetOwnerSearchRequest - (optional)
      Returns:
      Call<PageExternalTransferData>