接口参数示例
参数格式
- list接口
{
"objectType": "", // 目标对象名称:从数据字典中查看对象名称
"criteriaStr": "", // 查询参数 查询字段支持lastModifiedTime(TimeStamp)
"fields": [ // 查询字段列表:从数据字典中查看字段列表
]
}
- add接口
{
"objectType": "", // 目标对象名称:从数据字典中查看对象名称
"data": { // 要新增的字段:从数据字典中查看字段类列表
}
}
自定义对象
在数据字典中查看自定义对象(需登录)
- add接口(对象名称和字段列表需到数据字典中查看)
{
"objectType": "x", // 目标对象名称:从数据字典中查看对象名称
"data": { // 数据项
"name": "名称", // 从数据字典中查看字段列表
"externalObjectId": "x", // 外部系统对象唯一标识
"externalObjectType": "x", // 外部系统对象类型
"externalSystemCode": "x" // 外部系统标识
}
}
- list接口(对象名称和字段列表需到数据字典中查看)
{
"objectType": "x", // 目标对象名称:从数据字典中查看对象名称
"criteriaStr": "id is not null", // 查询参数 查询字段支持lastModifiedTime(TimeStamp)
"fields": [ // 查询字段列表
"id", // 主对象字段
"name", // 主对象字段
{
"fieldName": "category", // 外键字段 ps:如果字段有参照对照,如果字段名以id结尾,去掉id为fieldName,如果字段名不是以id结尾,字段名+Object为fieldName。此fieldName对应的字段为categoryId
"fields": [ // 外键字段对应对象字段列表
"id", // 外键字段对应对象字段
"name" // 外键字段对应对象字段
]
},
"code", // 主对象字段
{
"fieldName": "list", // 对象子表字段
"fields": [ // 对象子表字段列表
"id", // 对象子表字段
"name" // 对象子表字段
]
}
]
}
常见查询方案
- list 接口,根据时间查询,查询条件使用时间戳,时间戳单位为秒
{
"objectType":"RevenueConfirmation",
"criteriaStr":"businessDate = to_timestamp(1653408000)'" //查询条件使用时间戳, 查询2022年5月25号数据
"fields":[
"id", // 查询主对象
"name",
{
"fieldName":"billType", // 外键字段
"fields":[
"id", // 外键字段参照对象字段
"name" // 外键字段参照对象字段
]
}
]
}
- list 接口,根据时间查询,查询条件使用时间表达式,时间表达式需要使用0时区的时间
{
"objectType":"RevenueConfirmation",
"criteriaStr:"businessDate = '2022-05-24 16:00:00'" // 查询条件使用时间表达式,查询2022年5月25号数据
"fields":[
"id", // 查询主对象
"name",
{
"fieldName":"billType", // 外键字段
"fields":[
"id", // 外键字段参照对象字段
"name" // 外键字 段参照对象字段
]
}
]
}
- list 接口,根据子表条件查询
{
"objectType":"RevenueConfirmation",
"criteriaStr:"revenueConfirmationItems.productId = 'XXXXX'" // 查询条件,主表字段.子表字段, 子表包含存货XXXXX的数据
"fields":[
"id", // 查询主对象
"name",
{
"fieldName":"billType", // 外键字段
"fields":[
"id", // 外键字段参照对象字段
"name" // 外键字段参照对象字段
]
},
{
"fieldName":"revenueConfirmationItems", // 查询子列表,对应明细行
"fields":[
{
"fieldName":"product", // 明细对象的外键字段
"fields":[
"name" // 明细对象的外键字段参照对象字段
]
}
]
}
]
}
- list 接口,根据主表查询子表
{
"objectType":"RevenueConfirmation",
"criteriaStr":"id is not null limit 3 offset 0", // 查询条件,分页查询,3表示每页显示数据的个数,0表示从头开始查询
"fields":[
"id", // 查询主对象
"name",
{
"fieldName":"department", // 外键字段 ps:如果字段有参照对照,如果字段名以id结尾,去掉id为fie,如果字段名不是以id结尾,字段名+Object为fieldName。此fieldName对应的字段为departmentId
"fields":[
"id", // 外键字段参照对象字段
"name" // 外键字段参照对象字段
]
},
{
"fieldName":"revenueConfirmationItems", // 查询子列表,对应明细行
"fields":[
{
"fieldName":"product", // 明细对象的外键字段
"fields":[
"name" // 明细对象的外键字段参照对象字段
]
},
"quantity", // 明细对象字段
"price", // 明细对象字段
"taxRate", // 明细对象字段
"originAmount", // 明细对象字段
"amount", // 明细对象字段
"originAmountWithoutTax", // 明细对象字段
"amountWithoutTax", // 明细对象字段
"originTaxAmount", // 明细对象字段
"taxAmount", // 明细对象字段
"originPriceWithoutTax" // 明细对象字段
]
}
]
}
- update 接口
{
"objectType":"RevenueConfirmation",
"data":{
"id":"EH6FB060PST000Wz",
"billType.name":"收入确认单",
"businessType.name":"收入确认单立账",
"revenueConfirmationItems":[
{
"product.name":"B商品",
"quantity":5,
"price":1000,
"priceWithoutTax":917.43,
"taxRate":0.09,
"originAmount":5000,
"amount":5000,
"originAmountWithoutTax":4587.16,
"amountWithoutTax":4587.16,
"originTaxAmount":412.84,
"taxAmount":412.84,
"originPriceWithoutTax":917.43,
"unit.name":"箱",
"productStandardTypeId":"ProductStandardType.quantity",
"editFlag":"add" /// add->新增子对象数据
},
{
"id":"EH6FB060PST000W", // 子对象id:如果是更新,则必需指定
"product.name":"B商品",
"quantity":5,
"price":1000,
"priceWithoutTax":917.43,
"taxRate":0.09,
"originAmount":5000,
"amount":5000,
"originAmountWithoutTax":4587.16,
"amountWithoutTax":4587.16,
"originTaxAmount":412.84,
"taxAmount":412.84,
"originPriceWithoutTax":917.43,
"unit.name":"箱",
"productStandardTypeId":"ProductStandardType.quantity",
"editFlag":"update" // 子对象操作标记:update->更新(需指定子明细行id) add->新增
},
{
"id":"EH6FB060PST000X",
"editFlag":"delete" // 子对象操作标记 delete->删除, (需指定明细行id)
}
]
}
}
普通对象
部门
部门数据字典(Department)
- add接口
{
"objectType":"Department",
"data":{
"ownerLegalEntityOrg.name":"科技集团公司-多组织", // 启用多组织的时候,ownerLegalEntityOrgId必填
"code":"dd10035",
"name":"测试添加部门",
"parent.code":"0003",
"manager.name":"王小胖",
"executive.name":"王二胖",
"character.title":"研发",
"annualNumber":100,
"disabledTime":"2030-01-01",
"description":"说明",
"attachments":[
{
"name":"test",
"url":"https://www.51miz.com/tupian/1512602.html?keyword_id=85485",
"size":83310,
"type":"image/jpeg",
"ext":".jpeg"
}
],
"externalObjectId":"2100001",
"externalObjectType":"Department",
"externalSystemCode":"210001"
}
}
人员
人员数据字典 (User)
- add接口
{
"objectType":"User",
"data":{
"ownerLegalEntityOrg.code":"1122k", // 启用多组织的时候,ownerLegalEntityOrgId必填
"ownerLegalEntityOrg.name":"科技集团公司-多组织",
"code":"0003",
"name":"王三胖",
"englishName":"WangSanPang",
"statusId":"UserStatus.incumbent",
"department.code":"0002",
"department.name":"开发部",
"idTypeId":"IdType.other",
"idNumber":123123,
"birthdate":"1639366050000",
"genderId":"Gender.male",
"rank.code":"0002",
"isBizUser":true,
"isLoginUser":true,
"disabledTime":"2022-10-11",
"systemDisabledTime":"2022-10-11",
"mobile":"13800000000",
"email":"756787567@qq.com",
"qq":"756787567",
"address":"海淀区XX路",
"jobRelationships":[
{
"fromParty.code":"1122k", // 启用多组织的时候,fromPartyId必填
"department.code":"0002",
"department.name":"开发部",
"startTime":"2020-10-11",
"disabledTime":"2021-10-11",
"isMain":"true",
"supervisor.code":"0001",
"rank.code":"0001",
"position.code":"0001",
"position.name":"后端开发工程师",
"positionSequence.code":"0001",
"positionSequence.name":"T1",
"userCategory.code":"001",
"userCategory.name":"在职员工",
"salaryType.name":"工资薪金",
"settleObjectType":"Customer",
"settleObject.code":"0001000001"
}
],
"bankAccounts":[
{
"accountCode":"123123",
"name":"王三胖",
"epayToAcctTypeId":"EpayToAcctType.toPerson",
"bank.name":"中国建设银行",
"bankName":"开户银行说明",
"isDefault":true,
"isDisabled":false
}
],
"roles":[
{
"role.name":"普通员工"
}
],
"externalObjectId":"%s",
"externalObjectType":"2100004",
"externalSystemCode":"210004"
}
}
客户分类
客户分类数据字典(CustomerCategory)
- add接口
{
"objectType":"CustomerCategory",
"data":{
"createdOrg.code":"1122k", // 启用多组织的时候,createdOrgId必填
"createdOrg.name":"科技集团公司-多组织",
"code":"00101",
"name":"B类客户子客户",
"parent.code":"0002",
"parent.name":"B类客户",
"externalObjectId":"2100004",
"externalObjectType":"CustomerCategory",
"externalSystemCode":"210004"
}
}
客户
客户数据字典(Customer)
- add接口
{
"objectType":"Customer",
"data":{
"createdOrg.code":"1122k", // 启用多组织的时候,createdOrgId必填
"createdOrg.name":"科技集团公司-多组织",
"customerTypeId":"CustomerType.externalCustomer", // 启用多组织的时候,customerTypeId必填
"code":"0001",
"isManualCode":true, // 手动编码,指定后,系统会取指定的code的值,否则,系统会根据默认的编码规则自动生成编码
"name":"李二胖",
"abbrName":"李二胖",
"aidCode":"助记码",
"vendor.code":"0000100001",
"vendor.name":"材料供应商",
"category.code":"0001",
"category.name":"A类客户",
"isChannel":false,
"channel.code":"0001000001",
"channel.name":"李小胖",
"industry.code":"86",
"industry.name":"新闻和出版业",
"firstDealTime":"2022-06-13",
"disabledTime":"2025-06-13",
"legalPerson":"李多",
"address":"北京市海淀区XX路XX",
"taxIdNumber":"8FXXXXXXXX",
"telephone":"13500000000",
"settleCustomer.code":"0001000001",
"settleCustomer.name":"李小胖",
"ownerDept.code":"0001",
"ownerDept.name":"测试部",
"ownerUser.code":"0001",
"ownerUser.name":"王小胖",
"isPriceWithTax":true,
"settlementMethod.code":"02",
"settlementMethod.name":"银行转账",
"invoiceType.name":"增值税专用发票",
"reconcileMethodId":"ReconcileMethod.web",
"isReconcile":true,
"isCooperated":true,
"addresses":[
{
"country.name":"中国",
"districta.code":"0101",
"district.name":"东城区",
"address":"北京市东城区XX路XX号",
"isDefault":true
}
],
"bankAccounts":[
{
"accountCode":"6316876545678766567",
"name":"李二胖",
"epayToAcctTypeId":"EpayToAcctType.toCompany",
"bank.name":"中国工商银行",
"bankName":"中国工商银行里开户",
"isDefault":true
}
],
"contacts":[
{
"name":"555",
"telephone":"13500000001",
"mobile":"13500000001",
"email":"765678443@qq.com",
"postcode":"457864",
"position":"主管",
"isPrimary":true
}
],
"externalObjectId":"20006",
"externalObjectType":"Customer",
"externalSystemCode":"210006"
}
}
供应商分类
供应商分类数据字典(VendorCategory)
- add接口
{
"objectType":"VendorCategory",
"data":{
"createdOrg.code":"1122k", // 启用多组织的时候,createdOrgId必填
"createdOrg.name":"科技集团公司-多组织",
"code":"00021",
"name":"供应商测试",
"parent.code":"0002",
"parent.name":"B级供应商",
"externalObjectId":"200006",
"externalObjectType":"VendorCategory",
"externalSystemCode":"210006"
}
}
供应商
供应商数据字典(Vendor)
- add接口
{
"objectType":"Vendor",
"data":{
"createdOrg.code":"1122k", // 启用多组织的时候,createdOrgId必填
"createdOrg.name":"科技集团公司-多组织",
"vendorTypeId":"VendorType.externalVendor", // 启用多组织的时候,vendorTypeId必填
"code":"0000100002",
"name":"电脑供应商",
"abbrName":"电脑供应商",
"aidCode":"助记码",
"customer.code":"0001000002",
"customer.name":"李二胖",
"category.code":"00001",
"category.name":"A+级别供应商",
"industry.code":"01",
"industry.name":"农业",
"firstDealTime":"2022-06-13",
"disabledTime":"2025-06-13",
"legalPerson":"李多",
"address":"北京市海淀区XX路XX",
"taxIdNumber":"8FXXXXXXXX",
"telephone":"13500000000",
"settleCustomer.code":"0001000001",
"settleCustomer.name":"李小胖",
"ownerDept.code":"0001",
"ownerDept.name":"测试部",
"ownerUser.code":"0001",
"ownerUser.name":"王小胖",
"isPriceWithTax":true,
"settlementMethod.code":"02",
"settlementMethod.name":"银行转账",
"invoiceType.name":"增值税专用发票",
"reconcileMethodId":"ReconcileMethod.web",
"isReconcile":true,
"isCooperated":true,
"addresses":[
{
"country.name":"中国",
"districta.code":"0101",
"district.name":"东城区",
"address":"北京市东城区XX路XX号",
"isDefault":true
}
],
"bankAccounts":[
{
"accountCode":"6316876545678766567",
"name":"李二胖",
"epayToAcctTypeId":"EpayToAcctType.toCompany",
"bank.name":"中国工商银行",
"bankName":"中国工商银行里开户",
"isDefault":true
}
],
"contacts":[
{
"name":"555",
"telephone":"13500000001",
"mobile":"13500000001",
"email":"765678443@qq.com",
"postcode":"457864",
"position":"主管",
"isPrimary":true
}
],
"externalObjectId":"20006",
"externalObjectType":"Customer",
"externalSystemCode":"210006"
}
}
其他单位分类
其他单位分类数据字典( OtherPartyCategory)
- add 接口
{
"objectType":"OtherPartyCategory",
"data":{
"createdOrg.code":"1122k", // 启用多组织的时候,createdOrgId必填
"createdOrg.name":"科技集团公司-多组织",
"code":"0002",
"name":"其他单位测试",
"parent.code":"0001",
"parent.name":"单位",
"externalObjectId":"2100009",
"externalObjectType":"OtherPartyCategory",
"externalSystemCode":"210009"
}
}
其他单位
其他单位数据字典(OtherParty)
- add 接口
{
"objectType":"OtherParty",
"data":{
"createdOrg.code":"1122k", // 启用多组织的时候,createdOrgId必填
"createdOrg.name":"科技集团公司-多组织",
"code":"001",
"name":"test%s",
"abbrName":"DSL",
"aidCode":"DSL1",
"category.code":"0002",
"category.name":"其他单位测试",
"isFinancial":true,
"industry.code":"86",
"industry.name":"新闻和出版业",
"firstDealTime":"2022-06-13",
"disabledTime":"2025-06-13",
"legalPerson":"李多",
"telephone":"13500000000",
"address":"北京市海淀区XX路XX",
"taxIdNumber":"8FXXXXXXXX",
"settleCustomer.code":"0001000001",
"settleCustomer.name":"李小胖",
"ownerDept.code":"0001",
"ownerDept.name":"测试部",
"ownerUser.code":"0001",
"ownerUser.name":"王小胖",
"isPriceWithTax":true,
"settlementMethod.code":"02",
"settlementMethod.name":"银行转账",
"invoiceType.name":"增值税专用发票",
"addresses":[
{
"country.name":"中国",
"districta.code":"0101",
"district.name":"东城区",
"address":"北京市东城区XX路XX号",
"isDefault":true
}
],
"bankAccounts":[
{
"accountCode":"6316876545678766567",
"name":"李二胖",
"epayToAcctTypeId":"EpayToAcctType.toCompany",
"bank.name":"中国工商银行",
"bankName":"中国工商银行里开户",
"isDefault":true
}
],
"contacts":[
{
"name":"555",
"telephone":"13500000001",
"mobile":"13500000001",
"email":"765678443@qq.com",
"position":"主管",
"isPrimary":true
}
],
"externalObjectId":"2100009",
"externalObjectType":"OtherParty",
"externalSystemCode":"210009"
}
}
账户
账户数据字典(BankAccount)
- add 接口
{
"objectType":"BankAccount",
"data":{
"createdOrg.code":"1122k", // 启用多组织的时候,createdOrgId必填
"createdOrg.name":"科技集团公司-多组织",
"code":"00061",
"accountCode":"6222003803934400",
"name":"test%s",
"isManualCode":false,
"bank.name":"中国建设银行",
"bankAccountTypeId":"BankAccountType.cash",
"currency.name":"人民币",
"bankAddress":"北京市XX区XX路XX号",
"accountDate":"2022-05-12",
"accountApply.title":"支付",
"isReconciliate":false,
"isDeficitControl":true,
"bankName":"开户银行说明",
"isDisabled":false,
"externalObjectId":"2100013",
"externalObjectType":"BankAccount",
"externalSystemCode":"210013"
}
}
结算方式
结算方式数据字典( SettlementMethod)
- add 接口
{
"objectType":"SettlementMethod",
"data":{
"createdOrg.code":"1122k", // 启用多组织的时候,createdOrgId必填
"createdOrg.name":"科技集团公司-多组织",
"code":"dd001",
"name":"test%s",
"isBillManage":true,
"isDisabled":false,
"isEpay":true,
"bankAccount.code":"00061",
"externalObjectId":"2100015",
"externalObjectType":"SettlementMethod",
"externalSystemCode":"210015"
}
}
收入
收入数据字典(Revenue)
- add 接口
{
"objectType":"Revenue",
"data":{
"createdOrg.code":"1122k", // 启用多组织的时候,createdOrgId必填
"createdOrg.name":"科技集团公司-多组织",
"code":"DD001",
"name":"test%s",
"taxRate.name":"1%",
"taxClassifyCode":"123",
"isDisabled":false,
"description":"说明",
"revenueConfirmationTypeId":"RevenueConfirmationType.manualInput",
"externalObjectId":"2100017",
"externalObjectType":"Revenue",
"externalSystemCode":"210017"
}
}
费用
费用数据字典(Cost )
- add 接口
"objectType":"Cost",
"data":{
"createdOrg.code":"1122k", // 启用多组织的时候,createdOrgId必填
"createdOrg.name":"科技集团公司-多组织",
"code":"0002",
"name":"费用1",
"isDisabled":false,
"taxRate.name":"6%",
"description":"说明",
"isGenericDeductible":true,
"externalObjectId":"2100017",
"externalObjectType":"Cost",
"externalSystemCode":"210017"
}
}