精算伝票情報一括取得
OpenAPI説明
このAPIは最終更新日の範囲で精算伝票を検索する時に使用されます。
旧バージョンの入口
既に旧バージョンで精算伝票情報を取得するお客様は、続けて旧バージョンを利用可能です。
【Ver1.0 バージョン】へ
リクエストURI
/api/openapi/expense/reports/V2
リクエスト形式
GET
リクエストパラメータ例
/api/openapi/expense/reports/V2?startTime=2020-01-01 00:00:00&endTime=2020-02-29 00:00:00&fetchApprovalHistory=false&page=1&size=20&status=1004,1005
リクエストパラメータ説明
| パラメータ名 | タイプ | 必須 | 説明 |
|---|---|---|---|
| startTime | String | ○ | 検索スタート日時。フォーマット: yyyy-MM-dd HH:mm:ss |
| endTime | String | ○ | 検索エンド日時。フォーマット: yyyy-MM-dd HH:mm:ss |
| page | int | ○ | ページ、第一ページ: page=1 |
| size | int | ○ | ページごとの結果数。最大50 |
| status | String | ○ | 精算伝票ステータスIDリスト。 カンマで区切る |
| fetchApprovalHistory | Boolean | デフォルトはfalse 承認履歴の返送要否 |
{
"total": 1,
"current": 1,
"pageSize": 20,
"pages": 1,
"hasPrevious": false,
"hasNext": false,
"data": [
{
"tenantId": 1214732595705114600,
"businessCode": "CKA0000000520",
"title": "経費精算",
"remark": "remark",
"createdDate": "2020-02-27T04:42:39Z",
"lastUpdatedDate": "2020-02-27T07:56:21Z",
"company": {
"oid": "13c79677-ad3a-427b-a9ef-1b33ad2100a4",
"name": "Test-COM",
"code": "SPD-COM-001",
"path": null
},
"department": {
"oid": "81782f23-61b7-49d3-8b36-2f087324b111",
"name": "DEP001",
"code": "DEP001",
"path": "DEP_ROOT|DEP001"
},
"applicant": {
"userOID": "489b3cc6-52d4-4647-a9e2-305c083dc727",
"fullName": "Spendia",
"employeeId": "00001",
"corporation": {
"oid": "13c79677-ad3a-427b-a9ef-1b33ad2100a4",
"name": "Test-COM",
"code": null,
"path": null
},
"company": {
"oid": "13c79677-ad3a-427b-a9ef-1b33ad2100a4",
"name": "Test-COM",
"code": null,
"path": null
},
"department": {
"oid": "84d3a264-a5f8-48bd-90c5-c0fa8b7051f1",
"name": "DEP001",
"code": "DEP001",
"path": null
}
},
"submittedBy": {
"userOID": "489b3cc6-52d4-4647-a9e2-305c083dc727",
"fullName": "Spendia",
"employeeId": "00001",
"corporation": null,
"company": null,
"department": null
},
"createdBy": {
"userOID": "489b3cc6-52d4-4647-a9e2-305c083dc727",
"fullName": "Spendia",
"employeeId": "00001",
"corporation": null,
"company": null,
"department": null
},
"lastApprovalDate": "2020-02-27T04:42:48Z",
"lastAuditApprovalDate": "2020-02-27T04:47:05Z",
"lastAuditApprovalCode": "100001",
"lastAuditApprovalName": "財務1",
"customForm": {
"formOID": "1f3a03b0-44ce-4965-a446-95f41f0136da",
"name": "Travel expense",
"type": null,
"code": "Form002",
"customFields": [
{
"formValueOID": "902342dd-0662-4ea7-bb9b-f954519e0bb2",
"fieldOID": "7a951104-e0df-4220-807f-83b86255d542",
"fieldName": "Payment Date",
"fieldCode": null,
"fieldType": "DATE",
"oid": "7a951104-e0df-4220-807f-83b86255d542",
"name": "Payment Date",
"type": "DATE",
"value": "2020-02-27",
"messageKey": "common.date"
}
]
},
"expenseReportOID": "41451e47-61a7-4f2c-894b-946e3fc1badd",
"status": "PAID",
"setOfBooksId": 1214732595927412700,
"baseReimbursementAmount": 0,
"generalLedgerDate": "2020-02-26T15:00:00Z",
"callbackJournalNo": "2020-02-27",
"personalPaymentBaseAmount": 200,
"actualPaymentBaseAmount": 200,
"baseCurrencyAmount": 200,
"type": 1001,
"costCenter": {
"oid": "7a951104-e0df-4220-807f-83b86255d542",
"name": "CC001",
"code": "CC001"
},
"invoices": [
{
"expenseReportInvoiceOID": "7db78010-2b03-4e02-971a-1c4b2723e53c",
"invoiceOID": "3e08288c-7f29-44f7-b2c5-ee45f75ce8cd",
"status": 1000,
"rejectReason": null,
"expenseType": {
"oid": null,
"name": "Taxi",
"code": "10010001",
"path": null
},
"costCenterItem": {},
"invoiceStatus": "SUBMITTED",
"unitPrice": null,
"quantity": null,
"expenseTaxType": null,
"baseCurrencyAmount": 183805,
"baseCurrencyCode": "JPY",
"baseCurrencyTaxExclusiveAmount": 91903,
"baseCurrencyFeeWithoutExemptedTax": 137854,
"baseCurrencyTaxAmount": 91902,
"baseCurrencyExemptedTaxAmount": 45951,
"originalCurrencyAmount": 1110,
"originalCurrencyCode": "EUR",
"originalCurrencyTaxExclusiveAmount": 555,
"originalCurrencyFeeWithoutExemptedTax": 832.5,
"originalCurrencyTaxAmount": 555,
"originalCurrencyExemptedTaxAmount": 277.5,
"originalCurrencyRate": "165.5903295",
"comment": "",
"createdDate": "2024-11-14T12:36:35+09:00",
"invoiceCreateDate": "2024-11-22T23:59:00+09:00",
"rateDate": "2024-11-15T17:56:00+09:00",
"lastUpdatedDate": "2024-11-14T12:36:34+09:00",
"data": [
{
"type": "LOCATION",
"code": null,
"name": "都市",
"value": "JPN046039000",
"messageKey": "location"
}
],
"receipt": {
"tax": 9,
"exemptedTax": 9,
"consumptionTaxCode": "T1001",
"billingDate": "2022-09-10",
"phoneNumber": "07043096073",
"shopName": "ビックカメラ",
"businessRegistrationNumber": "T2201845125542",
"businessCategory": "1001",
"businessRegistrationDate": "2022-09-10",
"taxDetails": [
{
"rate": 10,
"tax": 1111
},
{
"rate": 3,
"tax": 356
},
{
"rate": 2,
"tax": 240
}
],
"attachments": [{
"fileName": "添付ファイルのfile1.pdf",
"fileUrl": "https://spendia-dynamic-stage.s3.ap-northeast-1.amazonaws.com/29ad55e2-702d-43be-b525-1b7a173c452b/invoices/5bfc11df-5436-4920-8632-ee1ba74a3bea-%E3%82%B9%E3%82%AF%E3%83%AA%E3%83%BC%E3%83%B3%E3%82%B7%E3%83%A7%E3%83%83%E3%83%88.xlsx?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20231127T014901Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=AKIAJYC4KIDBXXJMJSNQ%2F20231127%2Fap-northeast-1%2Fs3%2Faws4_request&X-Amz-Signature=8c3324b7496df5df48a1eeb486fd89106c60e8d6836a51723f59a9db865d0bd7"
}]
},
"isApportionUsed": true,
"expenseApportion": [
{
"apportionOID": "c755f7b6-1820-4b0b-8831-3d3cfc12ceb6",
"expenseOID": "3e08288c-7f29-44f7-b2c5-ee45f75ce8cd",
"amount": 91,
"baseCurrencyAmount": 91,
"taxAmount": 9,
"exemptedTaxAmount": 9,
"baseTaxAmount": 9,
"baseExemptedTaxAmount": 9,
"apportionUser": null,
"apportionPercentage": 1,
"costCenterItems": [
{
"type": null,
"costCenterOID": "00000000-0000-0000-0000-000000000000",
"costCenterCode": null,
"itemOID": "81782f23-61b7-49d3-8b36-2f087324b111",
"itemCode": "SPD022012"
}
]
}
],
"invoiceCreateDate": "2020-02-27T04:42:41Z",
"originalCurrencyAmount": 1000,
"originalCurrencyCode": "CNY",
"originalCurrencyRate": 21.7,
"originalCurrencyTaxExclusiveAmount": 900,
"originalCurrencyFeeWithoutExemptedTax": 900,
"originalCurrencyTaxAmount": 100,
"originalCurrencyExemptedTaxAmount": 100,
"source": "jsnavi",
"creditCardDetail": "{\"id\":\"1621032153136889857\",\"companyCode\":\"11111\",\"paymentType\":\"COMPANY\",\"paymentName\":\"会社支払\",\"orderSequence\":\"2556595\",\"userCardId\":\"SC1006\",\"creditCardSearchKey\":\"JCSC1006\",\"userOID\":\"6faa8192-7969-4af1-8c30-bec6d35bd1f4\",\"useDate\":\"2023-02-02\",\"areaClassification\":\"F\",\"currency\":\"CNY\",\"originalAmount\":322,\"currencyRate\":1,\"amount\":\"322\",\"franchiseStoreName\":\"大阪テスト大阪テスト大阪テスト\",\"creditCardCompanyCode\":\"JC\",\"creditCardCompanyName\":\"JCB\",\"creditCardBrand\":\"MASTER\",\"taxiTicketNumber\":\"dd000004\",\"taxiTicketRemark\":\"山田\",\"etcCardNo\":\"2020000000000000eTCETCETCETCET\",\"etcCardMemberName\":\"ETC会員\",\"departurePlace\":\"大けやき前(会津美里町)/会津バス\",\"arrivalPlace\":\"大けやき前(会津美里町)/会津バス\",\"departmentCode\":\"DEFAULTDEP\",\"departmentName\":\"経理部\",\"userDepartmentCode\":\"DEFAULTDEP\",\"userDepartmentName\":\"経理部\",\"billingDate\":\"2023-02-02\",\"storePhone\":null,\"industryCode\":\"90\",\"other2\":\"\",\"other3\":\"\",\"expenseCreatedTime\":\"2023-02-08T14:25:56+09:00\",\"purpose\":\"BUSINESS\",\"isExpenseCreated\":false,\"expenseOID\":null,\"referenceId\":\"2556595card\",\"source\":\"jsnavi\",\"monthOrdersCount\":null,\"originalAmountStr\":\"322\",\"orderDate\":\"2023-02-02\"}"
}
],
"application":[
{
"type": "BORROW_APPLICATION",
"applicationOID": "74e13a10-512a-4443-b995-4d75a66b2fda",
"businessCode": "LA00237495",
"reimbursementAmount": 100.0
},
{
"type": "BORROW_APPLICATION",
"applicationOID": "74e13a10-512a-4443-b995-4d75a66b2fdb",
"businessCode": "LA00237496",
"reimbursementAmount": 101.0
}
],
"requests":[
{
"type": "TRAVEL",
"businessCode": "TA00650475",
"totalAmount": 102.0
}
],
"paymentLines": [
{
"id": 421,
"tenantId": 1074840362127142914,
"reimbursementBatchOID": null,
"entityType": 1002,
"entityOID": "9f53621c-6ad0-408a-8068-48946c4cb650",
"status": 1001,
"baseCurrencyCode": "JPY",
"baseAmount": 50.0000,
"paymentMethodName": "オンライン手形は銀行あり",
"paymentMethodCategory": "ONLINE_PAYMENT",
"paymentMethodSubType": "BILL",
"paymentMethodCode": "098049283091221",
"paymentLineCustomFields": [
{
"fieldCode": "country",
"value": "AE"
}
],
"withBankInfo": true,
"estimatedPaymentDate": "2021-06-08",
"issueDepartmentOID": "3b4fa910-f2fa-4662-81bb-9dfdd696ca57",
"issueDepartmentName": "テスト-王|王様",
"issueDepartmentCode": "10100",
"issueDate": "2021-06-08",
"expiryDate": "2021-06-08",
"estimatedMaturityDate": "2021-06-08",
"receivingSupplier": "汇3",
"receivingSupplierId": 1153255526580518912,
"receivingPostalCode": "123123",
"receivingAddress": "room 101 building 3 road 1001 shanghai china",
"checkNetNo": "444",
"payeeBankId": 1374973747813957632,
"payeeBankCode": "0000",
"payeeBankName": "日本銀行",
"payeeBranchId": 0,
"payeeBranchCode": "093",
"payeeBranchName": "本店",
"payeeAccountType": "1",
"payeeAccountNo": "8975645",
"payeeAccountName": "明",
"payeeAccountFbName": "アキラ",
"country": "CHINA",
"overseaBankName": "CHINABANK",
"overseaBranchName": "PUDONG",
"overseaAccount": "231030202838383838",
"overseaPayeeName": "YANYINGMING",
"overseaBranchAddress": "YAOHUALU333",
"overseaPayeeAddress": "MUDANJIANGLU2223",
"internationalBalanceOfPaymentsItemCode": "3333",
"remittancePurpose": "FEEPAYMENT",
"licenceNo": "2314",
"licenceDate": "2021-06-08",
"appointmentCode": "9876",
"message": "check",
"commissionChargeParty": null,
"baseDate": "2021-06-08",
"applicantPostOID": "5d614e18-8327-11eb-b360-0a405f8b1a98",
"overseaPayeeISOBankInfo": {
"sequence": null,
"accountName": "ABC Trading Co., Ltd.",
"bankName": "Bank of America N.A.",
"swiftOrBic": "BOFAUS3N",
"internationalBankSystemName": "TARGE",
"internationalBankSystemCode": "26009593",
"ibanCode": "DE89 3704 0044 0532 0130 00",
"bankAccountNumber": "1234567890",
"branchCode": "123",
"leiCode": "5493001KJTIIGC8Y1R12",
"payeeBankAddress": {
"country": "JP",
"countryName": "Japan ",
"stateProvincePrefecture": "Tokyo",
"cityTownVillage": "Chiyoda-ku",
"postal": "100-8176",
"streetNameHouseNumber": "1-5-5 Otemachi",
"districtRegion": "Kanto Region",
"areaZone": "Marunouchi District",
"buildingName": "Otemachi Tower",
"buildingNumber": "Bldg. 3",
"floor": "12th Floor",
"roomApartmentNumber": "Suite 1205",
"mailbox": "P.O. Box 456",
"department": "International Banking Department",
"divisionSection": "Foreign Remittance Section"
},
"firstBank": true,
"firstBankInfo": {
"bankName": "Bank of America N.A.",
"swiftOrBic": "BOFAUS3N",
"internationalBankSystemName": "TARGE",
"internationalBankSystemCode": "26009593",
"ibanCode": "DE89 3704 0044 0532 0130 00",
"bankAccountNumber": "1234567890",
"branchCode": "123",
"bankAddress": {
"country": "JP",
"countryName": "Japan ",
"stateProvincePrefecture": "Tokyo",
"cityTownVillage": "Chiyoda-ku",
"postal": "100-8176",
"streetNameHouseNumber": "1-5-5 Otemachi",
"districtRegion": "Kanto Region",
"areaZone": "Marunouchi District",
"buildingName": "Otemachi Tower",
"buildingNumber": "Bldg. 3",
"floor": "12th Floor",
"roomApartmentNumber": "Suite 1205",
"mailbox": "P.O. Box 456",
"department": "International Banking Department",
"divisionSection": "Foreign Remittance Section"
}
},
"secondBank": true,
"secondBankInfo": {
"bankName": "Bank of America N.A.",
"swiftOrBic": "BOFAUS3N",
"internationalBankSystemName": "TARGE",
"internationalBankSystemCode": "26009593",
"ibanCode": "DE89 3704 0044 0532 0130 00",
"bankAccountNumber": "1234567890",
"branchCode": "123",
"bankAddress": {
"country": "JP",
"countryName": "Japan ",
"stateProvincePrefecture": "Tokyo",
"cityTownVillage": "Chiyoda-ku",
"postal": "100-8176",
"streetNameHouseNumber": "1-5-5 Otemachi",
"districtRegion": "Kanto Region",
"areaZone": "Marunouchi District",
"buildingName": "Otemachi Tower",
"buildingNumber": "Bldg. 3",
"floor": "12th Floor",
"roomApartmentNumber": "Suite 1205",
"mailbox": "P.O. Box 456",
"department": "International Banking Department",
"divisionSection": "Foreign Remittance Section"
}
},
"sameBankSameAccount": true,
"sameBankSameAccountInfo": {
"payeeBankAccountNumberIban": "DE89 3704 0044 0532 0130 00",
"payeeBankAccountNumber": "1234567890"
},
"bankFeeBearer": "SHAR",
"status": 1002,
"isPrimary": null
}
}
],
"paymentConfirmInfos": [
{
"paymentLineId": "152174",
"reimbursementBatchName": "20240429271676520638817345084",
"paymentDate": "2024-05-10",
"createdDate": "2024-04-29",
"paymentCurrency": "JPY",
"paymentType": "FBデータ",
"paymentCategoryCode": "1005",
"paymentCategoryName": "ONLINE_PAYMENT",
"paymentExchangeRate": 1.0,
"paymentRemaker": "備考1",
"bankInfo": {
"bankcode": "0000",
"branchBankCode": "093",
"bankAccount": "XXXXXX",
"bankName": "XXXXXX"
}
},
{
"paymentLineId": "152175",
"reimbursementBatchName": "20240429271676520638817345084",
"paymentDate": "2024-05-11",
"createdDate": "2024-04-29",
"paymentCurrency": "JPY",
"paymentType": "FBデータ",
"paymentCategoryCode": "1005",
"paymentCategoryName": "ONLINE_PAYMENT",
"paymentExchangeRate": 1.0,
"paymentRemaker": "備考2",
"bankInfo": {
"bankcode": "0000",
"branchBankCode": "094",
"bankAccount": "XXXXXX",
"bankName": "XXXXXX"
}
}
],
"sourceTaxations": [
{
"expenseReportOID": "24fba3d1-ce6f-4219-be3d-397d821f5c4b",
"id": 1400377252788600834,
"sourceTaxCategoryId": 1074936017499635714,
"sourceTaxCategoryCode": "01",
"sourceTaxCategoryName": "切り捨て法(税込)",
"basicRate": 0.10210,
"levyType": "CORP",
"paymentAmount": 300.0000,
"taxableAmount": null,
"sourceTaxAmount": null
}
]
}
]
}
トラマネ(TM)のリターン例
{
"source": "tm",
"tmRouteDetail": "{\"id\":\"1643137652967493634\",\"payDate\":\"2023-04-04\",\"payment\":\"950\",\"categoryCode\":\"BUS\",\"depStationName\":\"三鷹\",\"arvStationName\":\"中野\",\"depCompanyName\":\"JR東日本1\",\"arvCompanyName\":\"JR東日本2\",\"purpose\":\"BUSINESS\",\"expenseOID\":null,\"expenseCreated\":false,\"userOID\":\"428bcdaf-db13-4962-8457-aa862fda1346\",\"tenantId\":\"1262289482059026433\",\"companyId\":\"1743\",\"remark\":\"spendia测试\",\"monthOrdersCount\":null,\"orderDate\":\"2023-04-04\",\"amount\":\"950\"}"
}
経路明細のリターン例
{
"source": "transfer",
"routeDetails": {
"routeDetail": "{\"date\":\"2023-04-03T15:00:00Z\",\"price\":208,\"amount\":208,\"name\":\"東京--JR山手線内回り--秋葉原--JR総武線--御茶ノ水--JR中央線快速--新宿\",\"time\":16,\"arrivalTime\":null,\"departureTime\":null,\"isRound\":false}",
"routeInfoDetail": "{\"leFlag\":false,\"anFlag\":true,\"isRound\":false,\"time\":26,\"timeOnBoard\":16,\"departure\":\"東京\",\"arrival\":\"新宿\",\"LimitedExpress\":\"指定席\",\"OtherService\":\"新幹線eチケット\"}"
}
}
OpenAPIリターン項目
PageResposne
| パラメータ名 | タイプ | 説明 |
|---|---|---|
| total | int | 検索結果の総件数 |
| current | int | 当ページ数 |
| pageSize | int | ページごとの結果数 |
| pages | int | 検索結果総ページ数 |
| hasPrevious | boolean | 前のページがあるかどうか |
| hasNext | boolean | 次のページがあるかどうか |
| data | ExpenseReport[] | 精算伝票リスト |
ExpenseReport
| パラメーター名 | カテゴリ | 規則 | 説明 |
|---|---|---|---|
| expenseReportOID | UUID | 36桁 | テナントOID |
| tenantId | Long | テナントID | |
| businessCode | String | 最大36文字 | 精算伝票番号 |
| title | String | 最大500文字 | 事由 |
| remark | String | 最大255文字 | 説明 |
| createdDate | ZonedDateTime | 時間フォーマット:yyyy-MM-dd'T'HH:mm:ssZ | 作成時間 |
| lastUpdatedDate | ZonedDateTime | 時間フォーマット:yyyy-MM-dd'T'HH:mm:ssZ | 最終更新時間 |
| company | EntitySummary | 伝票会社 | |
| department | EntitySummary | 伝票部門 | |
| applicant | UserSummary | 申請者 | |
| submittedBy | UserSummary | 提出者 | |
| createdBy | UserSummary | 作成者 | |
| lastApprovalDate | String | 時間フォーマット:yyyy-MM-dd'T'HH:mm:ssZ | 最終承認時間 |
| lastAuditApprovalDate | String | 時間フォーマット:yyyy-MM-dd'T'HH:mm:ssZ | 最終検印時間 |
| lastAuditApprovalCode | String | 最終検印者従業員コード | |
| lastAuditApprovalName | String | 最終検印者名称 | |
| customForm | CustomForm | 関連カスタマイズフォーム | |
| approvalHistories | ApprovalHistory[] | 承認履歴 | |
| status | String | 伝票ステータス StatusTypeをご参照 | |
| setOfBooksId | String | 元帳ID | |
| baseReimbursementAmount | BigDecimal | 小数の桁数は通貨で決めます | 主要通貨返金額 |
| generalLedgerDate | ZonedDateTime | 時間フォーマット:yyyy-MM-dd'T'HH:mm:ssZ | 計上日 |
| callbackJournalNo | String | 仕訳番号 | |
| personalPaymentBaseAmount | BigDecimal | 小数の桁数は通貨で決めます | 個人支払主要通貨金額 |
| actualPaymentBaseAmount | BigDecimal | 小数の桁数は通貨で決めます | 精算伝票の支払主要通貨金額 |
| baseCurrencyAmount | BigDecimal | 小数の桁数は通貨で決めます | 精算伝票総額 |
| type | int | 精算伝票タイプ 1. 1001-日常精算伝票;1002-出張精算伝票;1003-費用精算伝票 | |
| costCenter | CostCenter | 精算伝票コストセンター | |
| invoices | ExpenseReportInvoice[] | 費用リスト | |
| application | Application[] | 精算伝票の関連仮払申請伝票リスト | |
| requests | DataEntity[] | 精算伝票の関連事前申請伝票リスト | |
| paymentLines | PaymentLine[] | 支払情報リスト | |
| paymentConfirmInfos | paymentConfirmInfo[] | 支払確認情報リスト | |
| sourceTaxations | ExpenseReportSourceTaxation[] | 源泉税明細 |
StatusType
| 値 | 列挙名 | 説明 |
|---|---|---|
| 1001 | INIT | 編集中(新規作成、取消、差戻済、検印差戻し、取消差戻) |
| 1002 | SUBMIT | 承認待ち |
| 1003 | PASSED | 承認済 |
| 1004 | FINANCE_AUDIT_PASSED | 検印済 |
| 1005 | PAID | 支払済 |
| 1008 | PAYMENT_IN_PROCESS | 支払待ち |
| 1020 | COMPLETION | 終了 |
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 |
| name | String | 最大100文字 | フォーム名称 |
| code | 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文字 | カスタマイズ項目値コード(コントロールのみ(コストセンター、部門、カスタマイズリスト、支払い方法、支払先)の追加) |
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 | 当エンティティ説明を参考 | 申請者 |
ApprovalOperationType
| 値 | 説明 |
|---|---|
| 1001 | 本人 |
| 1002 | 承認者 |
| 1003 | 経理担当 |
| 1005 | 返金経理承認 |
| 1006 | システム |
| 1009 | 管理者 |
| 1010 | 確認者 |
| 1011 | 取消 |
ApprovalOperation
| 値 | 説明 | 申請伝票 | 精算伝票 | 仮払申請伝票 |
|---|---|---|---|---|
| 1001 | 提出 | Y | Y | Y |
| 1002 | 取消 | Y | Y | Y |
| 1003 | 申請伝票変更 | Y | - | - |
| 1004 | 承認中 | Y | Y | Y |
| 1014 | 確認済 | Y | Y | Y |
| 2001 | 承認済 | Y | Y | Y |
| 2002 | 差戻済 | Y | Y | Y |
| 2003 | 承認差戻済の費用 | - | Y | - |
| 3001 | 検印済 | - | Y | Y |
| 3002 | 検印差戻 | - | Y | Y |
| 3003 | 領収書受領済 | - | Y | - |
| 3005 | 領収書差戻し | - | Y | - |
| 3006 | 検印通知 | - | Y | Y |
| 3007 | 送付 | - | Y | - |
| 3008 | 検印取消 | - | Y | Y |
| 3009 | 申請者終了 | - | Y | Y |
| 3010 | スマートエージェント検印 | - | Y | - |
| 4000 | 支払確認 | - | Y | Y |
| 4001 | 経理支払済 | - | Y | Y |
| 4002 | 経理支払失敗 | - | Y | Y |
| 5000 | APPで返金提出 | - | - | Y |
| 5001 | 現金返金提出 | - | - | Y |
| 5002 | 経理検収済 | - | - | Y |
| 5003 | 経理検収差戻 | - | - | Y |
| 5004 | 精算伝票で消込 | - | Y | - |
| 5005 | 申請伝票をクローズする | Y | - | - |
| 5006 | 申請者は申請伝票を無効にする | Y | - | - |
| 5007 | 申請者は申請伝票を有効にする | Y | - | - |
| 5008 | 中間APIで申請伝票を無効にする | Y | - | - |
| 5009 | 承認者追加 | Y | Y | Y |
| 5010 | 転送 | Y | Y | Y |
| 5011 | 管理者より委譲 | Y | Y | Y |
| 5020 | 支払取消 | - | Y | Y |
| 8001 | 経理と従業員とのやり取り | - | Y | Y |
| 8002 | 経理担当は添付ファイルをアップロードする | - | Y | Y |
| 8003 | 経理担当は添付ファイルを削除する | - | Y | Y |
| 9001 | 管理員は承認ステージをジャンプする | Y | Y | Y |
| 9003 | 催促 | Y | Y | Y |
| 12001 | 外部システム更新 | - | Y | Y |
| 13001 | 支払予定日の自動更新 | - | Y | Y |
ExpenseReportInvoice
| パラメーター名 | カテゴリ | 規則 | 説明 |
|---|---|---|---|
| expenseReportInvoiceOID | UUID | 36桁 | 精算伝票費用関連OID |
| invoiceOID | UUID | 36桁 | 費用OID |
| status | String | 費用ステータス値 | |
| rejectReason | String | 最大500文字 | 差戻理由 |
| expenseType | EntitySummary | 費目タイプ | |
| costCenterItem | EntitySummary | コストセンター値 | |
| invoiceStatus | String | 費用ステータス列挙名 | |
| unitPrice | String | 単価 | |
| quantity | String | 数量 | |
| expenseTaxType | Integer | 費目タイプ 1001:税抜 1002:税込 1003:対象外 | |
| baseCurrencyAmount | Double | 主要通貨金額 | |
| baseCurrencyCode | String | 主要通貨 | |
| baseCurrencyTaxExclusiveAmount | Double | 主要通貨税抜額 | |
| baseCurrencyFeeWithoutExemptedTax | Double | 主要通貨税抜額(税額控除後) | |
| baseCurrencyTaxAmount | Double | 主要通貨税額 | |
| baseCurrencyExemptedTaxAmount | Double | 主要通貨税額(税額控除後) | |
| comment | String | 事由 | |
| createdDate | ZonedDateTime | 時間フォーマット:yyyy-MM-dd'T'HH:mm:ssZ | 作成時間 |
| lastUpdatedDate | ZonedDateTime | 時間フォーマット:yyyy-MM-dd'T'HH:mm:ssZ | 最終更新時間 |
| data | ExpenseField[] | 費用カスタマイズフィールド | |
| receipt | Receipt | 費用関連領収書 | |
| isApportionUsed | Boolean | 分担利用可否 | |
| expenseApportion | ExpenseApportion[] | 費用分担リスト | |
| invoiceCreateDate | Date | 時間フォーマット:yyyy-MM-dd'T'HH:mm:ssZ | 費用発生日 |
| ratedate | Date | 時間フォーマット:yyyy-MM-dd'T'HH:mm:ssZ | レート日付 |
| originalCurrencyAmount | Double | 通貨金額 | |
| originalCurrencyCode | String | 通貨コード | |
| originalCurrencyRate | Double | 通貨レート | |
| originalCurrencyTaxExclusiveAmount | Double | 通貨税抜額 | |
| originalCurrencyFeeWithoutExemptedTax | Double | 通貨税抜額(税額控除後) | |
| originalCurrencyTaxAmount | Double | 通貨税額 | |
| originalCurrencyExemptedTaxAmount | Double | 通貨税額(税額控除後) | |
| source | String | ソース jsnavi:コーポレートカード tm:トラマネ(TM) btos:BTOS transfer:経路検索(短距離) routeSearch:経路検索 空白:手動登録 | |
| creditCardDetail | String | コーポレートカードデータ詳細 useDate:利用日 creditCardCompanyCode:クレジットカード会社コード creditCardCompanyName:クレジットカード会社名 creditCardBrand:利用カードブランド franchiseStoreName:加盟店名 currency:元通貨 originalAmount:元通貨金額 currencyRate:レート amount:円貨利用金額 billing_date:請求予定日 | |
| tmRouteDetail | String | トラマネ(TM)データ詳細 categoryCode:利用種別 depStationName:入場駅 arvStationName:出場駅 depCompanyName:事業者名(入場駅) arvCompanyName:事業者名(出場駅) amount:金額 | |
| routeDetails | RouteDetail | 経路明細データ詳細 |
Application
| パラメーター名 | カテゴリ | 規則 | 説明 |
|---|---|---|---|
| type | String | タイプ | |
| applicationOID | UUID | 仮払伝票OID | |
| businessCode | String | 仮払伝票番号 | |
| reimbursementAmount | BigDecimal | 消込金額 |
RouteDetail
| パラメーター名 | タイプ | 規則 | 説明 |
|---|---|---|---|
| routeDetail | String | 乗車区間 time:乗車時間 name:乗車区間 price:単価 amount:金額 | |
| routeInfoDetail | String | 乗車区間詳細 time:所要時間 leFlag:楽表示 anFlag:安表示 isRound:片道/往復 departure:出発地 arrival:到着地 LimitedExpress:特急料金 OtherService:適用サービス |
ExpenseField
| パラメータ名 | タイプ | 規則 | 説明 |
|---|---|---|---|
| type | String | 36桁 | 項目タイプ |
| code | String | 最大50文字 | カスタマイズ項目コード |
| name | String | 最大50文字 | カスタマイズ項目名称 |
| value | String | 最大255文字 | カスタマイズ項目ID |
| messageKey | String | 最大100文字 | メッセージキー |
| valueCode | String | 最大255文字 | マスタの場合、画面表示のコード |
| valueName | String | 最大255文字 | マスタの場合、画面表示の名称 |
| compositeIndex | Int | 複合コンポ番号 | |
| parentCompositeIndex | Int | 親コンポ番号 |
Receipt
| パラメーター名 | カテゴリ | 規則 | 説明 |
|---|---|---|---|
| tax | BigDecimal | 税額 | |
| exemptedTax | BigDecimal | 税額(税額控除後) | |
| consumptionTaxCode | String | 最大100文字 | 消費税コード |
| billingDate | Date | 日付フォーマット:yyyy-MM-dd | 受領日 |
| phoneNumber | String | 電話番号 | |
| shopName | String | 店名 | |
| businessRegistrationNumber | String | 事業者登録番号 | |
| businessCategory | Integer | 1001:課税事業者 1002:免税事業者 | 事業者区分 |
| businessRegistrationDate | Date | 日付フォーマット:yyyy-MM-dd | 事業者登録日 |
| taxDetails | taxDetails[] | 税明細 | |
| attachments | attachments[] | リンクリスト |
taxDetails
| 項目名 | タイプ | 規則 | 説明 |
|---|---|---|---|
| rate | number | 税明細税率 | |
| tax | number | 税明細税額 |
ExpenseApportion
| パラメータ名 | タイプ | 規則 | 説明 |
|---|---|---|---|
| apportionOID | UUID | 36桁 | 分担OID |
| expenseOID | UID | 36桁 | 費用OID |
| amount | BigDecimal | 費用金額 | |
| baseCurrencyAmount | BigDecimal | 主要通貨金額 | |
| taxAmount | BigDecimal | 元通貨税額 | |
| exemptedTaxAmount | BigDecimal | 元通貨税額(税額控除後) | |
| baseTaxAmount | BigDecimal | 主要通貨税額 | |
| baseExemptedTaxAmount | BigDecimal | 主要通貨税額(税額控除後) | |
| apportionUser | UserSummary | 分担関係者 | |
| apportionPercentage | BigDecimal | 分担比率 | |
| costCenterItems | CostCenterItem[] | コストセンター値リスト |
CostCenterItem
| パラメータ名 | タイプ | 規則 | 説明 |
|---|---|---|---|
| type | String | タイプ | |
| costCenterOID | UUID | 36桁 | コストセンターOID |
| costCenterCode | String | 最大100文字 | コストセンターコード |
| itemOID | UUID | 36桁 | コストセンター値OID |
| itemCode | String | 最大100文字 | コストセンター値コード |
PaymentLine
| パラメータ名 | タイプ | 規則 | 説明 |
|---|---|---|---|
| id | Long | 支払予定明細行ID | |
| tenantId | Long | テナントID | |
| reimbursementBatchOID | UUID | 支払バッチoid | |
| entityType | Integer | 伝票タイプ 1001申請伝票;1002精算伝票 | |
| entityOID | UUID | 伝票oid | |
| status | Integer | ステータス 1001未支払い;1008支払中1005支払済 | |
| baseCurrencyCode | String | 主要通貨 | |
| baseAmount | BigDecimal | 金額 | |
| paymentMethodName | String | 支払方法名称 | |
| paymentMethodCategory | String | 支払タイプ ONLINE_PAYMENTオンライン OFFLINE_PAYMENTオフライン EBANK_PAYMENT FBデータ OVERSEAS_REMITTANCE_ISO海外送金(ISO20022対応) | |
| paymentMethodSubType | String | 支払子タイプ BILL手形;OTHERその他 | |
| paymentMethodCode | String | 支払方法 | |
| paymentLineCustomFields | PaymentLineCustomField[] | 支払い方法のカスタマイズ値セット | |
| withBankInfo | Boolean | 銀行を表示するか | |
| estimatedPaymentDate | LocalDate | 支払予定日 | |
| issueDepartmentOID | UUID | 手形振出部門OID | |
| issueDepartmentName | String | 手形振出部門名称 | |
| issueDepartmentCode | String | 手形振出部門コード | |
| issueDate | LocalDate | 手形振出日 | |
| expiryDate | LocalDate | 手形満期日 | |
| estimatedMaturityDate | LocalDate | 決済予定日 | |
| receivingSupplier | String | 手形送付先 | |
| receivingSupplierId | Long | 手形送付先id-スポット支払ではない | |
| receivingPostalCode | String | 送付先郵便 | |
| receivingAddress | String | 送付先住所 | |
| checkNetNo | String | でんさいネットNO. | |
| payeeBankId | Long | 銀行コードid | |
| payeeBankCode | String | 銀行コード | |
| payeeBankName | String | 銀行名称 | |
| payeeBranchId | Long | 支店id | |
| payeeBranchCode | String | 支店コード | |
| payeeBranchName | String | 支店名称 | |
| payeeAccountType | String | 口座種別 | |
| payeeAccountNo | String | 口座番号 | |
| payeeAccountName | String | 口座名称 | |
| payeeAccountFbName | String | 口座名称(半角カナ) | |
| commissionChargeParty | String | 手数料負担区分 | |
| baseDate | LocalDate | 基準日 | |
| applicantPostOID | UUID | 申請者所属oid | |
| country | String | 国 | |
| overseaBankName | String | 海外FB用銀行名称 | |
| overseaBranchName | String | 海外FB用支店名 | |
| overseaAccount | String | 海外FB用銀行口座番号 | |
| overseaPayeeName | String | 海外FB用受取人名 | |
| overseaBranchAddress | String | 海外FB用支店住所 | |
| overseaPayeeAddress | String | 海外FB用受取人住所 | |
| internationalBalanceOfPaymentsItemCode | String | 国際収支項目番号 | |
| remittancePurpose | String | 送金目的 | |
| licenceNo | String | ライセンスNo. | |
| licenceDate | LocalDate | ライセンス日付 | |
| appointmentCode | String | 予約番号 | |
| message | String | メッセージ | |
| overseaPayeeISOBankInfo | overseaPayeeISOBankInfo | 海外送金(ISO20022対応)受取銀行情報 | |
| remittancePurposeInfo | remittancePurposeInfo | 海外送金(ISO20022対応)送金目的/送金許可 |
paymentConfirmInfo
| パラメータ名 | タイプ | 規則 | 説明 |
|---|---|---|---|
| paymentLineId | Long | 支払行ID | |
| reimbursementBatchName | Long | 支払バッチコード | |
| paymentDate | Date | 支払日 | |
| createdDate | Date | 支払操作日 | |
| paymentCurrency | String | 通貨 | |
| paymentType | String | 支払タイプ | |
| paymentCategoryCode | String | 支払コード | |
| paymentCategoryName | String | 支払方法 | |
| paymentExchangeRate | Double | レート | |
| paymentRemaker | String | 備考 | |
| bankInfo | bankInfo | 支払銀行情報 |
bankInfo
| パラメータ名 | タイプ | 規則 | 説明 |
|---|---|---|---|
| bankcode | String | 銀行コード | |
| branchBankCode | String | 支店コード | |
| bankAccount | String | 口座番号 | |
| bankName | String | 口座名 |
PaymentLineCustomField
| パラメータ名 | タイプ | 規則 | 説明 |
|---|---|---|---|
| fieldCode | String | 最大50文字 | カスタマイズ項目コード |
| value | String | 最大1000文字 | カスタマイズ項目値 |
ExpenseReportSourceTaxation
| パラメータ名 | タイプ | 規則 | 説明 |
|---|---|---|---|
| expenseReportOID | UUID | 精算伝票oid | |
| id | Long | 源泉税明細行id | |
| sourceTaxCategoryId | Long | 源泉税報酬区分id | |
| sourceTaxCategoryCode | String | 源泉税報酬区分コード | |
| sourceTaxCategoryName | String | 源泉税報酬区分名称 | |
| basicRate | BigDecimal | 基本税率 | |
| levyType | String | 源泉税徴収タイプ NONE源泉税徴収不要 CORP源泉税徴収(法人) INDIV源泉税徴収(個人) | |
| paymentAmount | BigDecimal | 支払金額 | |
| taxableAmount | BigDecimal | 要納税金額 | |
| sourceTaxAmount | BigDecimal | 源泉税金額 |
attachment(file)
| パラメータ名 | タイプ | 規則 | 説明 |
|---|---|---|---|
| fileName | String | 添付ファイルの名称 | |
| fileUrl | String | 添付ファイルのUrl |
DataEntity
| パラメータ名 | タイプ | 規則 | 説明 |
|---|---|---|---|
| type | String | 伝票タイプ | |
| businessCode | String | 最大36文字 | 伝票番号 |
| totalAmount | BigDecimal | 総金額 |
overseaPayeeISOBankInfo
| 項目名 | タイプ | 規則 | 説明 |
|---|---|---|---|
| sequence | String | 最大5文字 | NO. |
| accountName | String | 最大140文字 | 口座名義 |
| bankName | String | 最大140文字 | 支払先銀行名 |
| swiftOrBic | String | 最大11文字 | SWIFTまたはBIC |
| internationalBankSystemName | String | 固定5文字 | 国外銀行決済システム名称 |
| internationalBankSystemCode | String | 最大35文字 | 国外銀行決済システム番号 |
| ibanCode | String | 最大34文字 | IBANコード |
| bankAccountNumber | String | 最大34文字 | 口座番号 |
| branchCode | String | 固定3文字 | 支店番号 |
| leiCode | String | 固定20文字 | 受取人取引主体識別子(LEI) |
| payeeBankAddress | AddressInfo | 銀行支店住所情報 | |
| firstBank | Boolean | 中継銀行 | |
| firstBankInfo | BankInfo | 第1中継銀行情報 | |
| secondBank | Boolean | 第2中継銀行 | |
| secondBankInfo | BankInfo | 第2中継銀行情報 | |
| sameBankSameAccount | Boolean | 同一銀行・同一名義の振替銀行口座番号 | |
| sameBankSameAccountInfo | sameBankSameAccountInfo | 受取人取引/振替銀行口座番号(同一銀行・同一名義) | |
| bankFeeBearer | String | CRED:Credit DEBT:Debit BOTH:Both | 手数料負担区分 |
| status | Integer | ステータス | |
| isPrimary | Boolean | 主口座 |
AddressInfo
| パラメータ名 | タイプ | 規則 | 説明 |
|---|---|---|---|
| country | String | 値セット:国名-コード | 国名-ISOコード |
| countryName | String | 値セット:国名-英語名 | 国名-英語名 |
| stateProvincePrefecture | String | 最大35文字 | 都道府県/州/省 |
| cityTownVillage | String | 最大35文字 | 市区町村 |
| postal | String | 最大16文字 | 郵便番号 |
| streetNameHouseNumber | String | 最大70文字 | 番地等/通り名 |
| districtRegion | String | 最大35文字 | 地方/地域 |
| areaZone | String | 最大35文字 | 区域 |
| buildingName | String | 最大35文字 | 建物名 |
| buildingNumber | String | 最大16文字 | 建物番号 |
| floor | String | 最大70文字 | 建物階 |
| roomApartmentNumber | String | 最大70文字 | 部屋番号 |
| mailbox | String | 最大16文字 | 私書箱 |
| department | String | 最大70文字 | 部署 |
| divisionSection | String | 最大70文字 | 課 |
BankInfo
| パラメータ名 | タイプ | 規則 | 説明 |
|---|---|---|---|
| bankName | String | 最大140文字 | 銀行名 |
| swiftOrBic | String | 最大11文字 | SWIFTまたはBIC |
| internationalBankSystemName | String | 固定5文字 | 国外銀行決済システム名称 |
| internationalBankSystemCode | String | 最大35文字 | 国外銀行決済システム番号 |
| ibanCode | String | 最大34文字 | IBANコード |
| bankAccountNumber | String | 最大34文字 | 口座番号 |
| branchCode | String | 固定3文字 | 支店番号 |
| bankAddress | AddressInfo | 銀行住所情報 |
sameBankSameAccountInfo
| パラメータ名 | タイプ | 規則 | 説明 |
|---|---|---|---|
| payeeBankAccountNumberIban | String | 最大34文字 | 受取人取引銀行 IBANコード |
| payeeBankAccountNumber | String | 最大34文字 | 受取人取引銀行 口座番号 |
remittancePurposeInfo
| 項目名 | タイプ | 規則 | 説明 |
|---|---|---|---|
| remittancePurposeCategory | String | 1001:貿易 1002:仲介貿易 1003:貿易外取引 | 送金目的分類 |
| remittancePurposeCode | String | 送金目的コード | |
| remittancePurpose | String | 送金目的 | |
| applicableRegulatoryParty | String | CRED:Credit DEBT:Debit BOTH:Both | 法規制の適用側 |
| regulatoryRequesterCountry | String | 規制等の要求者所在国 | |
| regulatoryRequesterName | String | 法規制等の要求者名 | |
| regulationType | String | 法規制等の種類 | |
| regulationProposalDate | String | 日付フォーマット:yyyy-MM-dd | 法規制等の種類が提示された日付 |
| regulationCountry | String | 法規制等の種類を提示した国 | |
| reportReasonCode | String | 報告の理由等(コード形式) | |
| reportCurrency | String | 報告通貨 | |
| reportAmount | BigDecimal | 報告金額 | |
| additionalInfo1~10 | String | 補足情報1~10 |
失敗例
{
"message": "パラメータ送信フォーマット異常1002;90、正しいフォーマット1,2,3",
"errorCode": "120005"
}
項目説明
| 項目名 | タイプ | 説明 |
|---|---|---|
| message | String | エラーメッセージを返す |
| errorCode | String | エラーコードを返す |
エラーコード説明
| errorCode | message | 説明 |
|---|---|---|
| 120005 | パラメータ送信フォーマット異常{0}、正しいフォーマット{1} |