Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel2
outlinefalse
typelist
printablefalse

基准URL: /smartfin/api/v1/whitelist


获取公司数据

...

POST /smartfin/api/v1/whitelist/select

获取当前用户可见的所有公司数据。

验证 / 授权

  •  API密钥(令牌)

请求标头

架构

...

请求标头:

  • Content-Type: application/json

...

  • string - JWT <<您的API密钥(令牌)>> (必填项)

响应

例子:

Code Block
{
    "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
                ],
                 "regused_entity_capname": 0.0, [
                    "own_eq": 0.0,TEST",
                    "credit_score": 0.0,TEST1"
                "credit_lvl": 0.0],
                "recreg_credit_amtcap": 0.0,
                "affown_groupeq": null0.0,
                "bizcredit_abbrevscore": null0.0,
                "aff_group_credit_amtlvl": 0.0,
                "crec_namecredit_amt": "test2"0.0,
                "uaff_namegroup": "test2" null,
                 },"biz_abbrev": null,
             ...
   "aff_group_credit_amt": 0.0,
       ],         "dropdowncompany_auth_listamt": {"",
            "entity_name": [    "aff_group_auth_amt": "",
                "c_name": "CONNtest2",
                "上海嵘亿国际贸易有限公司u_name",: "test2"
            },
  "U",          ...
      "BASIS TRADE CHINA"],
        "dropdown_list": {
      "OKOKOK",       "entity_name": [
                "SALES4CONN",
                "1上海嵘亿国际贸易有限公司",
                "123U",
                ..."BASIS TRADE CHINA",
          ],      "OKOKOK",
      "aff_group": [         "SALES4",
       "ADSF"         "1",
   ],             "validation123":,
[                ...
"entity_type",            ],
            "aff_group": [
                "client_attrADSF"
            ],
            "entity_typevalidation": [
                "COUNTERPARTYentity_type",
                "BROKERclient_attr"
            ],
            "cliententity_attrtype": [
                {"COUNTERPARTY",
                "BROKER"
   "value": 1,          ],
            "labelclient_attr": [
  "DOMESTIC TRADE COUNTERPARTY"            {
    },                 {"value": 1,
                    "valuelabel": "DOMESTIC 2,TRADE COUNTERPARTY"
                },
  "label": "FOREIGN TRADE COUNTERPARTY"           {
     }             ]  "value": 2,
     }     }

返回

  • 一个名为list的对象列表,每个对象表示一个公司数据 ( 按stock_id降序排列 )

  • 一个名为dropdown_list的列表,其中包含在输入/更新公司数据时使用的各种选择列表。

架构

...

 

...

 

...

 

...

 

...

有关数据的最后更新时间以及更新数据的用户的信息。

...

 

...

 

...

 

...

有关数据的创建时间以及创建数据的用户的信息。

Code Block
user_id, entity_id, company_id - integer

  • user_id - 用户ID(数据所属的用户)

  • entity_id - 分配给数据独立ID。该ID可用于检索公司数据。

  • company_id - 此数据的母公司ID。

Code Block
entity_name, entity_type - string

  • entity_name - 公司名称 (必填项)

  • entity_type - 公司类型 (COUNTERPARTY (客户) or BROKER (经纪商))

Info

entity_nameentity_type 不能重复。

  • 如果在数据库中找到相同的 entity_name , 则将不允许存储entity_name

  • 'COMPANY NAME' 的 entity_name 和 'COUNTERPARTY' 的 entity_type 如果在数据库中已存在,将不允许存储相同的 entity_nameentity_type

Code Block
client_attr - array[integer] or null

...

   "label": "FOREIGN TRADE COUNTERPARTY"
                }
            ]
        }
    }

返回

  • 一个名为list的对象列表,每个对象表示一个公司数据 ( 按entity_id降序排列 )

  • 一个名为dropdown_list的列表,其中包含在输入/更新公司数据时使用的各种选择列表。

架构

...

Code Block
last_update_time, update_by_name, update_by - string

有关数据的最后更新时间以及更新数据的用户的信息。

Code Block
create_time, create_by, create_by_name - string

有关数据的创建时间以及创建数据的用户的信息。

Code Block
user_id, entity_id, company_id - integer

  • user_id - 用户ID(数据所属的用户)

  • entity_id - 公司ID, 分配给数据独立ID。该ID可用于检索公司数据。

  • company_id - 此数据的母公司ID。

Code Block
entity_name, entity_type, entity_name_eng - string

  • entity_name - 客户名称 (必填项)

  • entity_type - 公司类型 (COUNTERPARTY (客户) or BROKER (经纪商)) (必填项)

  • entity_name_eng - 客户英文名称

Info

entity_nameentity_type 不能重复。

  • 如果在数据库中找到相同的 entity_name , 则将不允许存储entity_name

  • 'COMPANY NAME' 的 entity_name 和 'COUNTERPARTY' 的 entity_type 如果在数据库中已存在,将不允许存储相同的 entity_nameentity_type

entity_name_engentity_name 不能有相同文本。

Code Block
client_attr - array[integer]
used_entity_name - array[string]

  • client_attr - 客户属性

  • used_entity_name - 客户曾用名

  • 数据以参数数组( array )形式存在,或者如果参数、为空,则将解析为 null。

Code Block
address, email, tel, country, fax_no, country, invoice_addr, 
invoice_bank, invoice_code, entity_ccy  - string

  • address - 地址

  • email - 电邮地址

  • tel - 联络号码

  • fax_no - 传真

  • country - 国家 (注: 传递国家代码而不是国家名称, China 代表者 CN)

  • invoice_code - 购买纳税人识别号

  • invoice_add - 开票地址

  • invoice_bank - 开票银行

  • reg_no - 营业执照编码

  • entity_ccy - 货币

Code Block
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 - string

  • credit_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 - 所属集团未了结合同总额(折人民币万元)

Code Block
invalid - boolean

公司的现状 (true (停用) or false ““ )

更新 / 输入公司数据

...

更新URL:
POST/smartfin/api/v1/whitelist/update

输入URL:
POST/smartfin/api/v1/whitelist/insert

将新的公司数据输入或更新到数据库中。

验证 / 授权

  •  API密钥(令牌)

请求标头

架构

...

请求标头:

  • Content-Type: application/json

...

  • string - JWT <<您的API密钥(令牌)>> (必填项)

请求载荷 ( 更新 )

例子:

JSON 主体:

Code Block
{
   "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
         ],
         "clientused_entity_attrname": [
            1"TEST",
            "TEST1"
2          ],
         "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_creditauth_amt":0 "",
      }
   ]
}

请求载荷 ( 输入 )

例子:

JSON 主体:

Code Block
{
   "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_add_bank":"",
         "reg_no":"",
         "invalid":"",
         "invoiceclient_bankattr":"",
         "regused_entity_noname":"" [],
         "invalidreg_cap":"",
         "clientown_attreq":"",
         "regcredit_capscore":"",
         "owncredit_eqlvl":"",
         "rec_credit_scoreamt":"",
         "creditaff_lvlgroup":"",
         "recbiz_credit_amtabbrev":"",
         "aff_group_credit_amt":"",
         "bizcompany_auth_abbrevamt": "",
         "aff_group_creditauth_amt": "",
      }
   ]
}

请求架构

...

Code Block
insert_list - array[object]

...

响应:

删除公司数据

...

DELETE/smartfin/api/v1/whitelist/delete

根据其 entity_id 删除单个/多个公司数据。

验证 / 授权

  •  API密钥(令牌)

请求标头

架构

...

请求标头:

  • Content-Type: application/json

...

  • string - JWT <<您的API密钥(令牌)>> (必填项)

请求载荷

例子:

JSON 主体:

Code Block
{
  "del_ids":[261579]
}
Code Block
del_ids - array[integer]
  • 包含用户删除的独立entity_id的数组。

响应: