Package org.apache.fineract.client.services

Interface AccountNumberFormatApi

public interface AccountNumberFormatApi

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<PostAccountNumberFormatsResponse>	create()	Create an Account number format Note: You may associate a single Account number format for a given account type Mandatory Fields for Account number formats accountType
retrofit2.Call<PostAccountNumberFormatsResponse>	create(Map<String,String> headers)	Create an Account number format Note: You may associate a single Account number format for a given account type Mandatory Fields for Account number formats accountType
retrofit2.Call<PostAccountNumberFormatsResponse>	create(PostAccountNumberFormatsRequest postAccountNumberFormatsRequest)	Create an Account number format Note: You may associate a single Account number format for a given account type Mandatory Fields for Account number formats accountType
retrofit2.Call<PostAccountNumberFormatsResponse>	create(PostAccountNumberFormatsRequest postAccountNumberFormatsRequest, Map<String,String> headers)	Create an Account number format Note: You may associate a single Account number format for a given account type Mandatory Fields for Account number formats accountType
retrofit2.Call<DeleteAccountNumberFormatsResponse>	delete(Long accountNumberFormatId)	Delete an Account number format Note: Account numbers created while this format was active would remain unchanged.
retrofit2.Call<DeleteAccountNumberFormatsResponse>	delete(Long accountNumberFormatId, Map<String,String> headers)	Delete an Account number format Note: Account numbers created while this format was active would remain unchanged.
retrofit2.Call<List<GetAccountNumberFormatsIdResponse>>	retrieveAll3()	List Account number formats Example Requests: accountnumberformats accountnumberformats?fields=accountType,prefixType
retrofit2.Call<List<GetAccountNumberFormatsIdResponse>>	retrieveAll3(Map<String,String> headers)	List Account number formats Example Requests: accountnumberformats accountnumberformats?fields=accountType,prefixType
retrofit2.Call<GetAccountNumberFormatsIdResponse>	retrieveOne(Long accountNumberFormatId)	Retrieve an Account number format Example Requests: accountnumberformats/1 accountnumberformats/1?template=true accountnumberformats/1?fields=accountType,prefixType
retrofit2.Call<GetAccountNumberFormatsIdResponse>	retrieveOne(Long accountNumberFormatId, Map<String,String> headers)	Retrieve an Account number format Example Requests: accountnumberformats/1 accountnumberformats/1?template=true accountnumberformats/1?fields=accountType,prefixType
retrofit2.Call<GetAccountNumberFormatsResponseTemplate>	retrieveTemplate2()	Retrieve Account number format Template This is a convenience resource.
retrofit2.Call<GetAccountNumberFormatsResponseTemplate>	retrieveTemplate2(Map<String,String> headers)	Retrieve Account number format Template This is a convenience resource.
retrofit2.Call<PutAccountNumberFormatsResponse>	update1(Long accountNumberFormatId, PutAccountNumberFormatsRequest putAccountNumberFormatsRequest)	Update an Account number format
retrofit2.Call<PutAccountNumberFormatsResponse>	update1(Long accountNumberFormatId, PutAccountNumberFormatsRequest putAccountNumberFormatsRequest, Map<String,String> headers)	Update an Account number format

Method Details

create

@Headers("Content-Type:application/json")
@POST("v1/accountnumberformats")
retrofit2.Call<PostAccountNumberFormatsResponse> create(@Body
 PostAccountNumberFormatsRequest postAccountNumberFormatsRequest)

Create an Account number format Note: You may associate a single Account number format for a given account type Mandatory Fields for Account number formats accountType

Parameters:

postAccountNumberFormatsRequest - (optional)

Returns:

Call<PostAccountNumberFormatsResponse>

delete

@DELETE("v1/accountnumberformats/{accountNumberFormatId}")
retrofit2.Call<DeleteAccountNumberFormatsResponse> delete(@Path("accountNumberFormatId")
 Long accountNumberFormatId)

Delete an Account number format Note: Account numbers created while this format was active would remain unchanged.

Parameters:

accountNumberFormatId - accountNumberFormatId (required)

Returns:

Call<DeleteAccountNumberFormatsResponse>

retrieveAll3

@GET("v1/accountnumberformats")
retrofit2.Call<List<GetAccountNumberFormatsIdResponse>> retrieveAll3()

List Account number formats Example Requests: accountnumberformats accountnumberformats?fields=accountType,prefixType

Returns:

Call<List<GetAccountNumberFormatsIdResponse>>

retrieveOne

@GET("v1/accountnumberformats/{accountNumberFormatId}")
retrofit2.Call<GetAccountNumberFormatsIdResponse> retrieveOne(@Path("accountNumberFormatId")
 Long accountNumberFormatId)

Retrieve an Account number format Example Requests: accountnumberformats/1 accountnumberformats/1?template=true accountnumberformats/1?fields=accountType,prefixType

Parameters:

accountNumberFormatId - accountNumberFormatId (required)

Returns:

Call<GetAccountNumberFormatsIdResponse>

retrieveTemplate2

@GET("v1/accountnumberformats/template")
retrofit2.Call<GetAccountNumberFormatsResponseTemplate> retrieveTemplate2()

Retrieve Account number format 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: accountnumberformats/template

Returns:

Call<GetAccountNumberFormatsResponseTemplate>

update1

@Headers("Content-Type:application/json")
@PUT("v1/accountnumberformats/{accountNumberFormatId}")
retrofit2.Call<PutAccountNumberFormatsResponse> update1(@Path("accountNumberFormatId")
 Long accountNumberFormatId,
 @Body
 PutAccountNumberFormatsRequest putAccountNumberFormatsRequest)

Update an Account number format

Parameters:

accountNumberFormatId - accountNumberFormatId (required)

putAccountNumberFormatsRequest - (required)

Returns:

Call<PutAccountNumberFormatsResponse>

create

@Headers("Content-Type:application/json")
@POST("v1/accountnumberformats")
retrofit2.Call<PostAccountNumberFormatsResponse> create()

Create an Account number format Note: You may associate a single Account number format for a given account type Mandatory Fields for Account number formats accountType

Parameters:

postAccountNumberFormatsRequest - (optional)

Returns:

Call<PostAccountNumberFormatsResponse>

create

@Headers("Content-Type:application/json")
@POST("v1/accountnumberformats")
retrofit2.Call<PostAccountNumberFormatsResponse> create(@Body
 PostAccountNumberFormatsRequest postAccountNumberFormatsRequest,
 @HeaderMap
 Map<String,String> headers)

Create an Account number format Note: You may associate a single Account number format for a given account type Mandatory Fields for Account number formats accountType

Parameters:

postAccountNumberFormatsRequest - (optional)

Returns:

Call<PostAccountNumberFormatsResponse>

delete

@DELETE("v1/accountnumberformats/{accountNumberFormatId}")
retrofit2.Call<DeleteAccountNumberFormatsResponse> delete(@Path("accountNumberFormatId")
 Long accountNumberFormatId,
 @HeaderMap
 Map<String,String> headers)

Delete an Account number format Note: Account numbers created while this format was active would remain unchanged.

Parameters:

accountNumberFormatId - accountNumberFormatId (required)

Returns:

Call<DeleteAccountNumberFormatsResponse>

retrieveAll3

@GET("v1/accountnumberformats")
retrofit2.Call<List<GetAccountNumberFormatsIdResponse>> retrieveAll3(@HeaderMap
 Map<String,String> headers)

List Account number formats Example Requests: accountnumberformats accountnumberformats?fields=accountType,prefixType

Returns:

Call<List<GetAccountNumberFormatsIdResponse>>

retrieveOne

@GET("v1/accountnumberformats/{accountNumberFormatId}")
retrofit2.Call<GetAccountNumberFormatsIdResponse> retrieveOne(@Path("accountNumberFormatId")
 Long accountNumberFormatId,
 @HeaderMap
 Map<String,String> headers)

Retrieve an Account number format Example Requests: accountnumberformats/1 accountnumberformats/1?template=true accountnumberformats/1?fields=accountType,prefixType

Parameters:

accountNumberFormatId - accountNumberFormatId (required)

Returns:

Call<GetAccountNumberFormatsIdResponse>

retrieveTemplate2

@GET("v1/accountnumberformats/template")
retrofit2.Call<GetAccountNumberFormatsResponseTemplate> retrieveTemplate2(@HeaderMap
 Map<String,String> headers)

Retrieve Account number format 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: accountnumberformats/template

Returns:

Call<GetAccountNumberFormatsResponseTemplate>

update1

@Headers("Content-Type:application/json")
@PUT("v1/accountnumberformats/{accountNumberFormatId}")
retrofit2.Call<PutAccountNumberFormatsResponse> update1(@Path("accountNumberFormatId")
 Long accountNumberFormatId,
 @Body
 PutAccountNumberFormatsRequest putAccountNumberFormatsRequest,
 @HeaderMap
 Map<String,String> headers)

Update an Account number format

Parameters:

accountNumberFormatId - accountNumberFormatId (required)

putAccountNumberFormatsRequest - (required)

Returns:

Call<PutAccountNumberFormatsResponse>

create

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

Create an Account number format Note: You may associate a single Account number format for a given account type Mandatory Fields for Account number formats accountType

Parameters:

postAccountNumberFormatsRequest - (optional)

Returns:

Call<PostAccountNumberFormatsResponse>