开发者文档

项目结算列表

GET/api/orgs/:orgId/settlements

权限与前置条件

当前有效工作区成员;工作区及账号必须有效。

此接口仅支持浏览器登录,不接受 API Key。Cookie 写入仍需允许来源的 Origin 和 X-Requested-With: suren360。不能同时携带 Cookie 与 API Key。所有路径参数须使用真实 ID。

请求参数

orgId · 路径参数 · 必填字符串

Query 查询参数

字段类型必填约束
pageinteger否{"default":1,"minimum":1,"maximum":9007199254740991}
pageSizeinteger否{"default":20,"minimum":1,"maximum":100}
qstring否{"default":"","maxLength":100}
projectIdstring否{"minLength":1,"maxLength":32}
contentIdstring否{"minLength":1,"maxLength":32}
statusstring否{"enum":["pending","partial","paid","reversed"]}
查看完整请求 JSON Schema
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "page": {
      "default": 1,
      "type": "integer",
      "minimum": 1,
      "maximum": 9007199254740991
    },
    "pageSize": {
      "default": 20,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "q": {
      "default": "",
      "type": "string",
      "maxLength": 100
    },
    "projectId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 32
    },
    "contentId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 32
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "partial",
        "paid",
        "reversed"
      ]
    }
  }
}

调用示例

先通过浏览器统一登录,使用受控环境中的已有会话。 请替换部署地址与示例字段,不要将凭证粘贴到聊天或日志中。

cURL · 示例占位值需替换
curl --request GET \
  'https://YOUR_DEPLOYMENT_HOST/api/orgs/YOUR_orgId/settlements' \
  --cookie "$SUREN360_COOKIE"

响应结构

成功返回 HTTP 200 的 JSON 对象。下方为响应结构定义,不是虚构的业务数据。

字段类型必填约束
itemsarray是{}
totalinteger是{"minimum":0,"maximum":9007199254740991}
pageinteger是{"minimum":0,"maximum":9007199254740991}
pageSizeinteger是{"minimum":0,"maximum":9007199254740991}
summaryobject是{"required":["incomeFen","paidFen","balanceFen"],"additionalProperties":false}
查看完整响应 JSON Schema
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "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
      }
    },
    "total": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "page": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "pageSize": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "summary": {
      "type": "object",
      "properties": {
        "incomeFen": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "paidFen": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "balanceFen": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        }
      },
      "required": [
        "incomeFen",
        "paidFen",
        "balanceFen"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "items",
    "total",
    "page",
    "pageSize",
    "summary"
  ],
  "additionalProperties": false
}
查看错误码与重试规则