🌐

APIを使った退職登録について

退職登録に使える2つのAPI

退職(所属解除)をインポートで登録する方法には、以下の2種類があります。
パターンA:通常インポートAPIパターンB:トランザクションインポートAPI
使用する項目・操作 属性(操作)
エンドポイント(承認同時実行の場合は (承認同時実行の場合は
適した用途メンバーの全所属を一括で退職させたい場合特定の会社・組織・事業所・プロジェクトだけをピンポイントで所属解除したい場合、兼務のうち一部だけ外したい場合
参照インポートAPIトランザクションインポートAPI

パターンA:通常インポートAPI(retireDate)

一人のメンバーの全所属を一括で退職させたい場合は、こちらのAPIがシンプルです。

mapping例

カラム名対応する項目
メンバー番号
メールアドレス
退社日
所属会社

CSVデータ例(単一会社所属の場合)

兼務している場合の注意点

⚠️
1社にのみ所属していて、その1社から外れる(退職する)場合は、それ以外のグループ(組織・事業所・プロジェクト)からも自動的に同日で所属が外れます。 一方、2社以上に所属していて1社からだけ外れる場合(他の会社への所属が残る場合)は、他のグループの所属はそのまま残ります。兼務先が複数あり、対応するグループの所属もあわせて外したい場合は、後述のパターンB:トランザクションインポートAPIを使用してください。
は、CSVの同じ行に含まれる会社の所属に対してのみ適用されます。複数社を兼務しているメンバーの場合、その行にすべての所属会社を含めない限り( の形で複数列にマッピングするなど)、一部の会社からしか退職扱いになりません。全所属会社が退職済みになって初めて、メンバーは他のすべての組織・事業所・プロジェクトからも自動的に外れます。

CSVデータ例(兼務メンバーを1行で一括退職させる場合)


パターンB:トランザクションインポートAPI(unreferenceEntity)

特定の会社・組織・事業所・プロジェクトだけをピンポイントで所属解除したい場合や、兼務のうち一部だけを外したい場合は、こちらのAPIが適しています。

mapping例

カラム名対応する項目
操作
変更日
社員番号
会社コード

CSVデータ例(複数会社を一括解除する場合)

1行につき1組織・1会社の指定になるため、兼務先の数だけ行を用意します。
組織・事業所・プロジェクトを外す場合は、 の代わりに / / を使い、同様に行を分けてマッピングします。

注意点

⚠️
変更日には「所属を解除する日の翌日」を指定します(15日退職なら16日、月末退職なら翌月1日)。この点は、通常インポートAPIの (実際の退職日をそのまま指定すればよい)と挙動が異なるため注意してください。
全ての会社から所属解除されると、そのメンバーは自動的に他の組織・事業所・プロジェクトからも解除されます。この挙動はパターンAと共通です。

使い分けの目安

目的使用するAPI
シンプルに「メンバーを退職させたい」パターンA(
兼務のうち一部の所属だけ外す/異動で特定の組織だけ解除したいパターンB(

メンバー・グループの名寄せキー

メンバーの名寄せキーはどちらのAPIも共通で、以下の順に一致確認が行われます。
  1. (メンバー番号)
  1. (社員番号)
  1. (メールアドレス)
グループの名寄せは、会社名()または会社コード()のいずれかで行われます。どちらか一方とマッピングすることで、対象の会社を指定して退職を登録できます。