public interface InvoicesApi
| Modifier and Type | Method and Description |
|---|---|
io.reactivex.Observable<InvoiceResponse> |
createInvoice(InvoiceCreateParams invoiceCreateParams)
請求書の作成
<h2 id=\"\">概要</h2> <p>指定した事業所の請求書を作成する</p> <h2 id=\"_1\">注意点</h2> <ul> <li> <p>partner_code, partner_idはどちらかの指定が必須です。ただし両方同時に指定することはできません。</p> </li> <li> <p>請求書ステータス(invoice_status)を発行(issue)で利用した場合、請求内容の合計金額が0円以上になる必要があります。</p> </li> <li> <p>partner_codeを利用するには、事業所の設定から取引先コードの利用を有効にする必要があります。</p> </li> <li> <p>本APIでは請求内容(invoice_contents)は、最大100行までになります。</p> </li> </ul>
|
io.reactivex.Completable |
destroyInvoice(Integer id,
Integer companyId)
請求書の削除
<h2 id=\"\">概要</h2> <p>指定した事業所の請求書を削除する</p>
|
io.reactivex.Observable<InvoiceResponse> |
getInvoice(Integer id,
Integer companyId)
請求書の取得
<h2 id=\"\">概要</h2> <p>指定した事業所の請求書詳細を取得する</p>
|
io.reactivex.Observable<InlineResponse2004> |
getInvoices(Integer companyId,
Integer partnerId,
String partnerCode,
String startIssueDate,
String endIssueDate,
String startDueDate,
String endDueDate,
String invoiceNumber,
String description,
String invoiceStatus,
String paymentStatus,
Integer offset,
Integer limit)
請求書一覧の取得
<h2 id=\"\">概要</h2> <p>指定した事業所の請求書一覧を取得する</p>
|
io.reactivex.Observable<InvoiceResponse> |
updateInvoice(Integer id,
InvoiceUpdateParams invoiceUpdateParams)
請求書の更新
<h2 id=\"\">概要</h2> <p>指定した事業所の請求書を更新する</p> <h2 id=\"_1\">注意点</h2> <ul> <li> <p>入金済みの請求書に対する金額関連の変更はできません。</p> </li> <li> <p>請求書ステータスは確定(issue)のみ指定可能です。請求書ステータスを確定する時のみ指定してください。</p> </li> <li> <p>請求書WFを利用している場合、承認済み請求書は承認権限を持たないユーザーでは更新できません。</p> </li> <li> <p>更新後の請求書ステータス(invoice_status)が下書き以外の場合、請求内容の合計金額が0円以上になる必要があります。</p> </li> <li> <p>partner_code, partner_idを両方同時に指定することはできません。</p> </li> <li> <p>partner_codeを利用するには、事業所の設定から取引先コードの利用を有効にする必要があります。</p> </li> <li> <p>本APIでは請求内容(invoice_contents)は、最大100行までになります。</p> </li> </ul>
|
@Headers(value="Content-Type:application/json") @POST(value="api/1/invoices") io.reactivex.Observable<InvoiceResponse> createInvoice(@Body InvoiceCreateParams invoiceCreateParams)
invoiceCreateParams - 請求書の作成 (optional)@DELETE(value="api/1/invoices/{id}")
io.reactivex.Completable destroyInvoice(@Path(value="id")
Integer id,
@Query(value="company_id")
Integer companyId)
id - (required)companyId - 事業所ID (required)@GET(value="api/1/invoices/{id}")
io.reactivex.Observable<InvoiceResponse> getInvoice(@Path(value="id")
Integer id,
@Query(value="company_id")
Integer companyId)
id - 請求書ID (required)companyId - 事業所ID (required)@GET(value="api/1/invoices") io.reactivex.Observable<InlineResponse2004> getInvoices(@Query(value="company_id") Integer companyId, @Query(value="partner_id") Integer partnerId, @Query(value="partner_code") String partnerCode, @Query(value="start_issue_date") String startIssueDate, @Query(value="end_issue_date") String endIssueDate, @Query(value="start_due_date") String startDueDate, @Query(value="end_due_date") String endDueDate, @Query(value="invoice_number") String invoiceNumber, @Query(value="description") String description, @Query(value="invoice_status") String invoiceStatus, @Query(value="payment_status") String paymentStatus, @Query(value="offset") Integer offset, @Query(value="limit") Integer limit)
companyId - 事業所ID (required)partnerId - 取引先IDで絞込 (optional)partnerCode - 取引先コードで絞込 (optional)startIssueDate - 請求日の開始日(yyyy-mm-dd) (optional)endIssueDate - 請求日の終了日(yyyy-mm-dd) (optional)startDueDate - 期日の開始日(yyyy-mm-dd) (optional)endDueDate - 期日の終了日(yyyy-mm-dd) (optional)invoiceNumber - 請求書番号 (optional)description - 概要 (optional)invoiceStatus - 請求書ステータス (draft: 下書き, applying: 申請中, remanded: 差し戻し, rejected: 却下, approved: 承認済み, unsubmitted: 送付待ち, submitted: 送付済み) (optional)paymentStatus - 入金ステータス (unsettled: 入金待ち, settled: 入金済み) (optional)offset - 取得レコードのオフセット (デフォルト: 0) (optional)limit - 取得レコードの件数 (デフォルト: 20, 最大: 100) (optional)@Headers(value="Content-Type:application/json")
@PUT(value="api/1/invoices/{id}")
io.reactivex.Observable<InvoiceResponse> updateInvoice(@Path(value="id")
Integer id,
@Body
InvoiceUpdateParams invoiceUpdateParams)
id - 請求書ID (required)invoiceUpdateParams - 請求書の更新 (optional)Copyright © 2020. All rights reserved.