コストセンター値照会
OpenAPI説明
本APIはコストセンター単位でコストセンター値の検索に利用します
新バージョンの入口
最新のバージョンに戻る
【最新のバージョン】へ
リクエストURI
/api/openapi/cost/center/items
リクエスト形式
GET
リクエストパラメータ例
/api/openapi/cost/center/items?page=1&size=20&costCenterCode=CC_001&setOfBooksCode=TestSOB
リクエストパラメータ説明
| 項目 | タイプ | 必須 | 説明 |
|---|---|---|---|
| page | int | ○ | ページ数、最初のページは1 |
| size | int | ○ | 一つページにある結果数。最大50 |
| costCenterCode | String | ○ | コストセンターコード。 |
| setOfBooksCode | String | 元帳コード。 カンパニーモードでは元帳コードの入力は任意ですが、 テナントモードでは元帳コードの入力は必須となります。 |
OpenAPIリターン例
{
"total": 1,
"current": 1,
"pageSize": 20,
"pages": 1,
"hasPrevious": false,
"hasNext": false,
"data": [
{
"costCenterCode": "PROJECT",
"name": "SpendiaDep",
"code": "costCenterItemCode",
"parentCode": "CCI_001",
"sequenceNumber": "1",
"managerEmployeeId": "LA10001",
"setOfBooksCode": "DEFAULT_SOB",
"isEnabled": true,
"isPublic": false,
"startDate": "2021-01-01",
"endDate": "2021-01-02",
"isApplyAllCompanies": true,
"primaryDepartmentCode": "dept001",
"secondaryDepartmentCodes": "dept002",
"remarkForInquiry":"カスタマイズ項目情報",
"customFields": [
{
"fieldCode": "Test",
"value": "1"
}
]
}
]
}
OpenAPIリターン項目
PageResposne
| パラメータ名 | タイプ | 説明 |
|---|---|---|
| total | int | 検索結果の総件数 |
| current | int | 当ページ数 |
| pageSize | int | ページごとの結果数 |
| pages | int | 検索結果総ページ数 |
| hasPrevious | boolean | 前のページがあるかどうか |
| hasNext | boolean | 次のページがあるかどうか |
| data | CostCenterItem[] | コストセンター一覧 |
CostCenterItem
| 項目 | タイプ | 制限 | 説明 |
|---|---|---|---|
| costCenterCode | String | 最大長 36 | コストセンターコード |
| name | String | 最大長 150 | コストセンター値名称 |
| code | String | 最大長 36 | コストセンター値コード |
| parentCode | String | 最大長 36 | 上級コストセンター値コード。上級コストセンター値に関連付けた場合は、Nullにしてはいけません |
| sequenceNumber | Long | 正整数で最大10桁 | 表示順 |
| managerEmployeeId | String | マネジャー従業員番号 | |
| setOfBooksCode | String | 最大長 36 | 所属元帳コード |
| isEnabled | Boolean | 有効/無効(デフォルト有効) | |
| startDate | Date | 日付フォーマット:yyyy-MM-dd | 有効開始日 |
| endDate | Date | 日付フォーマット:yyyy-MM-dd | 有効終了日 |
| isPublic | Boolean | 共通項目かどうか。デフォルトfalse | |
| isApplyAllCompanies | Boolean | 全ての会社に適用するかどうか。デフォルトtrue | |
| primaryDepartmentCode | String | 主要部門コード | |
| secondaryDepartmentCodes | String | 子部門コード。 複数ある場合は,カンマで区切る | |
| remarkForInquiry | String | 最大長 50 | 備考(検索用) |
| customFields | List <FormField> | カスタマイズ項目 |
CustomField
| パラメータ名 | タイプ | 規則 | 説明 |
|---|---|---|---|
| fieldCode | String | 最大100文字 | カスタマイズ項目コード |
| value | String | 最大2000文字 | カスタマイズ項目値 |
エラーコード説明
| errorCode | message | 説明 |
|---|---|---|
| 120003 | {0}は指定必須の項目です | |
| 120004 | パラメタ桁数超過{0}、長さは{1}から{2}の文字の間で設定をお願いします | |
| 120402 | コストセンターは存在しません | |
| 121801 | 元帳コードを空白にしてはいけない | |
| 121802 | 指定した元帳は存在しません |