开发者文档
作品结算明细
GET
/api/orgs/:orgId/settlements/:id权限与前置条件
当前有效工作区成员；工作区及账号必须有效。
此接口仅支持浏览器登录，不接受 API Key。Cookie 写入仍需允许来源的 Origin 和 X-Requested-With: suren360。不能同时携带 Cookie 与 API Key。所有路径参数须使用真实 ID。
请求参数
orgId · 路径参数 · 必填字符串
id · 路径参数 · 必填字符串
Query 查询参数
无额外字段；联合结构请查看完整定义。
查看完整请求 JSON Schema
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {},
"additionalProperties": false
}调用示例
先通过浏览器统一登录，使用受控环境中的已有会话。 请替换部署地址与示例字段，不要将凭证粘贴到聊天或日志中。
cURL · 示例占位值需替换
curl --request GET \
'https://YOUR_DEPLOYMENT_HOST/api/orgs/YOUR_orgId/settlements/YOUR_id' \
--cookie "$SUREN360_COOKIE"响应结构
成功返回 HTTP 200 的 JSON 对象。下方为响应结构定义，不是虚构的业务数据。
| 字段 | 类型 | 必填 | 约束 |
|---|---|---|---|
charges | array | 是 | {} |
settlement | object | 是 | {"required":["id","organizationId","projectId","creatorId","walletId","contentId","projectName","creatorName","title","platform","contentUrl","amountFen","paidFen","pendingFen","status","confirmedByName","createdAt","reversedAt","reversedByName","reversalReason"],"additionalProperties":false} |
payments | array | 是 | {} |
查看完整响应 JSON Schema
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"charges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 32
},
"kind": {
"type": "string",
"enum": [
"settlement",
"settlement_addition"
]
},
"amountFen": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"note": {
"type": "string"
},
"actorName": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
}
},
"required": [
"id",
"kind",
"amountFen",
"note",
"actorName",
"createdAt"
],
"additionalProperties": false
}
},
"settlement": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 32
},
"organizationId": {
"type": "string",
"minLength": 1,
"maxLength": 32
},
"projectId": {
"type": "string",
"minLength": 1,
"maxLength": 32
},
"creatorId": {
"type": "string",
"minLength": 1,
"maxLength": 32
},
"walletId": {
"type": "string",
"minLength": 1,
"maxLength": 32
},
"contentId": {
"type": "string",
"minLength": 1,
"maxLength": 32
},
"projectName": {
"type": "string"
},
"creatorName": {
"type": "string"
},
"title": {
"type": "string"
},
"platform": {
"type": "string"
},
"contentUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amountFen": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"paidFen": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"pendingFen": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"status": {
"type": "string",
"enum": [
"pending",
"partial",
"paid",
"reversed"
]
},
"confirmedByName": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"reversedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
{
"type": "null"
}
]
},
"reversedByName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"reversalReason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"organizationId",
"projectId",
"creatorId",
"walletId",
"contentId",
"projectName",
"creatorName",
"title",
"platform",
"contentUrl",
"amountFen",
"paidFen",
"pendingFen",
"status",
"confirmedByName",
"createdAt",
"reversedAt",
"reversedByName",
"reversalReason"
],
"additionalProperties": false
},
"payments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 32
},
"amountFen": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"note": {
"type": "string"
},
"createdByName": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"reversedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
{
"type": "null"
}
]
},
"reversedByName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"reversalReason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"allocations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"settlementId": {
"type": "string",
"minLength": 1,
"maxLength": 32
},
"title": {
"type": "string"
},
"projectName": {
"type": "string"
},
"amountFen": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"settlementId",
"title",
"projectName",
"amountFen"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"amountFen",
"note",
"createdByName",
"createdAt",
"reversedAt",
"reversedByName",
"reversalReason",
"allocations"
],
"additionalProperties": false
}
}
},
"required": [
"charges",
"settlement",
"payments"
],
"additionalProperties": false
}