請求情報一覧取得 API

概要

特定の監理団体の請求情報を一覧で返却する API です。

全件返却することを想定しています。

エンドポイント

メソッド URI Headers
GET /api/payment/claim/list/{id} Default

リクエストパラメーター

パラメーター名 型 内容 特記
id int 監理団体 ID 
/api/payment/claim/list/1

レスポンス

パラメーター名 型 内容 特記
id int 請求情報 ID
billing_confirmation_date string 請求確定日
settlement_date string 決済処理日
amount int 金額
plan int プラン
payment_method int 支払い方法 1：クレジット　 5：コンビニ払い
status int 決済状況 1:未入金　5:入金済み　10:処理失敗
pdf_url string PDF の URL 
{
    "result"   : true,
    "errors"   : "",
    "data"     : [
        {
            'id'                       : 1,
            'billing_confirmation_date': '2020/01/20',
            'settlement_date'          : '2020/01/31',
            'amount'                   : 100000,
            'plan'                     : 10,
            'payment_method'           : 1,
            'status'                   : 1,
            'pdf_url'                  : '{{route(pdf)}}'
        },
        {
            'id'                       : 2,
            'billing_confirmation_date': '2020/01/20',
            'settlement_date'          : '2020/01/31',
            'amount'                   : 100000,
            'plan'                     : 10,
            'payment_method'           : 1,
            'status'                   : 1,
            'pdf_url'                  : '{{route(pdf)}}'
        },
    ]
}

{primary} 何もなければ空配列で返却
失敗ではなく、成功として返却。

　

{danger} 失敗時は200以外のエラーコードが返却されます。共通ルールのレスポンスをチェック。

データ取得SQL

  • 所属している監理団体IDorganizations.id※Auth周りの調査がまだのため、パラメータ不要になる可能性あり
  • 論理削除されていない
SELECT
    *
FROM
    `organization_payments`
WHERE
    `organization_payments`.`organization_id` = Auth::organizationId()
AND `organization_payments`.`deleted_at` IS NULL
ORDER BY
    `organization_payments`.`id` DESC

RUN