請求先停止削除

/api/v1.0/billing/bulk_stop

複数の請求先、請求先部署、請求先決済手段を停止または削除する処理

アウトライン

リクエスト

Parameters

名前 概要 桁数 種別 必須
user_id ユーザーID(管理画面へのログインID) 100 メール形式 必須
access_key アクセスキー 100 半角英数 必須
billing 請求先に属するパラメータ   array  

billing (request)

下記のような項目のオブジェクトを持つリスト

名前 概要 桁数 種別 必須
code 請求先コード
※両端のスペース除去
20 半角英数 + 記号 必須
del_flg 請求先削除フラグ
0:停止 1:削除
※請求先部署のみまたは請求先決済手段のみを削除する時は、省略
1 数値  
biling.individual 請求先部署に属するパラメータ ※省略可能   array  
billing.payment 請求先決済手段に属するパラメータ ※省略可能   array  

individual (request)

下記のような項目のオブジェクトを持つリスト

名前 概要 桁数 種別 必須
number 請求先部署番号
※両端のスペース除去
18 数値 (請求先部署削除時)^1
code 請求先部署コード ※両端のスペース除去 20 半角英数 + 記号 (請求先部署削除時)^1
del_flg 請求先部署削除フラグ
0:停止 1:削除
1 数値 (請求先部署削除時)

payment (request)

下記のような項目のオブジェクトを持つリスト

名前 概要 桁数 種別 必須
code 決済情報コード 20 半角英数 + 記号 (請求先決済手段削除時)
del_flg 決済情報削除フラグ
0:停止 1:削除
1 数値 (請求先決済手段削除時)

レスポンス

Fields

名前 概要
user_id ユーザーID(管理画面へのログインID) string
access_key アクセスキー string
billing 請求先に属するパラメータ array

billing (response)

下記のような項目のオブジェクトを持つリスト

名前 概要
error_code エラーコード
※正常時はnull
int
error_message エラーメッセージ
※正常時はnull
string
code 請求先コード string
del_flg 請求先削除フラグ int
billing.individual 請求先部署に属するパラメータ array
billing.payment 請求先決済手段に属するパラメータ array

individual (response)

下記のような項目のオブジェクトを持つリスト

名前 概要
error_code エラーコード
※正常時はnull
int
error_message エラーメッセージ
※正常時はnull
string
number 請求先部署番号 int
code 請求先部署コード string
del_flg 請求先部署削除フラグ int

payment (response)

下記のような項目のオブジェクトを持つリスト

名前 概要
error_code エラーコード
※正常時はnull
int
error_message エラーメッセージ
※正常時はnull
string
code 決済情報コード string
del_flg 決済情報削除フラグ int

使用例

リクエスト例

{
    "user_id": "sample@robotpayment.co.jp",
    "access_key": "xxxxxxxxxxxxxxxx",
    "billing": [
        {
            "code": "billing",
            "individual": [
                {
                    "code": "abc-12345",
                    "del_flg": 0
                }
            ],
            "payment": [
                {
                    "code": "bank-123",
                    "del_flg": 0
                },
                {
                    "code": "bank-456",
                    "del_flg": 1
                }
            ]
        }
    ]
}

レスポンス例

Status: 200 OK

{
    "user_id": "sample@robotpayment.co.jp",
    "access_key": "xxxxxxxxxxxxxxxx",
    "billing": [
        {
            "error_code": null,
            "error_message": null,
            "code": "billing",
            "individual": [
                {
                    "error_code": null,
                    "error_message": null,
                    "number": 1,
                    "code": "abc-12345",
                    "del_flg": 0
                }
            ],
            "payment": [
                {
                    "error_code": null,
                    "error_message": null,
                    "code": "bank-123",
                    "del_flg": 0
                },
                {
                    "error_code": null,
                    "error_message": null,
                    "code": "bank-456",
                    "del_flg": 1
                }
            ]
        }
    ]
}

エラー

共通エラー

個別エラー

エラーコード 内容
1201 請求先コードが不正
1202 請求先削除フラグが不正
1203 請求先部署番号が不正
1204 請求先部署コードが不正
1205 請求先部署削除フラグが不正
1206 請求先決済情報コードが不正
1207 請求先決済情報削除フラグが不正
1208 請求先は既に停止しています
1209 請求先が存在しません
1210 対象の部署を親部署にした子部署が存在します
1211 削除フラグは同時に指定できません。
1212 請求情報番号と請求情報コードは同時に指定できません。
1213 請求先部署は既に停止しています
1214 請求先に紐づく請求先部署がなくなります。
1215 請求先部署が存在しません
1216 決済手段は既に停止しています
1217 決済手段が存在しません
1218 決済手段が請求先部署のデフォルト値として使用中です
1219 請求情報で使用されている決済手段です
1220 請求先の停止に失敗
1221 請求先の削除に失敗
1222 請求先部署の停止に失敗
1223 請求先部署の削除に失敗
1224 請求先利用可能決済手段の停止に失敗
1225 請求先利用可能決済手段の削除に失敗
1226 繰越待ち請求書が存在するので削除できません

TOPへ戻る