合同履约信息更新 - 甄零开放平台

请求参数

Header 参数

Authorization

string

可选

默认值:

Body 参数application/json

id

string

合同主键id

可选

合同主键必输（id/otherSourceReceipt/contractSerialNumber三选一）; otherSourceReceipt和source_system两个参数要同时存在

otherSourceReceipt

string

第三方系统合同主键

可选

sourceSystem

string

来源系统

可选

contractSerialNumber

string

合同流水号

可选

performanceState

string

履约状态

必需

OC.AGREEMENT_STATUS/独立值集（NotPerformance未履约、partialPerformance/部分履约、completePerformance/履约完成）

thirdChangeFreezeFlag

boolean

三方系统变更冻结

必需

false否，true是

executedAmount

integer

已履约金额

必需

传输合同对应的已付款/已收款金额的汇总金额；如外部系统传输的已履约金额大于当前合同头总金额，则返回报错【已履约金额不得大于合同总金额！】如外部系统传输的已履约金额为空，则忽略该字段的更新；

contractLineList

array [object {3}]

合同标的行表

可选

合同标的行表

id

integer

合同标的行id

可选

id 或者 sourceKey 两者至少一个不能为空

sourceKey

string

第三方主键

可选

executedQuantity

integer

已履约数量

可选

传输对应合同标的行的已发货/收货数量，当存在同一标的行多次发货/收货时，则传输对应标的行汇总发货/收货数量（接收退货需进行汇总）；如外部系统传输的已履约数量大于当前合同标的行数量，返回报错【已履约数量不得大于合同标的行数量！】如外部系统传输的已履约数量为空，则忽略该字段的更新；

contractPaySettlementList

array [object {3}]

合同付款计划结算行表

必需

id

string

合同付款计划结算行id

可选

id 或者 sourceKey 两者至少一个不能为空

sourceKey

string

第三方主键

可选

settlementAmount

string

结算金额

必需

传输对应合同付款计划结算行的已付款金额，当存在同一付款计划结算行多次付款时，则传输对应付款计划行汇总付款金额；如外部系统传输的付款结算金额大于当前付款计划行的计划付款金额，返回报错【结算金额不得大于计划付款行金额！】如外部系统传输的结算金额为空，则忽略该字段的更新；

contractReceiveSettlementList

array [object {3}]

必需

id

string

合同收款计划结算行id

可选

id 或者 sourceKey 两者至少一个不能为空

sourceKey

string

第三方主键

可选

settlementAmount

string

结算金额

必需

传输对应合同收款计划结算行的已收款金额，当存在同一收款计划结算行多次收款时，则传输对应收款计划行汇总收款金额；如外部系统传输的收款结算金额大于当前收款计划行的计划收款金额，返回报错【结算金额不得大于计划收款行金额！】如外部系统传输的结算金额为空，则忽略该字段的更新；

示例

{
    "id": "320190341213661766",
    "performanceState": "partialPerformance",
    "thirdChangeFreezeFlag": true,
    "executedAmount": 200,
    "contractLineList": [
        {
            "id": 4063151,
            "executedQuantity": 1
        }
    ]
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://oc-test.onecontract-cloud.com/api/hitf/v2/rest/async/invoke/OC_PERFORMANCE_UPDATE' \
--header 'Authorization: bearer eb2446a6-93f9-456b-b713-5cb6f6adf765' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": "320190341213661766",
    "performanceState": "partialPerformance",
    "thirdChangeFreezeFlag": true,
    "executedAmount": 200,
    "contractLineList": [
        {
            "id": 4063151,
            "executedQuantity": 1
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

object {0}

示例

{}