交易对手查询接口
POST
/open-api/counterparty/page
业务错误码#
错误码 | 错误描述(详情请看返回响应示例) | 解决方案 |
---|---|---|
000000 | 操作成功 | |
300000 | 业务处理异常 | 根据详细提示检查信息或联系相关技术人员进行排查 |
400001 | 入参校验错误 | 请检查入参信息(必填,格式,枚举值,长度等) |
请求参数
Body 参数application/json
page_no
integer
可选
示例值:
1
page_size
integer
可选
<= 200
示例值:
10
name
array[string]
可选
示例值:
["张三"]
code
array[string]
可选
示例值:
["XXX1","XXX2"]
is_effective
integer
可选
示例值:
1
is_account_effective
integer
可选
示例值:
1
示例
{
"page_no": 1,
"page_size": 10,
"name": "[\"张三\"]",
"code": "[\"XXX1\",\"XXX2\"]",
"is_effective": 1,
"is_account_effective": 1
}
示例代码
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/open-api/counterparty/page' \
--header 'Content-Type: application/json' \
--data-raw '{
"page_no": 1,
"page_size": 10,
"name": "[\"张三\"]",
"code": "[\"XXX1\",\"XXX2\"]",
"is_effective": 1,
"is_account_effective": 1
}'
返回响应
🟢200成功
application/json
Body
code
string
状态码
msg
string
返回消息
data
object (BizOpenApiPageCounterpartyPageApiResponse)
承载数据
page_no
integer <int64>
当前页码
示例值:
1
page_size
integer <int64>
页大小
示例值:
10
total_pages
integer <int64>
总页数
示例值:
1
records
array[object (CounterpartyPageApiResponse) {39}]
查询数据列表
默认值:
Collections.emptyList()
total
integer <int64>
总数
默认值:
0
示例
{
"code": "",
"msg": "",
"data": {
"page_no": 0,
"page_size": 0,
"total_pages": 0,
"records": [
{
"unique_id": "",
"name": "",
"code": "",
"mnemonic_code": "",
"eng_name": "",
"eng_abbreviation_name": "",
"country_code": "",
"country_name": "",
"unified_social_credit_code": "",
"registered_address": "",
"office_address": "",
"eng_office_address": "",
"is_general_taxpayer": 0,
"nature": "",
"establishment_date": "",
"year_limit_start": 0,
"year_limit_end": 0,
"registered_fund": "",
"currency_code": "",
"currency_name": "",
"legal_person": "",
"scale": "",
"annual_output_value": "",
"financial_officer": "",
"debt_ratio": "",
"label": [
{
"code": "",
"name": ""
}
],
"category": 0,
"category_info": "",
"classification": "",
"classification_info": "",
"is_share": 0,
"org_id": 0,
"org_name": "",
"responsible_person": "",
"is_effective": 0,
"description": "",
"accounts": [
{
"account_number": "",
"account_name": "",
"account_eng_name": "",
"bank_code": "",
"bank_name": "",
"branch_code": "",
"branch_name": "",
"branch_eng_name": "",
"country_code": "",
"country_name": "",
"currency_code": "",
"currency_name": "",
"address": "",
"swift_code": "",
"private_flag": 0,
"memo": "",
"is_default_settlement_account": 0,
"is_effective": 0
}
],
"contact_person": [
{
"name": "",
"phone": "",
"email": "",
"weixin": "",
"position": "",
"description": ""
}
],
"credit_rating": [
{
"rating": "",
"institution": "",
"obtain_date": "",
"expiring_date": "",
"description": ""
}
]
}
],
"total": 0
}
}