従業員口座追加

OpenAPI説明

当該OpenAPIは従業員の口座を追加する際に利用します。

OpenAPI権限

当該OpenAPIはテナント権限が必要です。

リクエストURI

/api/openapi/users/bank-accounts

リクエスト形式

POST

リクエスト例

{
    "employeeId": "EMP-001",
    "bankCode": "0000",
    "bankBranchCode": "001",
    "bankAccountType": "1",
    "bankAccountNo": "1234567",
    "bankAccountName": "口座名称",
    "bankAccountFbName": "ABC",
    "isTransferFeeAfforded": false,
    "isDebitAccount": true,
    "isPrimary": true,
    "isEnabled": true
}

リクエスト項目

項目名	タイプ	必須	キー	規則	説明
employeeId	String	〇	〇		従業員番号
bankCode	String	〇	〇		銀行コード
bankBranchCode	String	〇	〇		支店コード
bankAccountType	String	〇		1：普通預金 2：当座預金 4：貯蓄預金 9：その他	口座種別コード
bankAccountNo	String	〇	〇	数字、最大7文字	口座番号
bankAccountName	String	〇		最大50文字	口座名称
bankAccountFbName	String	〇		半角文字，最大30文字	口座名（FB用）
isTransferFeeAfforded	Boolean	〇			手数料負担区分 true:他社 false:自社
isDebitAccount	Boolean	〇			振替口座に指定
isPrimary	Boolean	〇			デフォルトに設定
isEnabled	Boolean	〇			ステータス

OpenAPIリターン例

成功例

{
    "message": "success",
    "oid": "7a02401e-11d7-438c-b9a3-ed9761719505"
}

失敗例

{
    "message": "口座番号を指定してください",
    "errorCode": "xxxxx"
}

項目説明

項目名	タイプ	説明
message	String	メッセージを返す
errorCode	String	エラーコードを返す
oid	UUID	口座番号oid

エラーコード説明

errorCode	message	説明
0013	パラメータ:{0}は{1}文字以内で指定してください
120003	パラメータ:{0}は指定必須の項目です
121716	銀行口座番号すでに占有されている
240014	デフォルトの銀行口座を無効に設定できません
240050	口座番号を７桁以下の半角数字にしてください
240054	口座名（半角カナ）は30文字以内の半角カナで入力してください
1202071	従業員番号は存在しません:{0}
5018003	銀行コードまたは支店コードが無効です
5269001	無効な {0}
120001	テナントの権限がありません
THIRD_PARTY_APPLICATION_004	認識できないクライアントマークまたはクライアントには権限がない