导入公司合同接口
接口说明
接口地址:/gys/gems-web-api/contract/saveOrgContract
接口用途:导入公司层合同接口
提交方式:POST
请求参数:JSON格式字符串
说明:
1、单次条数不超过10条;
重点说明
一、集成合同有以下两种场景:
1、在推送合同的时候,合同中的材料和合作单位已经同步到【广联达云平台】的基础数据中:
需要重点关注:合同中材料和合作单位的三方id必须和已经推送过来的材料和合作单位的三方id保持一致。
2、在推送合同的时候,合同中的材料和合作单位没有【广联达云平台】的基础数据中:此时,该接口会自动将合同中的材料和合作单位同步到项目管理平台的基础数据中:
需要重点关注:
a、在项目管理平台的【集成管理】-【数据集成】模块中,添加了材料和合作单位的数据源,并且这两个数据源的接入状态和分发状态都必须“启用”,否则,会导致合同推送失败。
b、合同接口中材料和合作单位的相关参数必须正确
二、orgId的获取
调用“获取公司信息接口”可以得到导入合同接口所需要的orgId参数值;详见获取公司信息接口
三、originQuantity的使用:
当补充协议需要对主合同相同材料的数量进行变更时,会使用originQuantity,分为以下两种场景:
1、主合同下钢筋的quantity=50,补充协议下钢筋的originQuantity=0,quantity=30 表示材料量的新增,钢筋的总量为两个合同的累加=80
2、主合同下钢筋的quantity=50,补充协议下钢筋的originQuantity=50,quantity=30 表示材料量的更新,钢筋的总量为补充协议变更后数量=30
请求参数
合同主表属性
参数 | 类型 | 必须 | 取值范围(字符长度) | 默认值 | 描述 |
---|---|---|---|---|---|
orgId | Long | Y | 20 | 公司层orgId获取公司信息接口 | |
optFlag | int | Y | 0,2 | 操作。新增或修改:0,删除:2 | |
serialNumber | String | Y | 64 | 单据编号 | |
signDate | Date | Y | 签约日期 格式(yyyy-MM-dd) | ||
purchaseType | String | Y | 64 | 采购类型(集采,自采) | |
code | String | Y | 64 | 合同编号 | |
name | String | Y | 64 | 合同名称 | |
unitId | String | Y | 100 | 第三方合同id | |
partyAId | Long | N | 20 | 甲方ID (GYS系统的ID,可以不传) | |
partyAName | String | Y | 255 | 甲方名称 | |
partyBId | Long | N | 20 | 乙方ID(广联达系统的ID,可以不传,会根据三方ID自动补全) | |
partyBName | String | Y | 255 | 乙方名称 | |
partyBCreditCode | String | N | 255 | 第三方供应商的统一社会信用代码(如果供应商未提前上传,则该字段必填) | |
partyUnitId | String | Y | 100 | 第三方供应商id(第三方乙方id) | |
unitPid | String | N | 100 | 第三方合同父id | |
materialCatalog | String | N | 200 | 材料类别 | |
agreementTypeCode | String | N | 100 | 补充协议类型编码 | |
agreementType | String | N | 100 | 补充协议类型标识 | |
paymentMethod | String | N | 255 | 付款方式(后期结算,直接付款) | |
money | BigDecimal | N | 19 | 合同金额 | |
moneyUnit | String | N | 64 | 金额单位 | |
remark | String | N | 255 | 备注 | |
contractType | String | N | 64 | 合同类型(材料采购/设备租赁/周材租赁) | |
calculateType | String | N | 64 | 计量方式(过磅计量/理论计量/点数计量) | |
supplyType | String | N | 64 | 供货模式(甲供/已供) | |
allowed | Boolean | N | 是否允许过磅(允许:true,不允许:false) | ||
contractForm | String | N | 64 | 合同形式 | |
effectiveDate | Date | N | 生效日期 | ||
statusType | Integer | N | 10 | 1 | 合同状态:-1废除,1履约,2中止,4终止,8已完成(不传值默认为履约) |
calculateStandard | Integer | N | 8 | 计量基准:1供方量,2实际收获量 | |
calculateDeviation | BigDecimal | N | 19,2 | 计量偏差 | |
extend | String | N | 扩展字段,json |
contractMaterialVoList 合同材料细表属性
参数 | 类型 | 必须 | 取值范围(字符长度) | 默认值 | 描述 |
---|---|---|---|---|---|
materialId | Long | Y | 20 | 若materialType为0(材料),取值材料ID;若materialType为1(材料类别),取值材料类别ID;若materialType为2(其他方式),可不传 ;广联达材料ID,不知道可传默认值:-1 | |
code | String | Y | 64 | 若materialType为0(材料),取值材料编码;若materialType为1(材料类别),取值材料类别编码;若materialType为2(其他方式),可不传; | |
name | String | Y | 128 | 若materialType为0(材料),取值材料名称;若materialType为1(材料类别),取值材料类别名称; | |
unitId | String | Y | 100 | 第三方合同材料行ID(第三方系统合同材料行ID) | |
unitPid | String | Y | 100 | 第三方合同ID | |
unitMaterialId | String | Y | 100 | 第三方材料id | |
materialType | Integer | N | 4 | 材料类型 0:材料;1:材料类别 | |
specification | String | N | 255 | 材料规格型号 | |
texture | String | N | 256 | 材质 | |
materialUnitId | Long | N | 20 | 材料单位ID | |
materialUnit | String | N | 45 | 材料单位 | |
originQuantity | BigDecimal | N | 19,5 | 材料变更前数量(适用于补充协议进行材料数量变更,详情见上方重点说明二) | |
quantity | BigDecimal | N | 19,5 | 材料数量 | |
materialBrand | String | N | 255 | 材料品牌 | |
moneyUnit | String | N | 20 | 货币单位 | |
includingTaxPrice | BigDecimal | N | 9,2 | 材料含税单价 | |
taxRate | BigDecimal | N | 9,2 | 税率 | |
moneyIncludingTax | BigDecimal | N | 19,2 | 含税金额 | |
excludingTaxPrice | BigDecimal | N | 9,2 | 材料无税单价 | |
moneyExcludingTax | BigDecimal | N | 19,2 | 无税金额 | |
taxAmount | BigDecimal | N | 19,2 | 税额 | |
remark | String | N | 255 | 备注 | |
referBizCode | String | N | 64 | 材料参考来源业务编码 | |
referId | Long | N | 20 | 参考来源ID | |
referSerialNumber | String | N | 64 | 参考来源单据编号 | |
unitDetailParentId | String | N | 100 | 第三方父明细Id | |
conversion | String | N | 255 | 转换系数 | |
conversionType | String | N | 32 | 换算规范 | |
extend | String | N | 扩展字段,json |
注:转换系数(conversion)的格式:[{ baseUnit:'米', baseUnitQuantity:1, targetUnit:'吨', targetUnitQuantity:1.12 }]
contractOtherFeeVoList 合同附加费细表属性
参数 | 类型 | 必须 | 取值范围(字符长度) | 默认值 | 描述 |
---|---|---|---|---|---|
code | String | Y | 64 | 费用编码 | |
name | String | Y | 128 | 费用名称 | |
unitId | String | Y | 100 | 第三方附加费行id(第三方系统Id) | |
unitPid | String | Y | 100 | 第三方合同ID | |
unit | String | N | 255 | 单位 | |
quantity | BigDecimal | N | 19,5 | 数量 | |
moneyUnit | String | N | 45 | 货币单位 | |
includingTaxPrice | BigDecimal | N | 9,2 | 含税单价 | |
taxRate | BigDecimal | N | 9,2 | 税率 | |
moneyIncludingTax | BigDecimal | N | 19,2 | 含税金额 | |
excludingTaxPrice | BigDecimal | N | 9,2 | 无税单价 | |
moneyExcludingTax | BigDecimal | N | 19,2 | 无税金额 | |
taxAmount | BigDecimal | N | 19,2 | 税额 | |
remark | String | N | 255 | 备注 |
请求参数示例格式:
[
{
"serialNumber":"A00001", --单据编号
"signDate":"2019-03-05", --签约日期
"purchaseType":"集采", -- 采购类型
"code":"WTHT20171024001-050", -- 合同编号
"name":"配砖合同(旭明)", -- 合同名称
"materialCatalog":"砖", --材料类别
"partyAId":null, --甲方ID
"partyAName":"狼图腾有限公司", --甲方名称
"partyBId":null, --乙方ID
"partyBName":"重庆市新兴有限公司", -- 乙方名称
"partyBCreditCode":"统一社会信用代码1", --统一社会信用代码
"paymentMethod":"后期结算", --付款方式
"money":50000, --合同金额
"moneyUnit":"元", --金额单位
"remark":"合同备注信息",
"orgId":11111, --公司层orgId
"contractType":"材料采购",-- 合同类型
"calculateType":"过磅计量", --计量方式
"supplyType":"甲供", --供货模式
"unitId":"123", -- 第三方合同id
"agreementTypeCode": "zlzx", -- 补充协议类型编码 增量增项编码
"agreementType": "增量增项", -- 补充协议类型显示值 增量增项
"partyUnitId":"dsf001", --第三方供应商id(第三方乙方id)
"allowed":true, -- 是否允许过磅
"statusType":1, --合同状态,1履约
"calculateStandard":1,-- 计量基准:1供方量,2实际收获量
"calculateDeviation":0.03,-- 计量偏差
"effectiveDate": "2019-03-05", -- 生效日期
"extend":"",-- 扩展字段,json
"optFlag":0, -- 新增
"contractMaterialVoList": [
{
"materialType":0,
"materialId":-1, --材料ID
"unitMaterialId":"14", --第三方材料id
"code":"2041300400200002", --材料编码
"texture":"材质", --材质
"name":"螺纹钢", --材料名称
"specification":"规格03", --材料规格型号
"materialUnitId":null, --材料单位ID
"materialUnit":"匹", -- 材料单位
"originQuantity":0, -- 材料变更前数量
"quantity":100, -- 材料数量
"materialBrand":"首钢品牌123",
"moneyUnit":"元", --货币单位
"includingTaxPrice":10.6, -- 材料含税单价
"taxRate":0.52, -- 税率
"moneyIncludingTax":10600, --含税金额
"excludingTaxPrice":9, -- 材料无税单价
"moneyExcludingTax":9000, -- 无税金额
"taxAmount":1600, --税额
"remark":"材料备注",
"referBizCode":null, --材料参考来源业务编码
"referId":1, --参考来源ID
"referSerialNumber":"abc", --参考来源单据编号
"unitId":"1421333", -- 第三方合同材料ID(第三方系统Id)
"unitPid":"123", --第三方合同ID
"unitDetailParentId": "123", -- 补充协议明细的父明细Id
"extend":"",-- 扩展字段,json
"conversion":"[{baseUnit:'匹',baseUnitQuantity:1,targetUnit:'KG',targetUnitQuantity:0.53}]", -- 转换系数
"conversionType":"1匹=0.53KG" --换算规范
}
],
"contractOtherFeeVoList": [
{
"code":"2041300400200002", --费用编码
"name":"60m汽车泵", --费用名称
"unit":"立方米", -- 单位
"quantity":100, -- 数量
"moneyUnit":"万元", --货币单位
"includingTaxPrice":10.6, -- 含税单价
"taxRate":0.52, -- 税率
"moneyIncludingTax":10600, --含税金额
"excludingTaxPrice":9, -- 无税单价
"moneyExcludingTax":9000, -- 无税金额
"taxAmount":1600, --税额
"remark":"备注",
"unitPid":"123", --第三方合同id
"unitId":"123" --第三方费用项行ID
}
]
},
{
"serialNumber":"A00002", --单据编号
"signDate":"2019-03-05", --签约日期
"purchaseType":"集采", -- 采购类型
"code":"WTHT20171024001-051", -- 合同编号
"name":"配砖合同(旭明)", -- 合同名称
"materialCatalog":"砖", --材料类别
"partyAId":null, --甲方ID
"partyAName":"狼图腾有限公司", --甲方名称
"partyBId":null, --乙方ID
"partyBName":"重庆市新兴有限公司", -- 乙方名称
"partyBCreditCode":"统一社会信用代码2", --统一社会信用代码
"paymentMethod":"后期结算", --付款方式
"money":50000, --合同金额
"moneyUnit":"元", --金额单位
"remark":"合同备注信息",
"orgId":11111, --公司层orgId
"contractType":"材料采购",-- 合同类型
"calculateType":"过磅计量", --计量方式
"effectiveDate": "2019-03-05", -- 生效日期
"supplyType":"甲供", --供货模式
"unitId":"1234", -- 第三方合同id
"agreementTypeCode": "zlzx", -- 补充协议类型编码 增量增项编码
"agreementType": "增量增项", -- 补充协议类型显示值 增量增项
"partyUnitId":"dsf001", --第三方供应商id(第三方乙方id)
"statusType":1, --合同状态,1履约
"allowed":true, -- 是否允许过磅
"contractMaterialVoList": [
{
"materialType":0,
"materialId":-1, --材料ID
"unitMaterialId":"14", --第三方材料id
"code":"2041300400200002", --材料编码
"texture":"材质", --材质
"name":"螺纹钢", --材料名称
"specification":"规格03", --材料规格型号
"materialUnitId":null, --材料单位ID
"materialUnit":"匹", -- 材料单位
"originQuantity":0, -- 材料变更前数量
"quantity":100, -- 材料数量
"materialBrand":"首钢品牌123",
"moneyUnit":"元", --货币单位
"includingTaxPrice":10.6, -- 材料含税单价
"taxRate":0.52, -- 税率
"moneyIncludingTax":10600, --含税金额
"excludingTaxPrice":9, -- 材料无税单价
"moneyExcludingTax":9000, -- 无税金额
"taxAmount":1600, --税额
"remark":"材料备注",
"referBizCode":null, --材料参考来源业务编码
"referId":1, --参考来源ID
"referSerialNumber":"abc", --参考来源单据编号
"unitId":"1421333", -- 第三方合同材料ID(第三方系统Id)
"unitPid":"1234", --第三方合同ID
"unitDetailParentId": "123", -- 补充协议明细的父明细Id
"conversion":"[{baseUnit:'匹',baseUnitQuantity:1,targetUnit:'KG',targetUnitQuantity:0.53}]", -- 转换系数
"conversionType":"1匹=0.53KG" --换算规范
}
]
}
]
返回结果:
{
"data" : {
"successList" : [ {
"allowed" : true, -- 是否允许过磅
"approvalStatus" : 4, -- 合同状态编码
"approvalStatusDesc" : "已生效", -- 合同状态
"calculateType" : "过磅计量", --计量方式
"code" : "WTHT20171024001-050", -- 合同编号
"contractType" : "材料采购", -- 合同类型
"guid" : "PURCHASECONTRACT##9459c8cf-7a56-4473-9eb1-a4d94eb5588b",
"id" : 231587448139776, -- 合同id
"isDeleted" : false, -- 是否作废
"lastModifyTime" : 1553857084414, -- 最后修改时间
"materialCatalog" : "砖", --材料类别
"money" : 50000, --合同金额
"moneyUnit" : "元", --金额单位
"name" : "配砖合同(旭明)", -- 合同名称
"orgId" : 229546816258048,
"partyAName" : "狼图腾有限公司", --甲方名称
"partyBId" : 1473803877, --乙方ID
"partyBName" : "重庆市新兴有限公司", -- 乙方名称
"partyBCreditCode":"统一社会信用代码1", --统一社会信用代码
"partyUnitId" : "dsf001", --第三方供应商id(第三方乙方id)
"paymentMethod" : "后期结算", --付款方式
"projectId" : 229546816278528, -- 项目id
"purchaseType" : "集采", -- 采购类型
"remark" : "合同备注信息",
"serialNumber" : "A00000001", -- 单据编号
"signDate" : "2019-03-05", --签约日期
"supplyType" : "甲供", --供货模式
"orgId":11111, --公司层orgId
"unitId" : "123", -- 第三方合同id
"statusType":1, --合同状态,1履约
"contractMaterialVoList" : [ {
"code" : "2041300400200002", --材料编码
"contractId" : 231587448139776, --合同id
"conversion" : "[{baseUnit:'匹',baseUnitQuantity:1,targetUnit:'KG',targetUnitQuantity:0.53}]",-- 转换系数
"conversionType" : "1匹=0.53KG", --换算规范
"excludingTaxPrice" : 9, -- 材料无税单价
"id" : 231587448139777, -- 合同材料id
"includingTaxPrice" : 10.6, -- 材料含税单价
"lastModifyTime" : 1553857084415,
"materialBrand" : "首钢品牌", -- 材料品牌
"materialId" : 5265619, --材料ID
"materialUnit" : "匹", -- 材料单位
"moneyExcludingTax" : 9000, -- 无税金额
"moneyIncludingTax" : 10600, --含税金额
"moneyUnit" : "元", --货币单位
"name" : "螺纹钢", --材料名称
"orgId" : 229546816258048,
"originQuantity":0, -- 材料变更前数量
"quantity" : 100, -- 材料数量
"referId":1, --参考来源ID
"referSerialNumber":"abc", --参考来源单据编号
"remark" : "材料备注",
"specification" : "规格03", -材料规格型号
"taxAmount" : 1600, --税额
"taxRate" : 0.52, -- 税率
"texture" : "材质", --材质
"unitId" : "1421333", -- 第三方合同材料ID(第三方系统Id)
"unitMaterialId" : "2040300000000000", --第三方材料id
"unitDetailParentId": "123", -- 补充协议明细的父明细Id
"unitPid" : "123" --第三方合同ID
} ],
"contractOtherFeeVoList": [ {
"code":"2041300400200002", --费用编码
"name":"60m汽车泵", --费用名称
"unit":"立方米", -- 单位
"quantity":100, -- 数量
"moneyUnit":"万元", --货币单位
"includingTaxPrice":10.6, -- 含税单价
"taxRate":0.52, -- 税率
"moneyIncludingTax":10600, --含税金额
"excludingTaxPrice":9, -- 无税单价
"moneyExcludingTax":9000, -- 无税金额
"taxAmount":1600, --税额
"remark":"备注",
"unitPid":"123", --第三方合同id
"unitId":"123" --第三方费用项行ID
}]
} ],
"errorList" : [ {
"allowed" : true, -- 是否允许过磅
"calculateType" : "过磅计量", --计量方式
"code" : "WTHT20171024001-050", -- 合同编号
"contractType" : "材料采购", -- 合同类型
"errMsg" : "根据项目同步编码没有找到对应的项目id", -- 失败的原因
"materialCatalog" : "砖", --材料类别
"money" : 50000, --合同金额
"moneyUnit" : "元", --金额单位
"name" : "配砖合同(旭明)", -- 合同名称
"partyAName" : "狼图腾有限公司", --甲方名称
"partyBId" : 1473803877, --乙方ID
"partyBName" : "重庆市新兴有限公司", -- 乙方名称
"partyBCreditCode":"统一社会信用代码2", --统一社会信用代码
"partyUnitId" : "dsf001",--第三方供应商id(第三方乙方id)
"paymentMethod" : "后期结算", --付款方式
"purchaseType" : "集采", -- 采购类型
"remark" : "合同备注信息",
"serialNumber" : "A00000002", --单据编号
"signDate" : "2019-03-05", --签约日期
"supplyType" : "甲供", --供货模式
"orgId":11111, --公司层orgId
"unitId" : "1234", -- 第三方合同id
"statusType":1, --合同状态,1履约
"contractMaterialVoList" : [ {
"code" : "2041300400200002", --材料编码
"conversion" : "[{baseUnit:'匹',baseUnitQuantity:1,targetUnit:'KG',targetUnitQuantity:0.53}]", -- 转换系数
"conversionType" : "1匹=0.53KG", --换算规范
"excludingTaxPrice" : 9, --材料无税单价
"includingTaxPrice" : 10.6, -- 材料含税单价
"materialBrand" : "首钢品牌", --材料品牌
"materialId" : -1, --材料ID
"materialUnit" : "匹", -- 材料单位
"moneyExcludingTax" : 9000, -含税金额
"moneyIncludingTax" : 10600, -- 无税金额
"moneyUnit" : "元", --金额单位
"name" : "螺纹钢",--材料名称
"originQuantity":0, -- 材料变更前数量
"quantity" : 100, -- 材料数量
"referId" : 1, --参考来源ID
"referSerialNumber":"abc", --参考来源单据编号
"remark" : "材料备注",
"specification" : "规格03", --材料规格型号
"taxAmount" : 1600, --税额
"taxRate" : 0.52, -- 税率
"texture" : "材质", --材质
"unitId" : "1421333", -- 第三方合同材料ID(第三方系统Id)
"unitMaterialId" : "2040300000000000", --第三方材料id
"unitDetailParentId": "123", -- 补充协议明细的父明细Id
"unitPid" : "1234" --第三方合同ID
} ]
} ],
"message" : "成功:1条,失败:1条"
},
"success" : true -- 状态
}