增量查询汇率

接口描述

此接口为增量接口,用于查询基准日期时间点有效的外币汇率。

接口权限

本接口需要集团权限

接口权限

/api/openapi/currency/rates

请求URI

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:同一币种只输出一条汇率

接口返回示例

{
    "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
      }
    ]
}

接口返回字段

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}