公司数据设置
- Kook Siong Then
- 1 获取公司数据
- 2 更新 / 输入公司数据
- 3 删除公司数据
基准URL: /smartfin/api/v1/whitelist
获取公司数据
POST /smartfin/api/v1/whitelist/select
获取当前用户可见的所有公司数据。
验证 / 授权
请求标头
架构
请求标头:
Content-Type: application/json
Authorization （验证）：
string - JWT <<您的API密钥（令牌）>> (必填项)
响应
例子:
{
"error_code": 0,
"value": {
"list": [
{
"entity_id": 261580,
"company_id": 119,
"entity_name": "TESTUPLOADFILE1",
"entity_type": "COUNTERPARTY",
"address": null,
"email": null,
"tel": null,
"country": null,
"create_by": 2,
"create_time": "2024-01-18 10:27:51",
"update_by": 2,
"update_time": "2024-01-18 10:40:04",
"user_id": 2,
"credit_amt": 2345.0,
"invoice_code": "234",
"invoice_add": null,
"invoice_bank": null,
"reg_no": null,
"entity_ccy": "DOP",
"fax_no": null,
"invalid": null,
"client_attr": [
1,
2
],
"used_entity_name": [
"TEST",
"TEST1"
],
"reg_cap": 0.0,
"own_eq": 0.0,
"credit_score": 0.0,
"credit_lvl": 0.0,
"rec_credit_amt": 0.0,
"aff_group": null,
"biz_abbrev": null,
"aff_group_credit_amt": 0.0,
"company_auth_amt": "",
"aff_group_auth_amt": "",
"c_name": "test2",
"u_name": "test2"
},
...
],
"dropdown_list": {
"entity_name": [
"CONN",
"上海嵘亿国际贸易有限公司",
"U",
"BASIS TRADE CHINA",
"OKOKOK",
"SALES4",
"1",
"123",
...
],
"aff_group": [
"ADSF"
],
"validation": [
"entity_type",
"client_attr"
],
"entity_type": [
"COUNTERPARTY",
"BROKER"
],
"client_attr": [
{
"value": 1,
"label": "DOMESTIC TRADE COUNTERPARTY"
},
{
"value": 2,
"label": "FOREIGN TRADE COUNTERPARTY"
}
]
}
} |
返回
|
架构
last_update_time, update_by_name, update_by - string有关数据的最后更新时间以及更新数据的用户的信息。
create_time, create_by, create_by_name - string有关数据的创建时间以及创建数据的用户的信息。
user_id, entity_id, company_id - integeruser_id- 用户ID（数据所属的用户）entity_id- 公司ID, 分配给数据独立ID。该ID可用于检索公司数据。company_id- 此数据的母公司ID。
entity_name, entity_type, entity_name_eng - stringentity_name- 客户名称 (必填项)entity_type- 公司类型 (COUNTERPARTY (客户)orBROKER (经纪商)) (必填项)entity_name_eng- 客户英文名称
entity_name 和 entity_type 不能重复。
如果在数据库中找到相同的
entity_name， 则将不允许存储entity_name。'COMPANY NAME' 的
entity_name和 'COUNTERPARTY' 的entity_type如果在数据库中已存在，将不允许存储相同的entity_name和entity_type。
entity_name_eng 与 entity_name 不能有相同文本。
client_attr - array[integer]
used_entity_name - array[string]client_attr- 客户属性used_entity_name- 客户曾用名数据以参数数组( array )形式存在，或者如果参数、为空，则将解析为 null。
address, email, tel, country, fax_no, country, invoice_addr,
invoice_bank, invoice_code, entity_ccy - stringaddress- 地址email- 电邮地址tel- 联络号码fax_no- 传真country- 国家 （注： 传递国家代码而不是国家名称， China 代表者 CN）invoice_code- 购买纳税人识别号invoice_add- 开票地址invoice_bank- 开票银行reg_no- 营业执照编码entity_ccy- 货币
credit_amt, aff_group_credit_amt , rec_credit_amt, credit_score, own_eq
reg_cap, company_auth_amt, aff_group_auth_amt - float
credit_lvl - integer
aff_group, biz_abbrev - stringcredit_amt-单一客户授信总额aff_group_credit_amt-所属集团联合授信总额（折人民币万元）biz_abbrev - 客户简称aff_group-所属集团rec_credit_amt-建议信用额度 (折人民币万元）credit_lvl-信用评级credit_score-信用分值own_eq-所有者权益 (折人民币万元）reg_cap- 注册资本(本位币万元)company_auth_amt- 单一客户未了结合同总额（折人民币万元）aff_group_auth_amt- 所属集团未了结合同总额（折人民币万元）
invalid - boolean公司的现状 (true （停用） or ““ )
更新 / 输入公司数据
更新URL:
POST /smartfin/api/v1/whitelist/update
输入URL:
POST /smartfin/api/v1/whitelist/insert
将新的公司数据输入或更新到数据库中。
验证 / 授权
请求标头
架构
请求标头:
Content-Type: application/json
Authorization （验证）：
string - JWT <<您的API密钥（令牌）>> (必填项)
请求载荷 （ 更新 ）
例子:
JSON 主体: {
"update_list":[
{
"entity_id":261580,
"entity_name":"TESTUPLOADFILE1",
"entity_type":"COUNTERPARTY",
"address":"Address",
"email":"",
"tel":"",
"fax_no":"",
"country":"",
"credit_amt":2345,
"entity_ccy":"DOP",
"invoice_code":"234",
"invoice_add":"",
"invoice_bank":"",
"reg_no":"",
"invalid":"",
"client_attr":[
1,
2
],
"used_entity_name": [
"TEST",
"TEST1"
],
"reg_cap":0,
"own_eq":0,
"credit_score":0,
"credit_lvl":0,
"rec_credit_amt":0,
"aff_group":"",
"biz_abbrev":"",
"aff_group_credit_amt":0,
"company_auth_amt": "",
"aff_group_auth_amt": "",
}
]
} |
请求载荷 ( 输入 )
例子:
JSON 主体: {
"insert_list":[
{
"entity_id":"",
"entity_name":"test company",
"entity_type":"BROKER",
"address":"",
"email":"",
"tel":"",
"fax_no":"",
"country":"",
"credit_amt":"",
"entity_ccy":"",
"invoice_code":"",
"invoice_add":"",
"invoice_bank":"",
"reg_no":"",
"invalid":"",
"client_attr":"",
"used_entity_name": [],
"reg_cap":"",
"own_eq":"",
"credit_score":"",
"credit_lvl":"",
"rec_credit_amt":"",
"aff_group":"",
"biz_abbrev":"",
"aff_group_credit_amt":"",
"company_auth_amt": "",
"aff_group_auth_amt": "",
}
]
} |
请求架构
insert_list - array[object]包含与
list于 公司数据设置 | 响应 相同的参数 ( 请参考上述 公司数据设置 | 请求载荷 ( 输入 ) 请求主体中需要包含的必需参数 )entity_id不需要传递，并且在此数组中不是必需的。包含要输入到数据库中的新公司数据。
update_list - array[object]包含与
list于 公司数据设置 | 响应 相同的参数 (请参考上述 公司数据设置 | 请求载荷 （ 更新 ） 请求主体中需要包含的必需参数 )包含要更新到数据库中的现有公司数据。
响应:
与 公司数据设置 | 响应 ( 请参考每个参数的定义 ) 的响应主体相同。
删除公司数据
DELETE /smartfin/api/v1/whitelist/delete
根据其 entity_id 删除单个/多个公司数据。
验证 / 授权
请求标头
架构
请求标头:
Content-Type: application/json
Authorization （验证）：
string - JWT <<您的API密钥（令牌）>> (必填项)
请求载荷
例子:
JSON 主体: {
"del_ids":[261579]
} |
del_ids - array[integer]包含用户删除的独立
entity_id的数组。
响应:
与 公司数据设置 | 响应 ( 请参考每个参数的定义 ) 的响应主体相同。