136 lines
4.9 KiB
YAML
136 lines
4.9 KiB
YAML
BillQuery:
|
|
post:
|
|
tags:
|
|
- 账单管理
|
|
summary: 账单查询
|
|
description: |
|
|
根据客户编号查询账单信息，包括客户基本信息和账单详情。
|
|
|
|
## 业务说明
|
|
- 支持根据客户编号（缴费号）查询账单
|
|
- 返回客户基本信息和未缴费账单列表
|
|
- 支持XML和JSON两种数据格式
|
|
- 数据传输支持多种加密方式
|
|
|
|
## 调用频率限制
|
|
- 单个客户编号每分钟最多查询10次
|
|
- 单个机构每分钟最多查询1000次
|
|
|
|
operationId: queryBill
|
|
parameters:
|
|
- $ref: '../components/parameters.yaml#/components/parameters/ContentTypeHeader'
|
|
- $ref: '../components/parameters.yaml#/components/parameters/EncryptTypeHeader'
|
|
- $ref: '../components/parameters.yaml#/components/parameters/EncryptModeHeader'
|
|
- $ref: '../components/parameters.yaml#/components/parameters/DataTypeHeader'
|
|
requestBody:
|
|
required: true
|
|
description: 账单查询请求数据
|
|
content:
|
|
application/xml:
|
|
schema:
|
|
$ref: '../components/schemas.yaml#/components/schemas/BillQueryRequest'
|
|
example: |
|
|
<?xml version="1.0" encoding="GBK"?>
|
|
<in>
|
|
<Version>1.0.1</Version>
|
|
<InstId>00001</InstId>
|
|
<TranCode>Query</TranCode>
|
|
<TranDate>20240101</TranDate>
|
|
<TranSeq>123456789012</TranSeq>
|
|
<BillKey>123456</BillKey>
|
|
<CompanyId>654321</CompanyId>
|
|
</in>
|
|
application/json:
|
|
schema:
|
|
$ref: '../components/schemas.yaml#/components/schemas/BillQueryRequest'
|
|
example:
|
|
Version: "1.0.1"
|
|
InstId: "00001"
|
|
TranCode: "Query"
|
|
TranDate: "20240101"
|
|
TranSeq: "123456789012"
|
|
BillKey: "123456"
|
|
CompanyId: "654321"
|
|
|
|
responses:
|
|
'200':
|
|
description: 查询成功
|
|
headers:
|
|
Content-Type:
|
|
$ref: '../components/headers.yaml#/components/headers/ContentType'
|
|
X-Response-Time:
|
|
$ref: '../components/headers.yaml#/components/headers/ResponseTime'
|
|
X-Request-Id:
|
|
$ref: '../components/headers.yaml#/components/headers/RequestId'
|
|
content:
|
|
application/xml:
|
|
schema:
|
|
$ref: '../components/schemas.yaml#/components/schemas/BillQueryResponse'
|
|
example: |
|
|
<?xml version="1.0" encoding="GBK"?>
|
|
<out>
|
|
<Version>1.0.1</Version>
|
|
<InstId>00001</InstId>
|
|
<TranCode>QueryRes</TranCode>
|
|
<TranDate>20240101</TranDate>
|
|
<TranSeq>123456789012</TranSeq>
|
|
<RespCode>AAAAAAA</RespCode>
|
|
<RespMessage>成功</RespMessage>
|
|
<Data>
|
|
<Customer>
|
|
<BillKey>123456</BillKey>
|
|
<CustomerName>张三</CustomerName>
|
|
<ContractNo>CONTRACT001</ContractNo>
|
|
<CompanyId>654321</CompanyId>
|
|
</Customer>
|
|
<Bills>
|
|
<Bill>
|
|
<BillKey>123456</BillKey>
|
|
<CompanyId>654321</CompanyId>
|
|
<PayAmount>150.00</PayAmount>
|
|
<Balance>0.00</Balance>
|
|
<BeginDate>2024-01-01</BeginDate>
|
|
<EndDate>2024-01-31</EndDate>
|
|
<BillStatus>0</BillStatus>
|
|
</Bill>
|
|
</Bills>
|
|
</Data>
|
|
</out>
|
|
application/json:
|
|
schema:
|
|
$ref: '../components/schemas.yaml#/components/schemas/BillQueryResponse'
|
|
example:
|
|
Version: "1.0.1"
|
|
InstId: "00001"
|
|
TranCode: "QueryRes"
|
|
TranDate: "20240101"
|
|
TranSeq: "123456789012"
|
|
RespCode: "AAAAAAA"
|
|
RespMessage: "成功"
|
|
Data:
|
|
Customer:
|
|
BillKey: "123456"
|
|
CustomerName: "张三"
|
|
ContractNo: "CONTRACT001"
|
|
CompanyId: "654321"
|
|
Bills:
|
|
- BillKey: "123456"
|
|
CompanyId: "654321"
|
|
PayAmount: 150.00
|
|
Balance: 0.00
|
|
BeginDate: "2024-01-01"
|
|
EndDate: "2024-01-31"
|
|
BillStatus: 0
|
|
|
|
'400':
|
|
$ref: '../components/responses.yaml#/components/responses/BusinessError'
|
|
'500':
|
|
$ref: '../components/responses.yaml#/components/responses/SystemError'
|
|
'401':
|
|
$ref: '../components/responses.yaml#/components/responses/SecurityError'
|
|
'408':
|
|
$ref: '../components/responses.yaml#/components/responses/NetworkError'
|
|
|
|
security:
|
|
- ApiKeyAuth: []
|
|
- EncryptedData: [] |