public interface PaymentRequestsApi
| Modifier and Type | Method and Description |
|---|---|
io.reactivex.Observable<PaymentRequestResponse> |
createPaymentRequest(PaymentRequestCreateParams paymentRequestCreateParams)
支払依頼の作成
|
io.reactivex.Completable |
destroyPaymentRequest(Integer id,
Integer companyId)
支払依頼の削除
|
io.reactivex.Observable<PaymentRequestResponse> |
getPaymentRequest(Integer id,
Integer companyId)
支払依頼詳細の取得
|
io.reactivex.Observable<PaymentRequestsIndexResponse> |
getPaymentRequests(Integer companyId,
String status,
String startApplicationDate,
String endApplicationDate,
String startIssueDate,
String endIssueDate,
Integer applicationNumber,
String title,
Integer applicantId,
Integer approverId,
Integer minAmount,
Integer maxAmount,
Integer partnerId,
String partnerCode,
String paymentMethod,
String startPaymentDate,
String endPaymentDate,
String documentCode,
Long offset,
Integer limit)
支払依頼一覧の取得
|
io.reactivex.Observable<PaymentRequestResponse> |
updatePaymentRequest(Integer id,
PaymentRequestUpdateParams paymentRequestUpdateParams)
支払依頼の更新
|
io.reactivex.Observable<PaymentRequestResponse> |
updatePaymentRequestAction(Integer id,
PaymentRequestActionCreateParams paymentRequestActionCreateParams)
支払依頼の承認操作
|
@Headers(value="Content-Type:application/json") @POST(value="api/1/payment_requests") io.reactivex.Observable<PaymentRequestResponse> createPaymentRequest(@Body PaymentRequestCreateParams paymentRequestCreateParams)
paymentRequestCreateParams - 支払依頼の作成 (optional)@DELETE(value="api/1/payment_requests/{id}")
io.reactivex.Completable destroyPaymentRequest(@Path(value="id")
Integer id,
@Query(value="company_id")
Integer companyId)
id - 支払依頼ID (required)companyId - 事業所ID (required)@GET(value="api/1/payment_requests/{id}")
io.reactivex.Observable<PaymentRequestResponse> getPaymentRequest(@Path(value="id")
Integer id,
@Query(value="company_id")
Integer companyId)
id - 支払依頼ID (required)companyId - 事業所ID (required)@GET(value="api/1/payment_requests") io.reactivex.Observable<PaymentRequestsIndexResponse> getPaymentRequests(@Query(value="company_id") Integer companyId, @Query(value="status") String status, @Query(value="start_application_date") String startApplicationDate, @Query(value="end_application_date") String endApplicationDate, @Query(value="start_issue_date") String startIssueDate, @Query(value="end_issue_date") String endIssueDate, @Query(value="application_number") Integer applicationNumber, @Query(value="title") String title, @Query(value="applicant_id") Integer applicantId, @Query(value="approver_id") Integer approverId, @Query(value="min_amount") Integer minAmount, @Query(value="max_amount") Integer maxAmount, @Query(value="partner_id") Integer partnerId, @Query(value="partner_code") String partnerCode, @Query(value="payment_method") String paymentMethod, @Query(value="start_payment_date") String startPaymentDate, @Query(value="end_payment_date") String endPaymentDate, @Query(value="document_code") String documentCode, @Query(value="offset") Long offset, @Query(value="limit") Integer limit)
companyId - 事業所ID (required)status - '申請ステータス(draft:下書き, in_progress:申請中, approved:承認済, rejected:却下, feedback:差戻し)、 取引ステータス(unsettled:支払待ち, settled:支払済み)'<br> approver_id を指定した場合は無効です。 (optional)startApplicationDate - 申請日で絞込：開始日(yyyy-mm-dd) (optional)endApplicationDate - 申請日で絞込：終了日(yyyy-mm-dd) (optional)startIssueDate - 発生日で絞込：開始日(yyyy-mm-dd) (optional)endIssueDate - 発生日で絞込：終了日(yyyy-mm-dd) (optional)applicationNumber - 申請No. (optional)title - 申請タイトル (optional)applicantId - 申請者のユーザーID (optional)approverId - 承認者のユーザーID<br> 'approver_id を指定した場合は、 in_progress: 申請中 の支払依頼のみを返します。' (optional)minAmount - 金額で絞込 (下限金額) (optional)maxAmount - 金額で絞込 (上限金額) (optional)partnerId - 取引先IDで絞込 (optional)partnerCode - 取引先コードで絞込 (optional)paymentMethod - 支払方法で絞込 (none: 指定なし, domestic_bank_transfer: 国内振込, abroad_bank_transfer: 国外振込, account_transfer: 口座振替, credit_card: クレジットカード) (optional)startPaymentDate - 支払期限で絞込：開始日(yyyy-mm-dd) (optional)endPaymentDate - 支払期限で絞込：終了日(yyyy-mm-dd) (optional)documentCode - 請求書番号で絞込 (optional)offset - 取得レコードのオフセット (デフォルト: 0) (optional)limit - 取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 500) (optional)@Headers(value="Content-Type:application/json")
@PUT(value="api/1/payment_requests/{id}")
io.reactivex.Observable<PaymentRequestResponse> updatePaymentRequest(@Path(value="id")
Integer id,
@Body
PaymentRequestUpdateParams paymentRequestUpdateParams)
id - 支払依頼ID (required)paymentRequestUpdateParams - 支払依頼の更新 (optional)@Headers(value="Content-Type:application/json")
@POST(value="api/1/payment_requests/{id}/actions")
io.reactivex.Observable<PaymentRequestResponse> updatePaymentRequestAction(@Path(value="id")
Integer id,
@Body
PaymentRequestActionCreateParams paymentRequestActionCreateParams)
id - 支払依頼ID (required)paymentRequestActionCreateParams - 支払依頼の承認操作 (required)Copyright © 2022. All rights reserved.