Package org.apache.fineract.client.services

Interface StandingInstructionsApi

public interface StandingInstructionsApi

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<PostStandingInstructionsResponse>	create5(StandingInstructionCreationRequest standingInstructionCreationRequest)	Create new Standing Instruction Ability to create new instruction for transfer of monetary funds from one account to another
retrofit2.Call<PostStandingInstructionsResponse>	create5(StandingInstructionCreationRequest standingInstructionCreationRequest, Map<String,String> headers)	Create new Standing Instruction Ability to create new instruction for transfer of monetary funds from one account to another
retrofit2.Call<GetStandingInstructionsResponse>	retrieveAll19(String externalId, Integer offset, Integer limit, String orderBy, String sortOrder, Integer transferType, String clientName, Long clientId, Long fromAccountId, Integer fromAccountType)	List Standing Instructions Example Requests: standinginstructions
retrofit2.Call<GetStandingInstructionsResponse>	retrieveAll19(String externalId, Integer offset, Integer limit, String orderBy, String sortOrder, Integer transferType, String clientName, Long clientId, Long fromAccountId, Integer fromAccountType, Map<String,String> headers)	List Standing Instructions Example Requests: standinginstructions
retrofit2.Call<GetStandingInstructionsStandingInstructionIdResponse>	retrieveOne10(Long standingInstructionId, String externalId, Integer offset, Integer limit, String orderBy, String sortOrder)	Retrieve Standing Instruction Example Requests : standinginstructions/1
retrofit2.Call<GetStandingInstructionsStandingInstructionIdResponse>	retrieveOne10(Long standingInstructionId, String externalId, Integer offset, Integer limit, String orderBy, String sortOrder, Map<String,String> headers)	Retrieve Standing Instruction Example Requests : standinginstructions/1
retrofit2.Call<GetStandingInstructionsTemplateResponse>	template6(Long fromOfficeId, Long fromClientId, Long fromAccountId, Integer fromAccountType, Long toOfficeId, Long toClientId, Long toAccountId, Integer toAccountType, Integer transferType)	Retrieve Standing Instruction Template This is a convenience resource.
retrofit2.Call<GetStandingInstructionsTemplateResponse>	template6(Long fromOfficeId, Long fromClientId, Long fromAccountId, Integer fromAccountType, Long toOfficeId, Long toClientId, Long toAccountId, Integer toAccountType, Integer transferType, Map<String,String> headers)	Retrieve Standing Instruction Template This is a convenience resource.
retrofit2.Call<PutStandingInstructionsStandingInstructionIdResponse>	update9(Long standingInstructionId, String command)	Update Standing Instruction | Delete Standing Instruction Ability to modify existing instruction for transfer of monetary funds from one account to another.
retrofit2.Call<PutStandingInstructionsStandingInstructionIdResponse>	update9(Long standingInstructionId, String command, Map<String,String> headers)	Update Standing Instruction | Delete Standing Instruction Ability to modify existing instruction for transfer of monetary funds from one account to another.
retrofit2.Call<PutStandingInstructionsStandingInstructionIdResponse>	update9(Long standingInstructionId, String command, StandingInstructionUpdatesRequest standingInstructionUpdatesRequest)	Update Standing Instruction | Delete Standing Instruction Ability to modify existing instruction for transfer of monetary funds from one account to another.
retrofit2.Call<PutStandingInstructionsStandingInstructionIdResponse>	update9(Long standingInstructionId, String command, StandingInstructionUpdatesRequest standingInstructionUpdatesRequest, Map<String,String> headers)	Update Standing Instruction | Delete Standing Instruction Ability to modify existing instruction for transfer of monetary funds from one account to another.

Method Details

create5

@Headers("Content-Type:application/json")
@POST("v1/standinginstructions")
retrofit2.Call<PostStandingInstructionsResponse> create5(@Body
 StandingInstructionCreationRequest standingInstructionCreationRequest)

Create new Standing Instruction Ability to create new instruction for transfer of monetary funds from one account to another

Parameters:

standingInstructionCreationRequest - (required)

Returns:

Call<PostStandingInstructionsResponse>

retrieveAll19

@GET("v1/standinginstructions")
retrofit2.Call<GetStandingInstructionsResponse> retrieveAll19(@Query("externalId")
 String externalId,
 @Query("offset")
 Integer offset,
 @Query("limit")
 Integer limit,
 @Query("orderBy")
 String orderBy,
 @Query("sortOrder")
 String sortOrder,
 @Query("transferType")
 Integer transferType,
 @Query("clientName")
 String clientName,
 @Query("clientId")
 Long clientId,
 @Query("fromAccountId")
 Long fromAccountId,
 @Query("fromAccountType")
 Integer fromAccountType)

List Standing Instructions Example Requests: standinginstructions

Parameters:

externalId - externalId (optional)

offset - offset (optional)

limit - limit (optional)

orderBy - orderBy (optional)

sortOrder - sortOrder (optional)

transferType - transferType (optional)

clientName - clientName (optional)

clientId - clientId (optional)

fromAccountId - fromAccountId (optional)

fromAccountType - fromAccountType (optional)

Returns:

Call<GetStandingInstructionsResponse>

retrieveOne10

@GET("v1/standinginstructions/{standingInstructionId}")
retrofit2.Call<GetStandingInstructionsStandingInstructionIdResponse> retrieveOne10(@Path("standingInstructionId")
 Long standingInstructionId,
 @Query("externalId")
 String externalId,
 @Query("offset")
 Integer offset,
 @Query("limit")
 Integer limit,
 @Query("orderBy")
 String orderBy,
 @Query("sortOrder")
 String sortOrder)

Retrieve Standing Instruction Example Requests : standinginstructions/1

Parameters:

standingInstructionId - standingInstructionId (required)

externalId - externalId (optional)

offset - offset (optional)

limit - limit (optional)

orderBy - orderBy (optional)

sortOrder - sortOrder (optional)

Returns:

Call<GetStandingInstructionsStandingInstructionIdResponse>

template6

@GET("v1/standinginstructions/template")
retrofit2.Call<GetStandingInstructionsTemplateResponse> template6(@Query("fromOfficeId")
 Long fromOfficeId,
 @Query("fromClientId")
 Long fromClientId,
 @Query("fromAccountId")
 Long fromAccountId,
 @Query("fromAccountType")
 Integer fromAccountType,
 @Query("toOfficeId")
 Long toOfficeId,
 @Query("toClientId")
 Long toClientId,
 @Query("toAccountId")
 Long toAccountId,
 @Query("toAccountType")
 Integer toAccountType,
 @Query("transferType")
 Integer transferType)

Retrieve Standing Instruction 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 Requests: standinginstructions/template?fromAccountType=2&fromOfficeId=1 standinginstructions/template?fromAccountType=2&fromOfficeId=1&fromClientId=1&transferType=1 standinginstructions/template?fromClientId=1&fromAccountType=2&fromAccountId=1&transferType=1

Parameters:

fromOfficeId - (optional)

fromClientId - (optional)

fromAccountId - (optional)

fromAccountType - (optional)

toOfficeId - (optional)

toClientId - (optional)

toAccountId - (optional)

toAccountType - (optional)

transferType - (optional)

Returns:

Call<GetStandingInstructionsTemplateResponse>

update9

@Headers("Content-Type:application/json")
@PUT("v1/standinginstructions/{standingInstructionId}")
retrofit2.Call<PutStandingInstructionsStandingInstructionIdResponse> update9(@Path("standingInstructionId")
 Long standingInstructionId,
 @Query("command")
 String command,
 @Body
 StandingInstructionUpdatesRequest standingInstructionUpdatesRequest)

Update Standing Instruction | Delete Standing Instruction Ability to modify existing instruction for transfer of monetary funds from one account to another. PUT https://DomainName/api/v1/standinginstructions/1?command=update Ability to modify existing instruction for transfer of monetary funds from one account to another. PUT https://DomainName/api/v1/standinginstructions/1?command=delete

Parameters:

standingInstructionId - standingInstructionId (required)

command - command (optional)

standingInstructionUpdatesRequest - (optional)

Returns:

Call<PutStandingInstructionsStandingInstructionIdResponse>

update9

@Headers("Content-Type:application/json")
@PUT("v1/standinginstructions/{standingInstructionId}")
retrofit2.Call<PutStandingInstructionsStandingInstructionIdResponse> update9(@Path("standingInstructionId")
 Long standingInstructionId,
 @Query("command")
 String command)

Update Standing Instruction | Delete Standing Instruction Ability to modify existing instruction for transfer of monetary funds from one account to another. PUT https://DomainName/api/v1/standinginstructions/1?command=update Ability to modify existing instruction for transfer of monetary funds from one account to another. PUT https://DomainName/api/v1/standinginstructions/1?command=delete

Parameters:

standingInstructionId - standingInstructionId (required)

command - command (optional)

standingInstructionUpdatesRequest - (optional)

Returns:

Call<PutStandingInstructionsStandingInstructionIdResponse>

create5

@Headers("Content-Type:application/json")
@POST("v1/standinginstructions")
retrofit2.Call<PostStandingInstructionsResponse> create5(@Body
 StandingInstructionCreationRequest standingInstructionCreationRequest,
 @HeaderMap
 Map<String,String> headers)

Create new Standing Instruction Ability to create new instruction for transfer of monetary funds from one account to another

Parameters:

standingInstructionCreationRequest - (required)

Returns:

Call<PostStandingInstructionsResponse>

retrieveAll19

@GET("v1/standinginstructions")
retrofit2.Call<GetStandingInstructionsResponse> retrieveAll19(@Query("externalId")
 String externalId,
 @Query("offset")
 Integer offset,
 @Query("limit")
 Integer limit,
 @Query("orderBy")
 String orderBy,
 @Query("sortOrder")
 String sortOrder,
 @Query("transferType")
 Integer transferType,
 @Query("clientName")
 String clientName,
 @Query("clientId")
 Long clientId,
 @Query("fromAccountId")
 Long fromAccountId,
 @Query("fromAccountType")
 Integer fromAccountType,
 @HeaderMap
 Map<String,String> headers)

List Standing Instructions Example Requests: standinginstructions

Parameters:

externalId - externalId (optional)

offset - offset (optional)

limit - limit (optional)

orderBy - orderBy (optional)

sortOrder - sortOrder (optional)

transferType - transferType (optional)

clientName - clientName (optional)

clientId - clientId (optional)

fromAccountId - fromAccountId (optional)

fromAccountType - fromAccountType (optional)

Returns:

Call<GetStandingInstructionsResponse>

retrieveOne10

@GET("v1/standinginstructions/{standingInstructionId}")
retrofit2.Call<GetStandingInstructionsStandingInstructionIdResponse> retrieveOne10(@Path("standingInstructionId")
 Long standingInstructionId,
 @Query("externalId")
 String externalId,
 @Query("offset")
 Integer offset,
 @Query("limit")
 Integer limit,
 @Query("orderBy")
 String orderBy,
 @Query("sortOrder")
 String sortOrder,
 @HeaderMap
 Map<String,String> headers)

Retrieve Standing Instruction Example Requests : standinginstructions/1

Parameters:

standingInstructionId - standingInstructionId (required)

externalId - externalId (optional)

offset - offset (optional)

limit - limit (optional)

orderBy - orderBy (optional)

sortOrder - sortOrder (optional)

Returns:

Call<GetStandingInstructionsStandingInstructionIdResponse>

template6

@GET("v1/standinginstructions/template")
retrofit2.Call<GetStandingInstructionsTemplateResponse> template6(@Query("fromOfficeId")
 Long fromOfficeId,
 @Query("fromClientId")
 Long fromClientId,
 @Query("fromAccountId")
 Long fromAccountId,
 @Query("fromAccountType")
 Integer fromAccountType,
 @Query("toOfficeId")
 Long toOfficeId,
 @Query("toClientId")
 Long toClientId,
 @Query("toAccountId")
 Long toAccountId,
 @Query("toAccountType")
 Integer toAccountType,
 @Query("transferType")
 Integer transferType,
 @HeaderMap
 Map<String,String> headers)

Retrieve Standing Instruction 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 Requests: standinginstructions/template?fromAccountType=2&fromOfficeId=1 standinginstructions/template?fromAccountType=2&fromOfficeId=1&fromClientId=1&transferType=1 standinginstructions/template?fromClientId=1&fromAccountType=2&fromAccountId=1&transferType=1

Parameters:

fromOfficeId - (optional)

fromClientId - (optional)

fromAccountId - (optional)

fromAccountType - (optional)

toOfficeId - (optional)

toClientId - (optional)

toAccountId - (optional)

toAccountType - (optional)

transferType - (optional)

Returns:

Call<GetStandingInstructionsTemplateResponse>

update9

@Headers("Content-Type:application/json")
@PUT("v1/standinginstructions/{standingInstructionId}")
retrofit2.Call<PutStandingInstructionsStandingInstructionIdResponse> update9(@Path("standingInstructionId")
 Long standingInstructionId,
 @Query("command")
 String command,
 @Body
 StandingInstructionUpdatesRequest standingInstructionUpdatesRequest,
 @HeaderMap
 Map<String,String> headers)

Update Standing Instruction | Delete Standing Instruction Ability to modify existing instruction for transfer of monetary funds from one account to another. PUT https://DomainName/api/v1/standinginstructions/1?command=update Ability to modify existing instruction for transfer of monetary funds from one account to another. PUT https://DomainName/api/v1/standinginstructions/1?command=delete

Parameters:

standingInstructionId - standingInstructionId (required)

command - command (optional)

standingInstructionUpdatesRequest - (optional)

Returns:

Call<PutStandingInstructionsStandingInstructionIdResponse>

update9

@Headers("Content-Type:application/json")
@PUT("v1/standinginstructions/{standingInstructionId}")
retrofit2.Call<PutStandingInstructionsStandingInstructionIdResponse> update9(@Path("standingInstructionId")
 Long standingInstructionId,
 @Query("command")
 String command,
 @HeaderMap
 Map<String,String> headers)

Update Standing Instruction | Delete Standing Instruction Ability to modify existing instruction for transfer of monetary funds from one account to another. PUT https://DomainName/api/v1/standinginstructions/1?command=update Ability to modify existing instruction for transfer of monetary funds from one account to another. PUT https://DomainName/api/v1/standinginstructions/1?command=delete

Parameters:

standingInstructionId - standingInstructionId (required)

command - command (optional)

standingInstructionUpdatesRequest - (optional)

Returns:

Call<PutStandingInstructionsStandingInstructionIdResponse>