接口列表
- 说明:需要在header中传递Authorization,Authorization是主动获取的id_token或者access_token
公共header说明
| header key | 是否必填 | 默认值 | 说明 |
|---|---|---|---|
| Content-Type | 是 | 固定值:application/json | |
| Authorization | 是 | token值(id_token/或者access_token) | |
| Ignore-Warn | 否 | false | 用于忽略警告。新增或提交时等操作时会有警告导致接口失败,比如客户查重不通过、凭证余额出现赤字,Ignore-Warn=true时,会忽略相关警告,继续执行接口 |
| Save-As-Draft | 否 | false | 如果为true,新增单据时保存为草稿态,否则自动提交 |
对象标准接口
- 请求body结构说明 ,字段列表见数据字典
add接口 (beta)
-
写入单个对象数据接口
-
接口host:https://api2.77hub.com
-
接口路径:/v2/add
-
请求方式:POST
-
header参数
- 见公共header
-
参数说明:字段externalSystemCode/externalObjectType/externalObjectId 必填,externalObjectType+externalObjectId不能重复
-
参数示例(字段注释请以数据字典显示为准)
body:
{
"json":"{\n \"objectType\":\"RevenueConfirmation\",\n \"data\":{\n \"billType.name\":\"收入确认单\",\n \"businessType.name\":\"收入确认单立账\",\n \"businessDate\":\"2020-01-01\",\n \"customer.name\":\"李雷\",\n \"invoiceType.name\":\"增值税专用发票\",\n \"currency.name\":\"人民币\",\n \"exchangeRate\":1,\n \"settleCustomer.name\":\"李雷\",\n \"revenueConfirmationItems\":[\n {\n \"project.name\":\"应收项目1\",\n \"product.name\":\"B商品\",\n \"quantity\":5,\n \"price\":1000,\n \"priceWithoutTax\":917.43,\n \"taxRate\":0.09,\n \"originAmount\":5000,\n \"amount\":5000,\n \"originAmountWithoutTax\":4587.16,\n \"amountWithoutTax\":4587.16,\n \"originTaxAmount\":412.84,\n \"taxAmount\":412.84,\n \"originPriceWithoutTax\":917.43,\n \"unit.name\":\"箱\"\n },\n {\n \"project.name\":\"应收项目1\",\n \"product.name\":\"B商品\",\n \"quantity\":5,\n \"price\":1000,\n \"priceWithoutTax\":917.43,\n \"taxRate\":0.09,\n \"originAmount\":5000,\n \"amount\":5000,\n \"originAmountWithoutTax\":4587.16,\n \"amountWithoutTax\":4587.16,\n \"originTaxAmount\":412.84,\n \"taxAmount\":412.84,\n \"originPriceWithoutTax\":917.43,\n \"unit.name\":\"箱\"\n }\n ],\n \"externalObjectId\":1582709110221112331,\n \"externalObjectType\":\"RevenueConfirmation\",\n \"externalSystemCode\":\"110212001\"\n }\n}"
}
// json的value值:
{
"objectType": "RevenueConfirmation", // 目标对象名称:收入确认单
"data": { // 数据项
"billType.name": "收入确认单", // 单据类型
"businessType.name": "收入确认单立账", // 业务类型
"businessDate": "2020-01-01", // 业务日期
"customer.name": "李雷", // 客户名称
"invoiceType.name": "增值税专用发票", // 发票类型
"currency.name": "人民币", // 币种
"exchangeRate": 1, // 汇率
"settleCustomer.name": "李雷", // 结算单位
"revenueConfirmationItems": [ // 收入确认单明细
{
"project.name": "应收项目1", // 项目名称
"product.name": "B商品", // 存货名称
"quantity": 5, // 数量
"price": 1000.000, // 单价
"priceWithoutTax": 917.430, // 本币无税单价
"taxRate": 0.09, // 税率
"originAmount": 5000.000, // 金额
"amount": 5000.000, // 金额
"originAmountWithoutTax": 4587.16, // 原币无税金额
"amountWithoutTax": 4587.16, // 本币无税金额
"originTaxAmount": 412.84, // 原币税额
"taxAmount": 412.84, // 本币税额
"originPriceWithoutTax": 917.430, // 原币无税单价
"unit.name": "箱" // 计量单位名称
},
{
"project.name": "应收项目1", // 项目名称
"product.name": "B商品", // 存货名称
"quantity": 5, // 数量
"price": 1000.000, // 单价
"priceWithoutTax": 917.430, // 本币无税单价
"taxRate": 0.09, // 税率
"originAmount": 5000.000, // 金额
"amount": 5000.000, // 金额
"originAmountWithoutTax": 4587.16, // 原币无税金额
"amountWithoutTax": 4587.16, // 本币无税金额
"originTaxAmount": 412.84, // 原币税额
"taxAmount": 412.84, // 本币税额
"originPriceWithoutTax": 917.430, // 原币无税单价
"unit.name": "箱" // 计量单位名称
}
],
"externalObjectId": 1582709110221112331, // 外部系统对象唯一标识
"externalObjectType": "RevenueConfirmation", // 外部系统对象类型
"externalSystemCode": "110212001" // 外部系统标识
}
}
- 接口响应
{
"json": "{\"id\":\"RMUEH160PG9000M\"}"
}
list接口
-
查询数据接口
-
接口host:https://api2.77hub.com
-
接口路径:/v2/list
-
请求方式:POST
-
header参数
- 见公共header
-
参数示例
body:
{
"json": "{
\"objectType\":\"Customer\",
\"criteriaStr\":\"id is not null\",
\"fields\":[
\"id\",
\"name\",
{
\"fieldName\":\"category\",
\"fields\":[
\"id\",
\"name\"
]
},
{
\"fieldName\":\"contacts\",
\"fields\":[
\"id\",
\"name\"
]
},
\"code\"
]
}"
}
// json的value值:
{
"objectType": "Customer", // 目标对象
"criteriaStr": "id is not null", // 查询参数 查询字段支持lastModifiedTime(TimeStamp)
"fields": [ // 查询字段列表
"id", // 主对象字段
"name", // 主对象字段
{
"fieldName": "category", // 外键字段 ps:如果字段有参照对照,如果字段名以id结尾,去掉id为fieldName,如果字段名不 是以id结尾,字段名+Object为fieldName。此fieldName对应的字段为categoryId
"fields": [ // 外键字段对应对象字段列表
"id", // 外键字段对应对象字段
"name" // 外键字段对应对象字段
]
},
{
"fieldName": "contacts", // 外键字段对应对象子表
"fields": [ // 外键字段对应对象子表字段列表
"id", // 外键字段对应对象子表字段
"name" // 外键字段对应对象子表字段
]
},
"code" // 主对象字段
]
}
- 接口响应
{
"json": "{\"data\":{\"list\":[{\"id\":\"XLWV090002\",\"name\":\"企企1\",\"category\":{\"id\":\"FDWV8X52C\",\"name\":\"内部商户\"},\"contacts\":[],\"code\":\"00001\"},{\"id\":\"5XSE4W000K\",\"name\":\"企企2\",\"category\":{\"id\":\"TKTEK001U\",\"name\":\"成都\"},\"contacts\":[],\"code\":\"00002\"}]},\"errors\":[]}"
}
update接口
-
数据更新接口
-
接口host:https://api2.77hub.com
-
接口路径:/v2/update
-
请求方式:PUT
-
header参数
- 见公共header
-
参数示例
body:
{
"json": "{
\"objectType\":\"Customer\",
\"data\":{
\"id\":\"633GUN505MB0108\",
\"categoryId\":\"89B1GN505UR0002\",
\"code\":\"1002000001\",
\"contacts\":[
{
\"id\":\"A5UK0R50LNT0027\",
\"mobile\":\"18988889997\",
\"editFlag\":\"update\"
},
{
\"isPrimary\":false,
\"name\":\"张三\",
\"mobile\":\"13565678898\",
\"isCooperated\":false,
\"editFlag\":\"add\"
}
],
\"addresses\":[
{
\"address\":\"\",
\"isDefault\":true,
\"id\":\"A5UK0R50LNT0026\",
\"editFlag\":\"update\",
\"countryId\":\"\",
\"districtId\":\"\"
}
]
}
}"
}
// json的value值
{
"objectType":"Customer", // 目标对象类型
"data":{ // 目标对象数据
"id":"633GUN505MB0108", // 目标对象id:必需指定
"categoryId":"89B1GN505UR0002",
"code":"1002000001",
"contacts":[ // 子对象
{
"id":"A5UK0R50LNT0027", // 子对象id:如果是更新,则必需指定
"mobile":"18988889997",
"editFlag":"update" // 子对象操作标记:update->更新(需指定子对象id) add->新增 delete->删除, 默认为add
},
{
"isPrimary":false,
"name":"12",
"mobile":"13565678898",
"isCooperated":false,
"editFlag":"add"
}
],
"addresses":[
{
"address":"",
"isDefault":true,
"id":"A5UK0R50LNT0026",
"editFlag":"update",
"countryId":"",
"districtId":""
}
]
}
}
- 接口响应
{
"json": "{\"success\":true}"
}
审批中修改接口
- 数据更新接口
- 接口host:https://api2.77hub.com
- 接口路径:/v2/approvingUpdate
- 请求方式:PUT
- 参数:和上面/update接口完全一致
delete接口
-
数据删除接口
-
接口host:https://api2.77hub.com
-
接口路径:/v2/delete
-
请求方式:POST
-
header参数
- 见公共header
-
参数示例
body:
{
"json": "{
\"objectType\":\"Customer\",
\"objectId\":\"SDFASFF00010999\"
}"
}
//json的value值:
{
"objectType": "Customer", // 目标对象类型
"objectId": "SDFASFF00010999" // 目标数据id
}