Package com.cheetahdigital.receipt.core.api

Interface ReceiptInterface

  • public interface ReceiptInterface
    Service interface which consists of Receipt API endpoints

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ENDPOINT
      Receipts API Endpoint

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      retrofit2.Call<com.cheetahdigital.corekit.models.BaseModel<Receipt>> getReceipt​(java.lang.String receiptId, java.util.Map<java.lang.String,​java.lang.Object> queryMap)
      Get a receipt via ID
      retrofit2.Call<com.cheetahdigital.corekit.models.BaseModel<Receipts>> getReceipts​(java.util.Map<java.lang.String,​java.lang.Object> queryMap)
      Get list of receipts
      retrofit2.Call<com.cheetahdigital.corekit.models.BaseModel<Receipt>> submitReceipt​(java.util.Map<java.lang.String,​java.lang.Object> queryMap, okhttp3.MultipartBody.Part receipt)
      Submit a receipt

    • Field Detail

    • Method Detail

      • getReceipts

        @GET("api/receipts")
retrofit2.Call<com.cheetahdigital.corekit.models.BaseModel<Receipts>> getReceipts​(@QueryMap
                                                                                  java.util.Map<java.lang.String,​java.lang.Object> queryMap)
        Get list of receipts
        Parameters:
        queryMap - map of query parameters
        Returns:
        list of Receipts

      • getReceipt

        @GET("api/receipts/{receipt_id}")
retrofit2.Call<com.cheetahdigital.corekit.models.BaseModel<Receipt>> getReceipt​(@Path("receipt_id")
                                                                                java.lang.String receiptId,
                                                                                @QueryMap
                                                                                java.util.Map<java.lang.String,​java.lang.Object> queryMap)
        Get a receipt via ID
        Parameters:
        receiptId - if of the receipt
        queryMap - map of query parameters
        Returns:
        Receipt

      • submitReceipt

        @Multipart
@POST("api/receipts")
retrofit2.Call<com.cheetahdigital.corekit.models.BaseModel<Receipt>> submitReceipt​(@QueryMap
                                                                                   java.util.Map<java.lang.String,​java.lang.Object> queryMap,
                                                                                   @Part
                                                                                   okhttp3.MultipartBody.Part receipt)
        Submit a receipt
        Parameters:
        queryMap - map of query parameters
        receipt - Receipt to submit
        Returns:
        Receipt