接口列表
- 说明:需要在header中传递Access-Key-Id和Open-Id, Access-Key-Id是发放的accessKeyId, Open-Id是主动获取的openid
公共header说明
| header key | 是否必填 | 默认值 | 说明 |
|---|---|---|---|
| Content-Type | 是 | 固定值:application/json | |
| X-Amz-Date | 是 | 请求时间,格式:yyyyMMdd'T'HHmmss'Z'; TimeZone 为UTC; 使用sdk无需关注该参数 | |
| Authorization | 是 | 接口签名结果,签名方式请查看【接口签名】 | |
| Access-Key-Id | 是 | 主动申请【获取密钥】 | |
| Open-Id | 是 | 主动获取【获取openid】 | |
| Ignore-Warn | 否 | false | 用于忽略警告。新增或提交时等操作时会有警告导致接口失败,比如客户查重不通过、凭证余额出现赤字,Ignore-Warn=true时,会忽略相关警告,继续执行接口 |
| Save-As-Draft | 否 | false | 如果为true,新增单据时保存为草稿态,否则自动提交 |
对象标准接口
- 请求body结构说明,字段列表见数据字典
add接口 (beta)
-
写入单个对象数据接口
-
接口host:https://api2.77hub.com
-
接口路径:/v1/add
-
请求方式:POST
-
header参数
- 见公共header
-
参数说明:字段externalSystemCode/externalObjectType/externalObjectId 必填,externalObjectType+externalObjectId不能重复
-
参数示例(字段注释请以数据字典显示为准)
body:
{"json":"{\"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,\"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\":\"箱\"},{\"project.name\":\"应收项目1\",\"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\":\"箱\"}],\"externalObjectId\":1582709110221112331,\"externalObjectType\":\"RevenueConfirmation\",\"externalSystemCode\":\"110212001\"}}"}
// 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
-
接口路径:/v1/list
-
请求方式:POST
-
header参数
- 见公共header
-
参数示例
body:
{"json":"{\"objectType\":\"Customer\",\"page\":true,\"maxResult\":10,\"firstResult\":0,\"criteriaStr\":\"id is not null\",\"fields\":[\"id\",\"name\",{\"fieldName\":\"category\",\"fields\":[\"id\",\"name\"]},{\"fieldName\":\"contacts\",\"fields\":[\"id\",\"name\"]},\"code\"]}"}
// json的value值:
{
"objectType": "Customer", // 目标对象
"page": true, // 是否返回page信息
"maxResult": 10, // 返回最大行数
"firstResult": 0, // 从那一行开始查询 开始为0
"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\":{\"page\":{\"count\":134},\"list\":[{\"id\":\"XLWV090002\",\"name\":\"企企1\",\"category\":{\"id\":\"FDWV8X52C\",\"name\":\"内部商户\"},\"contacts\":[],\"code\":\"00001\"},{\"id\":\"5XSE4W000K\",\"name\":\"企企2\",\"category\":{\"id\":\"TKTEK001U\",\"name\":\"成都\"},\"contacts\":[],\"code\":\"00002\"}]},\"errors\":[]}"
}
json的value
{
"data": {
"page": { // 入参page=true时返回
"count": 134
},
"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
-
接口路径:/v1/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
- 接口路径:/v1/approvingUpdate
- 请求方式:PUT
- 参数:和上面/update接口完全一致
delete接口
-
数据删除接口
-
接口host:https://api2.77hub.com
-
接口路径:/v1/delete
-
请求方式:POST
-
header参数
- 见公共header
-
参数示例
body:
{
"json": "{
\"objectType\":\"Customer\",
\"objectId\":\"SDFASFF00010999\"
}"
}
//json的value值:
{
"objectType": "Customer", // 目标对象类型
"objectId": "SDFASFF00010999" // 目标数据id
}
- 接口响应
{
"json": "{\"success\":true}"
}
addAutoSubmit接口 (beta)
- 写入单个对象数据接口,自动提交
- 接口host:https://api2.77hub.com
- 接口路径:/v1/addAutoSubmit
- 说明:参数及响应和add接口保持一致,新增后自动提交,提交任务结束后接口返回,提交失败自动删除单据,单据可能删除失败
根据code获取openid接口
- 接口host:https://api2.77hub.com
- 接口路径:/v1/code
- 请求方式:GET
- header参数
- 见公共header
- Open-Id 不用填
- 请求参数
- code:确认授权后收到的code
- 接口响应
- url:文件URL
{
"openid": "openid128kjsiiyysdlq7",// openid
"userId": "SDFESSDF777", // 授权的用户id
"tenantId": "DFVRHGYHRET9527" // 授权的企业id
}
企业信息接口
- 接口host:https://api2.77hub.com
- 接口路径:/v1/tenant
- 请求方式:GET
- header参数
- 见公共header
- 接口响应
{
"id": "1",
"name": "北京企企科技有限公司",
"error": ""
}
用户信息接口
- 接口描述:获取授权用户信息
- 接口host:https://api2.77hub.com
- 接口路径:/v1/user
- 请求方式:GET
- header参数
- 见公共header
- 接口响应
{
"id":"J32NV555ETN0023",
"name":"王小二",
"mobile":"13900000000",
"email":"",
"tenantName":"北京企企科技有限公司",
"gender":""
}
异步弃审接口
- 接口host:https://api2.77hub.com
- 接口路径:/v1/withdraw
- 请求方式:POST
- header参数
- 见公共header
- 请求参数
- objectType:弃审的目标对象
- objectId:弃审的目标id
- reason:弃审原因
{
"objectType": "RevenueConfirmation",
"objectId": "0BX0JM5015D0001",
"reason": "弃审原因"
}
- 接口响应
- runningIds:执行中的id列表
- requestId:请求id,使用此参数查询异步任务执行状态
- failIds:执行失败的id及对应失败信息
{"json":"{\"runningIds\":[\"LQ2AK161U2H002S\"],\"successIds\":[],\"failIds\":{},\"warningIds\":{},\"userTaskActionValue\":\"manualWithdraw\",\"objectType\":\"RevenueConfirmation\",\"failedCount\":0,\"runningCount\":1,\"successCount\":0,\"warningCount\":0,\"totalCount\":1,\"taskId\":\"W9CAK161U2H002F\",\"isCompleted\":false,\"requestId\":\"time-df78f9c4-267e-4cbe-abcd-8ae2c796bbfb\"}"}
{
"runningIds": [
"LQ2AK161U2H002S"
],
"successIds": [],
"failIds": {},
"warningIds": {},
"userTaskActionValue": "manualWithdraw",
"objectType": "RevenueConfirmation",
"failedCount": 0,
"runningCount": 1,
"successCount": 0,
"warningCount": 0,
"totalCount": 1,
"taskId": "W9CAK161U2H002F",
"isCompleted": false,
"requestId": "time-df78f9c4-267e-4cbe-abcd-8ae2c796bbfb"
}
异步任务状态查询接口
-
接口host:https://api2.77hub.com
-
接口路径:/v1/asynctask
-
请求方式:POST
-
header参数
- 见公共header
-
请求参数
- requestId:异步接口响应的requestId
body:
{
"requestId":"time-5969aedb-e32a-4913-8da8-5a4d7ac3ad1b"
}
-
接口响应
- isCompleted:是否完成
- asyncTaskItems:异步任务项
- asyncTaskItemStatusObject:异步任务项状态
- lastErrorMsg:错误消息
{
"requestId":"",
"isCompleted":true,
"asyncTaskItems":[
{
"id":"W9CAK161U2H002K",
"billStatusObject":{
"id":"BillStatus.effective",
"title":"已生效"
},
"objectType":"RevenueConfirmation",
"objectId":"LQ2AK161U2H002S",
"asyncTaskItemStatus":"AsyncTaskItemStatus.succeeded",
"asyncTaskItemStatusObject":{
"id":"AsyncTaskItemStatus.succeeded",
"title":"成功"
},
"lastErrorMsg":"null",
"isRead":false
}
]
}
红冲接口
- 接口host:https://api2.77hub.com
- 接口路径:/v1/toredbill
- 请求方式:POST
- header参数
- 见公共header
- 请求参数
- objectType:目标对象
- objectId:目标id
{
"objectType":"RevenueConfirmation",
"objectId":"0BX0JM5015D0001"
}
- 接口响应
- id:生成单id
- error:错误信息
{
"id": "PCL9KQ50LNT0001",
"error": ""
}
获取队列信息接口
- 接口host:https://api2.77hub.com
- 接口路径:/v1/queue
- 请求方式:GET
- header参数
- 见公共header
- 接口响应
- queueUrl:队列url
- queueHost:队列host
- queuePath:队列path
- error:错误信息
{
"queueUrl": "https://sqs.cn-north-1.amazonaws.com.cn/878775433445/Q7512J0010",
"queueHost": "https://sqs.cn-north-1.amazonaws.com.cn",
"queuePath": "/878775433445/Q7512J0010",
"error":""
}
同步任务接口
-
接口host:https://api2.77hub.com
-
接口路径:/v1/batchDo
-
请求方式:POST
-
header参数
- 见公共header
-
请求参数
- objectType:目标对象
- objectId:目标id
- action:执行动作,目前支持的动作:
| 动作 | 描述 |
|---|---|
| manualSubmit | 提交 |
| userAgree | 同意 |
| userDeny |