Back to top

ジョブカン経費精算/ワークフローAPI(β版)

はじめに

本APIはβ版のため、仕様変更の可能性があります。

ジョブカン経費精算/ワークフローAPI(β版)でできること。

現在、以下の機能がAPIから利用できます。

  • ユーザ

    • 一覧の取得
    • 個別情報の取得
    • 新規登録
    • 更新
    • 停止
  • グループ

    • 一覧の取得
    • 個別情報の取得
    • 新規登録
    • 更新
    • 削除
  • 役職

    • 一覧の取得
    • 個別情報の取得
    • 新規登録
    • 更新
    • 削除
  • プロジェクト

    • 一覧の取得
    • 個別情報の取得
    • 新規登録
    • 更新
    • 削除
  • 汎用マスタレコード

    • 一覧の取得
    • 個別情報の取得
    • 新規登録
    • 更新
    • 削除
  • 申請書

    • 一覧の取得
  • 仕訳

    • 確定済み未出力一覧の取得
    • 確定済み未出力一覧の更新
  • 交通系ICカード

    • アップロード

必要なもの

  1. 「ジョブカンワークフロー」または「ジョブカン経費精算」のアカウント

  2. APIのクライアントには以下が必要です

    • RESTfulなHTTPリクエスト
    • JSONのパースやシリアライズ
    • API Token(管理画面より取得)

利用手順

  • アクセストークンつきでHTTPリクエストを行うことで、APIにアクセスすることができます。

  • リクエスト、レスポンス、どちらもJSONでやりとりを行います。

  • 各APIは、URLとHTTPメソッドで操作を表します。

    • GET 参照
    • POST 新規登録
    • PUT 更新
    • DELETE 削除
  • POSTの際には、ヘッダにContent-Type: application/jsonをつけ、 リクエストボディにJSONを送信します。

  • リクエストボディのJSONに日本語が含まれる場合は 文字コードはUTF-8、\uNNNN 形式でエンコードされている必要があります。

  • 各処理で利用される「xxx_code」は、半角英数字のみ利用可能です。

  • Authorizationヘッダに以下の形式でアクセストークンを付与し、各APIへのリクエストを行います。

    • Tokenの前後には半角スペース一つずつを設定してください(「 Token 」としてください)。
  • Headers

    Authorization:  Token 管理画面より発行されたAPIトークン
  • 1アクセストークンあたり、1時間5000回のリクエストを上限とし、それ以上のリクエストはエラーとなります。

ページング

API のすべての GET メソッドでは、100件を超えるデータを一度に取得することはできません。

取得すべきデータが100件を超えた場合、レスポンスに含まれるデータは100件となり、同じレスポンスの "next" 要素に残りのデータを取得するための URL が示されます。この URL にアクセスし続けることで、順々に最後までデータを取得していただくことが可能です。

残りのデータが存在しない場合、"next"null となります。

API詳細

各APIインターフェイスです。
HTTPメソッドと、 https://ssl.wf.jobcan.jp/wf_api/ 以下のパスを記載しています。

Test

APIトークンテスト

APIトークンテスト
GET/test/

  • APIトークンの設定値が正しいかどうかのテスト時に利用する

  • 問題ない場合、ステータスコード200を返す

  • 問題がある場合、ステータスコード401を返す

Example URI

GET /test/
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "test": "ok"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "test": {
      "type": "string"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "detail": "Invalid token"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "detail": {
      "type": "string"
    }
  }
}

User

ユーザ情報 v1

ユーザ一覧取得
GET/v1/users/

  • 登録されているユーザ情報を取得する

  • 取得に成功した場合、ユーザ情報を返す

Example URI

GET /v1/users/
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "count": 130,
  "next": "https://ssl.wf.jobcan.jp/wf_api/v1/users/?page=2",
  "previous": null,
  "results": [
    {
      "user_code": "hoge",
      "email": "hoge@hoge.com",
      "last_name": "ジョブカン",
      "first_name": "太郎",
      "is_approver": true,
      "user_role": 1,
      "user_groups": [
        "100",
        "200"
      ],
      "user_positions": [
        "butyo"
      ],
      "user_bank_account": {
        "bank_code": "0000",
        "bank_name": "ジョブカン銀行",
        "branch_code": "000",
        "branch_name": "ドーナツ支店",
        "bank_account_type_code": "1",
        "bank_account_code": "1234567",
        "bank_account_name_kana": "ジョブカンタロウ"
      }
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "count": {
      "type": "number",
      "description": "合計件数"
    },
    "next": {
      "type": "string",
      "description": "next url"
    },
    "previous": {
      "type": [
        "object",
        "null"
      ],
      "properties": {},
      "description": "previous url"
    },
    "results": {
      "type": "array",
      "description": "ユーザ情報を格納した配列"
    }
  }
}

ユーザ新規登録
POST/v1/users/

  • ユーザを新規登録する

  • is_invitation=trueの場合、登録されたユーザに対してパスワード設定用の招待メールが送信されます。

  • 共通ID上で一括でパスワードを設定したい等の理由で、ユーザに対して招待メール送信を行いたくない場合は、is_invitation=falseもしくは、is_invitationを設定せずにpostしてください。

  • 登録するユーザのメールアドレスがジョブカン他サービスに既に登録されている場合、姓名とスタッフコードは、ご利用中のジョブカン他サービスにも自動反映されます。

Example URI

POST /v1/users/
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "user_code": "hoge",
  "email": "hoge@hoge.com",
  "last_name": "ジョブカン",
  "first_name": "太郎",
  "is_approver": true,
  "user_role": 1,
  "user_groups": [
    "100",
    "200"
  ],
  "user_positions": [
    "butyo"
  ],
  "user_bank_account": {
    "bank_code": "0000",
    "bank_name": "ジョブカン銀行",
    "branch_code": "000",
    "branch_name": "ドーナツ支店",
    "bank_account_type_code": "1",
    "bank_account_code": "1234567",
    "bank_account_name_kana": "ジョブカンタロウ"
  },
  "is_invitation": false
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "user_code": {
      "type": "string",
      "description": "スタッフコード"
    },
    "email": {
      "type": "string",
      "description": "email"
    },
    "last_name": {
      "type": "string",
      "description": "姓"
    },
    "first_name": {
      "type": "string",
      "description": "名"
    },
    "is_approver": {
      "type": "boolean",
      "description": "承認者フラグ"
    },
    "user_role": {
      "type": "number",
      "description": "ユーザ権限"
    },
    "user_groups": {
      "type": "array",
      "description": "所属グループコード"
    },
    "user_positions": {
      "type": "array",
      "description": "役職コード"
    },
    "user_bank_account": {
      "type": "object",
      "properties": {
        "bank_code": {
          "type": "string",
          "description": "銀行コード"
        },
        "bank_name": {
          "type": "string",
          "description": "銀行名"
        },
        "branch_code": {
          "type": "string",
          "description": "支店コード"
        },
        "branch_name": {
          "type": "string",
          "description": "支店名"
        },
        "bank_account_type_code": {
          "type": "string",
          "description": "口座種別(1:普通、2:当座)"
        },
        "bank_account_code": {
          "type": "string",
          "description": "口座番号"
        },
        "bank_account_name_kana": {
          "type": "string",
          "description": "口座名(カナ)"
        }
      }
    },
    "is_invitation": {
      "type": "boolean",
      "description": "ユーザを招待する"
    }
  },
  "required": [
    "user_code",
    "email",
    "last_name",
    "first_name"
  ]
}
Response  200

ユーザ情報 v2

ユーザ一覧取得
GET/v2/users/

  • 登録されているユーザ情報を取得する

  • 取得に成功した場合、ユーザ情報を返す

Example URI

GET /v2/users/
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "count": 130,
  "next": "https://ssl.wf.jobcan.jp/wf_api/v1/users/?page=2",
  "previous": null,
  "results": [
    {
      "user_code": "hoge",
      "email": "hoge@hoge.com",
      "last_name": "ジョブカン",
      "first_name": "太郎",
      "is_approver": true,
      "user_role": 1,
      "user_groups": [
        "100",
        "200"
      ],
      "user_positions": [
        {
          "position_code": "butyo",
          "group_code": "100"
        }
      ],
      "user_bank_account": {
        "bank_code": "0000",
        "bank_name": "ジョブカン銀行",
        "branch_code": "000",
        "branch_name": "ドーナツ支店",
        "bank_account_type_code": "1",
        "bank_account_code": "1234567",
        "bank_account_name_kana": "ジョブカンタロウ"
      }
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "count": {
      "type": "number",
      "description": "合計件数"
    },
    "next": {
      "type": "string",
      "description": "next url"
    },
    "previous": {
      "type": [
        "object",
        "null"
      ],
      "properties": {},
      "description": "previous url"
    },
    "results": {
      "type": "array",
      "description": "ユーザ情報を格納した配列"
    }
  }
}

ユーザ新規登録
POST/v2/users/

  • ユーザを新規登録する

  • is_invitation=trueの場合、登録されたユーザに対してパスワード設定用の招待メールが送信されます。

  • 共通ID上で一括でパスワードを設定したい等の理由で、ユーザに対して招待メール送信を行いたくない場合は、is_invitation=falseもしくは、is_invitationを設定せずにpostしてください。

  • 登録するユーザのメールアドレスがジョブカン他サービスに既に登録されている場合、姓名とスタッフコードは、ご利用中のジョブカン他サービスにも自動反映されます。

Example URI

POST /v2/users/
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "user_code": "hoge",
  "email": "hoge@hoge.com",
  "last_name": "ジョブカン",
  "first_name": "太郎",
  "is_approver": true,
  "user_role": 1,
  "user_groups": [
    "100",
    "200"
  ],
  "user_positions": [
    {
      "position_code": "butyo",
      "group_code": "100"
    }
  ],
  "user_bank_account": {
    "bank_code": "0000",
    "bank_name": "ジョブカン銀行",
    "branch_code": "000",
    "branch_name": "ドーナツ支店",
    "bank_account_type_code": "1",
    "bank_account_code": "1234567",
    "bank_account_name_kana": "ジョブカンタロウ"
  },
  "is_invitation": false
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "user_code": {
      "type": "string",
      "description": "スタッフコード"
    },
    "email": {
      "type": "string",
      "description": "email"
    },
    "last_name": {
      "type": "string",
      "description": "姓"
    },
    "first_name": {
      "type": "string",
      "description": "名"
    },
    "is_approver": {
      "type": "boolean",
      "description": "承認者フラグ"
    },
    "user_role": {
      "type": "number",
      "description": "ユーザ権限"
    },
    "user_groups": {
      "type": "array",
      "description": "所属グループコード"
    },
    "user_positions": {
      "type": "array",
      "description": "役職コード"
    },
    "user_bank_account": {
      "type": "object",
      "properties": {
        "bank_code": {
          "type": "string",
          "description": "銀行コード"
        },
        "bank_name": {
          "type": "string",
          "description": "銀行名"
        },
        "branch_code": {
          "type": "string",
          "description": "支店コード"
        },
        "branch_name": {
          "type": "string",
          "description": "支店名"
        },
        "bank_account_type_code": {
          "type": "string",
          "description": "口座種別(1:普通、2:当座)"
        },
        "bank_account_code": {
          "type": "string",
          "description": "口座番号"
        },
        "bank_account_name_kana": {
          "type": "string",
          "description": "口座名(カナ)"
        }
      }
    },
    "is_invitation": {
      "type": "boolean",
      "description": "ユーザを招待する"
    }
  },
  "required": [
    "user_code",
    "email",
    "last_name",
    "first_name"
  ]
}
Response  200

ユーザ情報 v3

ユーザ一覧取得
GET/v3/users/

  • 登録されているユーザ情報を取得する

  • 取得に成功した場合、ユーザ情報を返す

Example URI

GET /v3/users/
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "count": 130,
  "next": "https://ssl.wf.jobcan.jp/wf_api/v3/users/?page=2",
  "previous": null,
  "results": [
    {
      "user_code": "hoge",
      "email": "hoge@hoge.com",
      "last_name": "ジョブカン",
      "first_name": "太郎",
      "is_approver": true,
      "user_role": 1,
      "user_groups": [
        "100",
        "200"
      ],
      "user_positions": [
        {
          "position_code": "butyo",
          "group_code": "100"
        }
      ],
      "user_bank_account": {
        "bank_code": "0000",
        "bank_name": "ジョブカン銀行",
        "branch_code": "000",
        "branch_name": "ドーナツ支店",
        "bank_account_type_code": "1",
        "bank_account_code": "1234567",
        "bank_account_name_kana": "ジョブカンタロウ"
      },
      "memo": "特記事項あり"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "count": {
      "type": "number",
      "description": "合計件数"
    },
    "next": {
      "type": "string",
      "description": "next url"
    },
    "previous": {
      "type": [
        "object",
        "null"
      ],
      "properties": {},
      "description": "previous url"
    },
    "results": {
      "type": "array",
      "description": "ユーザ情報を格納した配列"
    }
  }
}

ユーザ新規登録
POST/v3/users/

  • ユーザを新規登録する

  • is_invitation=trueの場合、登録されたユーザに対してパスワード設定用の招待メールが送信されます。

  • 共通ID上で一括でパスワードを設定したい等の理由で、ユーザに対して招待メール送信を行いたくない場合は、is_invitation=falseもしくは、is_invitationを設定せずにpostしてください。

  • 登録するユーザのメールアドレスがジョブカン他サービスに既に登録されている場合、姓名とスタッフコードは、ご利用中のジョブカン他サービスにも自動反映されます。

Example URI

POST /v3/users/
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "user_code": "hoge",
  "email": "hoge@hoge.com",
  "last_name": "ジョブカン",
  "first_name": "太郎",
  "is_approver": true,
  "user_role": 1,
  "user_groups": [
    "100",
    "200"
  ],
  "user_positions": [
    {
      "position_code": "butyo",
      "group_code": "100"
    }
  ],
  "user_bank_account": {
    "bank_code": "0000",
    "bank_name": "ジョブカン銀行",
    "branch_code": "000",
    "branch_name": "ドーナツ支店",
    "bank_account_type_code": "1",
    "bank_account_code": "1234567",
    "bank_account_name_kana": "ジョブカンタロウ"
  },
  "memo": "特記事項あり",
  "is_invitation": false
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "user_code": {
      "type": "string",
      "description": "スタッフコード"
    },
    "email": {
      "type": "string",
      "description": "email"
    },
    "last_name": {
      "type": "string",
      "description": "姓"
    },
    "first_name": {
      "type": "string",
      "description": "名"
    },
    "is_approver": {
      "type": "boolean",
      "description": "承認者フラグ"
    },
    "user_role": {
      "type": "number",
      "description": "ユーザ権限"
    },
    "user_groups": {
      "type": "array",
      "description": "所属グループコード"
    },
    "user_positions": {
      "type": "array",
      "description": "役職コード"
    },
    "user_bank_account": {
      "type": "object",
      "properties": {
        "bank_code": {
          "type": "string",
          "description": "銀行コード"
        },
        "bank_name": {
          "type": "string",
          "description": "銀行名"
        },
        "branch_code": {
          "type": "string",
          "description": "支店コード"
        },
        "branch_name": {
          "type": "string",
          "description": "支店名"
        },
        "bank_account_type_code": {
          "type": "string",
          "description": "口座種別(1:普通、2:当座)"
        },
        "bank_account_code": {
          "type": "string",
          "description": "口座番号"
        },
        "bank_account_name_kana": {
          "type": "string",
          "description": "口座名(カナ)"
        }
      }
    },
    "memo": {
      "type": "string",
      "description": "備考"
    },
    "is_invitation": {
      "type": "boolean",
      "description": "ユーザを招待する"
    }
  },
  "required": [
    "user_code",
    "email",
    "last_name",
    "first_name"
  ]
}
Response  200
Response  400
HideShow

BadRequest時に以下のcodeを返す

  • 400003: パラメータが不正の場合

  • 400100: リクエストJSONの形式が不正の場合

  • 400900: 共通IDとの連携に失敗した場合

Headers
Content-Type: application/json
Body
{
  "code": 400100,
  "message": [
    "「user_code」が設定されていません。"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "enum": [
        400100,
        400003,
        400900
      ]
    },
    "message": {
      "type": "array"
    }
  }
}
Response  500

UserDetail

  • user_code指定でのユーザ情報の取得、更新、停止。

ユーザ詳細 v1

ユーザ情報取得API
GET/v1/users/{user_code}/

  • 指定したユーザの情報を返す。

  • user_codeは必須。指定がない場合、BadRequestを返す。

Example URI

GET /v1/users/ST-1/
URI Parameters
HideShow
user_code
string (required) Example: ST-1

スタッフコード

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "user_code": "hoge",
  "email": "hoge@hoge.com",
  "last_name": "ジョブカン",
  "first_name": "太郎",
  "is_approver": true,
  "user_role": 1,
  "user_groups": [
    "100",
    "200"
  ],
  "user_positions": [
    "butyo"
  ],
  "user_bank_account": {
    "bank_code": "0000",
    "bank_name": "ジョブカン銀行",
    "branch_code": "000",
    "branch_name": "ドーナツ支店",
    "bank_account_type_code": "1",
    "bank_account_code": "1234567",
    "bank_account_name_kana": "ジョブカンタロウ"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "user_code": {
      "type": "string",
      "description": "スタッフコード"
    },
    "email": {
      "type": "string",
      "description": "email"
    },
    "last_name": {
      "type": "string",
      "description": "姓"
    },
    "first_name": {
      "type": "string",
      "description": "名"
    },
    "is_approver": {
      "type": "boolean",
      "description": "承認者フラグ"
    },
    "user_role": {
      "type": "number",
      "description": "ユーザ権限"
    },
    "user_groups": {
      "type": "array",
      "description": "所属グループコード"
    },
    "user_positions": {
      "type": "array",
      "description": "役職コード"
    },
    "user_bank_account": {
      "type": "object",
      "properties": {
        "bank_code": {
          "type": "string",
          "description": "銀行コード"
        },
        "bank_name": {
          "type": "string",
          "description": "銀行名"
        },
        "branch_code": {
          "type": "string",
          "description": "支店コード"
        },
        "branch_name": {
          "type": "string",
          "description": "支店名"
        },
        "bank_account_type_code": {
          "type": "string",
          "description": "口座種別(1:普通、2:当座)"
        },
        "bank_account_code": {
          "type": "string",
          "description": "口座番号"
        },
        "bank_account_name_kana": {
          "type": "string",
          "description": "口座名(カナ)"
        }
      }
    }
  },
  "required": [
    "user_code",
    "email",
    "last_name",
    "first_name"
  ]
}

ユーザ情報更新API
PUT/v1/users/{user_code}/

  • 指定したユーザの情報を更新する。

  • user_codeは必須。指定がない場合、BadRequestを返す。

  • その他の項目については、APIに設定された項目のみを更新。

  • 更新するユーザがジョブカン他サービスにも登録されている場合、姓名とメールアドレスは、ご利用中のジョブカン他サービスにも自動反映されます。

Example URI

PUT /v1/users/ST-1/
URI Parameters
HideShow
user_code
string (required) Example: ST-1

スタッフコード

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "user_code": "hoge",
  "email": "hoge@hoge.com",
  "last_name": "ジョブカン",
  "first_name": "太郎",
  "is_approver": true,
  "user_role": 1,
  "user_groups": [
    "100",
    "200"
  ],
  "user_positions": [
    "butyo"
  ],
  "user_bank_account": {
    "bank_code": "0000",
    "bank_name": "ジョブカン銀行",
    "branch_code": "000",
    "branch_name": "ドーナツ支店",
    "bank_account_type_code": "1",
    "bank_account_code": "1234567",
    "bank_account_name_kana": "ジョブカンタロウ"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "user_code": {
      "type": "string",
      "description": "スタッフコード"
    },
    "email": {
      "type": "string",
      "description": "email"
    },
    "last_name": {
      "type": "string",
      "description": "姓"
    },
    "first_name": {
      "type": "string",
      "description": "名"
    },
    "is_approver": {
      "type": "boolean",
      "description": "承認者フラグ"
    },
    "user_role": {
      "type": "number",
      "description": "ユーザ権限"
    },
    "user_groups": {
      "type": "array",
      "description": "所属グループコード"
    },
    "user_positions": {
      "type": "array",
      "description": "役職コード"
    },
    "user_bank_account": {
      "type": "object",
      "properties": {
        "bank_code": {
          "type": "string",
          "description": "銀行コード"
        },
        "bank_name": {
          "type": "string",
          "description": "銀行名"
        },
        "branch_code": {
          "type": "string",
          "description": "支店コード"
        },
        "branch_name": {
          "type": "string",
          "description": "支店名"
        },
        "bank_account_type_code": {
          "type": "string",
          "description": "口座種別(1:普通、2:当座)"
        },
        "bank_account_code": {
          "type": "string",
          "description": "口座番号"
        },
        "bank_account_name_kana": {
          "type": "string",
          "description": "口座名(カナ)"
        }
      }
    }
  },
  "required": [
    "user_code",
    "email",
    "last_name",
    "first_name"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json

ユーザー停止API
DELETE/v1/users/{user_code}/

  • 指定したユーザを停止する。

Example URI

DELETE /v1/users/ST-1/
URI Parameters
HideShow
user_code
string (required) Example: ST-1

スタッフコード

Response  204

ユーザ詳細 v2

ユーザ情報取得API
GET/v2/users/{user_code}/

  • 指定したユーザの情報を返す。

  • user_codeは必須。指定がない場合、BadRequestを返す。

Example URI

GET /v2/users/ST-1/
URI Parameters
HideShow
user_code
string (required) Example: ST-1

スタッフコード

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "user_code": "hoge",
  "email": "hoge@hoge.com",
  "last_name": "ジョブカン",
  "first_name": "太郎",
  "is_approver": true,
  "user_role": 1,
  "user_groups": [
    "100",
    "200"
  ],
  "user_positions": [
    {
      "position_code": "butyo",
      "group_code": "100"
    }
  ],
  "user_bank_account": {
    "bank_code": "0000",
    "bank_name": "ジョブカン銀行",
    "branch_code": "000",
    "branch_name": "ドーナツ支店",
    "bank_account_type_code": "1",
    "bank_account_code": "1234567",
    "bank_account_name_kana": "ジョブカンタロウ"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "user_code": {
      "type": "string",
      "description": "スタッフコード"
    },
    "email": {
      "type": "string",
      "description": "email"
    },
    "last_name": {
      "type": "string",
      "description": "姓"
    },
    "first_name": {
      "type": "string",
      "description": "名"
    },
    "is_approver": {
      "type": "boolean",
      "description": "承認者フラグ"
    },
    "user_role": {
      "type": "number",
      "description": "ユーザ権限"
    },
    "user_groups": {
      "type": "array",
      "description": "所属グループコード"
    },
    "user_positions": {
      "type": "array",
      "description": "役職コード"
    },
    "user_bank_account": {
      "type": "object",
      "properties": {
        "bank_code": {
          "type": "string",
          "description": "銀行コード"
        },
        "bank_name": {
          "type": "string",
          "description": "銀行名"
        },
        "branch_code": {
          "type": "string",
          "description": "支店コード"
        },
        "branch_name": {
          "type": "string",
          "description": "支店名"
        },
        "bank_account_type_code": {
          "type": "string",
          "description": "口座種別(1:普通、2:当座)"
        },
        "bank_account_code": {
          "type": "string",
          "description": "口座番号"
        },
        "bank_account_name_kana": {
          "type": "string",
          "description": "口座名(カナ)"
        }
      }
    }
  },
  "required": [
    "user_code",
    "email",
    "last_name",
    "first_name"
  ]
}

ユーザ情報更新API
PUT/v2/users/{user_code}/

  • 指定したユーザの情報を更新する。

  • user_codeは必須。指定がない場合、BadRequestを返す。

  • その他の項目については、APIに設定された項目のみを更新。

  • 更新するユーザがジョブカン他サービスにも登録されている場合、姓名とメールアドレスは、ご利用中のジョブカン他サービスにも自動反映されます。

Example URI

PUT /v2/users/ST-1/
URI Parameters
HideShow
user_code
string (required) Example: ST-1

スタッフコード

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "user_code": "hoge",
  "email": "hoge@hoge.com",
  "last_name": "ジョブカン",
  "first_name": "太郎",
  "is_approver": true,
  "user_role": 1,
  "user_groups": [
    "100",
    "200"
  ],
  "user_positions": [
    {
      "position_code": "butyo",
      "group_code": "100"
    }
  ],
  "user_bank_account": {
    "bank_code": "0000",
    "bank_name": "ジョブカン銀行",
    "branch_code": "000",
    "branch_name": "ドーナツ支店",
    "bank_account_type_code": "1",
    "bank_account_code": "1234567",
    "bank_account_name_kana": "ジョブカンタロウ"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "user_code": {
      "type": "string",
      "description": "スタッフコード"
    },
    "email": {
      "type": "string",
      "description": "email"
    },
    "last_name": {
      "type": "string",
      "description": "姓"
    },
    "first_name": {
      "type": "string",
      "description": "名"
    },
    "is_approver": {
      "type": "boolean",
      "description": "承認者フラグ"
    },
    "user_role": {
      "type": "number",
      "description": "ユーザ権限"
    },
    "user_groups": {
      "type": "array",
      "description": "所属グループコード"
    },
    "user_positions": {
      "type": "array",
      "description": "役職コード"
    },
    "user_bank_account": {
      "type": "object",
      "properties": {
        "bank_code": {
          "type": "string",
          "description": "銀行コード"
        },
        "bank_name": {
          "type": "string",
          "description": "銀行名"
        },
        "branch_code": {
          "type": "string",
          "description": "支店コード"
        },
        "branch_name": {
          "type": "string",
          "description": "支店名"
        },
        "bank_account_type_code": {
          "type": "string",
          "description": "口座種別(1:普通、2:当座)"
        },
        "bank_account_code": {
          "type": "string",
          "description": "口座番号"
        },
        "bank_account_name_kana": {
          "type": "string",
          "description": "口座名(カナ)"
        }
      }
    }
  },
  "required": [
    "user_code",
    "email",
    "last_name",
    "first_name"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json

ユーザー停止API
DELETE/v2/users/{user_code}/

  • 指定したユーザを停止する。

Example URI

DELETE /v2/users/ST-1/
URI Parameters
HideShow
user_code
string (required) Example: ST-1

スタッフコード

Response  204

ユーザ詳細 v3

ユーザ情報取得API
GET/v3/users/:user_code/

  • 指定したユーザの情報を返す。

  • user_codeは必須。指定がない場合、BadRequestを返す。

Example URI

GET /v3/users/:user_code/
URI Parameters
HideShow
user_code
string (required) Example: ST-1

スタッフコード

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "user_code": "hoge",
  "email": "hoge@hoge.com",
  "last_name": "ジョブカン",
  "first_name": "太郎",
  "is_approver": true,
  "user_role": 1,
  "user_groups": [
    "100",
    "200"
  ],
  "user_positions": [
    {
      "position_code": "butyo",
      "group_code": "100"
    }
  ],
  "user_bank_account": {
    "bank_code": "0000",
    "bank_name": "ジョブカン銀行",
    "branch_code": "000",
    "branch_name": "ドーナツ支店",
    "bank_account_type_code": "1",
    "bank_account_code": "1234567",
    "bank_account_name_kana": "ジョブカンタロウ"
  },
  "memo": "特記事項あり"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "user_code": {
      "type": "string",
      "description": "スタッフコード"
    },
    "email": {
      "type": "string",
      "description": "email"
    },
    "last_name": {
      "type": "string",
      "description": "姓"
    },
    "first_name": {
      "type": "string",
      "description": "名"
    },
    "is_approver": {
      "type": "boolean",
      "description": "承認者フラグ"
    },
    "user_role": {
      "type": "number",
      "description": "ユーザ権限"
    },
    "user_groups": {
      "type": "array",
      "description": "所属グループコード"
    },
    "user_positions": {
      "type": "array",
      "description": "役職コード"
    },
    "user_bank_account": {
      "type": "object",
      "properties": {
        "bank_code": {
          "type": "string",
          "description": "銀行コード"
        },
        "bank_name": {
          "type": "string",
          "description": "銀行名"
        },
        "branch_code": {
          "type": "string",
          "description": "支店コード"
        },
        "branch_name": {
          "type": "string",
          "description": "支店名"
        },
        "bank_account_type_code": {
          "type": "string",
          "description": "口座種別(1:普通、2:当座)"
        },
        "bank_account_code": {
          "type": "string",
          "description": "口座番号"
        },
        "bank_account_name_kana": {
          "type": "string",
          "description": "口座名(カナ)"
        }
      }
    },
    "memo": {
      "type": "string",
      "description": "備考"
    }
  },
  "required": [
    "user_code",
    "email",
    "last_name",
    "first_name"
  ]
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "対象のユーザは存在しません。「user_code」を確認してください。:user_code"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

ユーザ情報更新API
PUT/v3/users/:user_code/

  • 指定したユーザの情報を更新する。

  • user_codeは必須。指定がない場合、BadRequestを返す。

  • その他の項目については、APIに設定された項目のみを更新。

  • 更新するユーザがジョブカン他サービスにも登録されている場合、姓名とメールアドレスは、ご利用中のジョブカン他サービスにも自動反映されます。

Example URI

PUT /v3/users/:user_code/
URI Parameters
HideShow
user_code
string (required) Example: ST-1

スタッフコード

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "user_code": "hoge",
  "email": "hoge@hoge.com",
  "last_name": "ジョブカン",
  "first_name": "太郎",
  "is_approver": true,
  "user_role": 1,
  "user_groups": [
    "100",
    "200"
  ],
  "user_positions": [
    {
      "position_code": "butyo",
      "group_code": "100"
    }
  ],
  "user_bank_account": {
    "bank_code": "0000",
    "bank_name": "ジョブカン銀行",
    "branch_code": "000",
    "branch_name": "ドーナツ支店",
    "bank_account_type_code": "1",
    "bank_account_code": "1234567",
    "bank_account_name_kana": "ジョブカンタロウ"
  },
  "memo": "特記事項あり"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "user_code": {
      "type": "string",
      "description": "スタッフコード"
    },
    "email": {
      "type": "string",
      "description": "email"
    },
    "last_name": {
      "type": "string",
      "description": "姓"
    },
    "first_name": {
      "type": "string",
      "description": "名"
    },
    "is_approver": {
      "type": "boolean",
      "description": "承認者フラグ"
    },
    "user_role": {
      "type": "number",
      "description": "ユーザ権限"
    },
    "user_groups": {
      "type": "array",
      "description": "所属グループコード"
    },
    "user_positions": {
      "type": "array",
      "description": "役職コード"
    },
    "user_bank_account": {
      "type": "object",
      "properties": {
        "bank_code": {
          "type": "string",
          "description": "銀行コード"
        },
        "bank_name": {
          "type": "string",
          "description": "銀行名"
        },
        "branch_code": {
          "type": "string",
          "description": "支店コード"
        },
        "branch_name": {
          "type": "string",
          "description": "支店名"
        },
        "bank_account_type_code": {
          "type": "string",
          "description": "口座種別(1:普通、2:当座)"
        },
        "bank_account_code": {
          "type": "string",
          "description": "口座番号"
        },
        "bank_account_name_kana": {
          "type": "string",
          "description": "口座名(カナ)"
        }
      }
    },
    "memo": {
      "type": "string",
      "description": "備考"
    }
  },
  "required": [
    "user_code",
    "email",
    "last_name",
    "first_name"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Response  400
HideShow

BadRequest時に以下のcodeを返す

  • 400003: パラメータが不正の場合

  • 400100: リクエストJSONの形式が不正の場合

  • 400900: 共通IDとの連携に失敗した場合

Headers
Content-Type: application/json
Body
{
  "code": 400003,
  "message": "対象のユーザは存在しません。「user_code」を確認してください。:user_code"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "enum": [
        400003,
        400100,
        400900
      ]
    },
    "message": {
      "type": "string"
    }
  }
}
Response  500

ユーザー停止API
DELETE/v3/users/:user_code/

  • 指定したユーザを停止する。

Example URI

DELETE /v3/users/:user_code/
URI Parameters
HideShow
user_code
string (required) Example: ST-1

スタッフコード

Response  204
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "対象のユーザは存在しません。「user_code」を確認してください。: user_code"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}
Response  500

Group

グループ情報

グループ一覧取得
GET/v1/groups/

  • 登録されているグループ情報を取得する

  • 取得に成功した場合、グループ情報を返す

Example URI

GET /v1/groups/
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "count": 130,
  "next": "https://ssl.wf.jobcan.jp/wf_api/v1/groups/?page=2",
  "previous": null,
  "results": [
    {
      "group_code": "100",
      "group_name": "営業部",
      "parent_group_code": "200",
      "description": "hogehoge"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "count": {
      "type": "number",
      "description": "合計件数"
    },
    "next": {
      "type": "string",
      "description": "next url"
    },
    "previous": {
      "type": [
        "object",
        "null"
      ],
      "properties": {},
      "description": "previous url"
    },
    "results": {
      "type": "array",
      "description": "グループ詳細を格納した配列"
    }
  }
}

グループ新規登録
POST/v1/groups/

  • グループを新規登録する

Example URI

POST /v1/groups/
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "group_code": "100",
  "group_name": "営業部",
  "parent_group_code": "200",
  "description": "hogehoge"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "group_code": {
      "type": "string",
      "description": "グループコード"
    },
    "group_name": {
      "type": "string",
      "description": "グループ名"
    },
    "parent_group_code": {
      "type": "string",
      "description": "親グループコード"
    },
    "description": {
      "type": "string",
      "description": "説明"
    }
  },
  "required": [
    "group_code",
    "group_name"
  ]
}
Response  200

GroupDetail

  • group_code指定でのグループ情報の取得、更新、削除。

グループ詳細

グループ情報取得API
GET/v1/groups/{group_code}/

  • 指定したグループの情報を返す。

  • group_codeは必須。指定がない場合、BadRequestを返す。

Example URI

GET /v1/groups/G-1/
URI Parameters
HideShow
group_code
string (required) Example: G-1

グループコード

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "group_code": "100",
  "group_name": "営業部",
  "parent_group_code": "200",
  "description": "hogehoge"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "group_code": {
      "type": "string",
      "description": "グループコード"
    },
    "group_name": {
      "type": "string",
      "description": "グループ名"
    },
    "parent_group_code": {
      "type": "string",
      "description": "親グループコード"
    },
    "description": {
      "type": "string",
      "description": "説明"
    }
  },
  "required": [
    "group_code",
    "group_name"
  ]
}

グループ情報更新API
PUT/v1/groups/{group_code}/

  • 指定したグループの情報を更新する。

  • group_codeは必須。指定がない場合、BadRequestを返す。

  • その他の項目については、APIに設定された項目のみを更新。

Example URI

PUT /v1/groups/G-1/
URI Parameters
HideShow
group_code
string (required) Example: G-1

グループコード

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "group_code": "100",
  "group_name": "営業部",
  "parent_group_code": "200",
  "description": "hogehoge"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "group_code": {
      "type": "string",
      "description": "グループコード"
    },
    "group_name": {
      "type": "string",
      "description": "グループ名"
    },
    "parent_group_code": {
      "type": "string",
      "description": "親グループコード"
    },
    "description": {
      "type": "string",
      "description": "説明"
    }
  },
  "required": [
    "group_code",
    "group_name"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json

グループ情報削除API
DELETE/v1/groups/{group_code}/

  • 指定したグループの情報を削除する。

Example URI

DELETE /v1/groups/G-1/
URI Parameters
HideShow
group_code
string (required) Example: G-1

グループコード

Response  204

Position

役職情報

役職一覧取得
GET/v1/positions/

  • 登録されている役職情報を取得する

  • 取得に成功した場合、役職情報を返す

Example URI

GET /v1/positions/
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "count": 130,
  "next": "https://ssl.wf.jobcan.jp/wf_api/v1/positions/?page=2",
  "previous": null,
  "results": [
    {
      "position_code": "100",
      "position_name": "部長",
      "description": "hogehoge"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "count": {
      "type": "number",
      "description": "合計件数"
    },
    "next": {
      "type": "string",
      "description": "next url"
    },
    "previous": {
      "type": [
        "object",
        "null"
      ],
      "properties": {},
      "description": "previous url"
    },
    "results": {
      "type": "array",
      "description": "役職詳細を格納した配列"
    }
  }
}

役職新規登録
POST/v1/positions/

  • 役職を新規登録する

Example URI

POST /v1/positions/
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "position_code": "100",
  "position_name": "部長",
  "description": "hogehoge"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "position_code": {
      "type": "string",
      "description": "役職コード"
    },
    "position_name": {
      "type": "string",
      "description": "役職名"
    },
    "description": {
      "type": "string",
      "description": "説明"
    }
  },
  "required": [
    "position_code",
    "position_name"
  ]
}
Response  200

PositionDetail

  • position_code指定での役職情報の取得、更新、削除。

役職詳細

役職情報取得API
GET/v1/positions/{position_code}/

  • 指定した役職の情報を返す。

  • position_codeは必須。指定がない場合、BadRequestを返す。

Example URI

GET /v1/positions/P-1/
URI Parameters
HideShow
position_code
string (required) Example: P-1

役職コード

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "position_code": "100",
  "position_name": "部長",
  "description": "hogehoge"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "position_code": {
      "type": "string",
      "description": "役職コード"
    },
    "position_name": {
      "type": "string",
      "description": "役職名"
    },
    "description": {
      "type": "string",
      "description": "説明"
    }
  },
  "required": [
    "position_code",
    "position_name"
  ]
}

役職情報更新API
PUT/v1/positions/{position_code}/

  • 指定した役職の情報を更新する。

  • position_codeは必須。指定がない場合、BadRequestを返す。

  • その他の項目については、APIに設定された項目のみを更新。

Example URI

PUT /v1/positions/P-1/
URI Parameters
HideShow
position_code
string (required) Example: P-1

役職コード

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "position_code": "100",
  "position_name": "部長",
  "description": "hogehoge"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "position_code": {
      "type": "string",
      "description": "役職コード"
    },
    "position_name": {
      "type": "string",
      "description": "役職名"
    },
    "description": {
      "type": "string",
      "description": "説明"
    }
  },
  "required": [
    "position_code",
    "position_name"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json

役職情報削除API
DELETE/v1/positions/{position_code}/

  • 指定した役職の情報を削除する。

Example URI

DELETE /v1/positions/P-1/
URI Parameters
HideShow
position_code
string (required) Example: P-1

役職コード

Response  204

Project

プロジェクト情報

プロジェクト一覧取得
GET/v1/projects/

  • 登録されているプロジェクト情報を取得する

  • 取得に成功した場合、プロジェクト情報を返す

Example URI

GET /v1/projects/
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "count": 130,
  "next": "https://ssl.wf.jobcan.jp/wf_api/v1/projects/?page=2",
  "previous": null,
  "results": [
    {
      "project_code": "100",
      "project_name": "hugahuga"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "count": {
      "type": "number",
      "description": "合計件数"
    },
    "next": {
      "type": "string",
      "description": "next url"
    },
    "previous": {
      "type": [
        "object",
        "null"
      ],
      "properties": {},
      "description": "previous url"
    },
    "results": {
      "type": "array",
      "description": "プロジェクト詳細を格納した配列"
    }
  }
}

プロジェクト新規登録
POST/v1/projects/

  • プロジェクトを新規登録する

Example URI

POST /v1/projects/
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "project_code": "100",
  "project_name": "hugahuga"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "project_code": {
      "type": "string",
      "description": "プロジェクトコード"
    },
    "project_name": {
      "type": "string",
      "description": "プロジェクト名"
    }
  },
  "required": [
    "project_code",
    "project_name"
  ]
}
Response  200

ProjectDetail

  • project_code指定での役職情報の取得、更新、削除。

プロジェクト詳細

プロジェクト情報取得API
GET/v1/projects/{project_code}/

  • 指定したプロジェクトの情報を返す。

  • project_codeは必須。指定がない場合、BadRequestを返す。

Example URI

GET /v1/projects/Pr-1/
URI Parameters
HideShow
project_code
string (required) Example: Pr-1

プロジェクトコード

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "project_code": "100",
  "project_name": "hugahuga"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "project_code": {
      "type": "string",
      "description": "プロジェクトコード"
    },
    "project_name": {
      "type": "string",
      "description": "プロジェクト名"
    }
  },
  "required": [
    "project_code",
    "project_name"
  ]
}

プロジェクト情報更新API
PUT/v1/projects/{project_code}/

  • 指定したプロジェクトの情報を更新する。

  • project_codeは必須。指定がない場合、BadRequestを返す。

  • その他の項目については、APIに設定された項目のみを更新。

Example URI

PUT /v1/projects/Pr-1/
URI Parameters
HideShow
project_code
string (required) Example: Pr-1

プロジェクトコード

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "project_code": "100",
  "project_name": "hugahuga"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "project_code": {
      "type": "string",
      "description": "プロジェクトコード"
    },
    "project_name": {
      "type": "string",
      "description": "プロジェクト名"
    }
  },
  "required": [
    "project_code",
    "project_name"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json

プロジェクト情報削除API
DELETE/v1/projects/{project_code}/

  • 指定したプロジェクトの情報を削除する。

Example URI

DELETE /v1/projects/Pr-1/
URI Parameters
HideShow
project_code
string (required) Example: Pr-1

プロジェクトコード

Response  204

Form

フォーム

フォーム一覧取得
GET/v1/forms/{?form_type,settlement_type,category_code,name,view_type,description,page}

  • フォーム一覧を返却する

Example URI

GET /v1/forms/?form_type=expense&settlement_type=pre_application&category_code=サンプル分類&name=サンプルフォーム&view_type=public&description=説明&page=1
URI Parameters
HideShow
form_type
string (optional) Example: expense

general:汎用フォーム, expense:経費精算, payment:支払依頼, ec_purchase: EC購入申請

settlement_type
string (optional) Example: pre_application

pre_application: 事前申請, settlement: 精算, 経費精算フォームの時のみ

category_code
string (optional) Example: サンプル分類

フォーム分類コード

name
string (optional) Example: サンプルフォーム

フォーム名。部分一致

view_type
string (optional) Example: public

public:全体公開, private:非公開, restricted:一部公開中

description
string (optional) Example: 説明

フォーム説明。部分一致

page
number (required) Example: 1

対象のページ番号。1ページあたり100件。デフォルトは1ページ目。

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "count": 130,
  "next": "https://ssl.wf.jobcan.jp/wf_api/v1/forms/?page=2",
  "previous": null,
  "results": [
    {
      "id": 123456,
      "category": "サンプル分類",
      "form_type": "expense",
      "settlement_type": "settlement",
      "name": "サンプルフォーム",
      "view_type": "public",
      "description": "サンプルのフォームです"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "count": {
      "type": "number",
      "description": "合計件数"
    },
    "next": {
      "type": "string",
      "description": "next url"
    },
    "previous": {
      "type": [
        "object",
        "null"
      ],
      "properties": {},
      "description": "previous url"
    },
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "フォームID"
          },
          "category": {
            "type": "string",
            "description": "フォーム分類"
          },
          "form_type": {
            "type": "string",
            "description": "general, expense, payment, ec_purchase"
          },
          "settlement_type": {
            "type": "string",
            "description": "pre_application, settlement"
          },
          "name": {
            "type": "string",
            "description": "フォーム名"
          },
          "view_type": {
            "type": "string",
            "description": "public, private, restricted"
          },
          "description": {
            "type": "string",
            "description": "フォーム説明"
          }
        }
      },
      "description": "フォーム一覧情報"
    }
  }
}
Response  400
HideShow

BadRequest時に以下のcodeを返す

  • 400003: パラメータが不正の場合
Headers
Content-Type: application/json
Body
{
  "message": "パラメータが不正です。",
  "code": 400003,
  "detail": [
    "form_typeが不正です。general: 汎用フォーム, expense: 経費精算, payment: 支払フォーム, ec_purchase: EC購入申請 のいずれかを指定してください。",
    "settlement_typeが不正です。pre_application: 事前申請, settlement: 精算 のいずれかを指定してください。",
    "view_typeが不正です。public: 全体公開中, private: 非公開, restricted: 一部公開中 のいずれかを指定してください。"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "エラーメッセージ"
    },
    "code": {
      "type": "number",
      "description": "エラーコード"
    },
    "detail": {
      "type": "array",
      "description": "エラー詳細"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "予期しないエラーが発生しました。",
  "code": 500000
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "エラーメッセージ"
    },
    "code": {
      "type": "number",
      "description": "エラーコード"
    }
  }
}

Company

取引先情報

取引先一覧取得
GET/v1/company/

  • 登録されている取引先情報を取得する

  • 取得に成功した場合、取引先情報を返す

Example URI

GET /v1/company/
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "count": 130,
  "next": "https://ssl.wf.jobcan.jp/wf_api/v1/company/?page=2",
  "previous": null,
  "results": [
    {
      "company_code": "100",
      "company_name": "hogehoge",
      "zip_code": "mogumogu",
      "address": "hugahuga",
      "bank_code": "0000",
      "bank_name": "ジョブカン銀行",
      "branch_code": "000",
      "branch_name": "ドーナツ支店",
      "bank_account_type_code": "1",
      "bank_account_code": "1234567",
      "bank_account_name_kana": "ジョブカンタロウ"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "count": {
      "type": "number",
      "description": "合計件数"
    },
    "next": {
      "type": "string",
      "description": "next url"
    },
    "previous": {
      "type": [
        "object",
        "null"
      ],
      "properties": {},
      "description": "previous url"
    },
    "results": {
      "type": "array",
      "description": "取引先詳細を格納した配列"
    }
  }
}

取引先新規登録
POST/v1/company/

  • 取引先を新規登録する

Example URI

POST /v1/company/
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "company_code": "100",
  "company_name": "hogehoge",
  "zip_code": "mogumogu",
  "address": "hugahuga",
  "bank_code": "0000",
  "bank_name": "ジョブカン銀行",
  "branch_code": "000",
  "branch_name": "ドーナツ支店",
  "bank_account_type_code": "1",
  "bank_account_code": "1234567",
  "bank_account_name_kana": "ジョブカンタロウ"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "company_code": {
      "type": "string",
      "description": "取引先コード"
    },
    "company_name": {
      "type": "string",
      "description": "取引名"
    },
    "zip_code": {
      "type": "string",
      "description": "郵便番号"
    },
    "address": {
      "type": "string",
      "description": "住所"
    },
    "bank_code": {
      "type": "string",
      "description": "銀行コード"
    },
    "bank_name": {
      "type": "string",
      "description": "銀行名"
    },
    "branch_code": {
      "type": "string",
      "description": "支店コード"
    },
    "branch_name": {
      "type": "string",
      "description": "支店名"
    },
    "bank_account_type_code": {
      "type": "string",
      "description": "口座種別(1:普通、2:当座)"
    },
    "bank_account_code": {
      "type": "string",
      "description": "口座番号"
    },
    "bank_account_name_kana": {
      "type": "string",
      "description": "口座名(カナ)"
    }
  },
  "required": [
    "company_code",
    "company_name"
  ]
}
Response  200

CompanyDetail

  • company_code指定での取引先情報の取得、更新、削除。

取引先詳細

取引先情報取得API
GET/v1/company/{company_code}/

  • 指定した取引先の情報を返す。

  • company_codeは必須。指定がない場合、BadRequestを返す。

Example URI

GET /v1/company/C-1/
URI Parameters
HideShow
company_code
string (required) Example: C-1

会社コード

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "company_code": "100",
  "company_name": "hogehoge",
  "zip_code": "mogumogu",
  "address": "hugahuga",
  "bank_code": "0000",
  "bank_name": "ジョブカン銀行",
  "branch_code": "000",
  "branch_name": "ドーナツ支店",
  "bank_account_type_code": "1",
  "bank_account_code": "1234567",
  "bank_account_name_kana": "ジョブカンタロウ"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "company_code": {
      "type": "string",
      "description": "取引先コード"
    },
    "company_name": {
      "type": "string",
      "description": "取引名"
    },
    "zip_code": {
      "type": "string",
      "description": "郵便番号"
    },
    "address": {
      "type": "string",
      "description": "住所"
    },
    "bank_code": {
      "type": "string",
      "description": "銀行コード"
    },
    "bank_name": {
      "type": "string",
      "description": "銀行名"
    },
    "branch_code": {
      "type": "string",
      "description": "支店コード"
    },
    "branch_name": {
      "type": "string",
      "description": "支店名"
    },
    "bank_account_type_code": {
      "type": "string",
      "description": "口座種別(1:普通、2:当座)"
    },
    "bank_account_code": {
      "type": "string",
      "description": "口座番号"
    },
    "bank_account_name_kana": {
      "type": "string",
      "description": "口座名(カナ)"
    }
  },
  "required": [
    "company_code",
    "company_name"
  ]
}

取引先情報更新API
PUT/v1/company/{company_code}/

  • 指定した取引先の情報を更新する。

  • company_codeは必須。指定がない場合、BadRequestを返す。

  • その他の項目については、APIに設定された項目のみを更新。

Example URI

PUT /v1/company/C-1/
URI Parameters
HideShow
company_code
string (required) Example: C-1

会社コード

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "company_code": "100",
  "company_name": "hogehoge",
  "zip_code": "mogumogu",
  "address": "hugahuga",
  "bank_code": "0000",
  "bank_name": "ジョブカン銀行",
  "branch_code": "000",
  "branch_name": "ドーナツ支店",
  "bank_account_type_code": "1",
  "bank_account_code": "1234567",
  "bank_account_name_kana": "ジョブカンタロウ"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "company_code": {
      "type": "string",
      "description": "取引先コード"
    },
    "company_name": {
      "type": "string",
      "description": "取引名"
    },
    "zip_code": {
      "type": "string",
      "description": "郵便番号"
    },
    "address": {
      "type": "string",
      "description": "住所"
    },
    "bank_code": {
      "type": "string",
      "description": "銀行コード"
    },
    "bank_name": {
      "type": "string",
      "description": "銀行名"
    },
    "branch_code": {
      "type": "string",
      "description": "支店コード"
    },
    "branch_name": {
      "type": "string",
      "description": "支店名"
    },
    "bank_account_type_code": {
      "type": "string",
      "description": "口座種別(1:普通、2:当座)"
    },
    "bank_account_code": {
      "type": "string",
      "description": "口座番号"
    },
    "bank_account_name_kana": {
      "type": "string",
      "description": "口座名(カナ)"
    }
  },
  "required": [
    "company_code",
    "company_name"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json

取引先情報削除API
DELETE/v1/company/{company_code}/

  • 指定した取引先の情報を削除する。

Example URI

DELETE /v1/company/C-1/
URI Parameters
HideShow
company_code
string (required) Example: C-1

会社コード

Response  204

GenericMasterRecord

汎用マスタレコード情報 v1

汎用マスタレコード一覧取得
GET/v1/generic_master/{generic_master_code}/

  • 登録されている汎用マスタレコード情報を取得する

  • 取得に成功した場合、汎用マスタレコード情報を返す

  • generic_master_code には「汎用マスタ」画面で登録した「コード」を設定してください。なお、generic_master_code 設定用APIは用意しておりません。

Example URI

GET /v1/generic_master/GM-1/
URI Parameters
HideShow
generic_master_code
string (required) Example: GM-1

汎用マスタのコード

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "count": 130,
  "next": "https://ssl.wf.jobcan.jp/wf_api/v1/generic_master/123/?page=2",
  "previous": null,
  "results": [
    {
      "generic_master_record_code": "100",
      "generic_master_record_name": "hoge",
      "content": "hogehoge",
      "memo": "hugahuga"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "count": {
      "type": "number",
      "description": "合計件数"
    },
    "next": {
      "type": "string",
      "description": "next url"
    },
    "previous": {
      "type": [
        "object",
        "null"
      ],
      "properties": {},
      "description": "previous url"
    },
    "results": {
      "type": "array",
      "description": "汎用マスタレコード詳細を格納した配列"
    }
  }
}

汎用マスタレコード新規登録
POST/v1/generic_master/{generic_master_code}/

  • 汎用マスタレコードを新規登録する

Example URI

POST /v1/generic_master/GM-1/
URI Parameters
HideShow
generic_master_code
string (required) Example: GM-1

汎用マスタのコード

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "generic_master_record_code": "100",
  "generic_master_record_name": "hoge",
  "content": "hogehoge",
  "memo": "hugahuga"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "generic_master_record_code": {
      "type": "string",
      "description": "コード値"
    },
    "generic_master_record_name": {
      "type": "string",
      "description": "コード名"
    },
    "content": {
      "type": "string",
      "description": "内容"
    },
    "memo": {
      "type": "string",
      "description": "備考"
    }
  },
  "required": [
    "generic_master_record_code",
    "generic_master_record_name"
  ]
}
Response  200

汎用マスタレコード情報 v2

汎用マスタレコード一覧取得
GET/v2/generic_master/{generic_master_code}/

  • 登録されている汎用マスタレコード情報を取得する

  • 取得に成功した場合、汎用マスタレコード情報を返す

  • generic_master_code には「汎用マスタ」画面で登録した「コード」を設定してください。なお、generic_master_code 設定用APIは用意しておりません。

  • Body中のitemsには「汎用マスタ」画面の「レコード項目の編集」で登録した項目が取得されます。

Example URI

GET /v2/generic_master/GM-1/
URI Parameters
HideShow
generic_master_code
string (required) Example: GM-1

汎用マスタのコード

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "count": 130,
  "next": "https://ssl.wf.jobcan.jp/wf_api/v1/generic_master/123/?page=2",
  "previous": null,
  "results": [
    {
      "generic_master_record_code": "100",
      "title_name": "hoge",
      "title_content": "huga",
      "description": "hogehoge",
      "memo": "hugahuga",
      "items": [
        {
          "item_number": 1,
          "item_name": "hogehoge",
          "item_content": "hugahuga"
        },
        {
          "item_number": 2,
          "item_name": "hogehoge",
          "item_content": "hugahuga"
        },
        {
          "item_number": 3,
          "item_name": "hogehoge",
          "item_content": "hugahuga"
        },
        {
          "item_number": 4,
          "item_name": "hogehoge",
          "item_content": "hugahuga"
        },
        {
          "item_number": 5,
          "item_name": "hogehoge",
          "item_content": "hugahuga"
        }
      ]
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "count": {
      "type": "number",
      "description": "合計件数"
    },
    "next": {
      "type": "string",
      "description": "next url"
    },
    "previous": {
      "type": [
        "object",
        "null"
      ],
      "properties": {},
      "description": "previous url"
    },
    "results": {
      "type": "array",
      "description": "汎用マスタレコード詳細を格納した配列"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "code": "400004",
  "message": "対象の汎用マスタは存在しません。「generic_master_code」を確認してください。:generic_master_code"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}

汎用マスタレコード新規登録
POST/v2/generic_master/{generic_master_code}/

  • 汎用マスタレコードを新規登録する

  • Body中のitemsには「汎用マスタ」画面の「レコード項目の編集」で登録した項目を設定してください。登録されていない場合は"items": []と指定してください。

Example URI

POST /v2/generic_master/GM-1/
URI Parameters
HideShow
generic_master_code
string (required) Example: GM-1

汎用マスタのコード

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "generic_master_record_code": "100",
  "title_content": "hoge",
  "description": "hogehoge",
  "memo": "hugahuga",
  "items": [
    {
      "item_content": "hugahuga"
    },
    {
      "item_content": "hugahuga"
    },
    {
      "item_content": "hugahuga"
    },
    {
      "item_content": "hugahuga"
    },
    {
      "item_content": "hugahuga"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "generic_master_record_code": {
      "type": "string",
      "description": "コード値"
    },
    "title_content": {
      "type": "string",
      "description": "レコード名"
    },
    "description": {
      "type": "string",
      "description": "説明"
    },
    "memo": {
      "type": "string",
      "description": "備考"
    },
    "items": {
      "type": "array",
      "description": "追加項目"
    }
  },
  "required": [
    "generic_master_record_code",
    "title_content"
  ]
}
Response  200
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "code": "400006",
  "message": "「generic_master_record_code」にnullが設定されています。有効な値を設定してください。"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "code": "400004",
  "message": "対象の汎用マスタは存在しません。「generic_master_code」を確認してください。:generic_master_code"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "code": "500000",
  "message": "An unexpected error has occurred. Please check your data and try again."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}

GenericMasterRecordDetail

  • generic_master_record_code指定での汎用マスタレコード情報の取得、更新、削除。

汎用マスタレコード詳細 v1

汎用マスタレコード情報取得API
GET/v1/generic_master/{generic_master_code}/{generic_master_record_code}/

  • 指定した汎用マスタレコードの情報を返す。

  • generic_master_codeおよび generic_master_record_code は必須。指定がない場合、BadRequestを返す。

Example URI

GET /v1/generic_master/GM-1/GMR-2/
URI Parameters
HideShow
generic_master_code
string (required) Example: GM-1

汎用マスタのコード

generic_master_record_code
string (required) Example: GMR-2

汎用マスタレコードのコード

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "generic_master_record_code": "100",
  "generic_master_record_name": "hoge",
  "content": "hogehoge",
  "memo": "hugahuga"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "generic_master_record_code": {
      "type": "string",
      "description": "コード値"
    },
    "generic_master_record_name": {
      "type": "string",
      "description": "コード名"
    },
    "content": {
      "type": "string",
      "description": "内容"
    },
    "memo": {
      "type": "string",
      "description": "備考"
    }
  },
  "required": [
    "generic_master_record_code",
    "generic_master_record_name"
  ]
}

汎用マスタレコード情報更新API
PUT/v1/generic_master/{generic_master_code}/{generic_master_record_code}/

  • 指定した汎用マスタレコードの情報を更新する。

  • generic_master_codeおよび generic_master_record_code は必須。指定がない場合、BadRequestを返す。

  • その他の項目については、APIに設定された項目のみを更新。

Example URI

PUT /v1/generic_master/GM-1/GMR-2/
URI Parameters
HideShow
generic_master_code
string (required) Example: GM-1

汎用マスタのコード

generic_master_record_code
string (required) Example: GMR-2

汎用マスタレコードのコード

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "generic_master_record_code": "100",
  "generic_master_record_name": "hoge",
  "content": "hogehoge",
  "memo": "hugahuga"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "generic_master_record_code": {
      "type": "string",
      "description": "コード値"
    },
    "generic_master_record_name": {
      "type": "string",
      "description": "コード名"
    },
    "content": {
      "type": "string",
      "description": "内容"
    },
    "memo": {
      "type": "string",
      "description": "備考"
    }
  },
  "required": [
    "generic_master_record_code",
    "generic_master_record_name"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json

汎用マスタレコード情報削除API
DELETE/v1/generic_master/{generic_master_code}/{generic_master_record_code}/

  • 指定した汎用マスタレコード情報を削除する。

Example URI

DELETE /v1/generic_master/GM-1/GMR-2/
URI Parameters
HideShow
generic_master_code
string (required) Example: GM-1

汎用マスタのコード

generic_master_record_code
string (required) Example: GMR-2

汎用マスタレコードのコード

Response  204

汎用マスタレコード詳細 v2

汎用マスタレコード情報取得API
GET/v2/generic_master/{generic_master_code}/{generic_master_record_code}/

  • 指定した汎用マスタレコードの情報を返す。

  • generic_master_codeおよび generic_master_record_code は必須。指定がない場合、BadRequestを返す。

  • Body中のitemsには「汎用マスタ」画面の「レコード項目の編集」で登録した項目が取得されます。

Example URI

GET /v2/generic_master/GM-1/GMR-2/
URI Parameters
HideShow
generic_master_code
string (required) Example: GM-1

汎用マスタのコード

generic_master_record_code
string (required) Example: GMR-2

汎用マスタレコードのコード

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "generic_master_record_code": "100",
  "title_name": "hoge",
  "title_content": "huga",
  "description": "hogehoge",
  "memo": "hugahuga",
  "items": [
    {
      "item_number": 1,
      "item_name": "hogehoge",
      "item_content": "hugahuga"
    },
    {
      "item_number": 2,
      "item_name": "hogehoge",
      "item_content": "hugahuga"
    },
    {
      "item_number": 3,
      "item_name": "hogehoge",
      "item_content": "hugahuga"
    },
    {
      "item_number": 4,
      "item_name": "hogehoge",
      "item_content": "hugahuga"
    },
    {
      "item_number": 5,
      "item_name": "hogehoge",
      "item_content": "hugahuga"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "generic_master_record_code": {
      "type": "string",
      "description": "コード値"
    },
    "title_name": {
      "type": "string",
      "description": "レコード名タイトル"
    },
    "title_content": {
      "type": "string",
      "description": "レコード名"
    },
    "description": {
      "type": "string",
      "description": "説明"
    },
    "memo": {
      "type": "string",
      "description": "備考"
    },
    "items": {
      "type": "array",
      "description": "追加項目"
    }
  },
  "required": [
    "generic_master_record_code"
  ]
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "code": "400004",
  "message": "対象の汎用マスタレコードは存在しません。「generic_master_record_code」を確認してください。:generic_master_record_code"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}

汎用マスタレコード情報更新API
PUT/v2/generic_master/{generic_master_code}/{generic_master_record_code}/

  • 指定した汎用マスタレコードの情報を更新する。

  • generic_master_codeおよび generic_master_record_code は必須。指定がない場合、BadRequestを返す。

  • その他の項目については、APIに設定された項目のみを更新。

  • Body中のitemsには「汎用マスタ」画面の「レコード項目の編集」で登録した項目を設定してください。登録されていない場合は"items": []と指定してください。

Example URI

PUT /v2/generic_master/GM-1/GMR-2/
URI Parameters
HideShow
generic_master_code
string (required) Example: GM-1

汎用マスタのコード

generic_master_record_code
string (required) Example: GMR-2

汎用マスタレコードのコード

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "generic_master_record_code": "100",
  "title_content": "hoge",
  "description": "hogehoge",
  "memo": "hugahuga",
  "items": [
    {
      "item_content": "hugahuga"
    },
    {
      "item_content": "hugahuga"
    },
    {
      "item_content": "hugahuga"
    },
    {
      "item_content": "hugahuga"
    },
    {
      "item_content": "hugahuga"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "generic_master_record_code": {
      "type": "string",
      "description": "コード値"
    },
    "title_content": {
      "type": "string",
      "description": "レコード名"
    },
    "description": {
      "type": "string",
      "description": "説明"
    },
    "memo": {
      "type": "string",
      "description": "備考"
    },
    "items": {
      "type": "array",
      "description": "追加項目"
    }
  },
  "required": [
    "generic_master_record_code",
    "title_content"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "code": "400006",
  "message": "「generic_master_record_code」にnullが設定されています。有効な値を設定してください。"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "code": "400004",
  "message": "対象の汎用マスタレコードは存在しません。「generic_master_record_code」を確認してください。:generic_master_record_code"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "code": "500000",
  "message": "An unexpected error has occurred. Please check your data and try again."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}

汎用マスタレコード情報削除API
DELETE/v2/generic_master/{generic_master_code}/{generic_master_record_code}/

  • 指定した汎用マスタレコード情報を削除する。

Example URI

DELETE /v2/generic_master/GM-1/GMR-2/
URI Parameters
HideShow
generic_master_code
string (required) Example: GM-1

汎用マスタのコード

generic_master_record_code
string (required) Example: GMR-2

汎用マスタレコードのコード

Response  204
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "code": "400004",
  "message": "対象の汎用マスタレコードは存在しません。「generic_master_record_code」を確認してください。:generic_master_record_code"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}

Request

申請書一覧情報 v1

申請書一覧取得 v1
GET/v1/requests/{?start_date,end_date,final_approved_date_start,final_approved_date_end}

  • 登録されている申請書情報を取得する

  • 取得に成功した場合、申請書情報を返す

Example URI

GET /v1/requests/?start_date=2017/01/01&end_date=2017/02/01&final_approved_date_start=2017/01/01&final_approved_date_end=2017/02/01
URI Parameters
HideShow
start_date
string (optional) Example: 2017/01/01

申請日:指定した日以降に申請された申請書を抽出する。

end_date
string (optional) Example: 2017/02/01

申請日:指定した日以前に申請された申請書を抽出する。

final_approved_date_start
string (optional) Example: 2017/01/01

最終承認日:指定した日以降に最終承認された申請書を抽出する。

final_approved_date_end
string (optional) Example: 2017/02/01

最終承認日:指定した日以前に最終承認された申請書を抽出する。

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "count": 130,
  "next": "https://ssl.wf.jobcan.jp/wf_api/v1/requests/?page=2",
  "previous": null,
  "results": [
    {
      "view_id": "100",
      "title": "hoge",
      "status": "2",
      "request_date": "100",
      "request_form_id": 100,
      "form_type": "1",
      "form_name": "サンプルフォーム",
      "final_approved_date": "2017",
      "edit_flow_flg": "0",
      "request_user_code": "user01",
      "user_last_name": "ジョブカン",
      "user_first_name": "太郎",
      "group_name": "hogehoge",
      "group_code": "200",
      "project_name": "hugahuga",
      "project_code": "100"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "count": {
      "type": "number",
      "description": "合計件数"
    },
    "next": {
      "type": "string",
      "description": "next url"
    },
    "previous": {
      "type": [
        "object",
        "null"
      ],
      "properties": {},
      "description": "previous url"
    },
    "results": {
      "type": "array",
      "description": "申請書情報を格納した配列"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json

申請書一覧情報 v2

申請書一覧取得 v2
GET/v2/requests/{?id,status,form_id,title,applicant_code,group_code,project_code,applied_after,applied_before,completed_after,completed_before,include_canceled,keyword,page,sort_by}

  • 登録されている申請書情報を取得する

  • idを指定した場合、他のパラメータは無視される

  • 日付はすべてyyyy/mm/dd hh:mm:ss形式またはyyyy/mm/dd形式

  • グループコードやプロジェクトコードが登録されていない場合、そのグループやプロジェクトで検索することはできない

Example URI

GET /v2/requests/?id=B-59&status=in_progress&form_id=12345&title=sample_request&applicant_code=a-13&group_code=G-2&project_code=P-3&applied_after=2021/01/01 01:00:03&applied_before=2021/02/01 23:58:43&completed_after=2021/01/01 11:20:50&completed_before=2021/02/01 16:59:59&include_canceled=true&keyword=sample_keyword&page=3&sort_by=applied_date_asc
URI Parameters
HideShow
id
string (optional) Example: B-59

申請ID。完全一致。,区切りで複数選択することが可能。

status
string (optional) Example: in_progress

申請状況。in_progress: 進行中, completed: 完了, rejected: 却下, canceled: 取り消し, returned: 差し戻し, canceled_after_completion: 完了後取消

form_id
number (optional) Example: 12345

フォームID。完全一致。

title
string (optional) Example: sample_request

申請のタイトル。部分一致。

applicant_code
string (optional) Example: a-13

スタッフコード。完全一致。

group_code
string (optional) Example: G-2

グループコード。完全一致。

project_code
string (optional) Example: P-3

プロジェクトコード。完全一致。

applied_after
string (optional) Example: 2021/01/01 01:00:03

申請日:指定した日時以降に申請された申請書を抽出する。

applied_before
string (optional) Example: 2021/02/01 23:58:43

申請日:指定した日以前に申請された申請書を抽出する。

completed_after
string (optional) Example: 2021/01/01 11:20:50

最終承認日:指定した日以降に最終承認された申請書を抽出する。

completed_before
string (optional) Example: 2021/02/01 16:59:59

最終承認日:指定した日以前に最終承認された申請書を抽出する。

include_canceled
boolean (optional) Example: true

取り消した申請を表示するか。false: 表示しない, true: 表示する。デフォルトはfalse

keyword
string (optional) Example: sample_keyword

キーワード

page
number (optional) Example: 3

対象のページ番号。1ページあたり100件。デフォルトは1ページ目。

sort_by
string (optional) Example: applied_date_asc

並び順。applied_date_asc: 申請日順(新しい順), applied_date_desc: 申請日順(古い順),group: グループ順, form: フォーム順, user: ユーザ順。デフォルトはapplied_date_desc

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "count": 130,
  "next": "https://ssl.wf.jobcan.jp/wf_api/v2/requests/?page=2",
  "previous": null,
  "results": [
    {
      "id": "sa-10",
      "title": "sample_title",
      "status": "in_progress",
      "form_id": 100,
      "form_name": "サンプルフォーム",
      "form_type": "expense",
      "settlement_type": "pre_application",
      "applied_date": "2021-03-08T13:42:23+09:00",
      "applicant_code": "user01",
      "applicant_last_name": "ジョブカン",
      "applicant_first_name": "太郎",
      "applicant_group_name": "営業",
      "applicant_position_name": "部長",
      "proxy_applicant_last_name": "代理ジョブカン",
      "proxy_applicant_first_name": "代理太郎",
      "group_name": "サンプルグループ",
      "group_code": "200",
      "project_name": "サンプルプロジェクト",
      "project_code": "100",
      "flow_step_name": "ステップ1",
      "is_content_changed": true,
      "total_amount": 1234,
      "pay_at": "2021-01-01T11:41:21+09:00",
      "final_approval_period": "2021-02-02T12:22:23+09:00",
      "final_approved_date": "2021-03-03T03:32:33+09:00"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "count": {
      "type": "number",
      "description": "合計件数"
    },
    "next": {
      "type": "string",
      "description": "next url"
    },
    "previous": {
      "type": [
        "object",
        "null"
      ],
      "properties": {},
      "description": "previous url"
    },
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "申請ID"
          },
          "title": {
            "type": "string",
            "description": "タイトル"
          },
          "status": {
            "type": "string",
            "enum": [
              "in_progress",
              "completed",
              "rejected",
              "returned",
              "canceled_after_completion"
            ],
            "description": "申請状況"
          },
          "form_id": {
            "type": "number",
            "description": "フォームID"
          },
          "form_name": {
            "type": "string",
            "description": "フォーム名"
          },
          "form_type": {
            "type": "string",
            "enum": [
              "general",
              "expense",
              "payment",
              "ec_purchase"
            ],
            "description": "フォームタイプ"
          },
          "settlement_type": {
            "type": "string",
            "enum": [
              "pre_application",
              "settlement"
            ],
            "description": "`pre_application`:事前申請, settlement:精算"
          },
          "applied_date": {
            "type": "string",
            "description": "申請日"
          },
          "applicant_code": {
            "type": "string",
            "description": "申請ユーザのスタッフコード"
          },
          "applicant_last_name": {
            "type": "string",
            "description": "申請ユーザの姓"
          },
          "applicant_first_name": {
            "type": "string",
            "description": "申請ユーザの名"
          },
          "applicant_group_name": {
            "type": "string",
            "description": "申請ユーザの所属グループ"
          },
          "applicant_position_name": {
            "type": "string",
            "description": "申請ユーザの役職"
          },
          "proxy_applicant_last_name": {
            "type": "string",
            "description": "代理申請ユーザの姓"
          },
          "proxy_applicant_first_name": {
            "type": "string",
            "description": "代理申請ユーザの名"
          },
          "group_name": {
            "type": "string",
            "description": "関連グループ名"
          },
          "group_code": {
            "type": "string",
            "description": "関連グループコード"
          },
          "project_name": {
            "type": "string",
            "description": "関連プロジェクト名"
          },
          "project_code": {
            "type": "string",
            "description": "関連プロジェクトコード"
          },
          "flow_step_name": {
            "type": "string",
            "description": "現在の承認ステップ"
          },
          "is_content_changed": {
            "type": "boolean",
            "description": "申請が修正されたことを示す"
          },
          "total_amount": {
            "type": "number",
            "description": "合計金額"
          },
          "pay_at": {
            "type": "string",
            "description": "支払日"
          },
          "final_approval_period": {
            "type": "string"
          },
          "final_approved_date": {
            "type": "string",
            "description": "最終承認日"
          }
        }
      },
      "description": "申請書情報を格納した配列"
    }
  }
}
Response  400
HideShow

BadRequest時に以下のcodeを返す

  • 400003: パラメータが不正の場合
Headers
Content-Type: application/json
Body
{
  "message": "パラメータが不正です。",
  "code": 400003,
  "detail": [
    "applied_afterの値が不正です。yyyy/mm/dd hh:mm:ss形式またはyyyy/mm/dd形式で指定してください。",
    "completed_beforeの値が不正です。yyyy/mm/dd hh:mm:ss形式またはyyyy/mm/dd形式で指定してください。",
    "group_codeの値が不正です。対象のグループが存在しません。"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "エラーメッセージ"
    },
    "code": {
      "type": "number",
      "description": "エラーコード"
    },
    "detail": {
      "type": "array",
      "description": "エラー詳細"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "予期しないエラーが発生しました。",
  "code": 500000
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "エラーメッセージ"
    },
    "code": {
      "type": "number",
      "description": "エラーコード"
    }
  }
}

申請書詳細情報

申請書詳細情報取得
GET/v1/requests/{request_id}/

  • 指定した申請の情報を取得する

  • detail以外は一覧取得と同じデータを返す

  • detailはフォームに応じたデータを返す

  • customized_itemsは項目タイプに応じたデータを返す

Example URI

GET /v1/requests/EX-10/
URI Parameters
HideShow
request_id
string (required) Example: EX-10

申請ID

Response  200
HideShow
フォーム形式ごとのdetail返却要素
フォーム形式 customized_items expense payment ec approval_process viewers default_attachment_files modify_logs
汎用フォーム
経費明細
支払依頼
EC購入申請
項目タイプごとのcustomized_items返却要素
項目タイプ title content generic_master files table
単一行テキスト
複数行テキスト
数字入力
日付選択
月選択
ラジオボタン
プルダウン
チェックボックス
取引先選択
申請書選択
ユーザ選択
グループ選択
プロジェクト選択
汎用マスタ選択
添付ファイル選択
見出し
説明文
明細表
時刻
計算
generic_master, files, table の Schema
generic_master
"generic_master": {
    "record_name": {
        "type": "string",
        "desctiption": "レコード名"
    },
    "record_code": {
        "type": "string",
        "desctiption": "コード"
    },
    "additional_items": {
        "type": "array",
        "desctiption": "追加項目"
    },
}
files
"files": [
    {
        "id": {
            "type": "number",
            "desctiption": "ファイルID"
        },
        "name": {
            "type": "string",
            "desctiption": "ファイル名"
        },
        "type": {
            "type": "string",
            "desctiption": "ファイルタイプ"
        },
    }
]
table
  • table(明細)の汎用マスタ選択はvalueではなくgeneric_masterを返す
"table": [
    [
        {
            "column_number": {
                "type": "string",
                "desctiption": "カラム番号"
            },
            "value": {
                "type": "string",
                "desctiption": "入力値"
            },
        }
    ],
]
Headers
Content-Type: application/json
Body
{
  "id": "sa-10",
  "title": "sample_title",
  "status": "in_progress",
  "form_id": 100,
  "form_name": "サンプルフォーム",
  "form_type": "general",
  "settlement_type": "pre_application",
  "applied_date": "2021-03-08T13:42:23+09:00",
  "applicant_code": "user01",
  "applicant_last_name": "ジョブカン",
  "applicant_first_name": "太郎",
  "applicant_group_name": "営業",
  "applicant_position_name": "部長",
  "proxy_applicant_last_name": "代理ジョブカン",
  "proxy_applicant_first_name": "代理太郎",
  "group_name": "サンプルグループ",
  "group_code": "200",
  "project_name": "サンプルプロジェクト",
  "project_code": "100",
  "flow_step_name": "ステップ1",
  "is_content_changed": true,
  "total_amount": 1234,
  "pay_at": "2021-01-01T11:41:21+09:00",
  "final_approval_period": "2021-02-02T12:22:23+09:00",
  "final_approved_date": "2021-03-03T03:32:33+09:00",
  "detail": {
    "customized_items": [
      {
        "title": "新しい項目",
        "content": "入力データ",
        "generic_master": {
          "record_name": "サンプルレコード",
          "record_code": "sample_code",
          "additional_items": [
            "追加項目1"
          ]
        },
        "files": [
          {
            "id": "10",
            "name": "sample_file_name",
            "type": "image/png"
          }
        ],
        "table": [
          [
            {
              "column_number": "3",
              "value": "入力値",
              "generic_master": {
                "record_name": "サンプルレコード",
                "record_code": "sample_code",
                "additional_items": [
                  "追加項目1"
                ]
              }
            }
          ]
        ]
      }
    ],
    "expense": {
      "amount": 1000,
      "related_request_title": "サンプル申請",
      "related_request_id": "pre-30",
      "specifics": [
        {
          "rows": [
            {
              "row_number": "1",
              "use_date": "2021/01/01",
              "group_name": "営業",
              "project_name": "サンプルプロジェクト",
              "content_description": "サンプル内容",
              "breakdown": "交通費",
              "amount": 500,
              "files": [
                {
                  "id": "10",
                  "name": "sample_file_name",
                  "type": "image/png"
                }
              ]
            }
          ],
          "type": "normal"
        }
      ],
      "use_suspense_payment": false,
      "content_description": "メモ",
      "advanced_payment": 2000,
      "suspense_payment_amount": 1000
    },
    "payment": {
      "amount": 1000,
      "related_request_title": "サンプル申請",
      "related_request_id": "pre-30",
      "specifics": [
        {
          "rows": [
            {
              "company_name": "取引先の会社",
              "zip_code": "111",
              "address": "テスト住所",
              "bank_name": "ジョブカン銀行",
              "bank_name_kana": "ジョブカンギンコウ",
              "bank_account_name_kana": "ジョブカンタロウ",
              "bank_code": 9999,
              "branch_code": 999,
              "row_number": "1",
              "use_date": "2021/01/01",
              "group_name": "営業",
              "project_name": "サンプルプロジェクト",
              "content_description": "サンプル内容",
              "breakdown": "交通費",
              "amount": 500,
              "files": [
                {
                  "id": "10",
                  "name": "sample_file_name",
                  "type": "image/png"
                }
              ]
            }
          ],
          "type": "normal"
        }
      ],
      "content_description": "内容"
    },
    "ec": {
      "related_request_id": "pre-1",
      "related_request_title": "テスト事前",
      "content_description": "説明文",
      "shipping_address": {
        "shipping_address_name": "テスト配送先",
        "zip_code": "111-2222",
        "country": "日本",
        "state": "東京都",
        "city": "新宿区",
        "address1": "テスト住所",
        "address2": "テストビル",
        "company_name": "テスト会社",
        "contact_name": "ジョブカン 太郎",
        "tel": "000-1111-2222",
        "email": "sample@example.com"
      },
      "billing_destination": "テスト請求先",
      "specifics": {
        "order_id": "JJ1111111",
        "retention_deadline": "2021-04-01T12:00:00+09:00",
        "rows": [
          {
            "row_number": "1",
            "item_name": "テスト商品",
            "item_url": "http://test.com",
            "item_id": "test_code",
            "manufacturer_name": "テスト製造元",
            "sold_by": "テスト販売元",
            "fulfilled_by": "テスト発送元",
            "unit_price": 1000,
            "quantity": "1",
            "subtotal": 1000
          }
        ],
        "tax_amount": 100,
        "shipping_amount": 150,
        "total_price": 1000,
        "total_amount": 1250
      }
    },
    "approval_process": {
      "is_route_changed_by_applicant": true,
      "approval_route_modify_logs": [
        {
          "date": "2021-05-19T05:34:15+09:00",
          "user_name": "ジョブカン 太郎"
        }
      ],
      "steps": [
        {
          "name": "ステップ1",
          "condition": "全員の承認が必要",
          "status": "承認済み",
          "approvers": [
            {
              "status": "承認済み",
              "approved_date": "2021-05-19T04:43:12+09:00",
              "approver_name": "ジョブカン 太郎",
              "proxy_approver_name": "ジョブカン 次郎"
            }
          ],
          "comments": [
            {
              "user_name": "ジョブカン 太郎",
              "date": "2021-03-15T01:17:34+09:00",
              "text": "コメントを記入しました。",
              "deleted": false
            }
          ],
          "files": [
            {
              "user_name": "ジョブカン 太郎",
              "date": "2021-03-15T01:17:34+09:00",
              "id": "10",
              "name": "sample_file_name",
              "type": "image/png",
              "deleted": false
            }
          ]
        }
      ],
      "after_completion": {
        "comments": [
          {
            "user_name": "ジョブカン 太郎",
            "date": "2021-03-15T01:17:34+09:00",
            "text": "コメントを記入しました。",
            "deleted": false
          }
        ],
        "files": [
          {
            "user_name": "ジョブカン 太郎",
            "date": "2021-03-15T01:17:34+09:00",
            "id": "10",
            "name": "sample_file_name",
            "type": "image/png",
            "deleted": false
          }
        ]
      }
    },
    "viewers": [
      {
        "user_name": "ジョブカン 太郎",
        "status": "閲覧済み",
        "group": "ワークフロー",
        "position": "部長 (以上の役職ランク)"
      }
    ],
    "default_attachment_files": [
      {
        "id": "10",
        "name": "sample_file_name",
        "type": "image/png"
      }
    ],
    "modify_logs": [
      {
        "date": "2020-08-27T11:10+09:00",
        "detail": [
          {
            "title": "タイトル",
            "old": "修正前",
            "new": "修正後",
            "log_type": "normal",
            "specifics": {
              "status": "diff",
              "difference": "金額:1 ⇒ 12344"
            }
          }
        ],
        "user_name": "ジョブカン 太郎"
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "申請ID"
    },
    "title": {
      "type": "string",
      "description": "タイトル"
    },
    "status": {
      "type": "string",
      "enum": [
        "in_progress",
        "completed",
        "rejected",
        "returned",
        "canceled_after_completion"
      ],
      "description": "申請状況"
    },
    "form_id": {
      "type": "number",
      "description": "フォームID"
    },
    "form_name": {
      "type": "string",
      "description": "フォーム名"
    },
    "form_type": {
      "type": "string",
      "enum": [
        "general",
        "expense",
        "payment",
        "ec_purchase"
      ],
      "description": "フォームタイプ"
    },
    "settlement_type": {
      "type": "string",
      "enum": [
        "pre_application",
        "settlement"
      ],
      "description": "`pre_application`:事前申請, settlement:精算"
    },
    "applied_date": {
      "type": "string",
      "description": "申請日"
    },
    "applicant_code": {
      "type": "string",
      "description": "申請ユーザのスタッフコード"
    },
    "applicant_last_name": {
      "type": "string",
      "description": "申請ユーザの姓"
    },
    "applicant_first_name": {
      "type": "string",
      "description": "申請ユーザの名"
    },
    "applicant_group_name": {
      "type": "string",
      "description": "申請ユーザの所属グループ"
    },
    "applicant_position_name": {
      "type": "string",
      "description": "申請ユーザの役職"
    },
    "proxy_applicant_last_name": {
      "type": "string",
      "description": "代理申請ユーザの姓"
    },
    "proxy_applicant_first_name": {
      "type": "string",
      "description": "代理申請ユーザの名"
    },
    "group_name": {
      "type": "string",
      "description": "関連グループ名"
    },
    "group_code": {
      "type": "string",
      "description": "関連グループコード"
    },
    "project_name": {
      "type": "string",
      "description": "関連プロジェクト名"
    },
    "project_code": {
      "type": "string",
      "description": "関連プロジェクトコード"
    },
    "flow_step_name": {
      "type": "string",
      "description": "現在の承認ステップ"
    },
    "is_content_changed": {
      "type": "boolean",
      "description": "申請が修正されたことを示す"
    },
    "total_amount": {
      "type": "number",
      "description": "合計金額"
    },
    "pay_at": {
      "type": "string",
      "description": "支払日"
    },
    "final_approval_period": {
      "type": "string"
    },
    "final_approved_date": {
      "type": "string",
      "description": "最終承認日"
    },
    "detail": {
      "type": "object",
      "properties": {
        "customized_items": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "title": {
                "type": "string",
                "description": "項目名称"
              },
              "content": {
                "type": "string",
                "description": "項目の入力データ"
              },
              "generic_master": {
                "type": "object",
                "properties": {
                  "record_name": {
                    "type": "string",
                    "description": "レコード名"
                  },
                  "record_code": {
                    "type": "string",
                    "description": "コード"
                  },
                  "additional_items": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "description": "追加項目"
                  }
                },
                "description": "汎用マスタ選択の場合のみ"
              },
              "files": {
                "type": "array",
                "description": "添付ファイル選択の場合のみ"
              },
              "table": {
                "type": "array",
                "description": "明細の場合のみ"
              }
            }
          },
          "description": "自由設定項目のデータ"
        },
        "expense": {
          "type": "object",
          "properties": {
            "amount": {
              "type": "number",
              "description": "明細小計"
            },
            "related_request_title": {
              "type": "string",
              "description": "事前申請のタイトル"
            },
            "related_request_id": {
              "type": "string",
              "description": "事前申請の申請ID"
            },
            "specifics": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "rows": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "row_number": {
                          "type": "string",
                          "description": "行番号"
                        },
                        "use_date": {
                          "type": "string",
                          "description": "利用日"
                        },
                        "group_name": {
                          "type": "string",
                          "description": "グループ名"
                        },
                        "project_name": {
                          "type": "string",
                          "description": "プロジェクト名"
                        },
                        "content_description": {
                          "type": "string",
                          "description": "内容"
                        },
                        "breakdown": {
                          "type": "string",
                          "description": "内訳"
                        },
                        "amount": {
                          "type": "number",
                          "description": "金額"
                        },
                        "files": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "description": "ファイルID"
                              },
                              "name": {
                                "type": "string",
                                "description": "ファイルの表示名"
                              },
                              "type": {
                                "type": "string",
                                "description": "ファイルタイプ"
                              }
                            }
                          },
                          "description": "添付ファイル"
                        }
                      }
                    },
                    "description": "明細行情報"
                  },
                  "type": {
                    "type": "string",
                    "description": "明細タイプ"
                  }
                }
              },
              "description": "経費明細の情報"
            },
            "use_suspense_payment": {
              "type": "boolean",
              "description": "仮払いを使用しているか"
            },
            "content_description": {
              "type": "string",
              "description": "内容"
            },
            "advanced_payment": {
              "type": "number",
              "description": "立替金額"
            },
            "suspense_payment_amount": {
              "type": "number",
              "description": "仮払い希望金額"
            }
          },
          "description": "経費のデータ(経費フォームの場合のみ)"
        },
        "payment": {
          "type": "object",
          "properties": {
            "amount": {
              "type": "number",
              "description": "明細小計"
            },
            "related_request_title": {
              "type": "string",
              "description": "事前申請のタイトル"
            },
            "related_request_id": {
              "type": "string",
              "description": "事前申請の申請ID"
            },
            "specifics": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "rows": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "company_name": {
                          "type": "string",
                          "description": "取引先の会社名"
                        },
                        "zip_code": {
                          "type": "string",
                          "description": "2222 (string) - 郵便番号"
                        },
                        "address": {
                          "type": "string",
                          "description": "住所"
                        },
                        "bank_name": {
                          "type": "string",
                          "description": "銀行名"
                        },
                        "bank_name_kana": {
                          "type": "string",
                          "description": "銀行名(カナ)"
                        },
                        "bank_account_name_kana": {
                          "type": "string",
                          "description": "名義人名(カナ)"
                        },
                        "bank_code": {
                          "type": "number",
                          "description": "銀行コード"
                        },
                        "branch_code": {
                          "type": "number",
                          "description": "支店コード"
                        },
                        "row_number": {
                          "type": "string",
                          "description": "行番号"
                        },
                        "use_date": {
                          "type": "string",
                          "description": "利用日"
                        },
                        "group_name": {
                          "type": "string",
                          "description": "グループ名"
                        },
                        "project_name": {
                          "type": "string",
                          "description": "プロジェクト名"
                        },
                        "content_description": {
                          "type": "string",
                          "description": "内容"
                        },
                        "breakdown": {
                          "type": "string",
                          "description": "内訳"
                        },
                        "amount": {
                          "type": "number",
                          "description": "金額"
                        },
                        "files": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "description": "ファイルID"
                              },
                              "name": {
                                "type": "string",
                                "description": "ファイルの表示名"
                              },
                              "type": {
                                "type": "string",
                                "description": "ファイルタイプ"
                              }
                            }
                          },
                          "description": "添付ファイル"
                        }
                      }
                    },
                    "description": "明細行情報"
                  },
                  "type": {
                    "type": "string",
                    "description": "明細タイプ"
                  }
                }
              },
              "description": "経費明細の情報"
            },
            "content_description": {
              "type": "string",
              "description": "内容"
            }
          },
          "description": "支払のデータ(支払フォームの場合のみ)"
        },
        "ec": {
          "type": "object",
          "properties": {
            "related_request_id": {
              "type": "string",
              "description": "事前申請ID"
            },
            "related_request_title": {
              "type": "string",
              "description": "事前申請タイトル"
            },
            "content_description": {
              "type": "string",
              "description": "内容"
            },
            "shipping_address": {
              "type": "object",
              "properties": {
                "shipping_address_name": {
                  "type": "string",
                  "description": "配送先名"
                },
                "zip_code": {
                  "type": "string",
                  "description": "郵便番号"
                },
                "country": {
                  "type": "string",
                  "description": "国"
                },
                "state": {
                  "type": "string",
                  "description": "都道府県"
                },
                "city": {
                  "type": "string",
                  "description": "市区町村"
                },
                "address1": {
                  "type": "string",
                  "description": "番地以降"
                },
                "address2": {
                  "type": "string",
                  "description": "その他(ビル名等)"
                },
                "company_name": {
                  "type": "string",
                  "description": "会社名"
                },
                "contact_name": {
                  "type": "string",
                  "description": "担当者名"
                },
                "tel": {
                  "type": "string",
                  "description": "電話番号"
                },
                "email": {
                  "type": "string",
                  "description": "担当者のメールアドレス"
                }
              },
              "description": "配送先情報"
            },
            "billing_destination": {
              "type": "string",
              "description": "請求先名"
            },
            "specifics": {
              "type": "object",
              "properties": {
                "order_id": {
                  "type": "string",
                  "description": "注文番号"
                },
                "retention_deadline": {
                  "type": "string",
                  "description": "在庫保持期間"
                },
                "rows": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "row_number": {
                        "type": "string",
                        "description": "行番号"
                      },
                      "item_name": {
                        "type": "string",
                        "description": "商品名"
                      },
                      "item_url": {
                        "type": "string",
                        "description": "商品のURL"
                      },
                      "item_id": {
                        "type": "string",
                        "description": "商品ID"
                      },
                      "manufacturer_name": {
                        "type": "string",
                        "description": "製造元"
                      },
                      "sold_by": {
                        "type": "string",
                        "description": "販売元"
                      },
                      "fulfilled_by": {
                        "type": "string",
                        "description": "発送元"
                      },
                      "unit_price": {
                        "type": "number",
                        "description": "単価"
                      },
                      "quantity": {
                        "type": "string",
                        "description": "数量"
                      },
                      "subtotal": {
                        "type": "number",
                        "description": "小計"
                      }
                    }
                  },
                  "description": "明細データ"
                },
                "tax_amount": {
                  "type": "number",
                  "description": "税"
                },
                "shipping_amount": {
                  "type": "number",
                  "description": "配送料"
                },
                "total_price": {
                  "type": "number",
                  "description": "税抜き金額"
                },
                "total_amount": {
                  "type": "number",
                  "description": "合計金額"
                }
              },
              "description": "明細情報"
            }
          },
          "description": "EC購入申請のデータ(EC購入申請フォームの場合のみ)"
        },
        "approval_process": {
          "type": "object",
          "properties": {
            "is_route_changed_by_applicant": {
              "type": "boolean",
              "description": "申請時に経路が編集された"
            },
            "approval_route_modify_logs": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "date": {
                    "type": "string",
                    "description": "修正した日時"
                  },
                  "user_name": {
                    "type": "string",
                    "description": "編集者名"
                  }
                }
              },
              "description": "経路を編集したユーザの情報"
            },
            "steps": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "description": "ステップ名"
                  },
                  "condition": {
                    "type": "string",
                    "description": "承認完了の条件(「全員の承認が必要」or「誰か1人の承認が必要」)"
                  },
                  "status": {
                    "type": "string",
                    "description": "ステップの承認状況(「承認待ち」or「承認済み」or「却下」or「差し戻し」)"
                  },
                  "approvers": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "status": {
                          "type": "string",
                          "description": "承認状況(「承認待ち」or「承認済み」or「却下」or「差し戻し」)"
                        },
                        "approved_date": {
                          "type": "string",
                          "description": "承認日"
                        },
                        "approver_name": {
                          "type": "string",
                          "description": "承認者名"
                        },
                        "proxy_approver_name": {
                          "type": "string",
                          "description": "代理承認者名"
                        }
                      }
                    },
                    "description": "承認者情報"
                  },
                  "comments": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "user_name": {
                          "type": "string",
                          "description": "コメントしたユーザ名"
                        },
                        "date": {
                          "type": "string",
                          "description": "コメントの日時"
                        },
                        "text": {
                          "type": "string",
                          "description": "コメント。削除されている場合はnull"
                        },
                        "deleted": {
                          "type": "boolean",
                          "description": "削除フラグ"
                        }
                      }
                    },
                    "description": "コメント"
                  },
                  "files": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "user_name": {
                          "type": "string",
                          "description": "ファイル添付したユーザ名"
                        },
                        "date": {
                          "type": "string",
                          "description": "ファイル添付した日時"
                        },
                        "id": {
                          "type": "string",
                          "description": "ファイルID。削除されている場合はnull"
                        },
                        "name": {
                          "type": "string",
                          "description": "ファイルの表示名。削除されている場合はnull"
                        },
                        "type": {
                          "type": "string",
                          "description": "ファイルタイプ。削除されている場合はnull"
                        },
                        "deleted": {
                          "type": "boolean",
                          "description": "削除フラグ"
                        }
                      }
                    },
                    "description": "添付ファイル"
                  }
                }
              },
              "description": "承認ステップの情報"
            },
            "after_completion": {
              "type": "object",
              "properties": {
                "comments": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "user_name": {
                        "type": "string",
                        "description": "コメントしたユーザ名"
                      },
                      "date": {
                        "type": "string",
                        "description": "コメントの日時"
                      },
                      "text": {
                        "type": "string",
                        "description": "コメント。削除されている場合はnull"
                      },
                      "deleted": {
                        "type": "boolean",
                        "description": "削除フラグ"
                      }
                    }
                  },
                  "description": "コメント"
                },
                "files": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "user_name": {
                        "type": "string",
                        "description": "ファイル添付したユーザ名"
                      },
                      "date": {
                        "type": "string",
                        "description": "ファイル添付した日時"
                      },
                      "id": {
                        "type": "string",
                        "description": "ファイルID。削除されている場合はnull"
                      },
                      "name": {
                        "type": "string",
                        "description": "ファイルの表示名。削除されている場合はnull"
                      },
                      "type": {
                        "type": "string",
                        "description": "ファイルタイプ。削除されている場合はnull"
                      },
                      "deleted": {
                        "type": "boolean",
                        "description": "削除フラグ"
                      }
                    }
                  },
                  "description": "添付ファイル"
                }
              },
              "description": "承認完了後のコメントや添付ファイル"
            }
          },
          "description": "承認状況のデータ"
        },
        "viewers": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "user_name": {
                "type": "string",
                "description": "ユーザ名"
              },
              "status": {
                "type": "string",
                "description": "閲覧状況(「閲覧済み」or「未閲覧」)"
              },
              "group": {
                "type": "string",
                "description": "閲覧可能グループ"
              },
              "position": {
                "type": "string",
                "description": "閲覧可能役職"
              }
            }
          },
          "description": "閲覧状況のデータ"
        },
        "default_attachment_files": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "ファイルID"
              },
              "name": {
                "type": "string",
                "description": "ファイルの表示名"
              },
              "type": {
                "type": "string",
                "description": "ファイルタイプ"
              }
            }
          },
          "description": "デフォルトの添付ファイルで添付されているファイルのデータ"
        },
        "modify_logs": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "date": {
                "type": "string",
                "description": "日付"
              },
              "detail": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "title": {
                      "type": "string",
                      "description": "項目名"
                    },
                    "old": {
                      "type": "string",
                      "description": "修正前の値"
                    },
                    "new": {
                      "type": "string",
                      "description": "修正後の値"
                    },
                    "log_type": {
                      "type": "string",
                      "description": "項目種別 (normal:一般項目, company:取引先, specifics:明細項目)"
                    },
                    "specifics": {
                      "type": "object",
                      "properties": {
                        "status": {
                          "type": "string",
                          "description": "修正情報( normal: 変更なし, add: 追加, diff: 修正, del: 削除 )"
                        },
                        "difference": {
                          "type": "string",
                          "description": "修正内容"
                        }
                      },
                      "description": "明細表の差異"
                    }
                  }
                },
                "description": "修正箇所の情報"
              },
              "user_name": {
                "type": "string",
                "description": "ユーザ氏名"
              }
            }
          },
          "description": "申請の修正履歴"
        }
      }
    }
  }
}
Response  404
HideShow

BadRequest時に以下のcodeを返す

  • 400004: 対象の申請が存在しない場合
Headers
Content-Type: application/json
Body
{
  "code": "400004",
  "message": "対象の申請が存在しません。"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "予期しないエラーが発生しました。",
  "code": 500000
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "エラーメッセージ"
    },
    "code": {
      "type": "number",
      "description": "エラーコード"
    }
  }
}

FixJournal

  • 仕訳情報の取得、更新。

確定済み未出力仕訳情報一覧 v1

確定済み未出力仕訳情報一覧取得API
GET/v1/fix_journals/unprinted/

  • 確定済み未出力仕訳情報一覧を返す。

  • リクエスト時点での未出力一覧が自動で返却される。

Example URI

GET /v1/fix_journals/unprinted/
URI Parameters
HideShow
page
number (optional) Example: 1

対象のページ番号。1ページあたり1000件。デフォルトは1ページ目。

journal_type
string (optional) Example: book

取得する仕訳タイプ。未指定の場合は全てを取得する。

  • book (string) - 計上仕訳

  • pay (string) - 支払仕訳

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "count": 1200,
  "next": "https://ssl.wf.jobcan.jp/wf_api/v1/fix_journals/unprinted/?page=2",
  "previous": null,
  "results": [
    {
      "journal_id": 1,
      "journal_type": "book",
      "journal_date": "2022/06/01",
      "req_date": "2022/06/03",
      "journal_summary": "20220603仕訳TEST",
      "view_id": "A1",
      "specifics_row_number": 1,
      "company_code": "testcode",
      "company_name": "テスト支払先株式会社",
      "user_code": "teststaff",
      "user_name": "ジョブカン太郎",
      "debit_account_title_code": "testkanjo1",
      "debit_account_title_name": "旅費交通費(テスト)",
      "debit_account_sub_title_code": "subcode",
      "debit_account_sub_title_name": "テスト科目",
      "debit_tax_category_code": "testzei1",
      "debit_tax_category_name": "課税仕入(テスト)",
      "debit_amount": 3000,
      "debit_tax_amount": 272,
      "debit_amount_without_tax": 2728,
      "debit_group_code": "TESTGROUP",
      "debit_group_name": "テストグループ",
      "debit_accounting_group_code": "TESTACCOUNTINGGROUP",
      "debit_project_code": "TESTPROJECT",
      "debit_project_name": "テストプロジェクト",
      "credit_account_title_code": "testkanjo4",
      "credit_account_title_name": "未払金(テスト)",
      "credit_account_sub_title_code": "testcodea",
      "credit_account_sub_title_name": "testcodeb",
      "credit_tax_category_code": "testzei2",
      "credit_tax_category_name": "対象外(テスト)",
      "credit_amount": 3000,
      "credit_tax_amount": 0,
      "credit_amount_without_tax": 3000,
      "credit_group_code": "testcodec",
      "credit_group_name": "テストグループ",
      "credit_accounting_group_code": "TESTACCOUNTINGGROUP",
      "credit_project_code": "testcoded",
      "credit_project_name": "テストプロジェクト"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "count": {
      "type": "number",
      "description": "合計件数"
    },
    "next": {
      "type": "string",
      "description": "next url"
    },
    "previous": {
      "type": [
        "object",
        "null"
      ],
      "properties": {},
      "description": "previous url"
    },
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "journal_id": {
            "type": "number",
            "description": "仕訳ID"
          },
          "journal_type": {
            "type": "string",
            "enum": [
              "book",
              "pay"
            ],
            "description": "仕訳タイプ"
          },
          "journal_date": {
            "type": "string",
            "description": "仕訳日"
          },
          "req_date": {
            "type": "string",
            "description": "申請日"
          },
          "journal_summary": {
            "type": "string",
            "description": "摘要"
          },
          "view_id": {
            "type": "string",
            "description": "申請ID"
          },
          "specifics_row_number": {
            "type": "number",
            "description": "明細行番号"
          },
          "company_code": {
            "type": "string",
            "description": "取引先コード"
          },
          "company_name": {
            "type": "string",
            "description": "取引先名"
          },
          "user_code": {
            "type": "string",
            "description": "スタッフコード"
          },
          "user_name": {
            "type": "string",
            "description": "氏名"
          },
          "debit_account_title_code": {
            "type": "string",
            "description": "借方:勘定科目コード"
          },
          "debit_account_title_name": {
            "type": "string",
            "description": "借方:勘定科目名"
          },
          "debit_account_sub_title_code": {
            "type": "string",
            "description": "借方:補助科目コード"
          },
          "debit_account_sub_title_name": {
            "type": "string",
            "description": "借方:補助科目名"
          },
          "debit_tax_category_code": {
            "type": "string",
            "description": "借方:税区分コード"
          },
          "debit_tax_category_name": {
            "type": "string",
            "description": "借方:税区分名"
          },
          "debit_amount": {
            "type": "number",
            "description": "借方:金額"
          },
          "debit_tax_amount": {
            "type": "number",
            "description": "借方:税額"
          },
          "debit_amount_without_tax": {
            "type": "number",
            "description": "借方:税抜金額"
          },
          "debit_group_code": {
            "type": "string",
            "description": "借方:負担グループコード"
          },
          "debit_group_name": {
            "type": "string",
            "description": "借方:負担グループ名"
          },
          "debit_accounting_group_code": {
            "type": "string",
            "description": "借方:会計グループコード"
          },
          "debit_project_code": {
            "type": "string",
            "description": "借方:負担プロジェクトコード"
          },
          "debit_project_name": {
            "type": "string",
            "description": "借方:負担プロジェクト名"
          },
          "credit_account_title_code": {
            "type": "string",
            "description": "貸方:勘定科目コード"
          },
          "credit_account_title_name": {
            "type": "string",
            "description": "貸方:勘定科目名"
          },
          "credit_account_sub_title_code": {
            "type": "string",
            "description": "貸方:補助科目コード"
          },
          "credit_account_sub_title_name": {
            "type": "string",
            "description": "貸方:補助科目名"
          },
          "credit_tax_category_code": {
            "type": "string",
            "description": "貸方:税区分コード"
          },
          "credit_tax_category_name": {
            "type": "string",
            "description": "貸方:税区分名"
          },
          "credit_amount": {
            "type": "number",
            "description": "貸方:金額"
          },
          "credit_tax_amount": {
            "type": "number",
            "description": "貸方:税額"
          },
          "credit_amount_without_tax": {
            "type": "number",
            "description": "貸方:税抜金額"
          },
          "credit_group_code": {
            "type": "string",
            "description": "貸方:負担グループコード"
          },
          "credit_group_name": {
            "type": "string",
            "description": "貸方:負担グループ名"
          },
          "credit_accounting_group_code": {
            "type": "string",
            "description": "貸方:会計グループコード"
          },
          "credit_project_code": {
            "type": "string",
            "description": "貸方:負担プロジェクトコード"
          },
          "credit_project_name": {
            "type": "string",
            "description": "貸方:負担プロジェクト名"
          }
        }
      }
    }
  }
}
Response  400
HideShow

BadRequest時に以下のcodeを返す

  • 400003: 入力パラメータが不正の場合
Headers
Content-Type: application/json
Body
{
  "code": 400003,
  "message": "パラメータが不正です。",
  "detail": [
    "journal_typeの値が不正です。book: 計上仕訳, pay: 支払仕訳 のいずれかを指定してください。"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ"
    },
    "detail": {
      "type": "array",
      "description": "エラー時の詳細が存在する場合のみ使用可能"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json

確定済み未出力仕訳情報一覧更新API
PUT/v1/fix_journals/unprinted/

  • 指定した仕訳IDのステータスを出力済みに更新する。

  • 一度のリクエストで、最大1,000件まで指定可能

Example URI

PUT /v1/fix_journals/unprinted/
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "journal_id_list": [
    1
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "journal_id_list": {
      "type": "array"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Response  400
HideShow

BadRequest時に以下のcodeを返す

  • 400100: JSONの内容が誤っている場合
Headers
Content-Type: application/json
Body
{
  "code": 400100,
  "message": "パラメータが不正です。",
  "detail": [
    "JSONの値が不正です。対象の仕訳IDが存在しないか、更新済みです。"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ"
    },
    "detail": {
      "type": "array",
      "description": "エラー時の詳細が存在する場合のみ使用可能"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "予期しないエラーが発生しました。",
  "code": 500000
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "エラーメッセージ"
    },
    "code": {
      "type": "number",
      "description": "エラーコード"
    }
  }
}

File

ファイル

ファイルダウンロード
GET/v1/userfiles/:file_id/

  • 対象のファイルをバイナリ形式でダウンロードする

Example URI

GET /v1/userfiles/:file_id/
Response  200
HideShow

jpeg画像ファイルの場合

Headers
Content-Type: image/jpeg
Content-Disposition: attachment; filename='sample.jpeg'
Body
(ファイルデータ)
Response  404
HideShow

BadRequest時に以下のcodeを返す

  • 400004: 対象のファイルが存在しない場合
Headers
Content-Type: application/json
Body
{
  "code": "400004",
  "message": "対象ファイルが存在しません。"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "予期しないエラーが発生しました。",
  "code": 500000
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "エラーメッセージ"
    },
    "code": {
      "type": "number",
      "description": "エラーコード"
    }
  }
}

Felica

交通系ICカード

アップロード(単体ごと)
POST/v1/felica/history/

  • 交通系ICカード履歴を単体ごとに選択して登録する。

Example URI

POST /v1/felica/history/
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "email": "sample@example.com",
  "felica_rows": [
    {
      "raw_data": "1601000422FA8204820A1B080001AD00",
      "usage_amount": 123
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "登録を実行するユーザのメールアドレス"
    },
    "felica_rows": {
      "type": "array",
      "description": "ICカードから読み込んだ生データ"
    }
  }
}
Response  201
Response  400
HideShow

BadRequest時に以下のcodeを返す

  • 400100: 入力がJson形式でない場合

  • 400003: 入力パラメータが不正の場合, 対象のユーザが存在しない場合

  • 400014: 重複したデータが含まれている場合

  • 400001: 駅コードが不正の場合

Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "detail": {
    "felica_rows": [
      {
        "raw_data": "1601000422FA8204820A1B080001AD00",
        "usage_amount": 123
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ"
    },
    "detail": {
      "type": "object",
      "properties": {
        "felica_rows": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "raw_data": {
                "type": "string",
                "description": "ICカードから読み込んだ生データ"
              },
              "usage_amount": {
                "type": "number",
                "description": "前後の残額から計算した利用金額"
              }
            },
            "required": [
              "raw_data",
              "usage_amount"
            ]
          },
          "description": "codeが400014の時の重複したデータ、またはcodeが400001の時の駅コードが不正のデータ"
        }
      },
      "description": "エラー時の詳細が存在する場合のみ使用可能"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "予期しないエラーが発生しました。",
  "code": 500000
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "エラーメッセージ"
    },
    "code": {
      "type": "number",
      "description": "エラーコード"
    }
  }
}

Generated by aglio on 28 Jul 2022