監理費請求 - 詳細取得 API

概要

{primary} ルートパラメータのIDに紐づくレコードを返却します。

エンドポイント

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

ROUTEパラメータ

パラメーター名 型 内容 特記
id int 請求書ID

レスポンス

成功時
パラメーター名 型 内容 特記
result boolean リクエスト結果 true
errors array 成功のためエラーがないので空配列が返ってきます
company_id int 実習実施先ID
registration_number string 登録番号
publishing_date datetime 請求書発行日
payment_deadline datetime 支払期限
email string メールアドレス
addressee string 宛名
subject string 件名
subtotal_amount int 小計
total_amount int 合計
items[][name] json 品目[名前]
items[][unit_price] json 品目[単価]
items[][quantity] json 品目[数量]
items[][unit] json 品目[単位]
items[][taxable_type ] json 品目[税区分] 1:課税, 2:非課税
items[][item_price ] json 品目[価格]
remarks string 備考 
{
    "result"   : true,
    "errors"   : "",
    "data"     : {
        "company_id"          : 1,
        "registration_number" : 1234567891234,
        "publishing_date"     : "2023/01/01",
        "payment_deadline"    : "2023/02/01",
        "email"               : "test@example.com",
        "addressee"           : "テスト実習実施先",
        "subject"             : "テスト件名",
        "subtotal_amount"     : "50000",
        "total_amount"        : "55000",
        "items"               : {
            0 : {
                "name"         : "テスト１",
                "unit_price"   : 500,
                "quantity"     : 5,
                "unit"         : "件",
                "taxable_type" : 1
            },
            1: {
                "name"         : "テスト２",
                "unit_price"   : 500,
                "quantity"     : 5,
                "unit"         : "件",
                "taxable_type" : 1
            }
                },
        "remarks"             : "テスト備考"
        }
    },
}
失敗時

ステータスコード：200

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

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

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

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

エラー件数は上限100件までとします。

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

データ取得

  • 実際はfindで取得します。
SELECT
    *
FROM
    `organization_bills`
WHERE
        `id` = $request->getInput('id')
    AND `organization_bills`.`deleted_at` IS NULL