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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of freee-accounting-sdk Show documentation
freee accounting client SDK for Java
There is a newer version: 2.29.0
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 jp.co.freee.accounting.models.ForbiddenError;
import jp.co.freee.accounting.models.InternalServerError;
import jp.co.freee.accounting.models.InvoiceCreateParams;
import jp.co.freee.accounting.models.InvoiceIndexResponse;
import jp.co.freee.accounting.models.InvoiceResponse;
import jp.co.freee.accounting.models.InvoiceUpdateParams;
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 InvoicesApi {
  /**
   * 請求書の作成
   * 
   * @param invoiceCreateParams 請求書の作成 (optional)
   * @return Observable<InvoiceResponse>
   */
  @Headers({
    "Content-Type:application/json"
  })
  @POST("api/1/invoices")
  Observable createInvoice(
    @retrofit2.http.Body InvoiceCreateParams invoiceCreateParams
  );

  /**
   * 請求書の削除
   * 
   * @param id  (required)
   * @param companyId 事業所ID (required)
   * @return Completable
   */
  @DELETE("api/1/invoices/{id}")
  Completable destroyInvoice(
    @retrofit2.http.Path("id") Integer id, @retrofit2.http.Query("company_id") Integer companyId
  );

  /**
   * 請求書の取得
   * 
   * @param id 請求書ID (required)
   * @param companyId 事業所ID (required)
   * @return Observable<InvoiceResponse>
   */
  @GET("api/1/invoices/{id}")
  Observable getInvoice(
    @retrofit2.http.Path("id") Integer id, @retrofit2.http.Query("company_id") Integer companyId
  );

  /**
   * 請求書一覧の取得
   * 
   * @param companyId 事業所ID (required)
   * @param partnerId 取引先IDで絞込 (optional)
   * @param partnerCode 取引先コードで絞込 (optional)
   * @param startIssueDate 請求日の開始日(yyyy-mm-dd) (optional)
   * @param endIssueDate 請求日の終了日(yyyy-mm-dd) (optional)
   * @param startDueDate 期日の開始日(yyyy-mm-dd) (optional)
   * @param endDueDate 期日の終了日(yyyy-mm-dd) (optional)
   * @param invoiceNumber 請求書番号 (optional)
   * @param description 概要 (optional)
   * @param invoiceStatus 請求書ステータス  (draft: 下書き, applying: 申請中, remanded: 差し戻し, rejected: 却下, approved: 承認済み, unsubmitted: 送付待ち, submitted: 送付済み) (optional)
   * @param paymentStatus 入金ステータス  (unsettled: 入金待ち, settled: 入金済み) (optional)
   * @param offset 取得レコードのオフセット (デフォルト: 0) (optional)
   * @param limit 取得レコードの件数 (デフォルト: 20, 最大: 100)  (optional)
   * @return Observable<InvoiceIndexResponse>
   */
  @GET("api/1/invoices")
  Observable getInvoices(
    @retrofit2.http.Query("company_id") Integer companyId, @retrofit2.http.Query("partner_id") Integer partnerId, @retrofit2.http.Query("partner_code") String partnerCode, @retrofit2.http.Query("start_issue_date") String startIssueDate, @retrofit2.http.Query("end_issue_date") String endIssueDate, @retrofit2.http.Query("start_due_date") String startDueDate, @retrofit2.http.Query("end_due_date") String endDueDate, @retrofit2.http.Query("invoice_number") String invoiceNumber, @retrofit2.http.Query("description") String description, @retrofit2.http.Query("invoice_status") String invoiceStatus, @retrofit2.http.Query("payment_status") String paymentStatus, @retrofit2.http.Query("offset") Long offset, @retrofit2.http.Query("limit") Integer limit
  );

  /**
   * 請求書の更新
   * 
   * @param id 請求書ID (required)
   * @param invoiceUpdateParams 請求書の更新 (optional)
   * @return Observable<InvoiceResponse>
   */
  @Headers({
    "Content-Type:application/json"
  })
  @PUT("api/1/invoices/{id}")
  Observable updateInvoice(
    @retrofit2.http.Path("id") Integer id, @retrofit2.http.Body InvoiceUpdateParams invoiceUpdateParams
  );

}