監理費請求 - 一覧 API

概要

{primary} 検索条件にて絞り込んだ監理費請求のレコードのリストを返却します。

監理団体または実習実施先アカウントで、ステータスが 5:利用中 のユーザのみ利用できます。

監理団体アカウントはマスター、管理者、一般に制限なく全ての監理費請求を閲覧可能です。

実習実施先アカウントは自分の実習実施先に紐づく監理費請求のみ閲覧可能です。

エンドポイント

メソッド URI Headers
GET /api/bill/list Default

リクエストパラメータ

パラメーター名 型 内容 特記
per_page int 件数 default:50
pages int ページ数 何 P 目をリクエストするか
billing_ym int 年月 NULLの場合全て
company_id int 実習実施先名絞り込み NULLの場合全て
search int 件名のキーワード検索 半角スペース区切りのLIKEOR検索

レスポンス

成功時
パラメーター名 型 内容 特記
result boolean リクエスト結果 true
errors array 成功のためエラーがないので空配列が返ってきます
id string 請求書ID
company_id string 実習実施先ID
subject string 件名
total_amount string 請求金額(税込)
email string メールアドレス
publishing_date string 発行日
email_sent_at string メール送信日時 未送信だったらNULL 
{
    "result"   : true,
    "errors"   : "",
    "data"     : {
        0 : {
            "id"                   : 1,
            "company_id"           : 1,
            "subject"              : "管理費",
            "total_amount"         : "100000",
            "email"                : "test1@example.com",
            "publishing_date"      : "2023/02/01",
            "email_sent_at"        : "2023/02/05 12:00",
        },
        1 : {
            "id"                   : 2,
            "company_id"           : 1,
            "subject"              : "管理費",
            "total_amount"         : "100000",
            "email"                : "test2@example.com",
            "publishing_date"      : "2023/02/01",
            "email_sent_at"        : "2023/02/05 12:00",
        },
        2 : {
            "id"                   : 3,
            "company_id"           : 1,
            "subject"              : "管理費",
            "total_amount"         : "100000",
            "email"                : "test3@example.com",
            "publishing_date"      : "2023/02/01",
            "email_sent_at"        : "2023/02/05 12:00",
        }
    },
}
失敗時

ステータスコード：200

パラメーター名 型 内容 特記
result boolean リクエスト結果
error List 失敗した理由を配列 
{
  "result"   : false,
  "errors"   : {
    'error'       : ['失敗しました'],
  },
  "data"     : "",
}

{primary} 何もなければ空配列で返却。検索条件で何も引っかからなかった場合を

想定しています。取得するデータが存在しないため

失敗ではなく、成功として返却します。

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

データ取得

  • キーワード検索のsearchは、半角スペース区切り$request->getInput('search')を分解し、$search1,2,3...とします。
SELECT
    *
FROM
    `organization_bills`
WHERE
        `organization_id` = Auth::organizationId()
    AND `company_id` = $request->getInput('company_id')
    AND `billing_ym` = $request->getInput('billing_ym')
    AND `organization_bills`.`deleted_at` IS NULL
    AND (
            `subject` = $search1
        OR  `subject` = $search2
        OR  `subject` = $search3 .....
    )