Files
pyGoEdge-UserPanel/reference/goedge 文档/UserBillService.md
2025-11-18 03:36:49 +08:00

4.1 KiB
Raw Blame History

UserBillService

账单相关服务


countAllUserBills

计算所有账单数量

  • 角色:admin, user
  • HTTPPOST https://backend.dooki.cloud/UserBillService/countAllUserBills
  • RPCrpc countAllUserBills (CountAllUserBillsRequest) returns (RPCCountResponse);

请求对象 (CountAllUserBillsRequest)

{
  "paidFlag": "int32 // 可选0|1|-1",
  "userId": "int64 // 可选用户ID",
  "month": "string // 可选,月份",
  "trafficRelated": "bool // 可选,是否为流量带宽相关",
  "minDailyBillDays": "int32 // 可选,按日计费账单生成最小天数",
  "minMonthlyBillDays": "int32 // 可选,按月计费账单生成最小天数"
}

响应对象 (RPCCountResponse)

{
  "count": "int64 // 数量"
}

调用示例

curl -X POST "https://backend.dooki.cloud/UserBillService/countAllUserBills" \
  -H "Content-Type: application/json" \
  -H "X-Edge-Access-Token: <YOUR_TOKEN>" \
  -d '{
    ...
  }'

findUserBill

查找账单信息

  • 角色:admin, user
  • HTTPPOST https://backend.dooki.cloud/UserBillService/findUserBill
  • RPCrpc findUserBill(FindUserBillRequest) returns (FindUserBillResponse);

请求对象 (FindUserBillRequest)

{
  "userBillId": "int64 // ID和单号二选一",
  "code": "string // 单号"
}

响应对象 (FindUserBillResponse)

{
  "userBill": "UserBill"
}

调用示例

curl -X POST "https://backend.dooki.cloud/UserBillService/findUserBill" \
  -H "Content-Type: application/json" \
  -H "X-Edge-Access-Token: <YOUR_TOKEN>" \
  -d '{
    ...
  }'

generateAllUserBills

手工生成账单

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/UserBillService/generateAllUserBills
  • RPCrpc generateAllUserBills (GenerateAllUserBillsRequest) returns (RPCSuccess);

请求对象 (GenerateAllUserBillsRequest)

{
  "month": "string",
  "day": "string"
}

响应对象 (RPCSuccess)

{}

调用示例

curl -X POST "https://backend.dooki.cloud/UserBillService/generateAllUserBills" \
  -H "Content-Type: application/json" \
  -H "X-Edge-Access-Token: <YOUR_TOKEN>" \
  -d '{
    ...
  }'

listUserBills

列出单页账单

  • 角色:admin, user
  • HTTPPOST https://backend.dooki.cloud/UserBillService/listUserBills
  • RPCrpc listUserBills (ListUserBillsRequest) returns (ListUserBillsResponse);

请求对象 (ListUserBillsRequest)

{
  "paidFlag": "int32",
  "userId": "int64 // 用户ID",
  "month": "string",
  "offset": "int64 // 读取位置",
  "size": "int64 // 数量通常不能小于0"
}

响应对象 (ListUserBillsResponse)

{
  "userBills": "[]UserBill"
}

调用示例

curl -X POST "https://backend.dooki.cloud/UserBillService/listUserBills" \
  -H "Content-Type: application/json" \
  -H "X-Edge-Access-Token: <YOUR_TOKEN>" \
  -d '{
    ...
  }'

payUserBill

支付账单

  • 角色:admin, user
  • HTTPPOST https://backend.dooki.cloud/UserBillService/payUserBill
  • RPCrpc payUserBill(PayUserBillRequest) returns (RPCSuccess);

请求对象 (PayUserBillRequest)

{
  "userBillId": "int64"
}

响应对象 (RPCSuccess)

{}

调用示例

curl -X POST "https://backend.dooki.cloud/UserBillService/payUserBill" \
  -H "Content-Type: application/json" \
  -H "X-Edge-Access-Token: <YOUR_TOKEN>" \
  -d '{
    ...
  }'

sumUserUnpaidBills

计算用户所有未支付账单总额

  • 角色:admin, user
  • HTTPPOST https://backend.dooki.cloud/UserBillService/sumUserUnpaidBills
  • RPCrpc sumUserUnpaidBills(SumUserUnpaidBillsRequest) returns (SumUserUnpaidBillsResponse);

请求对象 (SumUserUnpaidBillsRequest)

{
  "userId": "int64 // 用户ID"
}

响应对象 (SumUserUnpaidBillsResponse)

{
  "amount": "double"
}

调用示例

curl -X POST "https://backend.dooki.cloud/UserBillService/sumUserUnpaidBills" \
  -H "Content-Type: application/json" \
  -H "X-Edge-Access-Token: <YOUR_TOKEN>" \
  -d '{
    ...
  }'