跳到主要内容

POST 创建对账单

POST。body 为 JSON 对象,字段结构见接口参考。

接口编码所需范围后端接口
finance.reconciliations.createfinance:writePOST /v1/reconciliations/create(comap-finance)

必填字段

字段依据
direction接口规格
method接口规格
type接口规格
partyId接口规格
periodStart接口规格
periodEnd接口规格

条件必填(如「某状态时必填」)不在此表,以上方参数说明为准。 判定规则见必填字段的判定。

请求体字段(body)

字段类型必填说明
directionstring是对账方向 CUSTOMER/SUPPLIER
methodstring是对账方法 BY_PARTY/BY_CONTRACT/BY_ORDER/BY_SHIPMENT/BY_INVOICE/BY_BALANCE
typestring是对账类型 BALANCE/TRANSACTION/INVOICE/PAYMENT
partyIdinteger(int64)是往来单位ID
partyNamestring—往来单位名称
partyContactstring—联系人
partyPhonestring—联系电话
partyEmailstring—邮箱
partyAddressstring—地址
contractIdinteger(int64)—关联合同ID(按合同对账时)
contractNostring—合同编号
periodStartstring(date)是对账期间开始
periodEndstring(date)是对账期间结束
dataCaliber7DataCaliberDTO—对账数据口径配置
reconcileFrequencystring—对账频率 MONTHLY/QUARTERLY/SEMI_ANNUAL/ANNUAL
notestring—备注
sourceIdsinteger(int64)[]—待对账池选中的来源单据ID列表(来自待对账池分页的 sourceIds,用于占用登记)

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

请求示例

curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "Authorization: Bearer <访问令牌>" \
-H "Content-Type: application/json" \
-d '{
"apiCode": "finance.reconciliations.create",
"body": {
"direction": "string",
"method": "string",
"type": "string",
"partyId": "1961000000000000001",
"periodStart": "string",
"periodEnd": "string"
}
}'

错误处理​

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

错误码说明可重试
92101访问凭证无效否
92201接口未登记或已停用否
92202超出凭证授权范围——本接口需 finance:write否
92204绑定员工无此接口的功能权限否
92203上游服务调用失败先查询处理结果,禁止盲目重试
92301请求过于频繁是
92205写操作处理超时,结果未知(下游可能仍在执行)否,先查询确认结果
92302有参数相同的写请求正在处理中等待并确认前一次结果,勿重复提交

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

← 返回对账单