积分明细账单
POST/api/v1/credit-statements/read
按精确时间范围和客户／Entity 读取每笔余额分摊、原费率与退款；下一页必须沿用原 snapshotAt 和 nextCursor。总额按积分版本分别汇总。
SDK 0.0.1更新于
发起请求
按精确时间范围和客户／Entity 读取每笔余额分摊、原费率与退款；下一页必须沿用原 snapshotAt 和 nextCursor。总额按积分版本分别汇总。
- 调用凭据
- 服务端 API Key 或客户 Token。客户调用不能选择其他客户。
- 所需权限
credits:read
base URL 和 App ID 来自 SDK 接入页。示例使用占位值，不会执行请求。服务端 Key 不可放入浏览器。
1curl -X POST "$GROOVE_BASE_URL/api/v1/credit-statements/read" \2 -H "Authorization: Bearer $GROOVE_CUSTOMER_TOKEN" \3 -H "X-Groove-Project: $GROOVE_PROJECT_ID" \4 -H "X-Groove-Environment: sandbox" \5 -H "Content-Type: application/json" \6 -d '{7 "customerId": "00000000-0000-4000-8000-000000000001",8 "from": "2026-10-01T00:00:00Z",9 "to": "2026-11-01T00:00:00Z",10 "snapshotAt": null,11 "after": null,12 "limit": 5013}'
响应选项卡列出字段类型，不是响应示例；实际值由客户状态决定。
请求参数
JSON 请求体
fromdate-time必填本次操作的 from 值，类型和约束见字段标注。
todate-time必填本次操作的 to 值，类型和约束见字段标注。
entityIduuid可选当前客户范围内的实体 ID；只用于已配置的实体和许可功能。
snapshotAtdate-time | null必填本次操作的 snapshotAt 值，类型和约束见字段标注。
afterobject | null必填本次操作的 after 值，类型和约束见字段标注。
展开子字段
atdate-time必填本次操作的 at 值，类型和约束见字段标注。
iduuid必填本次操作的 id 值，类型和约束见字段标注。
positioninteger必填本次操作的 position 值，类型和约束见字段标注。
min: 0 · max: 9007199254740991
limitinteger必填一页返回的最大记录数量，受契约上限限制。
min: 1 · max: 100
customerIduuid可选Indiana 客户 ID。服务端从已验证身份关联；客户 Token 调用时省略并使用 Token 绑定的客户。
响应字段
成功响应包含 requestId 和 scope。结合实际业务状态或 accepted 判断操作结果；可选字段不可用时省略。
HTTP 200 · application/json
requestIduuid必填服务端生成的 HTTP 请求 UUID，排查请求时提供这个值。
scopeobject必填响应实际所属的 App 和环境。Header 只能核对，不能切换 Key 范围。
展开子字段
projectIdstring必填凭据绑定的 App ID。
minLength: 1
environmentenum必填独立数据范围：sandbox 或 live。
查看允许值
"sandbox""live"
statementobject必填本次操作的 statement 值，类型和约束见字段标注。
展开子字段
customerIduuid必填Indiana 客户 ID。服务端从已验证身份关联；客户 Token 调用时省略并使用 Token 绑定的客户。
entityIduuid | null必填当前客户范围内的实体 ID；只用于已配置的实体和许可功能。
fromdate-time必填本次操作的 from 值，类型和约束见字段标注。
todate-time必填本次操作的 to 值，类型和约束见字段标注。
snapshotAtdate-time必填本次操作的 snapshotAt 值，类型和约束见字段标注。
totalsarray必填本次操作的 totals 值，类型和约束见字段标注。
maxItems: 1000
展开子字段
creditVersionIduuid必填本次操作的 creditVersionId 值，类型和约束见字段标注。
namestring必填客户或对象的展示名称，不作为身份唯一键。
consumedstring必填本次操作的 consumed 值，类型和约束见字段标注。
pattern: ^(0|[1-9]\d{0,12})(\.\d{1,12})?$
refundedstring必填本次操作的 refunded 值，类型和约束见字段标注。
pattern: ^(0|[1-9]\d{0,12})(\.\d{1,12})?$
netstring必填本次操作的 net 值，类型和约束见字段标注。
pattern: ^-?(0|[1-9]\d{0,17})(\.\d{1,12})?$
rowsarray必填本次操作的 rows 值，类型和约束见字段标注。
maxItems: 100
展开子字段
operationIduuid必填业务操作 UUID；订阅执行引用 previewAttach 返回的 operationId，余额退款引用原消费操作。
positioninteger必填本次操作的 position 值，类型和约束见字段标注。
min: 0 · max: 9007199254740991
kindenum必填本次操作的 kind 值，类型和约束见字段标注。
查看允许值
"consume""confirm""refund"
originalIduuid | null必填本次操作的 originalId 值，类型和约束见字段标注。
occurredAtdate-time必填本次操作的 occurredAt 值，类型和约束见字段标注。
entitlementIduuid必填本次操作的 entitlementId 值，类型和约束见字段标注。
entitlementNamestring必填本次操作的 entitlementName 值，类型和约束见字段标注。
sourceIduuid必填本次操作的 sourceId 值，类型和约束见字段标注。
creditVersionIduuid必填本次操作的 creditVersionId 值，类型和约束见字段标注。
creditNamestring必填本次操作的 creditName 值，类型和约束见字段标注。
unitsobject必填本次操作的 units 值，类型和约束见字段标注。
amountstring必填积分或账本金额，按字段的十进制字符串或整数类型传入。
pattern: ^(0|[1-9]\d{0,12})(\.\d{1,12})?$
pricingarray必填本次操作的 pricing 值，类型和约束见字段标注。
maxItems: 12
展开子字段
creditVersionIduuid | null必填本次操作的 creditVersionId 值，类型和约束见字段标注。
meteredVersionIduuid必填本次操作的 meteredVersionId 值，类型和约束见字段标注。
dimensionstring必填本次操作的 dimension 值，类型和约束见字段标注。
minLength: 1 · maxLength: 64
counterKeystring必填本次操作的 counterKey 值，类型和约束见字段标注。
minLength: 1 · maxLength: 240
cycleStartdate-time必填本次操作的 cycleStart 值，类型和约束见字段标注。
unitCostobject必填本次操作的 unitCost 值，类型和约束见字段标注。
unitsobject必填本次操作的 units 值，类型和约束见字段标注。
amountstring必填积分或账本金额，按字段的十进制字符串或整数类型传入。
pattern: ^(0|[1-9]\d{0,12})(\.\d{1,12})?$
tierinteger | null必填本次操作的 tier 值，类型和约束见字段标注。
propertiesobject必填服务端校验的计价属性，用于匹配维度和倍率。
nextCursorobject | null必填下一页游标；null 表示结束。原样传回，改筛选条件时清空。
展开子字段
atdate-time必填本次操作的 at 值，类型和约束见字段标注。
iduuid必填本次操作的 id 值，类型和约束见字段标注。
positioninteger必填本次操作的 position 值，类型和约束见字段标注。
min: 0 · max: 9007199254740991
处理错误
常见失败| 错误码 | 处理方式 |
|---|
| UNAUTHENTICATED | 核对 Key，或将过期客户 Token 重新签发一次。 |
| FORBIDDEN | 核对当前 Key 权限与客户访问范围。 |
| INVALID_REQUEST | 检查字段类型、UUID、十进制字符串和互斥字段。 |
| SCOPE_MISMATCH | 使用凭据绑定的 App 和环境。 |
常见失败
UNAUTHENTICATED
- 处理方式
- 核对 Key，或将过期客户 Token 重新签发一次。
FORBIDDEN
- 处理方式
- 核对当前 Key 权限与客户访问范围。
INVALID_REQUEST
- 处理方式
- 检查字段类型、UUID、十进制字符串和互斥字段。
SCOPE_MISMATCH
- 处理方式
- 使用凭据绑定的 App 和环境。
相关:完整请求与错误约定·返回接口索引