跳到主要内容

POST 经营总览

POST 查询。body 为筛选条件 JSON(分页类含 pageNum、pageSize)。

接口编码所需范围后端接口
finance.report.overviewfinance:readPOST /v1/report/overview(comap-finance)

请求体字段(body)

字段类型必填说明
startMonthstring—起始月份 yyyy-MM
endMonthstring—结束月份 yyyy-MM
startDatestring—起始日期 yyyy-MM-dd
endDatestring—结束日期 yyyy-MM-dd
monthsinteger(int32)—最近几个月(与 startMonth/endMonth 二选一)
deptIdinteger(int64)—部门ID(人力资源支出查询)

「必填」仅反映接口规格声明的部分。服务内还有未体现在规格里的校验, 标「—」不等于可以不传;租户在主站配置的字段必填不约束本接口。 详见必填字段的判定与字段清单与自定义字段。

请求示例

curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "Authorization: Bearer <访问令牌>" \
-H "Content-Type: application/json" \
-d '{
"apiCode": "finance.report.overview",
"body": {}
}'

响应 data 字段

字段类型必填说明
asOfDatestring—统计截止日 yyyy-MM-dd
balanceUpdatedAtstring—资产负债最近更新时间 yyyy-MM-dd
kpi34FinanceOverviewKpiVO—经营总览核心指标
profitOverview9ProfitOverviewVO—财务报告利润总览
balanceSheet15BalanceSheetVO—资产负债表汇总
companyPayables16CompanyPayablesSummaryVO—公司应付 / 借款统一统计摘要
operatingBalanceTrend5OperatingBalanceTrendItemVO[]—经营余额月度趋势(应收/应付/库存/净营运资金)
businessAmountSummary8BusinessAmountSummaryItemVO[]—业务金额总览(销售/采购的订单/合同/回款付款)
receivableAgingData3ReceivableAgingItemVO[]—应收账龄分布
capitalOccupation2CapitalOccupationItemVO[]—资金占用结构
overdueCustomers3OverdueCustomerVO[]—逾期客户明细
highInventoryItems3HighInventoryItemVO[]—高库存物料
loanedInventoryItems21LoanedInventoryItemVO[]—借出库存明细(COMAP-3538);无数据或降级时为空
upcomingPayables4UpcomingPayableVO[]—即将到期应付
pendingAdvancePayments3PendingAdvancePaymentVO[]—待核销预付款
contractSigningHistory5ContractSigningHistoryVO[]—合同签约月度趋势
degradedSourcesstring[]—不可用的上游数据源

错误处理​

响应统一信封 { code, message, data },code == 200 为成功。以下是本接口可能返回的开放平台层错误:

错误码说明可重试
92101访问凭证无效否
92201接口未登记或已停用否
92202超出凭证授权范围——本接口需 finance:read否
92204绑定员工无此接口的功能权限否
92203上游服务调用失败是
92301请求过于频繁是

除此之外,comap-finance 自身的业务校验失败会原样透传其业务码与提示 (如字段校验、状态不允许、数据不存在),这类码不在开放平台的号段内, 以响应里的 message 为准。完整的平台层错误码见错误码说明。

← 返回财务报表