請求書申請伝票個別取得
OpenAPI説明
当該OpenAPIは請求書申請伝票番号を指定し、請求書申請伝票情報を取得します。
リクエストURI
/api/openapi/application/request/{businessCode}?fetchApprovalHistory=true
リクエスト形式
GET
リクエストパラメータ例
/api/openapi/application/request/IA00238187?fetchApprovalHistory=true
リクエストパラメータ説明
| パラメータ名 | タイプ | 必須 | 説明 |
|---|---|---|---|
| businessCode | String | ○ | 請求書申請伝票番号 |
| fetchApprovalHistory | Boolean | デフォルト値：false 承認履歴を返すかどうか |
OpenAPIリターン例
{
"tenantId": 1135722971472015361,
"businessCode": "IA00238187",
"title": "伝票チェックテスト",
"remark": "伝票チェックテスト",
"createdDate": "2021-06-03T17:24:20+09:00",
"lastUpdatedDate": "2021-06-03T17:24:21+09:00",
"setOfBooksCode": "s003",
"company": {
"oid": "f5b5ddb1-d9d4-4a7c-bdeb-335a7bd2b7fc",
"name": "会社",
"code": "s003_com001"
},
"department": {
"oid": "2c699fa5-1bb8-449d-8c3e-15b348b7e204",
"name": "技術グループ1",
"code": "D_TEC_1_1"
},
"applicant": {
"userOID": null,
"fullName": null,
"employeeId": null,
"corporation": null,
"company": null,
"department": null
},
"submittedBy": {
"userOID": "e52d1a94-d930-47a7-8397-63b6d2f17d54",
"fullName": null,
"employeeId": "DGR001",
"corporation": null,
"company": null,
"department": null
},
"createdBy": {
"userOID": "e52d1a94-d930-47a7-8397-63b6d2f17d54",
"fullName": null,
"employeeId": "DGR001",
"corporation": null,
"company": null,
"department": null
},
"lastApprovalDate": "2021-06-03T17:24:21+09:00",
"customForm": {
"formOID": "4bcc430a-91d8-46d8-b969-aaf3ef6c0b60",
"name": "請求書申請伝票",
"code": "request_app",
"formName": "請求書申請伝票",
"formType": 2007,
"formCode": "request_app",
"customFields": [
{
"formValueOID": "c16d5193-b1ef-4cb5-9310-c86e71f80996",
"fieldOID": "853b402e-36f2-47b8-a288-42ded77abf8a",
"fieldName": "取引日",
"fieldCode": "re1",
"fieldType": "DATE",
"value": "2021-06-30",
"valueName": "2021-06-30"
}
]
},
"approvalHistories": [
{
"operationType": 1002,
"operation": 2001,
"operationDetail": "",
"remark": null,
"approvalDate": "2023-01-04T12:26:08+09:00",
"operator": {
"userOID": "00000000-0000-0000-0000-000000000000",
"fullName": "システム承認",
"employeeId": "",
"corporation": null,
"company": {
"oid": "e4b4a421-0355-4449-a610-26ff99322ab1",
"name": "SYSTEM"
},
"department": {
"oid": "00000000-0000-0000-0000-000000000000",
"name": "系统部门"
}
},
"submitter": null,
"applicant": {
"userOID": "00000000-0000-0000-0000-000000000000",
"fullName": "システム承認",
"employeeId": "",
"corporation": null,
"company": {
"oid": "e4b4a421-0355-4449-a610-26ff99322ab1",
"name": "SYSTEM"
},
"department": {
"oid": "00000000-0000-0000-0000-000000000000",
"name": "系统部门"
}
}
},
{
"operationType": 1001,
"operation": 1001,
"operationDetail": null,
"remark": null,
"approvalDate": "2023-01-04T12:26:07+09:00",
"operator": {
"userOID": "428bcdaf-db13-4962-8457-aa862fda1346",
"fullName": "システム管理者",
"employeeId": "admin",
"corporation": {
"oid": "cde54596-7963-4d55-accd-bf5533cfdc79"
},
"company": {
"oid": "cde54596-7963-4d55-accd-bf5533cfdc79",
"name": "Stage動作検証環境–付刚",
"code": "test_001"
},
"department": {
"oid": "c92ddbf5-ea67-41a1-8b21-2ca9c199332e",
"name": "Stage動作検証環境–付刚222222222222222222",
"code": "stage_001"
}
},
"submitter": {
"userOID": "428bcdaf-db13-4962-8457-aa862fda1346",
"fullName": "システム管理者",
"employeeId": "admin",
"corporation": {
"oid": "cde54596-7963-4d55-accd-bf5533cfdc79"
},
"company": {
"oid": "cde54596-7963-4d55-accd-bf5533cfdc79",
"name": "Stage動作検証環境–付刚",
"code": "test_001"
},
"department": {
"oid": "c92ddbf5-ea67-41a1-8b21-2ca9c199332e",
"name": "Stage動作検証環境–付刚222222222222222222",
"code": "stage_001"
}
},
"applicant": null
}
],
"baseDate": "2021-06-03",
"applicationOID": "074aa71c-8839-487a-8c2e-46c63016fa6b",
"status": "PASSED",
"totalAmount": 1230.0,
"currencyCode": "JPY",
"baseCurrencyAmount": 1230.0000,
"type": 1004,
"expenseList": [
{
"expenseTypeCode": null,
"currencyCode": "JPY",
"amount": 1230.0,
"baseCurrencyAmount": 1230.0,
"actualCurrencyRate": 1.0,
"companyCurrencyRate": 1.0,
"createdDate": "2021-06-03T17:24:20+09:00",
"paymentType": 1001
}
]
}
OpenAPIリターン項目
RequestApplication
| 項目名 | タイプ | 規則 | 説明 |
|---|---|---|---|
| applicationOID | UUID | 最大36文字 | 請求書申請伝票OID |
| tenantId | Long | テナントID | |
| businessCode | String | 最大36文字 | 費用申請伝票番号 |
| title | String | 最大500文字 | 事由 |
| remark | String | 最大255文字 | 備考 |
| createdDate | ZonedDateTime | format：yyyy-MM-dd'T'HH:mm:ssZ | 作成日時 |
| lastUpdatedDate | ZonedDateTime | format：yyyy-MM-dd'T'HH:mm:ssZ | 最終更新日時 |
| lastApprovalDate | ZonedDateTime | format：yyyy-MM-dd'T'HH:mm:ssZ | 最終承認日時 |
| setOfBooksCode | String | 元帳コード | |
| company | EntitySummary | 伝票会社 | |
| department | EntitySummary | 伝票部門 | |
| applicant | UserSummary | 申請者 | |
| submittedBy | UserSummary | 提出者 | |
| createdBy | UserSummary | 作成者 | |
| status | StatusType | 伝票ステータス 参照 StatusType | |
| baseDate | Date | format：yyyy-MM-dd | 基準日 |
| currencyCode | String | 主要通貨 | |
| totalAmount | BigDecimal | 総金額 | |
| baseCurrencyAmount | BigDecimal | 伝票通貨の総金額 | |
| customForm | CustomForm | 関連カスタムフォーム | |
| approvalHistories | ApprovalHistory[] | 承認履歴 | |
| expenseList | Expense[] | 費用リスト | |
| type | Int | 申請伝票タイプ: 1004-請求書申請伝票 |
StatusType
| 値 | 列挙名 | 説明 |
|---|---|---|
| 1001 | INIT | 編集中(新規作成、取消、差戻済、検印差戻し、取消差戻) |
| 1002 | SUBMIT | 承認待ち |
| 1003 | PASSED | 承認済 |
| 1009 | CLOSED | 無効済 |
UserSummary
| 項目名 | タイプ | 規則 | 説明 |
|---|---|---|---|
| userOID | UUID | 36桁 | 従業員OID |
| fullName | String | 最大100文字 | 従業員氏名 |
| employeeId | String | 最大32文字 | 従業員番号 |
| corporation | EntitySummary | 法人エンティティ | |
| company | EntitySummary | 所属会社 | |
| department | EntitySummary | 部門 |
EntitySummary
| 項目名 | タイプ | 必須 | 規則 | 説明 |
|---|---|---|---|---|
| oid | UUID | 36桁 | エンティティOID | |
| name | String | 最大50文字 | エンティティ名称 | |
| code | String | 最大50文字 | エンティティCode | |
| path | String | エンティティパス（部門のみ） |
CustomForm
| フィールド名 | タイプ | 規則 | 説明 |
|---|---|---|---|
| formOID | UUID | 36桁 | フォームOID |
| formName | String | 最大100文字 | フォーム名称 |
| formType | Integer | CustomFormTypeを参考 | フォームタイプ |
| formCode | String | 最大100文字 | フォームコード |
| customFields | CustomField[] | カスタマイズ値セット |
CustomField
| パラメータ名 | タイプ | 規則 | 説明 |
|---|---|---|---|
| formValueOID | UUID | 最大36文字 | カスタマイズ項目業務OID |
| fieldOID | UUID | 最大36文字 | カスタマイズ項目OID |
| fieldName | String | 最大100文字 | カスタマイズ項目名称 |
| fieldCode | String | 最大50文字 | カスタマイズ項目コード |
| fieldType | String | 最大50文字 | カスタマイズ項目タイプ |
| value | String | 最大1000文字 | カスタマイズ項目値 |
| valueName | String | 最大1000文字 | カスタマイズ項目値名称 |
| valueCode | String | 最大100文字 | カスタマイズ項目値コード(コントロールのみ(コストセンター、部門、カスタマイズリスト、支払い方法)の追加) |
Expense
| 項目名 | タイプ | 規則 | 説明 |
|---|---|---|---|
| expenseTypeCode | String | 費用タイプコード | |
| amount | Double | 金額 | |
| actualCurrencyRate | Double | 手入力レート | |
| companyCurrencyRate | Double | 企業レート | |
| baseCurrencyAmount | Double | 主要通貨金額 | |
| currencyCode | String | 主要通貨 | |
| createdDate | ZonedDateTime | 時間のフォーマット：yyyy-MM-dd'T'HH:mm:ssZ | 作成日時 |
| paymentType | Int | 支払タイプ:1001個人支払，1002会社支払 |
ApprovalHistory
| フィールド名 | タイプ | 規則 | 説明 |
|---|---|---|---|
| operationType | Integer | ApprovalOperationTypeを参考 | 操作タイプ |
| operation | Integer | ApprovalOperationを参考 | 操作タイプ |
| operationDetail | String | 最大1000文字 | 操作備考 |
| remark | String | 最大1000文字 | 操作備考(補足) |
| approvalDate | String | 時間フォーマット：yyyy-MM-dd'T'HH:mm:ssZ | 承認時間 |
| operator | UserSummary | 当エンティティ説明を参考 | 操作者 |
| submitter | UserSummary | 当エンティティ説明を参考 | 提出者 |
| applicant | UserSummary | 当エンティティ説明を参考 | 申請者 |
ApprovalHistory
| フィールド名 | タイプ | 規則 | 説明 |
|---|---|---|---|
| operationType | Integer | ApprovalOperationTypeを参考 | 操作タイプ |
| operation | Integer | ApprovalOperationを参考 | 操作タイプ |
| operationDetail | String | 最大1000文字 | 操作備考 |
| remark | String | 最大1000文字 | 操作備考(補足) |
| approvalDate | String | 時間フォーマット：yyyy-MM-dd'T'HH:mm:ssZ | 承認時間 |
| operator | UserSummary | 当エンティティ説明を参考 | 操作者 |
| submitter | UserSummary | 当エンティティ説明を参考 | 提出者 |
| applicant | UserSummary | 当エンティティ説明を参考 | 申請者 |
失敗例
{
"message": "請求書申請伝票は存在しない ",
"errorCode": "spd.31278.003"
}
項目説明
| 項目名 | タイプ | 説明 |
|---|---|---|
| message | String | エラーメッセージを返す |
| errorCode | String | エラーコードを返す |
エラーコード説明
| errorCode | message | 説明 |
|---|---|---|
| spd.31278.003 | 請求書申請伝票は存在しない |