レート情報一括取得

OpenAPI説明

当該OpenAPIでは、指定した基準日に有効な外貨レートを一括取得します。

OpenAPI権限

当該OpenAPIはテナント権限が必要です。

リクエストURI

/api/openapi/currency/rates

リクエスト形式

GET

リクエストパラメータ例

/api/openapi/currency/rates?page=1&size=50&setOfBooksCode=TestSOB&baseDate=2021-03-03&isMultiRate=false

リクエストパラメータ説明

パラメータ名	タイプ	必須	説明
page	int	○	ページ、第一ページ: page=1
size	int	○	ページごとの結果数。最大50
setOfBooksCode	String	○	元帳コード
baseDate	String		基準日：yyyy-MM-dd 指定なしの場合、システム日付でレートを取得する
isMultiRate	Boolean		一通貨多数レート。true/false(デフォルトfalse) true: 同一外貨にレート用途別に複数レートを出力する；false：一外貨一レートを出力する

OpenAPIリターン例

{
  "total": 2,
  "current": 1,
  "pageSize": 20,
  "pages": 1,
  "hasPrevious": false,
  "hasNext": false,
  "data": [
    {
      "setOfBooksCode": "DEFAULT_SOB",
      "code": "CNY",
      "effectiveDate": "2021-01-01",
      "exchangeRate": 20.09,
      "exchangeRateUsageCode": "001",
      "isEnabled": true
    },
    {
      "setOfBooksCode": "DEFAULT_SOB",
      "code": "USD",
      "effectiveDate": "2021-01-01",
      "exchangeRate": 147.25,
      "exchangeRateUsageCode": "001",
      "isEnabled": true
    }
  ]
}

OpenAPIリターン項目

PageResposne

パラメータ名	タイプ	説明
total	int	検索結果の総件数
current	int	当ページ数
pageSize	int	ページごとの結果数
pages	int	検索結果総ページ数
hasPrevious	boolean	前のページがあるかどうか
hasNext	boolean	次のページがあるかどうか
data	Rate[]	レートデータ

Rate

項目	タイプ	制限	説明
setOfBooksCode	String	最大36文字	元帳コード
code	String	固定3文字	外貨コード
effectiveDate	String	日付フォーマット：yyyy-MM-dd	レート有効開始日
exchangeRate	Double		レート
exchangeRateUsageCode	String	最大36文字	レート用途コード（一通貨多数レートが有効な場合：値有り）
isEnabled	Boolean		ステータス：有効

失敗例

{
    "message": "テナントの権限がありません",
    "errorCode": "120001"
}

項目説明

項目名	タイプ	説明
message	String	エラーメッセージを返す
errorCode	String	エラーコードを返す

エラーコード説明

errorCode	message	説明
4002	無効な頁数です:{0}。
120001	テナントの権限がありません
121802	指定した元帳は存在しません
120003	{0}は指定必須の項目です