出張申請伝票個別取得
OpenAPI説明
当該OpenAPIは出張申請伝票番号を指定し、出張申請伝票情報を取得します。
リクエストURI
/api/openapi/application/travel/{businessCode}?fetchApprovalHistory=true
リクエスト形式
GET
リクエストパラメータ例
/api/openapi/application/travel/TA00658710?fetchApprovalHistory=true
リクエストパラメータ説明
パラメータ名 | タイプ | 必須 | 説明 |
---|---|---|---|
businessCode | String | ○ | 出張申請伝票番号 |
fetchApprovalHistory | Boolean | デフォルト値:false 承認履歴を返すかどうか |
OpenAPIリターン例
{
"tenantId": 1135722971472015361,
"businessCode": "TA00231181",
"title": "出張申請事由",
"remark": "出張申請備考",
"createdDate": "2021-03-16T12:00:54+09:00",
"lastUpdatedDate": "2021-03-17T18:33:40+09:00",
"setOfBooksCode": "DEFAULT_SOB",
"company": {
"oid": "7c819140-41cf-4a70-aed1-9ade4cc63c2d",
"name": "会社",
"code": "COM001"
},
"department": {
"oid": "f0b03110-10a7-4830-899e-92b601128fee",
"name": "技術グループ1",
"code": "111"
},
"applicant": {
"userOID": "ebcfdb25-5979-4e87-8c90-75c62889e5f6",
"fullName": "Admin",
"employeeId": "admin",
"corporation": null,
"company": {
"oid": "7c819140-41cf-4a70-aed1-9ade4cc63c2d",
"name": "会社",
"code": "COM001"
},
"department": {
"oid": "f0b03110-10a7-4830-899e-92b601128fee",
"name": "技術グループ1",
"code": "111"
}
},
"submittedBy": {
"userOID": "ebcfdb25-5979-4e87-8c90-75c62889e5f6",
"fullName": null,
"employeeId": "admin",
"corporation": null,
"company": null,
"department": null
},
"createdBy": {
"userOID": "ebcfdb25-5979-4e87-8c90-75c62889e5f6",
"fullName": null,
"employeeId": "admin",
"corporation": null,
"company": null,
"department": null
},
"customForm": {
"formOID": "47c9b424-6a9b-42a7-8317-2f1951d5b3a2",
"name": "出張申請伝票",
"code": "trip_application",
"formName": "出張申請伝票",
"formType": 2001,
"formCode": "trip_application",
"customFields": [
{
"formValueOID": "043adb7b-f80a-41fe-b5f7-551796ea69fe",
"fieldOID": "0095d314-1693-46bf-bcdf-4e20e5221996",
"fieldName": "部門",
"fieldType": "TEXT"
}
]
},
"approvalHistories": [
{
"operationType": 1001,
"operation": 1001,
"operationDetail": null,
"remark": null,
"approvalDate": "2023-01-04T10:42:13+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-03-16",
"applicationOID": "0e2284d5-4ea7-44f7-8d25-5e7b0d93ef0e",
"status": "INIT",
"currencyCode": "CNY",
"totalAmount": 220.0,
"originCurrencyCode": "CNY",
"originCurrencyTotalAmount": 220.0,
"type": 1002,
"travelStartDate": "2021-02-28T15:00:00.000+00:00",
"travelEndDate": "2021-04-13T15:00:00.000+00:00",
"expenseList": [
{
"expenseTypeCode": "DEFAULT_SOBEXP0005",
"currencyCode": "CNY",
"amount": 220.0,
"baseCurrencyAmount": 220.0,
"actualCurrencyRate": 1.0,
"companyCurrencyRate": 1.0,
"createdDate": "2021-03-17T18:33:40+09:00",
"paymentType": 1001
}
]
}
OpenAPIリターン項目
TravelApplication
項目 | タイプ | 規則 | 説明 |
---|---|---|---|
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 | 総金額 | |
originCurrencyCode | String | 伝票通貨,デフォルトは主要通貨 | |
originCurrencyTotalAmount | BigDecimal | 伝票通貨の総金額 | |
customForm | CustomForm | 関連カスタムフォーム | |
approvalHistories | ApprovalHistory[] | 承認履歴 | |
expenseList | Expense[] | 費用リスト | |
type | Int | 申請伝票タイプ: 1001-費用申請伝票,1002-出張申請伝票 | |
travelStartDate | Date | format:yyyy-MM-dd | 出張開始日 |
travelEndDate | Date | format:yyyy-MM-dd | 出張終了日 |
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.002"
}
項目説明
項目名 | タイプ | 説明 |
---|---|---|
message | String | エラーメッセージを返す |
errorCode | String | エラーコードを返す |
エラーコード説明
errorCode | message | 説明 |
---|---|---|
spd.31278.002 | 出張申請伝票は存在しない |
← 出張申請伝票削除 請求書申請伝票一括取得 →