jp.co.freee.accounting.api.ReceiptsApi Maven / Gradle / Ivy

Go to download
package jp.co.freee.accounting.api;

import jp.co.freee.accounting.CollectionFormats.*;

import io.reactivex.Observable;
import io.reactivex.Completable;
import retrofit2.http.*;

import okhttp3.RequestBody;
import okhttp3.ResponseBody;
import okhttp3.MultipartBody;

import jp.co.freee.accounting.models.BadRequestError;
import jp.co.freee.accounting.models.BadRequestNotFoundError;
import java.io.File;
import jp.co.freee.accounting.models.ForbiddenError;
import jp.co.freee.accounting.models.InlineResponse2005;
import jp.co.freee.accounting.models.InternalServerError;
import jp.co.freee.accounting.models.ReceiptResponse;
import jp.co.freee.accounting.models.ReceiptUpdateParams;
import jp.co.freee.accounting.models.UnauthorizedError;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public interface ReceiptsApi {
  /**
   * ファイルボックス（証憑ファイル）のアップロード
   * 
   * @param companyId 事業所ID (required)
   * @param receipt 証憑ファイル (required)
   * @param description メモ (255文字以内) (optional)
   * @param documentType この項目はインボイス制度で利用する項目です。2023年4月頃から利用できる予定です。 書類の種類（receipt: 領収書、invoice: 請求書、other: その他）  (optional)
   * @param issueDate 取引日 (yyyy-mm-dd) (optional)
   * @param qualifiedInvoice この項目はインボイス制度で利用する項目です。2023年4月頃から利用できる予定です。 適格請求書等（qualified: 該当する、not_qualified: 該当しない、unselected: 未選択）  (optional)
   * @param receiptMetadatumAmount 金額 (optional)
   * @param receiptMetadatumIssueDate 発行日 (yyyy-mm-dd) (optional)
   * @param receiptMetadatumPartnerName 発行元 (optional)
   * @return Observable<ReceiptResponse>
   */
  @retrofit2.http.Multipart
  @POST("api/1/receipts")
  Observable createReceipt(
    @retrofit2.http.Part("company_id") Integer companyId, @retrofit2.http.Part MultipartBody.Part receipt, @retrofit2.http.Part("description") String description, @retrofit2.http.Part("document_type") String documentType, @retrofit2.http.Part("issue_date") String issueDate, @retrofit2.http.Part("qualified_invoice") String qualifiedInvoice, @retrofit2.http.Part("receipt_metadatum_amount") Long receiptMetadatumAmount, @retrofit2.http.Part("receipt_metadatum_issue_date") String receiptMetadatumIssueDate, @retrofit2.http.Part("receipt_metadatum_partner_name") String receiptMetadatumPartnerName
  );

  /**
   * ファイルボックス（証憑ファイル）の削除
   * 
   * @param id ファイルボックス（証憑ファイル）ID (required)
   * @param companyId 事業所ID (required)
   * @return Completable
   */
  @DELETE("api/1/receipts/{id}")
  Completable destroyReceipt(
    @retrofit2.http.Path("id") Integer id, @retrofit2.http.Query("company_id") Integer companyId
  );

  /**
   * ファイルボックス（証憑ファイル）のダウンロード
   * 
   * @param id ファイルボックス（証憑ファイル）ID (required)
   * @param companyId 事業所ID (required)
   * @return Observable<ResponseBody>
   */
  @GET("api/1/receipts/{id}/download")
  Observable downloadReceipt(
    @retrofit2.http.Path("id") Integer id, @retrofit2.http.Query("company_id") Integer companyId
  );

  /**
   * ファイルボックス（証憑ファイル）の取得
   * 
   * @param id ファイルボックス（証憑ファイル）ID (required)
   * @param companyId 事業所ID (required)
   * @return Observable<ReceiptResponse>
   */
  @GET("api/1/receipts/{id}")
  Observable getReceipt(
    @retrofit2.http.Path("id") Integer id, @retrofit2.http.Query("company_id") Integer companyId
  );

  /**
   * ファイルボックス（証憑ファイル）一覧の取得
   * 
   * @param companyId 事業所ID (required)
   * @param startDate アップロード日 (yyyy-mm-dd) (required)
   * @param endDate アップロード日 (yyyy-mm-dd) (required)
   * @param userName アップロードしたユーザー名、メールアドレス (optional)
   * @param number アップロードファイルNo (optional)
   * @param commentType posted:コメントあり, raised:未解決, resolved:解決済 (optional)
   * @param commentImportant trueの時、重要コメント付きが対象 (optional)
   * @param category all:すべて、without_deal:未登録、with_expense_application_line:経費申請中, with_deal:登録済み、ignored:無視 (optional)
   * @param offset 取得レコードのオフセット (デフォルト: 0) (optional)
   * @param limit 取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 3000) (optional)
   * @return Observable<InlineResponse2005>
   */
  @GET("api/1/receipts")
  Observable getReceipts(
    @retrofit2.http.Query("company_id") Integer companyId, @retrofit2.http.Query("start_date") String startDate, @retrofit2.http.Query("end_date") String endDate, @retrofit2.http.Query("user_name") String userName, @retrofit2.http.Query("number") Integer number, @retrofit2.http.Query("comment_type") String commentType, @retrofit2.http.Query("comment_important") Boolean commentImportant, @retrofit2.http.Query("category") String category, @retrofit2.http.Query("offset") Long offset, @retrofit2.http.Query("limit") Integer limit
  );

  /**
   * ファイルボックス（証憑ファイル）の更新
   * 
   * @param id ファイルボックス（証憑ファイル）ID (required)
   * @param receiptUpdateParams  (required)
   * @return Observable<ReceiptResponse>
   */
  @Headers({
    "Content-Type:application/json"
  })
  @PUT("api/1/receipts/{id}")
  Observable updateReceipt(
    @retrofit2.http.Path("id") Integer id, @retrofit2.http.Body ReceiptUpdateParams receiptUpdateParams
  );

}