Package org.apache.fineract.client.services

Interface ProvisioningEntriesApi

public interface ProvisioningEntriesApi

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<PostProvisioningEntriesResponse>	createProvisioningEntries()	Create new Provisioning Entries Creates a new Provisioning Entries Mandatory Fields date dateFormat locale Optional Fields createjournalentries
retrofit2.Call<PostProvisioningEntriesResponse>	createProvisioningEntries(Map<String,String> headers)	Create new Provisioning Entries Creates a new Provisioning Entries Mandatory Fields date dateFormat locale Optional Fields createjournalentries
retrofit2.Call<PostProvisioningEntriesResponse>	createProvisioningEntries(ProvisionEntryRequest provisionEntryRequest)	Create new Provisioning Entries Creates a new Provisioning Entries Mandatory Fields date dateFormat locale Optional Fields createjournalentries
retrofit2.Call<PostProvisioningEntriesResponse>	createProvisioningEntries(ProvisionEntryRequest provisionEntryRequest, Map<String,String> headers)	Create new Provisioning Entries Creates a new Provisioning Entries Mandatory Fields date dateFormat locale Optional Fields createjournalentries
retrofit2.Call<PutProvisioningEntriesResponse>	modifyProvisioningEntry(Long entryId, String command)	Recreates Provisioning Entry Recreates Provisioning Entry | createjournalentry.
retrofit2.Call<PutProvisioningEntriesResponse>	modifyProvisioningEntry(Long entryId, String command, Map<String,String> headers)	Recreates Provisioning Entry Recreates Provisioning Entry | createjournalentry.
retrofit2.Call<PutProvisioningEntriesResponse>	modifyProvisioningEntry(Long entryId, String command, PutProvisioningEntriesRequest putProvisioningEntriesRequest)	Recreates Provisioning Entry Recreates Provisioning Entry | createjournalentry.
retrofit2.Call<PutProvisioningEntriesResponse>	modifyProvisioningEntry(Long entryId, String command, PutProvisioningEntriesRequest putProvisioningEntriesRequest, Map<String,String> headers)	Recreates Provisioning Entry Recreates Provisioning Entry | createjournalentry.
retrofit2.Call<PageProvisioningEntryData>	retrieveAllProvisioningEntries(Integer offset, Integer limit)	List all Provisioning Entries
retrofit2.Call<PageProvisioningEntryData>	retrieveAllProvisioningEntries(Integer offset, Integer limit, Map<String,String> headers)	List all Provisioning Entries
retrofit2.Call<PageLoanProductProvisioningEntryData>	retrieveProviioningEntries(Long entryId, Integer offset, Integer limit, Long officeId, Long productId, Long categoryId)
retrofit2.Call<PageLoanProductProvisioningEntryData>	retrieveProviioningEntries(Long entryId, Integer offset, Integer limit, Long officeId, Long productId, Long categoryId, Map<String,String> headers)
retrofit2.Call<ProvisioningEntryData>	retrieveProvisioningEntry(Long entryId)	Retrieves a Provisioning Entry Returns the details of a generated Provisioning Entry.
retrofit2.Call<ProvisioningEntryData>	retrieveProvisioningEntry(Long entryId, Map<String,String> headers)	Retrieves a Provisioning Entry Returns the details of a generated Provisioning Entry.

Method Details

createProvisioningEntries

@Headers("Content-Type:application/json")
@POST("v1/provisioningentries")
retrofit2.Call<PostProvisioningEntriesResponse> createProvisioningEntries(@Body
 ProvisionEntryRequest provisionEntryRequest)

Create new Provisioning Entries Creates a new Provisioning Entries Mandatory Fields date dateFormat locale Optional Fields createjournalentries

Parameters:

provisionEntryRequest - (optional)

Returns:

Call<PostProvisioningEntriesResponse>

modifyProvisioningEntry

@Headers("Content-Type:application/json")
@POST("v1/provisioningentries/{entryId}")
retrofit2.Call<PutProvisioningEntriesResponse> modifyProvisioningEntry(@Path("entryId")
 Long entryId,
 @Query("command")
 String command,
 @Body
 PutProvisioningEntriesRequest putProvisioningEntriesRequest)

Recreates Provisioning Entry Recreates Provisioning Entry | createjournalentry.

Parameters:

entryId - entryId (required)

command - command=createjournalentry command=recreateprovisioningentry (optional)

putProvisioningEntriesRequest - (optional)

Returns:

Call<PutProvisioningEntriesResponse>

retrieveAllProvisioningEntries

@GET("v1/provisioningentries")
retrofit2.Call<PageProvisioningEntryData> retrieveAllProvisioningEntries(@Query("offset")
 Integer offset,
 @Query("limit")
 Integer limit)

List all Provisioning Entries

Parameters:

offset - offset (optional)

limit - limit (optional)

Returns:

Call<PageProvisioningEntryData>

retrieveProviioningEntries

@GET("v1/provisioningentries/entries")
retrofit2.Call<PageLoanProductProvisioningEntryData> retrieveProviioningEntries(@Query("entryId")
 Long entryId,
 @Query("offset")
 Integer offset,
 @Query("limit")
 Integer limit,
 @Query("officeId")
 Long officeId,
 @Query("productId")
 Long productId,
 @Query("categoryId")
 Long categoryId)

Parameters:

entryId - (optional)

offset - (optional)

limit - (optional)

officeId - (optional)

productId - (optional)

categoryId - (optional)

Returns:

Call<PageLoanProductProvisioningEntryData>

retrieveProvisioningEntry

@GET("v1/provisioningentries/{entryId}")
retrofit2.Call<ProvisioningEntryData> retrieveProvisioningEntry(@Path("entryId")
 Long entryId)

Retrieves a Provisioning Entry Returns the details of a generated Provisioning Entry.

Parameters:

entryId - entryId (required)

Returns:

Call<ProvisioningEntryData>

createProvisioningEntries

@Headers("Content-Type:application/json")
@POST("v1/provisioningentries")
retrofit2.Call<PostProvisioningEntriesResponse> createProvisioningEntries()

Create new Provisioning Entries Creates a new Provisioning Entries Mandatory Fields date dateFormat locale Optional Fields createjournalentries

Parameters:

provisionEntryRequest - (optional)

Returns:

Call<PostProvisioningEntriesResponse>

modifyProvisioningEntry

@Headers("Content-Type:application/json")
@POST("v1/provisioningentries/{entryId}")
retrofit2.Call<PutProvisioningEntriesResponse> modifyProvisioningEntry(@Path("entryId")
 Long entryId,
 @Query("command")
 String command)

Recreates Provisioning Entry Recreates Provisioning Entry | createjournalentry.

Parameters:

entryId - entryId (required)

command - command=createjournalentry command=recreateprovisioningentry (optional)

putProvisioningEntriesRequest - (optional)

Returns:

Call<PutProvisioningEntriesResponse>

createProvisioningEntries

@Headers("Content-Type:application/json")
@POST("v1/provisioningentries")
retrofit2.Call<PostProvisioningEntriesResponse> createProvisioningEntries(@Body
 ProvisionEntryRequest provisionEntryRequest,
 @HeaderMap
 Map<String,String> headers)

Create new Provisioning Entries Creates a new Provisioning Entries Mandatory Fields date dateFormat locale Optional Fields createjournalentries

Parameters:

provisionEntryRequest - (optional)

Returns:

Call<PostProvisioningEntriesResponse>

modifyProvisioningEntry

@Headers("Content-Type:application/json")
@POST("v1/provisioningentries/{entryId}")
retrofit2.Call<PutProvisioningEntriesResponse> modifyProvisioningEntry(@Path("entryId")
 Long entryId,
 @Query("command")
 String command,
 @Body
 PutProvisioningEntriesRequest putProvisioningEntriesRequest,
 @HeaderMap
 Map<String,String> headers)

Recreates Provisioning Entry Recreates Provisioning Entry | createjournalentry.

Parameters:

entryId - entryId (required)

command - command=createjournalentry command=recreateprovisioningentry (optional)

putProvisioningEntriesRequest - (optional)

Returns:

Call<PutProvisioningEntriesResponse>

retrieveAllProvisioningEntries

@GET("v1/provisioningentries")
retrofit2.Call<PageProvisioningEntryData> retrieveAllProvisioningEntries(@Query("offset")
 Integer offset,
 @Query("limit")
 Integer limit,
 @HeaderMap
 Map<String,String> headers)

List all Provisioning Entries

Parameters:

offset - offset (optional)

limit - limit (optional)

Returns:

Call<PageProvisioningEntryData>

retrieveProviioningEntries

@GET("v1/provisioningentries/entries")
retrofit2.Call<PageLoanProductProvisioningEntryData> retrieveProviioningEntries(@Query("entryId")
 Long entryId,
 @Query("offset")
 Integer offset,
 @Query("limit")
 Integer limit,
 @Query("officeId")
 Long officeId,
 @Query("productId")
 Long productId,
 @Query("categoryId")
 Long categoryId,
 @HeaderMap
 Map<String,String> headers)

Parameters:

entryId - (optional)

offset - (optional)

limit - (optional)

officeId - (optional)

productId - (optional)

categoryId - (optional)

Returns:

Call<PageLoanProductProvisioningEntryData>

retrieveProvisioningEntry

@GET("v1/provisioningentries/{entryId}")
retrofit2.Call<ProvisioningEntryData> retrieveProvisioningEntry(@Path("entryId")
 Long entryId,
 @HeaderMap
 Map<String,String> headers)

Retrieves a Provisioning Entry Returns the details of a generated Provisioning Entry.

Parameters:

entryId - entryId (required)

Returns:

Call<ProvisioningEntryData>

createProvisioningEntries

@Headers("Content-Type:application/json")
@POST("v1/provisioningentries")
retrofit2.Call<PostProvisioningEntriesResponse> createProvisioningEntries(@HeaderMap
 Map<String,String> headers)

Create new Provisioning Entries Creates a new Provisioning Entries Mandatory Fields date dateFormat locale Optional Fields createjournalentries

Parameters:

provisionEntryRequest - (optional)

Returns:

Call<PostProvisioningEntriesResponse>

modifyProvisioningEntry

@Headers("Content-Type:application/json")
@POST("v1/provisioningentries/{entryId}")
retrofit2.Call<PutProvisioningEntriesResponse> modifyProvisioningEntry(@Path("entryId")
 Long entryId,
 @Query("command")
 String command,
 @HeaderMap
 Map<String,String> headers)

Recreates Provisioning Entry Recreates Provisioning Entry | createjournalentry.

Parameters:

entryId - entryId (required)

command - command=createjournalentry command=recreateprovisioningentry (optional)

putProvisioningEntriesRequest - (optional)

Returns:

Call<PutProvisioningEntriesResponse>