請求管理削除＿API

概要

請求情報の更新をする API です。

未入金状態のデータしか削除できません。

エンドポイント

メソッド URI Headers
DELETE /api/claim Default

リクエストパラメーター

パラメーター名 型 内容 特記
id int 請求情報 ID 
{
    'id'    :1,
}

レスポンス

成功時
パラメーター名 型 内容 特記
id int 請求情報 ID 
{
    "result"   : true,
    "errors"   : "",
    "data"     :    {
        'id'     : 1,
    },
}

{primary} 未入金状態のデータしか基本的には更新できません。状態変更のみ全データ更新できます。

失敗時

ステータスコード：200

パラメーター名 型 内容 特記
result boolean リクエスト結果
error string 連想配列 / パラメータと key を同一にするように 
{
  "result"   : false,
  "errors"   : {
    'error'        : ['削除できないデータです。'],
  },
  "data"     : "",
}

データ取得

  • パラメータのidと一致し、且つ請求状態が未入金のデータのみ削除可能です。
SELECT
    *
FROM
    organization_payments
WHERE
    id = {$request->id}
AND status = 1 // 1：未入金
AND deleted_at IS NULL

データストア

organization_payments

物理名 フィールド名 型 備考
deleted_at deleted_at datetime 現在の日時をセット

RUN