請求管理情報取得＿API

概要

請求情報の詳細を返却する API です。

エンドポイント

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

リクエストパラメーター

パラメーター名 型 内容 特記
id int 請求情報 ID 
/api/claim/1/

レスポンス

パラメーター名 型 内容 特記
id int 請求情報 ID
organization_id int 監理団体 ID
api_member_id int GMOID（仮）
name string 監理団体名称
payment_type string 請求種類 1:未認証　2：認証済　5:利用中　10：アカウント停止　15：解約
plan int 監理団体のプラン
total_amount int 請求金額
payment_year int 支払年
payment_month int 支払月
payment_method string 請求方法 1：クレジット　 5：コンビニ払い
payment_timing string 支払時期 1：月払い 5：年払い
credit_card_number char カード下四桁
billing_confirmed_at datetime 請求確定日 /区切り
settled_at datetime 決済日 /区切り
status string 請求状態 1:未入金 2:入金済み
remarks string 備考
basic_charge_unit_price string 基本料金単価
pay_per_use_price string 従量課金単価 
{
    "result"   : true,
    "errors"   : "",
    "data"     :    {
        'id'                              : 1,
        'organization_id'                 : 1,
        'api_member_id'                   : 1,
        'name'                            : 'テスト監理団体',
        'type'                            : '利用中',
        'plan'                            : 10,
        'toral_amount'                    : 70000,
        'payment_year'                    : 2021,
        'payment_month'                   : 7,
        'payment_method'                  : 'クレジットカード',
        'payment_timing'                  : '月払い',
        'payment_card_digits'             : 0123,
        'billing_confirmation_date'       : '2021/07/20',
        'settlement_date'                 : '2021/07/31',
        'status'                          : '入金済み',
        'memo'                            : 'memomemomemomemomemo',
        'basic_charge_unit_price'         : 50000,
        'pay_per_use_price'               : 1000,
    },
}

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

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

データ取得

SELECT
    *
FROM
    `organizations`
WHERE
    `organizations`.`id` = $request->route('id')
AND `organizations`.`deleted_at` IS NULL

{warning} ※実際はfindで取得します。

SELECT
    *
FROM
    `organization_payments`
WHERE
    `organization_payments`.`organization_id` = $request->route('id')
AND `organization_payments`.`deleted_at` IS NULL

RUN