Jobcan Expense Settlement / Workflow API

https://ssl.wf.jobcan.jp/api_doc
Admin
Jobcan Expense Settlement / Workflow API (Beta version) provides endpoints for managing user, group,...
Tokens:64,816
Snippets:195
Trust Score:8
Update:1 year ago
Show doc for...
Tokens:
Raw
### Get Application List v1 Example URI

Source: https://ssl.wf.jobcan.jp/api_doc/index

Example URI for fetching a list of applications using the v1 endpoint, with optional query parameters for filtering by date ranges.

```http
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
```

--------------------------------

### Get User Details API Request Example

Source: https://ssl.wf.jobcan.jp/api_doc/index

Shows an example URI for fetching a specific user's details using the GET /v1/users/{user_code}/ endpoint. The 'user_code' is a required string parameter for identifying the user.

```http
GET /v1/users/ST-1/
```

--------------------------------

### Request to Get Application Details (Example URI)

Source: https://ssl.wf.jobcan.jp/api_doc/index

This snippet shows an example URI for retrieving the details of a specific application using its request ID. The request method is GET, and it targets the /v1/requests/{request_id}/ endpoint. The 'request_id' is a required string parameter.

```http
GET /v1/requests/EX-10/
```

--------------------------------

### User Detail Response Example (200 OK)

Source: https://ssl.wf.jobcan.jp/api_doc/index

Example JSON body for a successful (200 OK) response from the Get User Details API. It includes all user properties as defined in the schema, such as user code, contact information, role, group and position details, and bank account information.

```json
{
  "user_code": "hoge",
  "email": "hoge@hoge.com",
  "last_name": "ジョブカン",
  "first_name": "太郎",
  "is_approver": true,
  "is_modifier": 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": "特記事項あり"
}
```

--------------------------------

### Get Application List v1 Response Body

Source: https://ssl.wf.jobcan.jp/api_doc/index

Example JSON response for the v1 application list endpoint, including total count, pagination links, and a list of application results with detailed fields.

```json
{
  "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"
    }
  ]
}
```

--------------------------------

### User Not Found Response Example (404 Not Found)

Source: https://ssl.wf.jobcan.jp/api_doc/index

Example JSON body for a 404 Not Found response when a user is not found by the Get User Details API. The response indicates that the target user does not exist and advises to check the provided user_code.

```json
{
  "message": "対象のユーザは存在しません。「user_code」を確認してください。：user_code"
}
```

--------------------------------

### Get Company Detail Response Body

Source: https://ssl.wf.jobcan.jp/api_doc/index

Example response body for retrieving a specific company's details. Includes all company and bank information.

```json
{
  "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": "ｼﾞﾖﾌﾞｶﾝﾀﾛｳ",
  "invoice_registrated_number": "T1234567890123"
}
```

--------------------------------

### POST /v3/users/

Source: https://ssl.wf.jobcan.jp/api_doc/index

Creates a new user. If `is_invitation` is true, an invitation email will be sent to the user for password setup. If `is_invitation` is false or omitted, no invitation email will be sent.

```APIDOC
## POST /v3/users/

### Description
Creates a new user. If `is_invitation` is true, an invitation email will be sent to the user for password setup. If `is_invitation` is false or omitted, no invitation email will be sent. If the user's email is already registered in other Jobcan services, the last name and staff code will be automatically reflected.

### Method
POST

### Endpoint
/v3/users/

### Parameters
#### Request Body
- **user_code** (string) - Required - Staff code.
- **email** (string) - Required - Email address.
- **last_name** (string) - Required - Last name.
- **first_name** (string) - Required - First name.
- **is_approver** (boolean) - Optional - Approver flag.
- **is_modifier** (boolean) - Optional - Modifier flag.
- **user_role** (number) - Optional - User role.
- **user_groups** (array of strings) - Optional - Array of group codes.
- **user_positions** (array of objects) - Optional - Array of position objects.
  - **position_code** (string) - Position code.
  - **group_code** (string) - Group code.
- **user_bank_account** (object) - Optional - User bank account details.
  - **bank_code** (string) - Bank code.
  - **bank_name** (string) - Bank name.
  - **branch_code** (string) - Branch code.
  - **branch_name** (string) - Branch name.
  - **bank_account_type_code** (string) - Bank account type code (1: Ordinary, 2: Current).
  - **bank_account_code** (string) - Bank account number.
  - **bank_account_name_kana** (string) - Bank account name in kana.
- **memo** (string) - Optional - Remarks.
- **is_invitation** (boolean) - Optional - Flag to invite the user. If true, an invitation email is sent.

### Request Example
```json
{
  "user_code": "hoge",
  "email": "hoge@hoge.com",
  "last_name": "ジョブカン",
  "first_name": "太郎",
  "is_approver": true,
  "is_modifier": 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
}
```
```

--------------------------------

### Example Response Body for Get Generic Master Record

Source: https://ssl.wf.jobcan.jp/api_doc/index

This JSON structure represents a successful response (200 OK) when retrieving generic master record information. It includes the record's code, titles, description, memo, and a list of associated items.

```json
{
  "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"
    }
  ]
}
```

--------------------------------

### Get Project List API

Source: https://ssl.wf.jobcan.jp/api_doc/index

Retrieves a list of registered projects. Returns project information upon success. The response includes pagination details.

```http
GET /v1/projects/

**Example URI**
GET /v1/projects/
```

--------------------------------

### Get Generic Master Records Response Body

Source: https://ssl.wf.jobcan.jp/api_doc/index

Example JSON body for a 200 OK response when retrieving a list of generic master records. It includes pagination information and a list of records, each with code, name, content, and memo.

```json
{
  "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"
    }
  ]
}
```

--------------------------------

### GET /v2/users/

Source: https://ssl.wf.jobcan.jp/api_doc/index

Retrieves a list of registered users. Returns user information upon successful retrieval.

```APIDOC
## GET /v2/users/

### Description
Retrieves a list of registered users. Returns user information upon successful retrieval.

### Method
GET

### Endpoint
/v2/users/

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page number for pagination.

### Request Example
```
GET /v2/users/
```

### Response
#### Success Response (200)
- **count** (number) - Total number of users.
- **next** (string) - URL for the next page of results.
- **previous** (object or null) - URL for the previous page of results.
- **results** (array) - An array containing user information objects.
  - **user_code** (string) - Staff code.
  - **email** (string) - Email address.
  - **last_name** (string) - Last name.
  - **first_name** (string) - First name.
  - **is_approver** (boolean) - Approver flag.
  - **is_modifier** (boolean) - Modifier flag.
  - **user_role** (number) - User role.
  - **user_groups** (array) - Array of group codes.
  - **user_positions** (array) - Array of position objects, each with `position_code` and `group_code`.
  - **user_bank_account** (object) - User bank account details.
    - **bank_code** (string) - Bank code.
    - **bank_name** (string) - Bank name.
    - **branch_code** (string) - Branch code.
    - **branch_name** (string) - Branch name.
    - **bank_account_type_code** (string) - Bank account type code (1: Ordinary, 2: Current).
    - **bank_account_code** (string) - Bank account number.
    - **bank_account_name_kana** (string) - Account name in kana.

#### Response Example
```json
{
  "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,
      "is_modifier": 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": "ｼﾞﾖﾌﾞｶﾝﾀﾛｳ"
      }
    }
  ]
}
```
```

--------------------------------

### Delete Generic Master Record Example

Source: https://ssl.wf.jobcan.jp/api_doc/index

Example URI for deleting a specific generic master record using its code and the record's code. It demonstrates the DELETE method and path parameters.

```http
DELETE /v2/generic_master/GM-1/GMR-2/
```

--------------------------------

### POST /v2/users/

Source: https://ssl.wf.jobcan.jp/api_doc/index

Creates a new user. If `is_invitation=true`, an invitation email is sent to the registered user for password setup. If the user's email already exists in Jobcan services, their last name and first name will be automatically updated.

```APIDOC
## POST /v2/users/

### Description
Creates a new user. If `is_invitation=true`, an invitation email is sent to the registered user for password setup. If the user's email already exists in Jobcan services, their last name and first name will be automatically updated.

### Method
POST

### Endpoint
/v2/users/

### Parameters
#### Request Body
- **user_code** (string) - Required - Staff code.
- **email** (string) - Required - Email address.
- **last_name** (string) - Required - Last name.
- **first_name** (string) - Required - First name.
- **is_approver** (boolean) - Optional - Approver flag.
- **is_modifier** (boolean) - Optional - Modifier flag.
- **user_role** (number) - Optional - User role.
- **user_groups** (array) - Optional - Array of group codes.
- **user_positions** (array) - Optional - Array of position objects, each with `position_code` and `group_code`.
- **user_bank_account** (object) - Optional - User bank account details.
  - **bank_code** (string) - Bank code.
  - **bank_name** (string) - Bank name.
  - **branch_code** (string) - Branch code.
  - **branch_name** (string) - Branch name.
  - **bank_account_type_code** (string) - Bank account type code (1: Ordinary, 2: Current).
  - **bank_account_code** (string) - Bank account number.
  - **bank_account_name_kana** (string) - Account name in kana.
- **is_invitation** (boolean) - Optional - Flag to invite the user. If set to `true`, an invitation email will be sent.

### Request Example
```json
{
  "user_code": "hoge",
  "email": "hoge@hoge.com",
  "last_name": "ジョブカン",
  "first_name": "太郎",
  "is_approver": true,
  "is_modifier": 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
}
```

### Response
#### Success Response (200)
*The response for a successful POST request is typically an empty body or a confirmation message, depending on the API design. Specific user details might be returned if the API is designed to do so.*
```

--------------------------------

### Get Application Details

Source: https://ssl.wf.jobcan.jp/api_doc/index

Retrieves the details of a specific application. The response varies based on the application type and selected details.

```APIDOC
## GET /v1/requests/{request_id}/

### Description
Retrieves the details of a specific application. The response varies based on the application type and selected details. The `detail` field returns data specific to the form, and `customized_items` returns data based on item type.

### Method
GET

### Endpoint
`/v1/requests/{request_id}/`

### Parameters
#### Path Parameters
- **request_id** (string) - Required - The ID of the application to retrieve.

### Response
#### Success Response (200)
Returns application details, which may include `customized_items`, `expense`, `payment`, `ec`, `approval_process`, `viewers`, `default_attachment_files`, and `modify_logs`, depending on the form type.

**Customized Items Schema Details:**
- **単一行テキスト**: `item_text` (string)
- **数字入力**: `number` (string)
- **プルダウン**: `pulldown` (string)
- **汎用マスタ選択**: `generic_master` (object)
- **計算**: `calc` (string)

**`generic_master` Schema:**
- **record_name** (string) - Description: Record name
- **record_code** (string) - Description: Code
- **additional_items** (array) - Description: Additional items

**`files` Schema:**
- **id** (number) - Description: File ID
- **name** (string) - Description: File name
- **type** (string) - Description: File type

**`table` Schema:**
- Represents detailed items within a table.
- For table items with `generic_master` selection, `generic_master` is returned instead of `value`.
- **column_number** (string) - Description: Column number
- **value** (string) - Description: Input value

#### Response Example
(Response structure varies based on the application type and selected detail fields. Refer to the documentation for specific form type data and `customized_items` structure.)
```

--------------------------------

### GET /v2/generic_master/{generic_master_code}/

Source: https://ssl.wf.jobcan.jp/api_doc/index

Retrieves a list of generic master records.

```APIDOC
## GET /v2/generic_master/{generic_master_code}/

### Description
Retrieves registered generic master records. Returns the generic master record information upon successful retrieval.
The `generic_master_code` should be the 'code' registered in the 'Generic Master' screen. Please note that an API for setting `generic_master_code` is not provided.
Items in the request body will include fields registered in the 'Edit Record Items' of the 'Generic Master' screen.

### Method
GET

### Endpoint
/v2/generic_master/{generic_master_code}/

### Parameters
#### Path Parameters
- **generic_master_code** (string) - Required - The code for the generic master. Example: GM-1

### Response
#### Success Response (200)
- **count** (number) - Total number of records.
- **next** (string) - URL for the next page of results.
- **previous** (object | null) - URL for the previous page of results.
- **results** (array) - An array containing detailed generic master record information.
  - **generic_master_record_code** (string) - Code value of the record.
  - **title_name** (string) - Name of the record.
  - **title_content** (string) - Content of the record.
  - **description** (string) - Description of the record.
  - **memo** (string) - Remarks for the record.
  - **items** (array) - An array of items associated with the record.
    - **item_number** (number) - The sequence number of the item.
    - **item_name** (string) - The name of the item.
    - **item_content** (string) - The content of the item.

#### Response Example (200)
```json
{
  "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"
        }
      ]
    }
  ]
}
```

#### Error Response (404)
- **code** (string) - Error code.
- **message** (string) - Error message.

```json
{
  "code": "400004",
  "message": "対象の汎用マスタは存在しません。「generic_master_code」を確認してください。：generic_master_code"
}
```
```

--------------------------------

### Get Project by Code API

Source: https://ssl.wf.jobcan.jp/api_doc/index

Retrieves project information using a specified 'project_code'. Requires 'project_code' in the URI. Returns project details upon success.

```http
GET /v1/projects/{project_code}/

**Example URI**
GET /v1/projects/Pr-1/
```

--------------------------------

### GET /v2/users/{user_code}/

Source: https://ssl.wf.jobcan.jp/api_doc/index

Retrieves the details of a specified user. The user_code is mandatory. If not provided, a BadRequest will be returned.

```APIDOC
## GET /v2/users/{user_code}/

### Description
Retrieves the details of a specified user. The user_code is mandatory. If not provided, a BadRequest will be returned.

### Method
GET

### Endpoint
/v2/users/{user_code}/

#### Path Parameters
- **user_code** (string) - Required - スタッフコード

### Response
#### Success Response (200)
- **user_code** (string) - スタッフコード
- **email** (string) - email
- **last_name** (string) - 姓
- **first_name** (string) - 名
- **is_approver** (boolean) - 承認者フラグ
- **is_modifier** (boolean) - 修正可能者設定フラグ
- **user_role** (number) - ユーザ権限
- **user_groups** (array) - 所属グループコード
- **user_positions** (array) - 役職コード
- **user_bank_account** (object) - 銀行口座情報
  - **bank_code** (string) - 銀行コード
  - **bank_name** (string) - 銀行名
  - **branch_code** (string) - 支店コード
  - **branch_name** (string) - 支店名
  - **bank_account_type_code** (string) - 口座種別（1:普通、2:当座）
  - **bank_account_code** (string) - 口座番号
  - **bank_account_name_kana** (string) - 口座名（カナ）

### Response Example
```json
{
  "user_code": "ST-1",
  "email": "test@example.com",
  "last_name": "山田",
  "first_name": "太郎",
  "is_approver": false,
  "is_modifier": true,
  "user_role": 0,
  "user_groups": [
    "grp-001"
  ],
  "user_positions": [
    "pos-001"
  ],
  "user_bank_account": {
    "bank_code": "1234",
    "bank_name": "テスト銀行",
    "branch_code": "001",
    "branch_name": "テスト支店",
    "bank_account_type_code": "1",
    "bank_account_code": "9876543",
    "bank_account_name_kana": "ﾃｽﾄﾀﾛｳ"
  }
}
```
```

--------------------------------

### GET /v3/users/

Source: https://ssl.wf.jobcan.jp/api_doc/index

Retrieves a list of registered users. If successful, it returns the user information. The response includes total count, next/previous page links, and an array of user objects.

```APIDOC
## GET /v3/users/

### Description
Retrieves a list of registered users. If successful, it returns the user information.

### Method
GET

### Endpoint
/v3/users/

### Parameters
#### Query Parameters
- **page** (integer) - Optional - The page number to retrieve.

### Response
#### Success Response (200)
- **count** (number) - Total number of users.
- **next** (string) - URL for the next page of results.
- **previous** (string or null) - URL for the previous page of results.
- **results** (array) - An array of user objects.
  - **user_code** (string) - Staff code.
  - **email** (string) - Email address.
  - **last_name** (string) - Last name.
  - **first_name** (string) - First name.
  - **is_approver** (boolean) - Approver flag.
  - **is_modifier** (boolean) - Modifier flag.
  - **user_role** (number) - User role.
  - **user_groups** (array of strings) - Array of group codes.
  - **user_positions** (array of objects) - Array of position objects.
    - **position_code** (string) - Position code.
    - **group_code** (string) - Group code.
  - **user_bank_account** (object) - User bank account details.
    - **bank_code** (string) - Bank code.
    - **bank_name** (string) - Bank name.
    - **branch_code** (string) - Branch code.
    - **branch_name** (string) - Branch name.
    - **bank_account_type_code** (string) - Bank account type code (1: Ordinary, 2: Current).
    - **bank_account_code** (string) - Bank account number.
    - **bank_account_name_kana** (string) - Bank account name in kana.
  - **memo** (string) - Remarks.
  - **is_invitation** (boolean) - Flag to invite the user.

#### Response Example
```json
{
  "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,
      "is_modifier": 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": "特記事項あり"
    }
  ]
}
```
```

--------------------------------

### GET /v1/company/

Source: https://ssl.wf.jobcan.jp/api_doc/index

Retrieves a list of registered companies. Returns company information upon successful retrieval.

```APIDOC
## GET /v1/company/

### Description
Retrieves a list of registered companies. Returns company information upon successful retrieval.

### Method
GET

### Endpoint
/v1/company/

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page number for pagination.

### Response
#### Success Response (200)
- **count** (number) - Total number of companies.
- **next** (string) - URL for the next page of results.
- **previous** (string) - URL for the previous page of results.
- **results** (array) - Array of company objects.
  - **company_code** (string) - Company code.
  - **company_name** (string) - Company name.
  - **zip_code** (string) - Zip code.
  - **address** (string) - Address.
  - **bank_code** (string) - Bank code.
  - **bank_name** (string) - Bank name.
  - **branch_code** (string) - Branch code.
  - **branch_name** (string) - Branch name.
  - **bank_account_type_code** (string) - Bank account type code (1: Ordinary, 2: Current).
  - **bank_account_code** (string) - Bank account number.
  - **bank_account_name_kana** (string) - Bank account name in kana.
  - **invoice_registrated_number** (string) - Invoice registration number.

#### Response Example
```json
{
  "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": "ｼﾞﾖﾌﾞｶﾝﾀﾛｳ",
      "invoice_registrated_number": "T1234567890123"
    }
  ]
}
```
```

--------------------------------

### Position List Response Body

Source: https://ssl.wf.jobcan.jp/api_doc/index

Example JSON response body for retrieving a list of positions, including pagination and position details.

```json
{
  "count": 130,
  "next": "https://ssl.wf.jobcan.jp/wf_api/v1/positions/?page=2",
  "previous": null,
  "results": [
    {
      "position_code": "100",
      "position_name": "部長",
      "description": "hogehoge"
    }
  ]
}
```

--------------------------------

### GET /v1/forms/

Source: https://ssl.wf.jobcan.jp/api_doc/index

Retrieves a list of forms. Allows filtering by form type, settlement type, category, name, view type, and description. Pagination is supported.

```APIDOC
## GET /v1/forms/

### Description
Retrieves a list of forms. Allows filtering by form type, settlement type, category, name, view type, and description. Pagination is supported.

### Method
GET

### Endpoint
/v1/forms/

### Parameters
#### Query Parameters
- **form_type** (string) - Optional - フォームタイプ (general:汎用フォーム, expense:経費精算, payment:支払依頼, ec_purchase: EC購入申請)
- **settlement_type** (string) - Optional - 精算タイプ (pre_application:事前申請, settlement:精算) - 経費精算フォームの時のみ
- **category_code** (string) - Optional - フォーム分類コード
- **name** (string) - Optional - フォーム名 (部分一致)
- **view_type** (string) - Optional - 表示タイプ (public:全体公開, private:非公開, restricted:一部公開中)
- **description** (string) - Optional - フォーム説明 (部分一致)
- **page** (number) - Required - 対象のページ番号。1ページあたり100件。デフォルトは1ページ目。

### Response
#### Success Response (200)
- **count** (number) - 合計件数
- **next** (string) - 次のページのURL
- **previous** (object|null) - 前のページのURL
- **results** (array) - フォーム一覧情報
  - **id** (number) - フォームID
  - **category** (string) - フォーム分類
  - **form_type** (string) - フォームタイプ (general, expense, payment, ec_purchase)
  - **settlement_type** (string) - 精算タイプ (pre_application, settlement)
  - **name** (string) - フォーム名
  - **view_type** (string) - 表示タイプ (public, private, restricted)
  - **description** (string) - フォーム説明

#### Response Example
```json
{
  "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": "サンプルのフォームです"
    }
  ]
}
```

#### Error Response (400)
- **message** (string) - エラーメッセージ
- **code** (number) - エラーコード
- **detail** (array) - エラー詳細

#### Error Response Example (400)
```json
{
  "message": "パラメータが不正です。",
  "code": 400003,
  "detail": [
    "form_typeが不正です。general: 汎用フォーム, expense: 経費精算, payment: 支払フォーム, ec_purchase: EC購入申請 のいずれかを指定してください。",
    "settlement_typeが不正です。pre_application: 事前申請, settlement: 精算 のいずれかを指定してください。",
    "view_typeが不正です。public: 全体公開中, private: 非公開, restricted: 一部公開中 のいずれかを指定してください。"
  ]
}
```

#### Error Response (500)
- **message** (string) - エラーメッセージ
- **code** (number) - エラーコード

#### Error Response Example (500)
```json
{
  "message": "予期しないエラーが発生しました。",
  "code": 500000
}
```
```

--------------------------------

### Get Generic Master Records (v2) Response

Source: https://ssl.wf.jobcan.jp/api_doc/index

Returns a list of generic master records, including pagination details and a results array. Each record contains code, title, description, memo, and items.

```json
{
  "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"
        }
      ]
    }
  ]
}
```

--------------------------------

### Successful User Details Response (200)

Source: https://ssl.wf.jobcan.jp/api_doc/index

Provides an example of a successful JSON response (200 OK) when retrieving user details. It includes comprehensive user information, including bank account specifics.

```json
{
  "user_code": "hoge",
  "email": "hoge@hoge.com",
  "last_name": "ジョブカン",
  "first_name": "太郎",
  "is_approver": true,
  "is_modifier": 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": "ｼﾞﾖﾌﾞｶﾝﾀﾛｳ"
  }
}

```

--------------------------------

### Retrieve User List (GET /v2/users/)

Source: https://ssl.wf.jobcan.jp/api_doc/index

Fetches a list of registered users from the Jobcan API. Returns a paginated response containing user information, including count, next/previous page links, and an array of user results.

```json
{
  "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,
      "is_modifier": 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": "ｼﾞﾖﾌﾞｶﾝﾀﾛｳ"
      }
    }
  ]
}
```

--------------------------------

### Create Project API

Source: https://ssl.wf.jobcan.jp/api_doc/index

Creates a new project. Accepts project details in the request body, including 'project_code' and 'project_name'.

```http
POST /v1/projects/

**Example URI**
POST /v1/projects/

**Request Body**
{
  "project_code": "100",
  "project_name": "hugahuga"
}
```

--------------------------------

### APIトークンヘッダー

Source: https://ssl.wf.jobcan.jp/api_doc/index

APIリクエスト時にAuthorizationヘッダーにAPIトークンを設定する方法を示しています。トークンの前後には半角スペースが必要です。

```http
Authorization:  Token 管理画面より発行されたAPIトークン
```

--------------------------------

### ユーザ新規登録（リクエストボディ）

Source: https://ssl.wf.jobcan.jp/api_doc/index

ユーザ新規登録APIのPOSTリクエストボディ例です。ユーザコード、メールアドレス、氏名、役職、銀行口座情報などを指定します。`is_invitation`で招待メール送信の有無を設定できます。

```json
{
  "user_code": "hoge",
  "email": "hoge@hoge.com",
  "last_name": "ジョブカン",
  "first_name": "太郎",
  "is_approver": true,
  "is_modifier": 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
}
```

--------------------------------

### APIトークンテスト（GET /test/）

Source: https://ssl.wf.jobcan.jp/api_doc/index

APIトークンの設定値が正しいかを確認するためのテストです。成功するとステータスコード200とJSONレスポンスを返しますが、トークンが無効な場合はステータスコード401を返します。

```http
GET /test/
```

--------------------------------

### Get Group List (GET /v1/groups/)

Source: https://ssl.wf.jobcan.jp/api_doc/index

Retrieves a list of registered groups. Upon successful retrieval, the API returns the group information.

```json
{
  "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"
    }
  ]
}
```

--------------------------------

### ユーザ一覧取得（GET /v1/users/）

Source: https://ssl.wf.jobcan.jp/api_doc/index

登録されているユーザ情報を取得するAPIです。成功すると、ユーザ情報のリストとページネーション情報を含むJSONレスポンスを返します。一度に最大100件のデータが取得可能です。

```http
GET /v1/users/
```
Tokens:
Raw