Interface TellerCashManagementApi


public interface TellerCashManagementApi
  • Method Details

    • allocateCashToCashier

      @Headers("Content-Type:application/json") @POST("v1/tellers/{tellerId}/cashiers/{cashierId}/allocate") retrofit2.Call<PostTellersTellerIdCashiersCashierIdAllocateResponse> allocateCashToCashier(@Path("tellerId") Long tellerId, @Path("cashierId") Long cashierId, @Body PostTellersTellerIdCashiersCashierIdAllocateRequest postTellersTellerIdCashiersCashierIdAllocateRequest)
      Allocate Cash To Cashier Mandatory Fields: Date, Amount, Currency, Notes/Comments
      Parameters:
      tellerId - tellerId (required)
      cashierId - cashierId (required)
      postTellersTellerIdCashiersCashierIdAllocateRequest - (required)
      Returns:
      Call<PostTellersTellerIdCashiersCashierIdAllocateResponse>
    • createCashier

      @Headers("Content-Type:application/json") @POST("v1/tellers/{tellerId}/cashiers") retrofit2.Call<PostTellersTellerIdCashiersResponse> createCashier(@Path("tellerId") Long tellerId, @Body PostTellersTellerIdCashiersRequest postTellersTellerIdCashiersRequest)
      Create Cashiers Mandatory Fields: Cashier/staff, Fromm Date, To Date, Full Day or From time and To time Optional Fields: Description/Notes
      Parameters:
      tellerId - tellerId (required)
      postTellersTellerIdCashiersRequest - (required)
      Returns:
      Call<PostTellersTellerIdCashiersResponse>
    • createTeller

      @Headers("Content-Type:application/json") @POST("v1/tellers") retrofit2.Call<PostTellersResponse> createTeller(@Body PostTellersRequest postTellersRequest)
      Create teller Mandatory Fields Teller name, OfficeId, Description, Start Date, Status Optional Fields End Date
      Parameters:
      postTellersRequest - (required)
      Returns:
      Call<PostTellersResponse>
    • deleteCashier

      @DELETE("v1/tellers/{tellerId}/cashiers/{cashierId}") retrofit2.Call<DeleteTellersTellerIdCashiersCashierIdResponse> deleteCashier(@Path("tellerId") Long tellerId, @Path("cashierId") Long cashierId)
      Delete Cashier
      Parameters:
      tellerId - tellerId (required)
      cashierId - cashierId (required)
      Returns:
      Call<DeleteTellersTellerIdCashiersCashierIdResponse>
    • deleteTeller

      @DELETE("v1/tellers/{tellerId}") retrofit2.Call<CommandProcessingResult> deleteTeller(@Path("tellerId") Long tellerId)
      Parameters:
      tellerId - tellerId (required)
      Returns:
      Call<CommandProcessingResult>
    • findCashierData

      @GET("v1/tellers/{tellerId}/cashiers/{cashierId}") retrofit2.Call<GetTellersTellerIdCashiersCashierIdResponse> findCashierData(@Path("tellerId") Long tellerId, @Path("cashierId") Long cashierId)
      Retrieve a cashier
      Parameters:
      tellerId - tellerId (required)
      cashierId - cashierId (required)
      Returns:
      Call<GetTellersTellerIdCashiersCashierIdResponse>
    • findTeller

      @GET("v1/tellers/{tellerId}") retrofit2.Call<GetTellersResponse> findTeller(@Path("tellerId") Long tellerId)
      Retrieve tellers
      Parameters:
      tellerId - tellerId (required)
      Returns:
      Call<GetTellersResponse>
    • findTransactionData

      @GET("v1/tellers/{tellerId}/transactions/{transactionId}") retrofit2.Call<TellerTransactionData> findTransactionData(@Path("tellerId") Long tellerId, @Path("transactionId") Long transactionId)
      Parameters:
      tellerId - tellerId (required)
      transactionId - transactionId (required)
      Returns:
      Call<TellerTransactionData>
    • getCashierData1

      @GET("v1/tellers/{tellerId}/cashiers") retrofit2.Call<GetTellersTellerIdCashiersResponse> getCashierData1(@Path("tellerId") Long tellerId, @Query("fromdate") String fromdate, @Query("todate") String todate)
      List Cashiers
      Parameters:
      tellerId - tellerId (required)
      fromdate - fromdate (optional)
      todate - todate (optional)
      Returns:
      Call<GetTellersTellerIdCashiersResponse>
    • getCashierTemplate

      @GET("v1/tellers/{tellerId}/cashiers/template") retrofit2.Call<GetTellersTellerIdCashiersTemplateResponse> getCashierTemplate(@Path("tellerId") Long tellerId)
      Find Cashiers
      Parameters:
      tellerId - tellerId (required)
      Returns:
      Call<GetTellersTellerIdCashiersTemplateResponse>
    • getCashierTxnTemplate

      @GET("v1/tellers/{tellerId}/cashiers/{cashierId}/transactions/template") retrofit2.Call<GetTellersTellerIdCashiersCashiersIdTransactionsTemplateResponse> getCashierTxnTemplate(@Path("tellerId") Long tellerId, @Path("cashierId") Long cashierId)
      Retrieve Cashier Transaction Template
      Parameters:
      tellerId - tellerId (required)
      cashierId - cashierId (required)
      Returns:
      Call<GetTellersTellerIdCashiersCashiersIdTransactionsTemplateResponse>
    • getJournalData

      @GET("v1/tellers/{tellerId}/journals") retrofit2.Call<List<TellerJournalData>> getJournalData(@Path("tellerId") Long tellerId, @Query("cashierId") Long cashierId, @Query("dateRange") String dateRange)
      Parameters:
      tellerId - tellerId (required)
      cashierId - cashierId (optional)
      dateRange - dateRange (optional)
      Returns:
      Call<List<TellerJournalData>>
    • getTellerData

      @GET("v1/tellers") retrofit2.Call<List<GetTellersResponse>> getTellerData(@Query("officeId") Long officeId)
      List all tellers Retrieves list tellers
      Parameters:
      officeId - officeId (optional)
      Returns:
      Call<List<GetTellersResponse>>
    • getTransactionData

      @GET("v1/tellers/{tellerId}/transactions") retrofit2.Call<List<TellerTransactionData>> getTransactionData(@Path("tellerId") Long tellerId, @Query("dateRange") String dateRange)
      Parameters:
      tellerId - tellerId (required)
      dateRange - dateRange (optional)
      Returns:
      Call<List<TellerTransactionData>>
    • getTransactionsForCashier

      @GET("v1/tellers/{tellerId}/cashiers/{cashierId}/transactions") retrofit2.Call<GetTellersTellerIdCashiersCashiersIdTransactionsResponse> getTransactionsForCashier(@Path("tellerId") Long tellerId, @Path("cashierId") Long cashierId, @Query("currencyCode") String currencyCode, @Query("offset") Integer offset, @Query("limit") Integer limit, @Query("orderBy") String orderBy, @Query("sortOrder") String sortOrder)
      Retrieve Cashier Transactions
      Parameters:
      tellerId - tellerId (required)
      cashierId - cashierId (required)
      currencyCode - currencyCode (optional)
      offset - offset (optional)
      limit - limit (optional)
      orderBy - orderBy (optional)
      sortOrder - sortOrder (optional)
      Returns:
      Call<GetTellersTellerIdCashiersCashiersIdTransactionsResponse>
    • getTransactionsWithSummaryForCashier

      @GET("v1/tellers/{tellerId}/cashiers/{cashierId}/summaryandtransactions") retrofit2.Call<GetTellersTellerIdCashiersCashiersIdSummaryAndTransactionsResponse> getTransactionsWithSummaryForCashier(@Path("tellerId") Long tellerId, @Path("cashierId") Long cashierId, @Query("currencyCode") String currencyCode, @Query("offset") Integer offset, @Query("limit") Integer limit, @Query("orderBy") String orderBy, @Query("sortOrder") String sortOrder)
      Retrieve Transactions With Summary For Cashier
      Parameters:
      tellerId - tellerId (required)
      cashierId - cashierId (required)
      currencyCode - currencyCode (optional)
      offset - offset (optional)
      limit - limit (optional)
      orderBy - orderBy (optional)
      sortOrder - sortOrder (optional)
      Returns:
      Call<GetTellersTellerIdCashiersCashiersIdSummaryAndTransactionsResponse>
    • settleCashFromCashier

      @Headers("Content-Type:application/json") @POST("v1/tellers/{tellerId}/cashiers/{cashierId}/settle") retrofit2.Call<PostTellersTellerIdCashiersCashierIdSettleResponse> settleCashFromCashier(@Path("tellerId") Long tellerId, @Path("cashierId") Long cashierId, @Body PostTellersTellerIdCashiersCashierIdSettleRequest postTellersTellerIdCashiersCashierIdSettleRequest)
      Settle Cash From Cashier Mandatory Fields Date, Amount, Currency, Notes/Comments
      Parameters:
      tellerId - tellerId (required)
      cashierId - cashierId (required)
      postTellersTellerIdCashiersCashierIdSettleRequest - (required)
      Returns:
      Call<PostTellersTellerIdCashiersCashierIdSettleResponse>
    • updateCashier

      @Headers("Content-Type:application/json") @PUT("v1/tellers/{tellerId}/cashiers/{cashierId}") retrofit2.Call<PutTellersTellerIdCashiersCashierIdResponse> updateCashier(@Path("tellerId") Long tellerId, @Path("cashierId") Long cashierId, @Body PutTellersTellerIdCashiersCashierIdRequest putTellersTellerIdCashiersCashierIdRequest)
      Update Cashier
      Parameters:
      tellerId - tellerId (required)
      cashierId - cashierId (required)
      putTellersTellerIdCashiersCashierIdRequest - (required)
      Returns:
      Call<PutTellersTellerIdCashiersCashierIdResponse>
    • updateTeller

      @Headers("Content-Type:application/json") @PUT("v1/tellers/{tellerId}") retrofit2.Call<PutTellersResponse> updateTeller(@Path("tellerId") Long tellerId, @Body PutTellersRequest putTellersRequest)
      Update teller
      Parameters:
      tellerId - tellerId (required)
      putTellersRequest - (required)
      Returns:
      Call<PutTellersResponse>
    • allocateCashToCashier

      @Headers("Content-Type:application/json") @POST("v1/tellers/{tellerId}/cashiers/{cashierId}/allocate") retrofit2.Call<PostTellersTellerIdCashiersCashierIdAllocateResponse> allocateCashToCashier(@Path("tellerId") Long tellerId, @Path("cashierId") Long cashierId, @Body PostTellersTellerIdCashiersCashierIdAllocateRequest postTellersTellerIdCashiersCashierIdAllocateRequest, @HeaderMap Map<String,String> headers)
      Allocate Cash To Cashier Mandatory Fields: Date, Amount, Currency, Notes/Comments
      Parameters:
      tellerId - tellerId (required)
      cashierId - cashierId (required)
      postTellersTellerIdCashiersCashierIdAllocateRequest - (required)
      Returns:
      Call<PostTellersTellerIdCashiersCashierIdAllocateResponse>
    • createCashier

      @Headers("Content-Type:application/json") @POST("v1/tellers/{tellerId}/cashiers") retrofit2.Call<PostTellersTellerIdCashiersResponse> createCashier(@Path("tellerId") Long tellerId, @Body PostTellersTellerIdCashiersRequest postTellersTellerIdCashiersRequest, @HeaderMap Map<String,String> headers)
      Create Cashiers Mandatory Fields: Cashier/staff, Fromm Date, To Date, Full Day or From time and To time Optional Fields: Description/Notes
      Parameters:
      tellerId - tellerId (required)
      postTellersTellerIdCashiersRequest - (required)
      Returns:
      Call<PostTellersTellerIdCashiersResponse>
    • createTeller

      @Headers("Content-Type:application/json") @POST("v1/tellers") retrofit2.Call<PostTellersResponse> createTeller(@Body PostTellersRequest postTellersRequest, @HeaderMap Map<String,String> headers)
      Create teller Mandatory Fields Teller name, OfficeId, Description, Start Date, Status Optional Fields End Date
      Parameters:
      postTellersRequest - (required)
      Returns:
      Call<PostTellersResponse>
    • deleteCashier

      @DELETE("v1/tellers/{tellerId}/cashiers/{cashierId}") retrofit2.Call<DeleteTellersTellerIdCashiersCashierIdResponse> deleteCashier(@Path("tellerId") Long tellerId, @Path("cashierId") Long cashierId, @HeaderMap Map<String,String> headers)
      Delete Cashier
      Parameters:
      tellerId - tellerId (required)
      cashierId - cashierId (required)
      Returns:
      Call<DeleteTellersTellerIdCashiersCashierIdResponse>
    • deleteTeller

      @DELETE("v1/tellers/{tellerId}") retrofit2.Call<CommandProcessingResult> deleteTeller(@Path("tellerId") Long tellerId, @HeaderMap Map<String,String> headers)
      Parameters:
      tellerId - tellerId (required)
      Returns:
      Call<CommandProcessingResult>
    • findCashierData

      @GET("v1/tellers/{tellerId}/cashiers/{cashierId}") retrofit2.Call<GetTellersTellerIdCashiersCashierIdResponse> findCashierData(@Path("tellerId") Long tellerId, @Path("cashierId") Long cashierId, @HeaderMap Map<String,String> headers)
      Retrieve a cashier
      Parameters:
      tellerId - tellerId (required)
      cashierId - cashierId (required)
      Returns:
      Call<GetTellersTellerIdCashiersCashierIdResponse>
    • findTeller

      @GET("v1/tellers/{tellerId}") retrofit2.Call<GetTellersResponse> findTeller(@Path("tellerId") Long tellerId, @HeaderMap Map<String,String> headers)
      Retrieve tellers
      Parameters:
      tellerId - tellerId (required)
      Returns:
      Call<GetTellersResponse>
    • findTransactionData

      @GET("v1/tellers/{tellerId}/transactions/{transactionId}") retrofit2.Call<TellerTransactionData> findTransactionData(@Path("tellerId") Long tellerId, @Path("transactionId") Long transactionId, @HeaderMap Map<String,String> headers)
      Parameters:
      tellerId - tellerId (required)
      transactionId - transactionId (required)
      Returns:
      Call<TellerTransactionData>
    • getCashierData1

      @GET("v1/tellers/{tellerId}/cashiers") retrofit2.Call<GetTellersTellerIdCashiersResponse> getCashierData1(@Path("tellerId") Long tellerId, @Query("fromdate") String fromdate, @Query("todate") String todate, @HeaderMap Map<String,String> headers)
      List Cashiers
      Parameters:
      tellerId - tellerId (required)
      fromdate - fromdate (optional)
      todate - todate (optional)
      Returns:
      Call<GetTellersTellerIdCashiersResponse>
    • getCashierTemplate

      @GET("v1/tellers/{tellerId}/cashiers/template") retrofit2.Call<GetTellersTellerIdCashiersTemplateResponse> getCashierTemplate(@Path("tellerId") Long tellerId, @HeaderMap Map<String,String> headers)
      Find Cashiers
      Parameters:
      tellerId - tellerId (required)
      Returns:
      Call<GetTellersTellerIdCashiersTemplateResponse>
    • getCashierTxnTemplate

      @GET("v1/tellers/{tellerId}/cashiers/{cashierId}/transactions/template") retrofit2.Call<GetTellersTellerIdCashiersCashiersIdTransactionsTemplateResponse> getCashierTxnTemplate(@Path("tellerId") Long tellerId, @Path("cashierId") Long cashierId, @HeaderMap Map<String,String> headers)
      Retrieve Cashier Transaction Template
      Parameters:
      tellerId - tellerId (required)
      cashierId - cashierId (required)
      Returns:
      Call<GetTellersTellerIdCashiersCashiersIdTransactionsTemplateResponse>
    • getJournalData

      @GET("v1/tellers/{tellerId}/journals") retrofit2.Call<List<TellerJournalData>> getJournalData(@Path("tellerId") Long tellerId, @Query("cashierId") Long cashierId, @Query("dateRange") String dateRange, @HeaderMap Map<String,String> headers)
      Parameters:
      tellerId - tellerId (required)
      cashierId - cashierId (optional)
      dateRange - dateRange (optional)
      Returns:
      Call<List<TellerJournalData>>
    • getTellerData

      @GET("v1/tellers") retrofit2.Call<List<GetTellersResponse>> getTellerData(@Query("officeId") Long officeId, @HeaderMap Map<String,String> headers)
      List all tellers Retrieves list tellers
      Parameters:
      officeId - officeId (optional)
      Returns:
      Call<List<GetTellersResponse>>
    • getTransactionData

      @GET("v1/tellers/{tellerId}/transactions") retrofit2.Call<List<TellerTransactionData>> getTransactionData(@Path("tellerId") Long tellerId, @Query("dateRange") String dateRange, @HeaderMap Map<String,String> headers)
      Parameters:
      tellerId - tellerId (required)
      dateRange - dateRange (optional)
      Returns:
      Call<List<TellerTransactionData>>
    • getTransactionsForCashier

      @GET("v1/tellers/{tellerId}/cashiers/{cashierId}/transactions") retrofit2.Call<GetTellersTellerIdCashiersCashiersIdTransactionsResponse> getTransactionsForCashier(@Path("tellerId") Long tellerId, @Path("cashierId") Long cashierId, @Query("currencyCode") String currencyCode, @Query("offset") Integer offset, @Query("limit") Integer limit, @Query("orderBy") String orderBy, @Query("sortOrder") String sortOrder, @HeaderMap Map<String,String> headers)
      Retrieve Cashier Transactions
      Parameters:
      tellerId - tellerId (required)
      cashierId - cashierId (required)
      currencyCode - currencyCode (optional)
      offset - offset (optional)
      limit - limit (optional)
      orderBy - orderBy (optional)
      sortOrder - sortOrder (optional)
      Returns:
      Call<GetTellersTellerIdCashiersCashiersIdTransactionsResponse>
    • getTransactionsWithSummaryForCashier

      @GET("v1/tellers/{tellerId}/cashiers/{cashierId}/summaryandtransactions") retrofit2.Call<GetTellersTellerIdCashiersCashiersIdSummaryAndTransactionsResponse> getTransactionsWithSummaryForCashier(@Path("tellerId") Long tellerId, @Path("cashierId") Long cashierId, @Query("currencyCode") String currencyCode, @Query("offset") Integer offset, @Query("limit") Integer limit, @Query("orderBy") String orderBy, @Query("sortOrder") String sortOrder, @HeaderMap Map<String,String> headers)
      Retrieve Transactions With Summary For Cashier
      Parameters:
      tellerId - tellerId (required)
      cashierId - cashierId (required)
      currencyCode - currencyCode (optional)
      offset - offset (optional)
      limit - limit (optional)
      orderBy - orderBy (optional)
      sortOrder - sortOrder (optional)
      Returns:
      Call<GetTellersTellerIdCashiersCashiersIdSummaryAndTransactionsResponse>
    • settleCashFromCashier

      @Headers("Content-Type:application/json") @POST("v1/tellers/{tellerId}/cashiers/{cashierId}/settle") retrofit2.Call<PostTellersTellerIdCashiersCashierIdSettleResponse> settleCashFromCashier(@Path("tellerId") Long tellerId, @Path("cashierId") Long cashierId, @Body PostTellersTellerIdCashiersCashierIdSettleRequest postTellersTellerIdCashiersCashierIdSettleRequest, @HeaderMap Map<String,String> headers)
      Settle Cash From Cashier Mandatory Fields Date, Amount, Currency, Notes/Comments
      Parameters:
      tellerId - tellerId (required)
      cashierId - cashierId (required)
      postTellersTellerIdCashiersCashierIdSettleRequest - (required)
      Returns:
      Call<PostTellersTellerIdCashiersCashierIdSettleResponse>
    • updateCashier

      @Headers("Content-Type:application/json") @PUT("v1/tellers/{tellerId}/cashiers/{cashierId}") retrofit2.Call<PutTellersTellerIdCashiersCashierIdResponse> updateCashier(@Path("tellerId") Long tellerId, @Path("cashierId") Long cashierId, @Body PutTellersTellerIdCashiersCashierIdRequest putTellersTellerIdCashiersCashierIdRequest, @HeaderMap Map<String,String> headers)
      Update Cashier
      Parameters:
      tellerId - tellerId (required)
      cashierId - cashierId (required)
      putTellersTellerIdCashiersCashierIdRequest - (required)
      Returns:
      Call<PutTellersTellerIdCashiersCashierIdResponse>
    • updateTeller

      @Headers("Content-Type:application/json") @PUT("v1/tellers/{tellerId}") retrofit2.Call<PutTellersResponse> updateTeller(@Path("tellerId") Long tellerId, @Body PutTellersRequest putTellersRequest, @HeaderMap Map<String,String> headers)
      Update teller
      Parameters:
      tellerId - tellerId (required)
      putTellersRequest - (required)
      Returns:
      Call<PutTellersResponse>