logo-pf
API docs by Redocly

契約書 (1.0.0)

Download OpenAPI specification:Download

制限

RESTful API に従って提供されており、標準な HTTP メソッドを使用してデータの送受信を行う。

呼び出し回数

アクセストークン毎に 10 回/1 秒の呼び出し制限を設けている。こちらの制限に該当した場合は特定のエラーコードを返却する。

項目 説明
ステータスコード 400
errorCode CODE_OVR
errorDetail 1000ミリ秒間に10件を超過するリクエストを受信しました。時間をおいてリトライを実行してください。

クロスドメインリクエスト

クロスドメインリクエストを許可する。

並列処理

並列で処理が可能な仕様。
ただし同一のアクセストークンの場合は呼び出し回数制限が適用される。
また、同一のリソースに対する更新については、タイミングによっては先のリクエストが適用され後続のリクエストは排他制御によりエラーになる場合がある。

契約書

契約書受領状況確認

  • 概要：取引先から受領した契約書および終了依頼・再開依頼の受領を確認する際に利用する。
query Parameters
response_type
required
string <= 10 characters
Example: response_type=string

“json”または”xml”を指定する。

contract_status
number <= 4 characters
Example: contract_status=1

以下のいずれかのコード値を指定する。
3200:受領
3400:社内申請中
3500:社内承認済
3700:受信済
4000:終了待ち
4100:再開待ち
0000：左記すべてのステータス
Default　0000：すべてのステータス

sort_item
number <= 1 characters
Example: sort_item=0

0：更新日時
1：契約書番号
2：件名
3：締結日
4：ステータス
Default 更新日時

sort_order
number <= 1 characters
Example: sort_order=0

0：昇順
1：降順
Default 降順

contract_limit
number <= 4 characters
Example: contract_limit=0

取得件数の上限を指定する。
Default　100
Max 1000

Responses

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "contract_limit_over_flg": 0,
  • "search_result[]": [
    ]
}

締結概要書取得

  • 概要：契約書の締結概要書を取得するため利用する。
    契約ステータスが確認済、締結済、終了かつ企業間で結んだ契約書が利用可能。
query Parameters
response_type
required
string <= 10 characters
Example: response_type=string

“json”または”xml”を指定する。

contract_no
required
number <= 12 characters
Example: contract_no=0

契約書番号を指定する。

Responses

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "contract_no": 0,
  • "file_name": "string",
  • "file_data": "string"
}

契約書検索

  • 概要：契約書の検索を行う場合に利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

Array of objects (契約ステータスリスト)

ステータスで絞り込みを行いたい場合に指定する。

Array of objects (契約書番号リスト)

契約書番号で絞り込みを行いたい場合に指定する。
契約書番号は最大500件まで指定可能。

update_date
string <date-time> (更新日時)

更新日時以降に変更があった契約書を検索する
YYYY-MM-DD hh24:mm:ss形式
Default　指定なし

sort_item
number (ソート項目) <= 1 characters

0：更新日時
1：契約書番号
2：件名
3：締結日
4：ステータス
Default 更新日時

sort_order
number (ソート基準) <= 1 characters

0：昇順
1：降順
Default 降順

contract_limit
number (検索件数上限) <= 4 characters

取得件数の上限を指定する。
Default　100
Max 1000

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "contract_status_list[]": [
    ],
  • "contract_no_list[]": [
    ],
  • "update_date": "yyyy-MM-dd HH：mm：ss",
  • "sort_item": 0,
  • "sort_order": 0,
  • "contract_limit": 0
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "contract_limit_over_flg": 0,
  • "search_result[]": [
    ]
}

契約書発行

  • 概要：作成した契約書を取引先に発行する場合に利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

contract_no
required
number (契約書番号) <= 12 characters

契約書番号を指定する。

send_comment
string (発行時コメント) <= 500 characters

発行時のコメントを指定する。文章の改行を行う場合は\nを指定する。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "contract_no": 0,
  • "send_comment": 0
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "contract_no": 0,
  • "contract_status": 0
}

契約書締結

  • 概要：取引先から受領した契約書を締結する場合に利用する。
    電子署名が必要な契約書の場合は契約ステータスが締結済みになる。
    電子署名が不要な契約書の場合は契約ステータスが確認済みになる。
  • 備考・補足：受領した契約書を締結する際に、WF連携を利用する・しないによって契約書締結APIを実行できるユーザーが異なる。
    WF連携しない場合は契約書の自社担当者のみ契約書締結APIを実行することができる。
    WF連携する場合は契約書の自社担当者＋全契約書編集権限のユーザーが契約書締結APIを実行することができる。
    ※APIの実行するユーザーを変更する場合は、アクセストークンの取得時に当該ユーザーのID・パスワードにて認証を行う必要がある。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

contract_no
required
number (契約書番号) <= 12 characters

契約書番号を指定する。

contract_nominee_id
required
string (契約名義人) <= 10 characters

契約名義人を指定する。 ※取引先の電子署名が不要の場合は指定不要。 マスタ値の参照方法はAppendixの「契約名義人ID」を参照

agreement_comment
string (締結・確認時コメント) <= 500 characters

締結・確認時のコメントを指定する。 文章の改行を行う場合は\nを指定する。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "contract_no": 0,
  • "contract_nominee_id": "string",
  • "agreement_comment": "string"
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "contract_no": 0,
  • "contract_status": 0
}

契約書終了依頼

  • 概要：取引先と締結済みの契約書を契約更新せずに終了させたい場合や契約期限を迎えた場合に契約を終了させるために利用する。
  • 備考・補足： ※終了依頼を取引先が承認すると契約ステータスが締結済みから終了に更新される。ただし自社保管の場合は、即時に契約ステータスが終了となる。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

contract_no
required
number (契約書番号) <= 12 characters

契約書番号を指定する。

expiration_comment
required
string (終了理由) <= 500 characters

取引先へ通知する契約を終了する理由を指定する。 ※自社保管の場合は指定不要。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "contract_no": 0,
  • "expiration_comment": "string"
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "contract_no": 0,
  • "contract_status": 0
}

契約書終了依頼承認

  • 概要：取引先から終了依頼を受信した際に、依頼を承認するために利用する。
    取引先が依頼を承認すると契約ステータスが締結済みから終了に変わる。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

contract_no
required
number (契約書番号) <= 12 characters

契約書番号を指定する。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "contract_no": 0
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "contract_no": 0,
  • "contract_status": 0
}

契約書終了依頼却下

  • 概要：取引先から終了依頼を受信した際に、依頼を却下するために利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

contract_no
required
number (契約書番号) <= 12 characters

契約書番号を指定する。

reject_comment
required
string (却下理由) <= 500 characters

却下理由を設定する。 文章の改行を行う場合は\nを指定する。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "contract_no": 0,
  • "reject_comment": "string"
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "contract_no": 0,
  • "contract_status": 0
}

契約書再開依頼

  • 概要：すでに終了にした契約書を再度、締結済みに戻したい場合に利用する。
  • 備考・補足：※再開依頼を取引先が承認すると契約ステータスが終了から締結済みに変更される。ただし自社保管の場合は、即時に契約ステータスが締結済みとなる。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

contract_no
required
number (契約書番号) <= 12 characters

契約書番号を指定する。

restart_comment
required
string (再開依頼理由) <= 500 characters

取引先へ通知する契約を再開する理由を指定する。 ※自社保管の場合は指定不要。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "contract_no": 0,
  • "restart_comment": "string"
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "contract_no": 0,
  • "contract_status": 0
}

契約書再開依頼承認

  • 概要：すでに終了にした契約書を再度、締結済みに戻したい場合に利用する。
    取引先が依頼を承認すると契約ステータスが終了から締結済みに変更される。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

contract_no
required
number (契約書番号) <= 12 characters

契約書番号を指定する。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "contract_no": 0
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "contract_no": 0,
  • "contract_status": 0
}

契約書再開依頼却下

  • 概要：取引先から再開依頼を受信した際に、依頼を却下するために利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

contract_no
required
number (契約書番号) <= 12 characters

契約書番号を指定する。

reject_comment
required
string (却下理由) <= 500 characters

却下理由を設定する。 文章の改行を行う場合は\nを指定する。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "contract_no": 0,
  • "reject_comment": "string"
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "contract_no": 0,
  • "contract_status": 0
}

契約書取り消し

  • 概要：作成した契約書の取り消しを行う場合に利用する。
    ただし取引先に発行後は取消しできない。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

contract_no
required
number (契約書番号) <= 12 characters

契約書番号を指定する。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "contract_no": 0
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "contract_no": 0,
  • "contract_status": 0
}

契約書削除

  • 概要：すでに取り消し済みの契約書を削除したい場合に利用する。
    削除した契約書は元に戻せない。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

contract_no
required
number (契約書番号) <= 12 characters

契約書番号を指定する。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "contract_no": 0
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "contract_no": 0,
  • "contract_status": 0
}

契約書差戻

  • 概要：取引先から受領した契約書を取引先に差し戻す際に利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

contract_no
required
number (契約書番号) <= 12 characters

契約書番号を指定する。

remand_comment
required
string (差戻時コメント) <= 500 characters

差戻時のコメントを指定する。
文章の改行を行う場合は\nを指定する。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "contract_no": 0,
  • "remand_comment": "string"
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "contract_no": 0,
  • "contract_status": 0
}

基本情報

基本情報取得

  • 概要：契約書の契約書pdfファイルや取引先などの情報を取得するために利用する。
query Parameters
response_type
required
string <= 10 characters
Example: response_type=string

“json”または”xml”を指定する。

contract_no
required
number <= 12 characters
Example: contract_no=0

契約書番号を指定する。

Responses

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "contract_no": 0,
  • "contract_storage_type": 0,
  • "contract_storage_name": "string",
  • "unilateral_flg": 0,
  • "unilateral_name": "string",
  • "creator_flg": 0,
  • "creator_flg_name": "string",
  • "contract_status": 0,
  • "contract_status_name": "string",
  • "contract_file_info{}": {
    },
  • "customer_info": [
    ],
  • "stamp_type": 0,
  • "stamp_type_name": "string",
  • "Title": "string",
  • "contract_type": 0,
  • "contract_type_name": "string",
  • "agreement_date": "yyyy-MM-dd",
  • "valid_from": "yyyy-MM-dd",
  • "valid_to": "yyyy-MM-dd",
  • "latest_valid_to": "yyyy-MM-dd",
  • "auto_ext_flg": 0,
  • "auto_ext_name": "string",
  • "auto_ext_term": 0,
  • "survival_clause_flg": 0,
  • "survival_clause_name": "string",
  • "amount": "string",
  • "contract_nominee_id": 0,
  • "contract_nominee": "string",
  • "common_memo": "string",
  • "detail_page_url": "string",
  • "execution_date": "yyyy-MM-dd",
  • "notification_date": "yyyy-MM-dd HH：mm",
  • "create_company_name": "string",
  • "create_user_name": "string",
  • "remand_user_name": "string",
  • "end_request_status": [
    ],
  • "end_request_history": [
    ],
  • "comment_info": [
    ],
  • "create_date": "yyyy-MM-dd HH：mm",
  • "update_date": "yyyy-MM-dd HH：mm"
}

基本情報作成

  • 概要：契約書を作成する際に利用する。
    また添付ファイル、参照者設定などの設定を行う場合は、後に記載するAPIを利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

contract_storage_type
required
number (契約書区分) <= 1 characters

契約書区分を指定する。 0：電子契約 1：自社保管

title
required
string (件名) <= 40 characters

契約書の件名を指定する。

required
object (契約書ファイル情報)
required
Array of objects (取引先情報)

最大４社の取引先を指定可能。

stamp_type
number (印影タイプ) <= 1 characters

1: 角印　2: 丸印 Default 1：角印　※印影設定がある場合のみ

contract_type
required
number (契約種別(コード)) <= 10 characters

契約種別を指定する。
例）1 ( 秘密保持契約書)
コード値は「Appendix」を参照

unilateral_flg
number (取引先の電子署名フラグ) <= 1 characters

0：取引先の電子署名不要
1：取引先の電子署名要
Default 1：取引先の電子署名要

agreement_date
string <date> (契約日) <= 10 characters

YYYY-MM-DD形式
例）2020-06-01

valid_from
string <date> (契約期間（開始）) <= 10 characters

YYYY-MM-DD形式
例）2020-06-01

valid_to
string <date> (契約期間（終了）) <= 10 characters

YYYY-MM-DD形式
例）2020-06-01

auto_ext_flg
number (自動延長フラグ) <= 1 characters

0：自動延長なし 1：自動延長あり

auto_ext_term
number (自動延長期間（月）) <= 3 characters

自動延長ありの場合、1～999（月単位）を入力する。
自動延長ありで未入力の場合は以下のデフォルト値が適用される。
Default 12： 自動延長期間12か月

survival_clause_flg
number (残存条項フラグ) <= 1 characters

0：残存条項なし 1：残存条項あり

amount
string (契約金額) <= 15 characters

契約金額を指定する。
※マイナス値許容

common_memo
string (備考) <= 500 characters

取引先に共有する備考内容を指定する。
文章の改行を行う場合は\nを指定する。

send_comment
string (発行時コメント) <= 500 characters

契約書を発行する際に、取引先へ通知するコメントを指定する。文章の改行を行う場合は\nを指定する。

contract_nominee_id
number (契約名義人ID) <= 10 characters

電子契約の場合は必須
マスタ値の参照方法はAppendixの「契約名義人ID」を参照

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "contract_storage_type": 0,
  • "title": "string",
  • "contract_file_info{}": {
    },
  • "customer_info[]": [
    ],
  • "stamp_type": 0,
  • "contract_type": 0,
  • "unilateral_flg": 0,
  • "agreement_date": "yyyy-MM-dd",
  • "valid_from": "yyyy-MM-dd",
  • "valid_to": "yyyy-MM-dd",
  • "auto_ext_flg": 0,
  • "auto_ext_term": 0,
  • "survival_clause_flg": 0,
  • "amount": "string",
  • "common_memo": "string",
  • "send_comment": "string",
  • "contract_nominee_id": 0
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "contract_no": 0,
  • "contract_status": 0
}

契約種別更新

  • 概要：契約書の契約種別を変更したい場合に使用する。
    契約ステータスが「社内申請中」以外の場合のみ利用可能。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

contract_no
required
number (契約書番号) <= 12 characters

契約書番号を指定する。

contract_type
required
number (契約種別(コード)) <= 10 characters

契約種別を指定する。
例）1 ( 秘密保持契約書)
コード値はAppendixの「契約種別」を参照

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "contract_no": 0,
  • "contract_type": 0
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "contract_no": 0,
  • "contract_status": 0
}

添付ファイル

添付ファイル取得

  • 概要：契約書の添付ファイルを取得するために利用する。
query Parameters
response_type
required
string <= 10 characters
Example: response_type=string

“json”または”xml”を指定する。

contract_no
required
number <= 12 characters
Example: contract_no=0

契約書番号を指定する。

Responses

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "contract_no": 0,
  • "attachfile_info[]": [
    ]
}

添付ファイル追加

  • 概要：契約書に対して、別紙的なファイルを付与して取引先に閲覧させたい場合などに利用する。
    ただし契約書を取引先に発行後は添付ファイルの追加ができない。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

contract_no
required
number (契約書番号) <= 12 characters

契約書番号を指定する。

required
Array of objects (添付ファイル情報)

最大10ファイルまで指定可能。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "contract_no": 0,
  • "attachfile_info[]": [
    ]
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "contract_no": 0,
  • "contract_status": 0
}

添付ファイル削除

  • 概要：契約書に対して、付与した添付ファイルの削除を行う場合に利用する。
    ただし、契約書を取引先に発行後は削除できない。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

contract_no
required
number (契約書番号) <= 12 characters

契約書番号を指定する。

required
Array of objects (添付ファイル情報)

最大10ファイルまで指定可能。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "contract_no": 0,
  • "attachfile_info[]": [
    ]
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "contract_no": 0,
  • "contract_status": 0
}

自社情報

自社情報取得

  • 概要：契約書の自社情報（自社担当者・タグ・社内メモなど）を取得するために利用する。
query Parameters
response_type
required
string <= 10 characters
Example: response_type=string

“json”または”xml”を指定する。

contract_no
required
number <= 12 characters
Example: contract_no=0

契約書番号を指定する。

Responses

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "contract_no": 0,
  • "contract_mng_no": "string",
  • "charge_user_code": "string",
  • "charge_user_name": "string",
  • "tag_info[]": [
    ],
  • "company_memo": "string",
  • "notice_info[]": {
    },
  • "notice_user_info[]": [
    ]
}

自社情報更新

  • 概要：対象の契約書に付随する自社で管理する情報（自社担当者・タグ・社内メモなど）を更新する場合に利用する。
  • 備考・補足：※項目に空を指定した場合は未入力として更新を行う。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

contract_no
required
number (契約書番号) <= 12 characters

例）100000012345

contract_mng_no
string (自社契約書番号) <= 20 characters

自社内で管理番号などがある場合に利用する。
半角英数（記号は-_.が利用可能）

charge_user_code
required
string (自社担当者（社員コード）) <= 15 characters

マスタ値の参照方法はAppendixの「社員コード」を参照

Array of objects (タグ情報)

最大10個のタグまで指定可能。

company_memo
string (社内メモ) <= 500 characters

社内のみ共有するメモを指定する。
文章の改行を行う場合は\nを指定する。

object (通知情報)
Array of objects (通知対象者情報)

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "contract_no": 0,
  • "contract_mng_no": "string",
  • "charge_user_code": "string",
  • "tag_info[]": [
    ],
  • "company_memo": "string",
  • "notice_info[]": {
    },
  • "notice_user_info[]": [
    ]
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "contract_no": 0,
  • "contract_status": 0
}

参照者情報

参照者情報取得

  • 概要：契約書の参照者設定を取得するために利用する。
query Parameters
response_type
required
string <= 10 characters
Example: response_type=string

“json”または”xml”を指定する。

contract_no
required
number <= 12 characters
Example: contract_no=0

契約書番号を指定する。

Responses

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "contract_no": 0,
  • "referrer_info[]": [
    ],
  • "sector_info[]": [
    ],
  • "all_referrer_flg": 0,
  • "all_referrer_name": "string"
}

参照者情報更新

  • 概要：契約書の参照者（個人や組織）を設定する場合に利用する。
    項目に空を指定した場合は未入力として更新を行う。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

contract_no
required
number (契約書番号) <= 12 characters

契約書番号を指定する。

Array of objects (参照者情報)

参照者は最大50まで登録可能。

Array of objects (参照部署情報)

参照部署は最大50まで登録可能。

all_referrer_flg
number (全社員参照可能フラグ) <= 1 characters

1：全社員が参照可能
0：作成者および自社担当者、代理作成者、全契約書参照権限、全自社保管参照権限のみ参照可能
Default　0

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "contract_no": 0,
  • "referrer_info[]": [
    ],
  • "sector_info[]": [
    ],
  • "all_referrer_flg": 0
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "contract_no": 0,
  • "contract_status": 0
}

関連契約書

関連付け情報取得

  • 概要：契約書の関連付け情報を取得するために利用する。
query Parameters
response_type
required
string <= 10 characters
Example: response_type=string

“json”または”xml”を指定する。

contract_no
required
number <= 12 characters
Example: contract_no=0

契約書番号を指定する。

Responses

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "contract_no": 0,
  • "relation_info{}": [
    ]
}

関連付け情報(親)更新

  • 概要：BtoBPF契約書で管理している既存の契約書と関連付けを行いたい場合に利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

contract_no
required
number (契約書番号) <= 12 characters

契約書番号を指定する。

parent_contract_no
number (関連付け親契約書番号) <= 12 characters

親として関連付けを行う契約書番号を指定する。 指定しない場合はすでに設定済みの契約書に紐づく関連付け(親)を解除する。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "contract_no": 0,
  • "parent_contract_no": 0
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "contract_no": 0,
  • "contract_status": 0
}

関連付け情報(子)更新

  • 概要：BtoBPF契約書で管理している既存の契約書と関連付けを行いたい場合に利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

contract_no
required
number (契約書番号) <= 12 characters

契約書番号を指定する。

Array of objects (関連付け子契約書)

関連付けは最大500まで指定可能。 指定しない場合はすでに設定済みの関連付け(子)を解除する。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "contract_no": 0,
  • "relation_child_info[]": [
    ]
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "contract_no": 0,
  • "contract_status": 0
}

雇用契約

雇用契約詳細取得

  • 概要：雇用契約書や雇用契約書（自社保管）の詳細情報を取得する。
query Parameters
response_type
required
string <= 10 characters
Example: response_type=string

“json”または”xml”を指定する。

employ_no
required
string <= 10 characters
Example: employ_no=string

取得対象の雇用契約書番号を指定する。

Responses

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "employ_no": "string",
  • "employ_status": 0,
  • "basic_info[]": [
    ],
  • "company_info[]": [
    ],
  • "send_request_info[]": [
    ],
  • "confirm_request_info[]": [
    ],
  • "referrer_info[]": [
    ],
  • "sector_info[]": [
    ],
  • "send_error_flg": 0,
  • "regain_comment": "string",
  • "remand_comment": "string",
  • "storage_flg": 0,
  • "sendreq_info[]": [
    ]
}

雇用契約ひな形取得

  • 概要：書類セットに紐づくテンプレートに含まれる各項目の情報を取得する場合に利用する。
    雇用契約を作成するためには、「書類セット検索 API」→「雇用契約ひな型取得 API」→「雇用契約作成 API」を実行する必要がある。
    上記の詳細はAppendixの「業務シーケンス」を参照のこと。
query Parameters
response_type
required
string <= 10 characters
Example: response_type=string

“json”または”xml”を指定する。

document_set_id
required
number <= 10 characters
Example: document_set_id=0

作成したい雇用契約書の書類セットを指定する。
書類セットIDは「5.33 書類セット検索API」を実行する事で特定可能

Responses

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "document_set_id": 0,
  • "document_set_name": "string",
  • "template_info[]": [
    ]
}

雇用契約検索

  • 概要：雇用契約書や雇用契約書（自社保管）の検索を行う場合に利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

Array of objects (キーワードリスト)

検索ワードで絞り込みを行いたい場合に指定する。
キーワードは最大10件まで指定可能

Array of objects (雇用契約ステータスリスト)

雇用契約ステータスで絞り込みを行いたい場合に指定する。

Array of objects (社内確認状態リスト)

社内確認状態で絞り込みを行いたい場合に指定する。

Array of objects (雇用契約書番号リスト)

雇用契約書番号で絞り込みを行いたい場合に指定する。 雇用契約書番号は最大500件まで指定可能

send_error_flg
number (送信エラーフラグ)

送信エラーが発生している雇用契約書で絞り込みを行いたい場合は1を指定する。
0:送信エラー無し
1:送信エラーあり
Default 指定なし

agreement_limit_from
string <date> (合意期限日(FROM)) <= 10 characters

合意期限日で絞り込みを行いたい場合に指定する。
Default 指定なし
YYYY-MM-DD 形式
例) 2020-06-01

agreement_limit_to
string <date> (合意期限日(TO)) <= 10 characters

合意期限日で絞込みを行いたい場合に指定する。
Default 指定なし
YYYY-MM-DD 形式
例）2020-06-01

create_date_from
string <date> (作成日(FROM)) <= 10 characters

作成日で絞込みを行いたい場合に指定する。
Default 指定なし
YYYY-MM-DD 形式
例）2020-06-01

create_date_to
string <date> (作成日(TO)) <= 10 characters

作成日で絞込みを行いたい場合に指定する。
Default 指定なし
YYYY-MM-DD 形式
例）2020-06-01

send_date_from
string <date> (送信日(FROM)) <= 10 characters

送信日で絞込みを行いたい場合に指定する。
Default 指定なし
YYYY-MM-DD 形式
例）2020-06-01

send_date_to
string <date> (送信日(TO)) <= 10 characters

送信日で絞込みを行いたい場合に指定する。
Default 指定なし
YYYY-MM-DD 形式
例）2020-06-01

agreement_date_from
string <date> (合意日(FROM)) <= 10 characters

合意日で絞込みを行いたい場合に指定する。
Default 指定なし
YYYY-MM-DD 形式
例）2020-06-01

agreement_date_to
string <date> (合意日(TO)) <= 10 characters

合意日で絞込みを行いたい場合に指定する。
Default 指定なし
YYYY-MM-DD 形式
例）2020-06-01

valid_start_date_from
string <date> (契約期間（開始）(FROM)) <= 10 characters

契約期間で絞込みを行いたい場合に指定する。
Default 指定なし
YYYY-MM-DD 形式
例）2020-06-01

valid_start_date_to
string <date> (契約期間（開始）(TO)) <= 10 characters

契約期間で絞込みを行いたい場合に指定する。
Default 指定なし
YYYY-MM-DD 形式
例）2020-06-01

valid_end_date_from
string <date> (契約期間（終了）(FROM)) <= 10 characters

契約期間で絞込みを行いたい場合に指定する。
Default 指定なし
YYYY-MM-DD 形式
例）2020-06-01

valid_end_date_to
string <date> (契約期間（終了）(TO)) <= 10 characters

契約期間で絞込みを行いたい場合に指定する。
Default 指定なし
YYYY-MM-DD 形式
例）2020-06-01

expired_flg
number (契約期間切れ) <= 1 characters

契約期間期限切れで絞込みを行いたい場合に指定する。
1：契約期間期限切れで絞込み
0：契約期間切れによる絞込みをしない
Default 契約期間切れによる絞込みをしない

remind_date_from
string <date> (リマインド日(FROM)) <= 10 characters

リマインド日で絞込みを行いたい場合に指定する。
Default 指定なし
YYYY-MM-DD 形式
例）2020-06-01

remind_date_to
string <date> (リマインド日(TO)) <= 10 characters

リマインド日で絞込みを行いたい場合に指定する。
Default 指定なし
YYYY-MM-DD 形式
例）2020-06-01

open_flg
number (未読/既読) <= 1 characters

API 実行者の雇用契約書の未読/既読で絞込みを行いたい場合に指定する。
0:未読
1:既読
Default 指定なし

worker_open_flg
number (開封状況) <= 1 characters

労働者の開封状況で絞込みを行いたい場合に指定する。
0:開封済み
1:未開封
Default 指定なし

creator_user_code
string (作成者(社員コード)) <= 15 characters

作成者で絞込みを行いたい場合に指定する。
マスタ値の参照方法はAppendixの「社員コード」を参照
Default 指定なし

Array of objects (タグ情報)

タグで絞り込みを行いたい場合に指定する。
タグは最大 10 件まで指定可能。

update_date
string <date-time> (更新日時) <= 19 characters

更新日時以降に変更があった雇用契約書を検索する。
YYYY-MM-DD hh:mi:ss 形式
Default 指定なし

storage_flg
number (自社保管フラグ) <= 1 characters

雇用契約か自社保管で絞込みを行いたい場合に指定する。
0:雇用契約
1:自社保管
Default 指定なし

sort_item
number (ソート項目) <= 1 characters

0：更新日時
1：労働者氏名
2：件名
3：書類セット名
4：ステータス
5：合意期限日
6：契約終了日
Default 更新日時

sort_order
number (ソート基準) <= 1 characters

0：昇順
1：降順
Default 降順

search_limit
number (検索結果上限) <= 4 characters

取得件数の上限を指定する。
Default 100
Max 1000

sendreq_lock_flg
number (提出依頼確認状況) <= 1 characters

提出依頼確認状況で絞込みを行いたい場合に指定する。
0:未確定
1:確定
2:両方
※提出依頼確認状況を指定した場合は、提出依頼を利用する雇用契約書のみ抽出されます。
Default 指定なし

emp_sendfile_flg
number (労働者の書類添付状況) <= 1 characters

労働者の書類添付状況で絞込みを行いたい場合に指定する。
0:提出書類の添付なし
1:提出書類の添付あり
2:両方
※労働者の書類添付状況を指定した場合は、提出依頼を利用する雇用契約書のみ抽出されます。
Default 指定なし

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "keyword_list[]": [
    ],
  • "employ_status_list[]": [
    ],
  • "in_house_status_list[]": [
    ],
  • "employ_no_list[]": [
    ],
  • "send_error_flg": 0,
  • "agreement_limit_from": "yyyy-MM-dd",
  • "agreement_limit_to": "yyyy-MM-dd",
  • "create_date_from": "yyyy-MM-dd",
  • "create_date_to": "yyyy-MM-dd",
  • "send_date_from": "yyyy-MM-dd",
  • "send_date_to": "yyyy-MM-dd",
  • "agreement_date_from": "yyyy-MM-dd",
  • "agreement_date_to": "yyyy-MM-dd",
  • "valid_start_date_from": "yyyy-MM-dd",
  • "valid_start_date_to": "yyyy-MM-dd",
  • "valid_end_date_from": "yyyy-MM-dd",
  • "valid_end_date_to": "yyyy-MM-dd",
  • "expired_flg": 0,
  • "remind_date_from": "yyyy-MM-dd",
  • "remind_date_to": "yyyy-MM-dd",
  • "open_flg": 0,
  • "worker_open_flg": 0,
  • "creator_user_code": "string",
  • "tag_info[]": [
    ],
  • "update_date": "yyyy-MM-dd HH：mm：ss",
  • "storage_flg": 0,
  • "sort_item": 0,
  • "sort_order": 0,
  • "search_limit": 0,
  • "sendreq_lock_flg": 0,
  • "emp_sendfile_flg": 0
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "limit_over_flg": 0,
  • "search_result[]": [
    ]
}

雇用契約作成

  • 概要：雇用契約書を作成する際に利用する。
    また社内管理書類、付帯書類、参照者設定などの設定を行う場合は、後に記載する API を利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

document_set_id
required
number (使用書類セットID) <= 10 characters

使用する書類セットIDを指定する

required
Array of objects (テンプレート情報)

雇用契約ひな形取得APIで取得した[テンプレート情報]をすべて指定する。

required
Array of objects (基本情報)

1件のみ指定する。

required
Array of objects (管理情報)

1 件のみ指定する。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "document_set_id": 0,
  • "template_info[]": [
    ],
  • "basic_info[]": [
    ],
  • "company_info[]": [
    ]
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "employ_no": "string",
  • "employ_status": 0
}

雇用契約送信

  • 概要：雇用契約書を労働者に送信する際に利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

employ_no
required
string (雇用契約書番号) <= 10 characters

送信対象の雇用契約書番号を指定する。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "employ_no": "string"
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "employ_no": "string",
  • "employ_status": 0
}

雇用契約更新

  • 概要：対象の雇用契約書の労働者メールアドレスや付随する自社で管理する情報（タグ・社内メモなど）を更新する場合に利用する。
    ※項目に空を指定した場合は未入力として更新する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

employ_no
required
string (雇用契約書番号) <= 10 characters

更新対象の雇用契約書番号を指定する。

emp_mail_address
string (労働者メールアドレス) <= 200 characters

雇用契約書を送付する労働者のメールアドレスを指定する。
値に空を指定すると未入力の状態に更新する。
パラメータ項目(emp_mail_address)を省略すると更新対象外となる

Array of objects (管理情報)

パラメータ項目(company_info[])を省略すると更新対象外となる。
雇用契約ステータスが取消の場合は管理情報の更新不可。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "employ_no": "string",
  • "emp_mail_address": "string",
  • "company_info[]": [
    ]
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "employ_no": "string",
  • "employ_status": 0
}

雇用契約取戻

  • 概要：労働者に送信した雇用契約書を取り戻す際に利用する。
    ※すでに合意済み、差し戻しされている場合は取り戻し不可
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

employ_no
required
string (雇用契約書番号) <= 10 characters

取戻対象の雇用契約書番号を指定する。

regain_comment
required
string (取戻コメント) <= 500 characters

取戻コメントを指定する。
文章の改行を行う場合は\nを指定する。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "employ_no": "string",
  • "regain_comment": "string"
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "employ_no": "string",
  • "employ_status": 0
}

雇用契約取消

  • 概要：雇用契約書を取り消す際に利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

employ_no
required
string (雇用契約書番号) <= 10 characters

取消対象の雇用契約書番号を指定する。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "employ_no": "string"
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "employ_no": "string",
  • "employ_status": 0
}

雇用契約削除

  • 概要：雇用契約書を削除する際に利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

employ_no
required
string (雇用契約書番号) <= 10 characters

更新対象の雇用契約書番号を指定する。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "employ_no": "string"
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ]
}

自社保管

自社保管作成

  • 概要：雇用契約書(自社保管)を作成する際に利用する。
    また社内管理書類、付帯書類、参照者設定などの設定を行う場合は、後に記載するAPIを利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

required
Array of objects (自社保管ファイル情報)

自社保管ファイルは最大５個まで登録可能。

required
Array of objects (基本情報)

1 件のみ指定する。

required
Array of objects (管理情報)

1 件のみ指定する。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "storage_file_info[]": [
    ],
  • "basic_info[]": [
    ],
  • "company_info[]": [
    ]
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "employ_no": "string",
  • "employ_status": 0
}

自社保管更新

  • 概要：雇用契約書(自社保管)を更新する場合に利用する。
    ※項目に空を指定した場合は未入力として更新する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

employ_no
required
string (雇用契約書番号) <= 10 characters

更新対象の雇用契約書番号を指定する。

required
Array of objects (基本情報)

1 件のみ指定する。

required
Array of objects (管理情報)

1 件のみ指定する。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "employ_no": "string",
  • "basic_info[]": [
    ],
  • "company_info[]": [
    ]
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "employ_no": "string",
  • "employ_status": 0
}

自社保管取消

  • 概要：雇用契約書(自社保管)を取り消しする場合に利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

employ_no
required
string (雇用契約書番号) <= 10 characters

取消対象の雇用契約書番号を指定する。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "employ_no": "string"
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "employ_no": "string",
  • "employ_status": 0
}

自社保管削除

  • 概要：雇用契約書(自社保管)を削除する場合に利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

employ_no
required
string (雇用契約書番号) <= 10 characters

取消対象の雇用契約書番号を指定する。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "employ_no": "string"
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ]
}

社内管理書類

社内管理書類追加

  • 概要：雇用契約書や雇用契約書（自社保管）に対して、社内用の管理書類を付与する場合に利用する。
    ※社内管理書類は労働者の参照不可。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

employ_no
required
string (雇用契約書番号) <= 10 characters

取消対象の雇用契約書番号を指定する。

required
Array of objects (社内管理書類情報)

社内管理書類は最大10個まで登録可能

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "employ_no": "string",
  • "internal_document_info[]": [
    ]
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "employ_no": "string",
  • "employ_status": 0
}

社内管理書類削除

  • 概要：雇用契約書や雇用契約書（自社保管）に対して、付与した社内用の管理書類を削除する場合に利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

employ_no
required
string (雇用契約書番号) <= 10 characters

社内管理書類の削除対象の雇用契約書番号を指定する。

required
Array of objects (社内管理書類情報)

削除対象の社内管理書類名は最大10個まで指定可能。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "employ_no": "string",
  • "internal_document_info[]": [
    ]
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "employ_no": "string",
  • "employ_status": 0
}

付帯書類

付帯書類追加

  • 概要：雇用契約書や雇用契約書(自社保管)に対して、別紙的なファイルを付与して労働者に参照させる場合に利用する。
    ※雇用契約書を労働者に送信した後は追加不可。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

employ_no
required
string (雇用契約書番号) <= 10 characters

付帯書類の追加対象の雇用契約番号を指定する。

required
Array of objects (付帯書類情報)

付帯書類は最大10個まで登録可能

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "employ_no": "string",
  • "attach_document_info[]": [
    ]
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "employ_no": "string",
  • "employ_status": 0
}

付帯書類削除

  • 概要：雇用契約書や雇用契約書(自社保管)に対して、付与した付帯書類を削除する場合に利用する。
    ※雇用契約書を労働者に送信した後は削除不可、
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

employ_no
required
string (雇用契約書番号) <= 10 characters

付帯書類の削除対象の雇用契約番号を指定する。

required
Array of objects (付帯書類情報)

削除対象の付帯書類は最大10個まで指定可能

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "employ_no": "string",
  • "attach_document_info[]": [
    ]
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "employ_no": "string",
  • "employ_status": 0
}

提出書類

雇用契約提出依頼書類更新

  • 概要：雇用契約書の提出依頼確認状況を更新する場合に利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

employ_no
required
string (雇用契約書番号) <= 10 characters

付帯書類の追加対象の雇用契約番号を指定する。

sendreq_lock_flg
required
string (提出依頼確認状況) <= 1 characters

0:未確認
1:確認

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "employ_no": "string",
  • "sendreq_lock_flg": "string"
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "employ_no": "string",
  • "employ_status": 0
}

雇用契約提出依頼書類削除

  • 概要：雇用契約書に対して、付与された提出書類を削除する場合に利用する。
    ※提出依頼確認状況が確定の場合は削除不可。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

employ_no
required
string (雇用契約書番号) <= 10 characters

提出書類の削除対象の雇用契約書番号を指定する。

required
Array of objects (提出依頼確認状況)

提出書類の削除対象の雇用契約書番号を指定する。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "employ_no": "string",
  • "sendfile_info[]": "string"
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "employ_no": "string",
  • "employ_status": 0
}

参照者情報(雇用契約)

参照者情報更新

  • 概要：雇用契約書や雇用契約書(自社保管)の参照者(個人や組織)を設定する場合に利用する。
    ※項目に空を指定した場合は未入力として更新を行う。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

employ_no
required
string (雇用契約書番号) <= 10 characters

参照者情報の更新対象の雇用契約書番号を指定する。

Array of objects (参照者情報)

参照者は最大50個まで登録可能。

Array of objects (参照部署情報)

参照者は最大50個まで登録可能。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "employ_no": "string",
  • "referrer_info[]": "string",
  • "sector_info[]": "string"
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "employ_no": "string",
  • "employ_status": 0
}

社内依頼

社内依頼送信

  • 概要：雇用契約書の送信依頼・確認依頼の送信を行う場合に利用する。
    ※社内依頼の送信は社内確認状態が未送信、社内確認（差戻）、社内確認（取戻）の場合に可能で、実行後は社内確認中になる。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

employ_no
required
string (雇用契約書番号) <= 10 characters

社内依頼送信対象の雇用契約書番号を指定する。

process_type
required
number (処理対象) <= 1 characters

1：送信依頼 2：確認依頼

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "employ_no": "string",
  • "process_type": 0
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "employ_no": "string",
  • "employ_status": "string",
  • "send_request_info[]": [
    ],
  • "confirm_request_info[]": [
    ]
}

社内依頼承認

  • 概要：雇用契約書の送信依頼・確認依頼の承認を行う場合に利用する。
    ※社内依頼を承認すると社内確認状態が社内確認中から社内確認済になる。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

employ_no
required
string (雇用契約書番号) <= 10 characters

社内依頼承認対象の雇用契約書番号を指定する。

process_type
required
number (処理対象) <= 1 characters

1：送信依頼 2：確認依頼

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "employ_no": "string",
  • "process_type": 0
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "employ_no": "string",
  • "employ_status": "string",
  • "send_request_info[]": [
    ],
  • "confirm_request_info[]": [
    ]
}

社内依頼更新

  • 概要：雇用契約書の送信依頼・更新依頼の確認者を変更したい場合に利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

employ_no
required
string (雇用契約書番号) <= 10 characters

更新対象の雇用契約書番号を指定する。

Array of objects (送信依頼情報)

パラメータ項目(send_request_info[])を省略すると更新対象外となる。

Array of objects (確認依頼情報)

パラメータ項目(confirm_request_info[])を省略すると更新対象外となる。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "employ_no": "string",
  • "send_request_info[]": [
    ],
  • "confirm_request_info[]": [
    ]
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "employ_no": "string",
  • "employ_status": "string",
  • "send_request_info[]": [
    ],
  • "confirm_request_info[]": [
    ]
}

社内依頼取戻

  • 概要：雇用契約書の送信依頼・確認依頼の取り戻しを行う場合に利用する。 ※社内依頼を取り戻しすると社内確認状態が社内確認中から社内確認（取戻）になる。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

employ_no
required
string (雇用契約書番号) <= 10 characters

社内依頼取戻対象の雇用契約書番号を指定する。

regain_comment
required
string (取戻コメント) <= 500 characters

取戻コメントを設定する。
文章の改行を行う場合は\nを指定する。

process_type
required
number (処理対象) <= 1 characters

1：送信依頼 2：確認依頼

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "employ_no": "string",
  • "regain_comment": "string",
  • "process_type": 0
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "employ_no": "string",
  • "employ_status": "string",
  • "send_request_info[]": [
    ],
  • "confirm_request_info[]": [
    ]
}

社内依頼差戻

  • 概要：雇用契約書の送信依頼・確認依頼の差し戻しを行う場合に利用する。 ※社内依頼を差し戻しすると社内確認状態が社内確認中から社内確認（差戻）になる。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

employ_no
required
string (雇用契約書番号) <= 10 characters

社内依頼差戻対象の雇用契約書番号を指定する。

remand_comment
required
string (差戻コメント) <= 500 characters

差戻コメントを設定する。 文章の改行を行う場合は\nを指定する。

process_type
required
number (処理対象) <= 1 characters

1：送信依頼 2：確認依頼

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "employ_no": "string",
  • "remand_comment": "string",
  • "process_type": 0
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "employ_no": "string",
  • "employ_status": "string",
  • "send_request_info[]": [
    ],
  • "confirm_request_info[]": [
    ]
}

利用者管理

利用者検索

  • 概要：利用者管理（雇用契約機能の利用者を管理する機能）を検索する
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

Array of objects (社員コードリスト)

社員コードで絞り込みを行いたい場合に指定する。
社員コードは最大50個まで指定可能。

Array of objects (キーワードリスト)

検索ワードで絞り込みを行いたい場合に指定する。
キーワードは最大10件まで指定可能。

search_limit
number (検索結果上限) <= 4 characters

取得件数の上限を指定する。
Default 100
Max 1000

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "user_code_info[]": [
    ],
  • "keyword_list[]": [
    ],
  • "search_limit": 0
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "limiti_over_flg": "string",
  • "search_result[]": [
    ]
}

利用者設定

  • 概要：利用者管理（雇用契約機能の利用者を管理する機能）に社員を追加する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

required
Array of objects (社員コードリスト)

社員コードは最大50個まで指定可能。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "user_code_info[]": [
    ]
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ]
}

利用者削除

  • 概要：利用者管理（雇用契約機能の利用者を管理する機能）から社員を削除する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

required
Array of objects (社員コードリスト)

社員コードは最大50個まで指定可能。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "user_code_info[]": [
    ]
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ]
}

タグ管理

タグ検索

  • 概要：雇用契約のタグを検索する場合に利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

Array of objects (タグキーワードリスト)

検索ワードで絞り込みを行いたい場合に指定する。
キーワードは最大10件まで指定可能。

search_limit
number (検索結果上限) <= 4 characters

取得件数の上限を指定する。
Default 100
Max 1000

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "tag_keyword_list[]": [
    ],
  • "search_limit": 0
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "limit_over_flg": "string",
  • "tag_info[]": [
    ]
}

タグ登録

  • 概要：雇用契約のタグを登録する場合に利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

required
Array of objects (タグ情報)

タグは最大50個まで登録可能。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "tag_info[]": [
    ]
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "tag_info[]": [
    ]
}

タグ更新

  • 概要：指定した雇用契約のタグを更新する場合に利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

required
Array of objects (タグ情報)

タグは最大50個まで登録可能。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "tag_info[]": [
    ]
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "tag_info[]": [
    ]
}

タグ削除

  • 概要：指定した雇用契約のタグを削除する場合に利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

required
Array of objects (タグ情報)

タグは最大50個まで登録可能。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "tag_info[]": [
    ]
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ]
}

書類セット管理

書類セット検索

  • 概要：雇用契約の書類セットの検索を行う場合に利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

Array of objects (書類セットキーワードリスト)

検索ワードで絞り込みを行いたい場合に指定する。
キーワードは最大10件まで指定可能。

sendreq_use_flg
string (提出依頼の利用) <= 1 characters

提出依頼の利用有無で絞り込みを行いたい場合に指定する。
0：提出依頼を利用しない
1：提出依頼を利用する
Default 指定なし

sendreq_required_flg
string (提出依頼の必須設定) <= 1 characters

提出依頼の必須設定で絞り込みを行いたい場合に指定する。
0：任意
1：必須
Default 指定なし

search_limit
number (検索結果上限) <= 4 characters

取得件数の上限を指定する。
Default 100 Max 1000

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "document_set_keyword_list[]": [
    ],
  • "sendreq_use_flg": "s",
  • "sendreq_required_flg": "s",
  • "search_limit": 0
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "limit_over_flg": 0,
  • "document_set_info[]": [
    ]
}

テンプレート管理

テンプレート検索

  • 概要：雇用契約のテンプレートの検索を行う場合に利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

“json”または”xml”を指定する。

Array of objects (テンプレートキーワードリスト)

検索ワードで絞り込みを行いたい場合に指定する。
キーワードは最大10件まで指定可能。

search_limit
number (検索結果上限) <= 4 characters

取得件数の上限を指定する。
Default 100 Max 1000

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "template_keyword_list[]": [
    ],
  • "search_limit": 0
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "limit_over_flg": 0,
  • "template_info[]": [
    ]
}

Appendix

補足資料

ReleaseNote

契約書

更新日 API 内容
2020/8/27 自社情報取得API
自社情報更新API		 「リマインド(日付指定)」を追加
2021/1/8 各API 説明文の変更
2021/5/12 契約書取消API
契約書削除API
契約書差戻API
添付ファイル削除API		 APIのメソッドをDELETEからPUTに変更
2021/6/2 契約種別 備考欄を訂正
2021/6/10 エラーコード一覧 API名称の誤字を訂正
2021/6/10 参照者情報更新API 全社員参照可能フラグのDefault値の記載を追加
2021/7/6 呼び出し回数制限 呼び出し回数制限を超過した場合に返却するエラーコードを記載
2021/8/11 契約書検索API Bodyパラメータ仕様の更新日時（update_date）の書式を記載
2021/10/21 エラーコード一覧 HTTPステータスコード値の記載一部エラーメッセージの修正
2021/11/11 契約書差戻API
契約書締結API
基本情報取得API
基本情報作成API
契約種別更新API
エラーコード一覧		 契約書差戻API
差戻コメント→差戻時コメントに変更

契約書締結API
agreement_commentを追加

基本情報取得API
auto_ext_termをauto_ext_flgに変更 auto_ext_term_nameをauto_ext_nameに変更 auto_ext_term(自動延長期間（月）)を追加
remand_commentを削除 send_commentを削除 comment_infoを追加

基本情報作成API
auto_ext_termをauto_ext_flgに変更
auto_ext_term(自動延長期間（月）)を追加

契約種別更新APIを追加

エラーコード一覧
API追加・変更に伴う変更
2021/12/9 基本情報作成API
エラーコード一覧		 基本情報作成API
・ExcelファイルのPDF変換対応

エラーコード一覧
・エラーメッセージ(CNT08_006)の修正
2022/6/1 エラーコード一覧 エラーメッセージ(CNT08_082, CNT08_083, CNT08_084, CNT08_085, CNT08_086, CNT08_087, CNT08_088)の追加
2022/12/27 エラーコード一覧 ・エラーメッセージ(CNT12_017, CNT12_018)の追加
・エラーメッセージ(CNT12_013)の修正
2024/10/23 締結概要書取得API 新規追加
2025/3/18 基本情報作成API エラーメッセージ(CNT08_056, CNT08_057, CNT08_060, CNT08_061)の修正

雇用契約

更新日 API 内容
2021/10/20 初版
2022/1/20 雇用契約削除API
自社保管削除API		 新規追加
2022/3/15 雇用契約提出依頼書類更新API
雇用契約提出依頼書類削除API		 新規追加
2022/3/15 雇用契約検索API リクエスト項目に以下を追加
「提出依頼確認状況」
「労働者の書類添付状況」
2022/3/15 雇用契約詳細取得API レスポンス項目に以下を追加
「提出依頼情報」
2022/3/15 書類セット検索API ・リクエスト項目に以下を追加
「提出依頼の利用」
「提出依頼の必須設定」
・レスポンス項目に以下を追加
「提出依頼の利用」
「提出依頼の必須設定」
「提出依頼の説明文」
2022/12/27 エラーコード一覧 エラーメッセージ(EMP17_024)を追加