sino-bc-cli 1.0.0-beta.0

package/dist/api-doc/oapi/wallet.md

@@ -0,0 +1,275 @@
+# 预付钱包
+
+对应命令：`wallet +<shortcut>` 与 `wallet api <name>`。
+
+执行前 MUST 读取 [sino-bc-shared](../../skills/sino-bc-shared/SKILL.md) 轻量入口，再按命中条件读取其 references；当前上下文已读且仍适用时可复用。可用 `sino-bc-cli /skill` 查询真实路径。
+
+## 1. 钱包首页
+
+`GET /sino-wallet-pu/platform/wallet/own`
+
+主体上下文：`tenant=true`。
+
+角色范围：`passport/system`。
+
+风险：`read`。
+
+主体必填：每次传入 `--corporation-id` 与 `--auth-context-id`，两者不放进 `--data`；绑定与恢复按 shared 条件索引读取主体参考。
+
+调用示例：`sino-bc-cli wallet api wallet-own --data '<json>' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`。
+
+查当前主体钱包：预付给现金/待还，后付给现金+信用金。
+
+## 2. 最近钱包流水
+
+`GET /sino-wallet-pu/platform/wallet/recent/walletchangeitem`
+
+主体上下文：`tenant=true`。
+
+角色范围：`passport/system`。
+
+风险：`read`。
+
+主体必填：每次传入 `--corporation-id` 与 `--auth-context-id`，两者不放进 `--data`；绑定与恢复按 shared 条件索引读取主体参考。
+
+调用示例：`sino-bc-cli wallet api wallet-change-recent --data '<json>' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`。
+
+钱包首页最近消费/返额，默认 7 条。
+
+**输入参数（--data）**
+
+| 字段 | 类型 | 位置 | 必填 | 说明 |
+| --- | --- | --- | --- | --- |
+| `pageSize` | integer | query | 否 | 条数，默认 7 |
+
+## 3. 最近充值记录
+
+`GET /sino-wallet-pu/platform/wallet/recent/recharge`
+
+主体上下文：`tenant=true`。
+
+角色范围：`passport/system`。
+
+风险：`read`。
+
+主体必填：每次传入 `--corporation-id` 与 `--auth-context-id`，两者不放进 `--data`；绑定与恢复按 shared 条件索引读取主体参考。
+
+调用示例：`sino-bc-cli wallet api wallet-recharge-recent --data '<json>' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`。
+
+钱包首页最近充值，默认 7 条。
+
+**输入参数（--data）**
+
+| 字段 | 类型 | 位置 | 必填 | 说明 |
+| --- | --- | --- | --- | --- |
+| `pageSize` | integer | query | 否 | 条数，默认 7 |
+
+## 4. 钱包币种列表
+
+`GET /sino-wallet-pu/platform/wallet/currency/list`
+
+主体上下文：`tenant=true`。
+
+角色范围：`passport/system`。
+
+风险：`read`。
+
+主体必填：每次传入 `--corporation-id` 与 `--auth-context-id`，两者不放进 `--data`；绑定与恢复按 shared 条件索引读取主体参考。
+
+调用示例：`sino-bc-cli wallet api wallet-currency-list --data '<json>' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`。
+
+当前主体可用币种。
+
+## 5. 现金账务类型
+
+`GET /sino-wallet-pu/platform/wallet/cashchange/list/accountstype`
+
+主体上下文：`tenant=true`。
+
+角色范围：`passport/system`。
+
+风险：`read`。
+
+主体必填：每次传入 `--corporation-id` 与 `--auth-context-id`，两者不放进 `--data`；绑定与恢复按 shared 条件索引读取主体参考。
+
+调用示例：`sino-bc-cli wallet api wallet-cash-change-accounts-type --data '<json>' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`。
+
+现金收支筛选项：账务类型与流水方向。
+
+## 6. 现金收支明细
+
+`POST /sino-wallet-pu/platform/wallet/cashchange/list`
+
+主体上下文：`tenant=true`。
+
+角色范围：`passport/system`。
+
+风险：`read`。
+
+主体必填：每次传入 `--corporation-id` 与 `--auth-context-id`，两者不放进 `--data`；绑定与恢复按 shared 条件索引读取主体参考。
+
+调用示例：`sino-bc-cli wallet api wallet-cash-change-list --data '<json>' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`。
+
+分页查现金/返点账户流水。响应不含收支汇总。
+
+**输入参数（--data）**
+
+| 字段 | 类型 | 位置 | 必填 | 说明 |
+| --- | --- | --- | --- | --- |
+| `pageNum` | integer | body | 否 | 页码，从 1 开始 |
+| `pageSize` | integer | body | 否 | 每页条数 |
+| `changeTimeOrderBy` | string | body | 是 | desc 倒序 / asc 正序 |
+| `startTime` | string | body | 否 | 开始日期 |
+| `endTime` | string | body | 否 | 结束日期 |
+| `externalBizType` | string | body | 否 | 来自现金账务类型接口 |
+| `flowDirectionList` | array | body | 否 | 来自账务类型接口 |
+| `incomeAndExpensesType` | string | body | 否 | income 收入 / expenses 支出 |
+| `currencyList` | array | body | 否 | 币种类型 |
+| `flowNo` | string | body | 否 | 流水单号 |
+| `min` | number | body | 否 | 收支金额最小值 |
+| `max` | number | body | 否 | 收支金额最大值 |
+| `operatorIds` | array | body | 否 | 操作人 |
+| `departmentCodeList` | array | body | 否 | 含顶级团队时服务端会再加管理员团队 0 |
+| `collectFlag` | boolean | body | 否 | 本契约丢弃汇总，可不传 |
+
+## 7. 钱包账务类型
+
+`GET /sino-wallet-pu/platform/wallet/walletchange/list/accountstype`
+
+主体上下文：`tenant=true`。
+
+角色范围：`passport/system`。
+
+风险：`read`。
+
+主体必填：每次传入 `--corporation-id` 与 `--auth-context-id`，两者不放进 `--data`；绑定与恢复按 shared 条件索引读取主体参考。
+
+调用示例：`sino-bc-cli wallet api wallet-change-accounts-type --data '<json>' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`。
+
+钱包消费明细的账务类型筛选项。
+
+## 8. 钱包额度类型
+
+`GET /sino-wallet-pu/platform/wallet/walletchange/list/quotatype`
+
+主体上下文：`tenant=true`。
+
+角色范围：`passport/system`。
+
+风险：`read`。
+
+主体必填：每次传入 `--corporation-id` 与 `--auth-context-id`，两者不放进 `--data`；绑定与恢复按 shared 条件索引读取主体参考。
+
+调用示例：`sino-bc-cli wallet api wallet-change-quota-type --data '<json>' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`。
+
+额度类型：consume 消费 / return_quota 返额。
+
+## 9. 钱包消费明细
+
+`POST /sino-wallet-pu/platform/wallet/walletchange/list`
+
+主体上下文：`tenant=true`。
+
+角色范围：`passport/system`。
+
+风险：`read`。
+
+主体必填：每次传入 `--corporation-id` 与 `--auth-context-id`，两者不放进 `--data`；绑定与恢复按 shared 条件索引读取主体参考。
+
+调用示例：`sino-bc-cli wallet api wallet-change-list --data '<json>' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`。
+
+分页查钱包额度流水。响应不含消费/返额汇总。
+
+**输入参数（--data）**
+
+| 字段 | 类型 | 位置 | 必填 | 说明 |
+| --- | --- | --- | --- | --- |
+| `pageNum` | integer | body | 否 | 页码，从 1 开始 |
+| `pageSize` | integer | body | 否 | 每页条数 |
+| `changeTimeOrderBy` | string | body | 是 | desc 倒序 / asc 正序 |
+| `startTime` | string | body | 否 | 开始日期 |
+| `endTime` | string | body | 否 | 结束日期 |
+| `quotaType` | string | body | 否 | 额度类型 |
+| `externalBizType` | string | body | 否 | 来自钱包账务类型接口 |
+| `flowDirectionList` | array | body | 否 | 来自账务类型接口 |
+| `currencyList` | array | body | 否 | 币种类型 |
+| `flowNo` | string | body | 否 | 流水单号 |
+| `min` | number | body | 否 | 额度最小值 |
+| `max` | number | body | 否 | 额度最大值 |
+| `operatorIds` | array | body | 否 | 操作人 |
+| `departmentCodeList` | array | body | 否 | 含顶级团队时服务端会再加管理员团队 0 |
+| `collectFlag` | boolean | body | 否 | 服务端默认 true；本契约丢弃汇总 |
+
+## 10. 充值明细
+
+`POST /sino-wallet-pu/platform/wallet/recharge/list`
+
+主体上下文：`tenant=true`。
+
+角色范围：`passport/system`。
+
+风险：`read`。
+
+主体必填：每次传入 `--corporation-id` 与 `--auth-context-id`，两者不放进 `--data`；绑定与恢复按 shared 条件索引读取主体参考。
+
+调用示例：`sino-bc-cli wallet api wallet-recharge-list --data '<json>' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`。
+
+按入账时间查充值记录。响应只保留列表，不含充值汇总。
+
+**输入参数（--data）**
+
+| 字段 | 类型 | 位置 | 必填 | 说明 |
+| --- | --- | --- | --- | --- |
+| `pageNum` | integer | body | 否 | 页码，从 1 开始 |
+| `pageSize` | integer | body | 否 | 每页条数 |
+| `incomeTimeOrderBy` | string | body | 是 | desc 倒序 / asc 正序 |
+| `startIncomeTime` | string | body | 否 | yyyy-MM-dd |
+| `endIncomeTime` | string | body | 否 | yyyy-MM-dd |
+| `currency` | string | body | 否 | 单币种 |
+| `min` | number | body | 否 | 充值金额最小值 |
+| `max` | number | body | 否 | 充值金额最大值 |
+
+## 11. 币种可用额度
+
+`GET /sino-wallet-pu/platform/wallet/currency/list/amount`
+
+主体上下文：`tenant=true`。
+
+角色范围：`passport/system`。
+
+风险：`read`。
+
+主体必填：每次传入 `--corporation-id` 与 `--auth-context-id`，两者不放进 `--data`；绑定与恢复按 shared 条件索引读取主体参考。
+
+调用示例：`sino-bc-cli wallet api wallet-currency-amount --data '<json>' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`。
+
+按币种查各账户可用额度。
+
+**输入参数（--data）**
+
+| 字段 | 类型 | 位置 | 必填 | 说明 |
+| --- | --- | --- | --- | --- |
+| `currency` | string | query | 是 | 币种，如 USD |
+
+## 12. 币种汇率
+
+`GET /sino-wallet-pu/platform/wallet/currency/exchange/rate`
+
+主体上下文：`tenant=true`。
+
+角色范围：`passport/system`。
+
+风险：`read`。
+
+主体必填：每次传入 `--corporation-id` 与 `--auth-context-id`，两者不放进 `--data`；绑定与恢复按 shared 条件索引读取主体参考。
+
+调用示例：`sino-bc-cli wallet api wallet-exchange-rate --data '<json>' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`。
+
+查 sourceCurrency 到 targetCurrency 的汇率。
+
+**输入参数（--data）**
+
+| 字段 | 类型 | 位置 | 必填 | 说明 |
+| --- | --- | --- | --- | --- |
+| `sourceCurrency` | string | query | 是 | 原始币种 |
+| `targetCurrency` | string | query | 是 | 目标币种 |