员工卡接口

新增员工

URL: POST /staff/employee/create

输入:

字段 类型 必填 说明
username string 是 邮箱(用户名)
area_code string 是 手机区号, 如852
mobile string 是 手机号，如13900000000
employee_name string 是 员工名
employee_type string 是 员工身份, NORMAL普通员工, BUDGET_MANAGER预算管理员
employee_remark string 否 员工备注
password string 是 密码
card_ids list<string> 否 关联员工卡id列表

输出:

字段 类型 说明
id string 员工id

获取员工列表

URL: GET /staff/employee/list?page=1

Query:

字段 必填 说明
page 否 页码，从1开始
size 否 每页大小
search 否 搜索关键词
status 否 员工状态

输出: list<Employee>

Employee

字段 类型 说明
id string id
username string 邮箱/用户名
role string 角色
area_code string 手机区号, 如852
mobile string 手机号，如13900000000
employee_name string 员工名
employee_type string 员工身份, NORMAL普通员工, BUDGET_MANAGER预算管理员
status string 员工状态, NORMAL正常, SUSPENDED已停用
employee_remark string 员工备注
employee_card_count number 关联卡数
employee_total_consume number 累计消费, 单位元
last_login string 最后登录时间
created_at string 创建时间
updated_at string 更新时间

编辑员工

URL: POST /staff/employee/{employee_id}/update

输入:

字段 类型 必填 说明
username string 是 邮箱(用户名)
area_code string 是 手机区号, 如852
mobile string 是 手机号，如13900000000
employee_name string 是 员工名
employee_type string 是 员工身份, NORMAL普通员工, BUDGET_MANAGER预算管理员
employee_remark string 否 员工备注
password string 否 密码如果不填，表示不更新密码
card_ids list<string> 否 关联员工卡id列表

输出: 无

修改员工状态

URL: POST /staff/employee/{employee_id}/change_status

输入:

字段 类型 必填 说明
status string 是 员工状态, NORMAL正常, SUSPENDED已停用

输出: 无

删除员工

URL: POST /staff/employee/{employee_id}/delete

输入: 无

输出: 无

获取员工卡公共信息

URL: GET /staff/info

Query: 无

输出:

字段 类型 说明
max_card_count number 最大开卡数
remaining_card_count number 剩余可开卡数
total_amount number 预算内总金额, 单位元
budget_count number 总预算数

申请总开卡数

URL: POST /staff/apply_max_count

输入:

字段 类型 必填 说明
apply_count number 是 申请数量
purpose list<string> 是 使用场景, TIKTOK, FACEBOOK, GOOGLE
reason string 是 申请原因

输出: 无

获取预算列表

URL: GET /staff/budget/list?page=1

Query:

字段 必填 说明
page 否 页码，从1开始
size 否 每页大小
search 否 搜索关键词
status 否 状态
employee_id 否 员工id

输出: list<StaffBudget>

StaffBudget

字段 类型 说明
id string id
title string 名称
amount number 预算金额, 单位元
status string 状态, NORMAL正常, SUSPENDED已停用
manager_id string 管理员工id
manager_name string 管理员工名称
total_consume number 累计消费, 单位元
total_consume_count number 累计消费笔数
card_count number 关联卡数量
created_at string 创建时间
updated_at string 更新时间

获取预算详情

URL: GET /staff/budget/{budget_id}/detail

Query: 无

输出: StaffBudget

StaffBudget

字段 类型 说明
id string id
title string 名称
amount number 预算金额, 单位元
status string 状态, NORMAL正常, SUSPENDED已停用
manager_id string 管理员工id
manager_name string 管理员工名称
created_at string 创建时间
updated_at string 更新时间
total_consume number 累计消费, 单位元
total_consume_count number 累计消费笔数
card_count number 关联卡数量

新增预算

URL: POST /staff/budget/create

输入:

字段 类型 必填 说明
title string 是 名称
amount number 是 预算金额
所有金额都是整数且精确到分，如1850，表示18.5元
manager_id string 是 管理员工id

输出:

字段 类型 说明
id string 预算id

更新预算

URL: POST /staff/budget/{budget_id}/update

输入:

字段 类型 必填 说明
title string 是 名称

输出: 无

预算充值

注意: 当前仅支持从钱包充值

URL: POST /staff/budget/{budget_id}/recharge

输入:

字段 类型 必填 说明
amount number 是 充值金额
所有金额都是整数且精确到分，如1850，表示18.5元

输出:

字段 类型 说明
budget_amount number 预算新金额, 单位元
wallet_balance number 钱包新余额, 单位元

预算转出

注意: 当前仅支持转出到钱包

URL: POST /staff/budget/{budget_id}/transfer_out

输入:

字段 类型 必填 说明
amount number 是 转出金额
所有金额都是整数且精确到分，如1850，表示18.5元

输出:

字段 类型 说明
budget_amount number 预算新金额, 单位元
wallet_balance number 钱包新余额, 单位元

修改预算状态

URL: POST /staff/budget/{budget_id}/change_status

输入:

字段 类型 必填 说明
status string 是 状态, NORMAL正常, SUSPENDED已停用

输出: 无

删除预算

URL: POST /staff/budget/{budget_id}/delete

输入: 无

输出: 无

获取员工卡列表

URL: GET /staff/card/list?page=1

Query:

字段 必填 说明
page 否 页码，从1开始
size 否 每页大小
search 否 搜索关键词
status 否 状态
employee_id 否 员工ID
no_employee 否 true查询未关联员工的卡片
staff_budget_id 否 员工预算ID

输出: list<StaffCard>

StaffCard

字段 类型 说明
id string 卡id
cardholder_id string 持卡人ID
segment_id string 卡段ID
card_number string 卡号
name_on_card string 卡名
brand string 品牌，如VISA
expiry_year string 过期年份
expiry_month string 过期月份
cvv string cvv
balance number 余额, 单位元
total_consume number 累计消费, 单位元
total_recharge number 累计充值, 单位元
total_transfer_out number 累计转出, 单位元
actual_recharge number 实际充值, 单位元
total_refund number 累计退款, 单位元
currency string 币种, 如USD
tag string 标签
purpose list<string> 使用场景, TIKTOK, FACEBOOK, GOOGLE
status string 状态, NOPENDING未处理, PENDING待处理, ACTIVE已激活,
INACTIVE已失效, BLOCKED已锁定, LOST已丢失, STOLEN已被盗,
CLOSED已关闭, FAILED创建失败, EXPIRED已过期
limit_type string 额度类型, UNLIMITED无限制, CYCLE循环额度, ACCUMULATE累计额度
cycle_limit_type string 循环额度类型, DAILY每日, WEEKLY每周, MONTHLY每月
limit_amount string 额度金额, 单位元
employee_id string 员工ID
employee_name string 员工姓名
staff_budget_id string 预算ID
staff_budget_title string 预算名称

新增员工卡

URL: POST /staff/card/create

输入:

字段 类型 必填 说明
segment_id string 是 卡段ID
cardholder_id string 是 持卡人ID
currency string 是 币种
tag string 否 标签
purpose list<string> 是 使用场景, TIKTOK, FACEBOOK, GOOGLE
staff_budget_id string 是 员工预算ID
employee_id string 是 员工ID

输出:

字段 类型 说明
id string 卡id

修改额度

URL: POST /staff/card/{card_id}/change_limit

输入:

字段 类型 必填 说明
limit_type string 是 额度类型, UNLIMITED无限制, CYCLE循环额度, ACCUMULATE累计额度
cycle_limit_type string 否 循环额度类型, DAILY每日, WEEKLY每周, MONTHLY每月
类型是CYCLE时必填
limit_amount string 否 额度金额
所有金额都是整数且精确到分，如1850，表示18.5元
类型不是UNLIMITED时必填

输出: 无

批量修改额度卡标签

URL: POST /staff/card/update_tag

输入:

字段 类型 必填 说明
ids string 是 卡ID列表

输出: 无

冻结卡片

URL: POST /staff/card/{card_id}/freeze

输入: 无

输出: 无

解冻卡片

URL: POST /staff/card/{card_id}/unfreeze

输入: 无

输出: 无

删除卡片

URL: POST /staff/card/{card_id}/delete

输入: 无

输出: 无