合同详情接口
业务场景说明
单据详情接口,无法查询到已删除单据信息。
接口说明
请求方式
GET
接口地址
接口地址中的{formCode}为单据查询列表中的formCode,单据唯一标识码。
/api/openapi/form/contract/{formCode}
请求参数说明
无参数,URL中 {formCode} 需替换为您所需要查询的单据的单据号。 若需要合同明细数据(默认不返回),需要在URL拼接 ?needExpense=true,
响应参数说明
在相应参数中,具有特殊类型字段,如AmountInput、AmountInput、AttachInput等,该部分的类型字段的数据结构请查看数据类型说明。
字段名称 | 字段类型 | 必有 | 字段说明 |
---|---|---|---|
formDataCode | String(100) | 是 | 单据号(单据内码) |
formCode | String(100) | 是 | 单据号 |
formSubTypeBizCode | String | 是 | 单据小类编码 |
formSubTypeName | String | 是 | 单据小类名称 |
contractName | String | 是 | 合同名称 |
contractNum | String | 是 | 合同编号 |
responsibleUsers | List<ResponsibleUser> | 是 | 业务经办人列表 |
legalEntityBizCode | String | 否 | 公司抬头 |
legalEntityName | String | 否 | 公司抬头 |
departmentBizCode | String | 是 | 部门业务编码 |
departmentName | String | 是 | 部门Name |
comments | String | 否 | 备注 |
submittedAt | Long | 否 | 最新一次提单时间 |
amount | AmountInput | 是 | 合同金额 |
waitPayAmount | AmountInput | 否 | 待支付金额 |
payingAmount | AmountInput | 否 | 支付中金额 |
paidAmount | AmountInput | 否 | 已支付金额 |
nonReceiptAmount | AmountInput | 否 | 未到票金额 |
processingReceiptAmount | AmountInput | 否 | 流程中到票金额 |
completeReceiptAmount | AmountInput | 否 | 已到票金额 |
formStatus | String | 是 | 单据状态 |
approvedAt | Long | 否 | 审批通过时间 |
approvedAmount | AmountInput | 否 | 审批通过金额 |
tradingPartnerBizCode | String | 否 | 往来单位code |
tradingPartnerParentBizCode | String | 否 | 当前往来单位的上一级分类的编码 |
tradingPartnerName | String | 否 | 往来单位名称 |
reimburse | List<string> | 否 | 关联的报销单 |
consumeApplications | List<string> | 否 | 关联的申请单 |
paymentPlans | PaymentPlanInput | 否 | 付款计划 |
reimburseDtoList | List<ReimburseDto> | 否 | 实际执行情况 |
balances | List<BalanceDto> | 否 | 剩余情况 |
procurementDetails | ProcurementDetailInput | 否 | 采购明细 |
createdAt | Long | 是 | 单据创建时间 |
customObject | customObject | 是 | 自定义字段Map集合(表单的“控件”列所有组件) |
beforeChangeFormCode | String | 否 | 变更前的合同的FormCode |
detailTotalAmount | Map<String, List<OpenApiTotalAmountDataDto>> | 否 | 明细组件下的金额组件的总金额(计算后的)(C级字段) |
tagList | List<OpenApiDynaTagDataDto> | 是 | 标签列表 |
contractCcy | String | 否 | 合同币种 |
contractDateDto | ContractDateDto | 否 | 合同日期 |
contractNature | String | 是 | 合同性质 |
associatedExternalFormList | List<OpenApiExternalFormAssociationDto> | 否 | 关联外部单据对象列表 |
associatedForms | List<AssociationFormDto> | 否 | 关联单据对象列表 |
contractExpense | List<ContractDetailListInput> | 否 | 合同明细 |
payeeAccount | AccountInput | 否 | 收款账户 |
参数示例
{
"formDataCode":"CTD23309193540802593",
"formCode":"MK23050012",
"contractNum":"001",
"formSubTypeBizCode":"FT210916YUTV3I8",
"formSubTypeName":"合同",
"contractName":"合同单据",
"responsibleUsers":[
{
"userCode":"UI11111111",
"userName":"张三",
"userEmployeeNo":"Mk0001",
"userSourceId":null
}
],
"departmentBizCode":"dept001",
"departmentName":"财务管理部",
"comments":null,
"submittedAt":1683876433172,
"amount":{
"currency":"CNY",
"amount":2000,
"amountStr":"2000.00"
},
"waitPayAmount":{
"currency":"CNY",
"amount":2000,
"amountStr":"2000.00"
},
"payingAmount":{
"currency":"CNY",
"amount":0,
"amountStr":"0.00"
},
"paidAmount":{
"currency":"CNY",
"amount":0,
"amountStr":"0.00"
},
"nonReceiptAmount": {
"currency": "CNY",
"amount": 0.00,
"amountStr": "0.00"
},
"processingReceiptAmount": {
"currency": "CNY",
"amount": 0.00,
"amountStr": "0.00"
},
"completeReceiptAmount": {
"currency": "CNY",
"amount": 0.00,
"amountStr": "0.00"
},
"formStatus":"APPROVING",
"approvedAt":1684498406006,
"approvedAmount":{
"currency":"CNY",
"amount":2000,
"amountStr":"2000.00"
},
"tradingPartnerBizCode":"TRP23306451919312966",
"tradingPartnerParentBizCode":"TRP2109121UJ2K5TS",
"tradingPartnerName":"测试往来单位",
"legalEntityBizCode":"101",
"legalEntityName":"公司抬头名称",
"reimburse":[
],
"consumeApplications":[
],
"paymentPlans":{
"periodNo": 1,
"code": "PPI33640836371585068",
"paymentRatio": 2000.00,
"paymentAmount": {
"currency": "CNY",
"amount": 2000.00,
"amountStr": "2000.00"
},
"expectTime": 1634004910189,
"customObject": {
"CF471": null
},
"paymentPlanExpenseTypeList":[
{
"bizSuffixCode":"01.005",
"expenseTypeName":"火车"
}
]
},
"reimburseDtoList": [
{
"formStatus": "COMPLETED",
"statusText": "已完成",
"approvedAmount": {
"amount": 600.00,
"currency": "CNY",
"customExchangeRate": 1,
"amountStr": "¥600.00"
},
"ratio": 1.01,
"procEndTime": 1634004910189,
"paymentPlanCode": null
}
],
"balances": [
{
"paymentPlanCode": null,
"balanceAmount": {
"amount": 1400.00,
"currency": "CNY",
"customExchangeRate": 1,
"amountStr": "¥1400.00"
}
},{
"paymentPlanCode": "PPI33640836371585068",
"balanceAmount": {
"amount": 2000.00,
"currency": "CNY",
"customExchangeRate": 1,
"amountStr": "¥2000.00"
}
}
],
"procurementDetails":{
"code": "PDC33640836289797176",
"commodityName": "测试",
"specifications": "",
"quantity": 10.000000,
"unit": "KG",
"unitPrice": {
"currency": "CNY",
"amount": 0.00,
"amountStr": "0.00"
},
"totalAmount": {
"currency": "CNY",
"amount": 2000.00,
"amountStr": "2000.00"
},
"customObject": {}
},
"createdAt":1683617089614,
"payeeAccount":null,
"customObject":{
"CF257":2,
"CF134":null
},
"formAssociatedList":null,
"beforeChangeFormCode":null,
"detailTotalAmount":{
},
"tagList":[
],
"contractCcy":"CNY",
"contractDateDto":{
"startDate":1688140800000,
"endDate":1690819200000
},
"associatedExternalFormList":[
{
"formDataCode":"EFD23120411ZJUY9S",
"formCode":"mk001",
"formName":"外部单据001",
"submittedAt":1600570132000,
"formAmount":{
"amount":91.1,
"currency":"CNY",
"customExchangeRate":1,
"amountStr":"¥91.10"
},
"submitUser":"knight"
},
{
"formDataCode":"EFD23120411ZJVAWW",
"formCode":"mk002",
"formName":"外部单据002",
"submittedAt":1600570132000,
"formAmount":{
"amount":0,
"currency":"CNY",
"customExchangeRate":1,
"amountStr":"¥0.00"
},
"submitUser":null
}
],
"associatedForms":[
{
"formType":"LOAN",
"formSubTypeName":"借款单(支持申请生成)",
"formSubTypeCode":"FT2202181P280KJK",
"formSubTypeBizCode":"FT2202181P280KJK",
"formCode":"MK23050271"
},
{
"formType":"LOAN",
"formSubTypeName":"借款单(支持申请生成)",
"formSubTypeCode":"FT2202181P280KJK",
"formSubTypeBizCode":"FT2202181P280KJK",
"formCode":"MK23050267"
}
]
}
更新记录
2024-10-08:新增字段 到票金额、执行情况
2023-12-12:新增字段 填单人姓名、填单人工号
2023-12-22:新增字段 合同性质