Spendia Open API

仮払申請伝票一括取得

OpenAPI説明

本APIは、最終更新日の範囲で仮払申請伝票の検索に利用します。

リクエストURI

/api/openapi/application/loans

リクエスト形式

GET

リクエストパラメータ例

/api/openapi/application/loans?startTime=2020-02-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 ○ 仮払申請のステータスのコード。
複数の場合、カンマで区切る
fetchApprovalHistory Boolean デフォルトはfalse
承認履歴の返送要否

OpenAPIリターン例

{
    "total": 1,
    "current": 1,
    "pageSize": 20,
    "pages": 1,
    "hasPrevious": false,
    "hasNext": false,
    "data": [
        {
            "applicationOID": "6962085a-2174-4151-bed0-89dbd06cf95d",
            "tenantId": 1214732595705114626,
            "businessCode": "LA0000000001",
            "title": "出張仮払",
            "remark": "",
            "status": "PASSED",
            "createdDate": "2020-02-14T04:52:35Z",
            "lastUpdatedDate": "2020-02-14T04:59:09Z",
            "setOfBooksCode": "DEFAULT_SOB",
            "baseDate": "2020-08-18",
            "company": {
                "oid": "13c79677-ad3a-427b-a9ef-1b33ad2100a4",
                "code": "SPD-COM-001"
            },
            "department": {
                "oid": "48098dd1-c81e-4c96-a295-1632f9ebdd85",
                "name": "技術グループ1",
                "code": "SPD-DEP-001"
            },
            "applicant": {
                "userOID": "2631d98e-dc5d-48ff-9654-f2625bf71002",
                "fullName": "システム管理者",
                "employeeId": "admin",
                "company": {
                    "oid": "13c79677-ad3a-427b-a9ef-1b33ad2100a4",
                    "code": "SPD-DEP-001"
                },
                "department": {
                    "oid": "48098dd1-c81e-4c96-a295-1632f9ebdd85",
                    "name": "技術グループ1",
                    "code": "SPD-DEP-001"
                }
            },
            "submittedBy": {
                "userOID": "2631d98e-dc5d-48ff-9654-f2625bf71002",
                "employeeId": "admin"
            },
            "createdBy": {
                "userOID": "2631d98e-dc5d-48ff-9654-f2625bf71002"
            },
            "lastApprovalDate": "2020-02-14T04:54:46Z",
            "lastAuditApprovalDate": "2020-02-14T04:59:08Z",
            "lastAuditApprovalCode": "100001",
            "lastAuditApprovalName": "財務１",
            "customForm": {
                "formOID": "a02292cf-9e97-43b6-8160-5d91d25e3f90",
                "name": "経費仮払申請",
                "type": null,
                "code": "Form001",
                "customFields": [
                    {
                        "formValueOID": "9194adc3-39a5-4e55-ae57-da9ecd9755c1",
                        "fieldOID": "ea6aa332-0706-4e18-9384-9bb16cbc5da1",
                        "fieldName": "用途",
                        "fieldCode": "PURPOSE",
                        "fieldType": "TEXT",
                        "value": null
                    }
                ]
            },
            "approvalHistories": [
                {
                    "operationType": 1001,
                    "operation": 1001,
                    "operationDetail": null,
                    "remark": null,
                    "approvalDate": "2023-01-04T11:09:23+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
                }
            ],
            "baseCurrencyCode": "JPY",
            "baseCurrencyTotalAmount": 100.00,
            "currencyCode": "JPY",
            "currencyRate": 1.0,
            "totalAmount": 100.00,
            "generalLedgerDate": "2020-02-13T15:00:00Z",
            "expenseClaims":[
                  {
                    "type": "NORMAL",
                    "businessCode": "ER01811504",
                    "totalAmount": 100.0
                  },
                  {
                    "type": "EXPENSE",
                    "businessCode": "ER01811505",
                    "totalAmount": 100.0
                  }
                ], 
            "requests":[
            　　{
                    "type": "TRAVEL",
                    "businessCode": "TA00650475",
                    "totalAmount": 100.0
                  }
                ],
            "paymentLines": [
                {
                    "id": 152,
                    "tenantId": 1074840362127142914,
                    "reimbursementBatchOID": null,
                    "entityType": 1001,
                    "entityOID": "9a1d6019-b861-4ad0-b4cb-eb192c2dcd3f",
                    "status": 1001,
                    "baseCurrencyCode": "JPY",
                    "baseAmount": 111.0000,
                    "paymentMethodName": "オンライン手形は銀行なし",
                    "paymentMethodCategory": "ONLINE_PAYMENT",
                    "paymentMethodSubType": "BILL",
                    "paymentMethodCode": "3",
                    "paymentLineCustomFields": [
                        {
                          "fieldCode": "country",
                          "value": "AE"
                        }
                    ],
                    "withBankInfo": false,
                    "estimatedPaymentDate": "2021-06-04",
                    "issueDepartmentOID": "3b4fa910-f2fa-4662-81bb-9dfdd696ca57",
                    "issueDepartmentName": "テスト－王|王様",
                    "issueDepartmentCode": "10100",
                    "issueDate": "2021-06-30",
                    "expiryDate": "2021-06-04",
                    "estimatedMaturityDate": "2021-06-04",
                    "receivingSupplier": "汇３",
                    "receivingSupplierId": 1153255526580518912,
                    "receivingPostalCode": "123123",
                    "receivingAddress": "room 101 building 3 road 1001 shanghai china",
                    "checkNetNo": "444",
                    "payeeBankId": null,
                    "payeeBankCode": null,
                    "payeeBankName": null,
                    "payeeBranchId": null,
                    "payeeBranchCode": "",
                    "payeeBranchName": null,
                    "payeeAccountType": null,
                    "payeeAccountNo": null,
                    "payeeAccountName": null,
                    "payeeAccountFbName": null,
                    "commissionChargeParty": null,
                    "baseDate": "2021-06-04",
                    "applicantPostOID": "5d614e18-8327-11eb-b360-0a405f8b1a98"
                }
            ]
        }
    ],
    "sourceTaxations": [
      {
        "applicationOID": "099e8927-505d-449b-a3cd-f2bb0293289e",
        "id": "5",
        "sourceTaxCategoryId": "1410508550409940994",
        "sourceTaxCategoryCode": "1",
        "sourceTaxCategoryName": "報酬",
        "basicRate": 0.10000,
        "levyType": "INDIV",
        "paymentAmount": null,
        "taxableAmount": 1000.0000,
        "sourceTaxAmount": 99.0000
      }
    ],
  "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": "備考１",
      "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": "備考２",
      "bankInfo": {
        "bankcode": "0000",
        "branchBankCode": "094",
        "bankAccount": "XXXXXX",
        "bankName": "XXXXXX"
      }
    }
  ]
}

OpenAPIリターン項目

PageResposne

パラメータ名 タイプ 説明
total int 検索結果の総件数
current int 当ページ数
pageSize int ページごとの結果数
pages int 検索結果総ページ数
hasPrevious boolean 前のページがあるかどうか
hasNext boolean 次のページがあるかどうか
data LoanApplication[] 仮払申請伝票リスト

LoanApplication

パラメーター名 カテゴリ 規則 説明
applicationOID UUID 36桁 仮払申請伝票OID
tenantId Long テナントID
businessCode String 最大36文字 仮払申請伝票番号
title String 最大500文字 事由
remark String 最大255文字 備考
status String 伝票ステータス
StatusTypeをご参照
baseCurrencyCode String 3桁、国際の標準通貨コードを利用します。例JPY 主要通貨コード
baseCurrencyTotalAmount BigDecimal 小数の桁数は通貨で決めます 主要通貨金額
currencyCode String 3桁、国際の標準通貨コードを利用します。例JPY 申請伝票通貨コード
currencyRate Double 申請伝票通貨と主要通貨の為替レート
totalAmount BigDecimal 小数の桁数は通貨によって変わる 申請伝票通貨金額
generalLedgerDate ZonedDateTime 時間のフォーマット：yyyy-MM-dd'T'HH:mm:ssZ 仮払申請伝票の計上日付
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[] 承認履歴
paymentLines PaymentLine[] 支払情報リスト
paymentConfirmInfos paymentConfirmInfo[] 支払確認情報リスト
requests DataEntity[] 仮払伝票の関連事前申請伝票リスト
expenseClaims DataEntity[] 仮払伝票の関連精算申請伝票リスト
sourceTaxations ApplicationSourceTaxation[] 源泉税明細

StatusType

値 列挙名 説明
1001 INIT 編集中(新規作成、取消、差戻済、検印差戻し、取消差戻)
1002 SUBMIT 承認待ち
1003 PASSED 承認済
1004 AUDIT_PASSED 検印済
1005 PAID 支払済
1006 A_1006 返金待ち
1007 A_1007 返金完了
1008 PAYMENT_IN_PROCESS 支払待ち
1009 CLOSED 無効済
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

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データ
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

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文字 カスタマイズ項目値

DataEntity

パラメータ名 タイプ 規則 説明
type String 伝票タイプ
businessCode String 最大36文字 伝票番号
totalAmount BigDecimal 総金額

ApplicationSourceTaxation

パラメータ名 タイプ 規則 説明
applicationOID 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 源泉税金額

仮払申請情報個別取得 →