1. Interface Description
Interface request domain name: bill.api3.convergecloud.com.
Queries repayment records and write-off records of an account.
Default interface request rate limit: 20 times per second.
Interface update time: 2019-07-05 18:15:20.
The interface is both signature verification and authentication.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: DescribeAccountWater |
| Version | Yes | No | String | Public parameter, The value of this interface: 2018-10-25 |
| Region | No | No | String | Public parameter,Regional information This interface does not need to pass this parameter. |
| AcctId | Yes | No | String | The unique identifier of the account. Example: 1001 |
| SubAcctid | Yes | No | String | The identifier of the credit-fixed sub-account. CREDIT_FIXED Example: CREDIT_FIXED |
| Device | Yes | No | Int64 | The type of the device that sends the request. 0: PC. 1: mobile phone. Example: 1 |
| Ts | Yes | No | Int64 | The UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC. Example: 1730702488 |
| StartTime | No | No | String | The beginning of the time range to query. The value is a number representing the point in time, such as 20150617 or 20150617111855. Example: 20150617111855 |
| EndTime | No | No | String | The end of the time range to query. The value is a number representing the point in time, such as 20150617 or 20150617111855. Example: 20150617111855 |
| Limit | No | No | Uint64 | The number of transaction records to be returned. The maximum value is 20. Example: 20 |
| Offset | No | No | Uint64 | The number of the page to be returned. Example: 0 |
| WaterFilter | No | No | String | If this parameter is specified, the system queries transaction records based on the specify type. Valid values: RefundDebt: repayment records. WriteOff: write-off records. Example: nRefundDebt |
| BillNo | No | No | String | The ID of the write-off transaction. If the WaterFilter parameter is set to WriteOff, this parameter is required. Example: 20240912110368 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| AllNum | String | The total number of transaction records. Example: 1000 |
| RetNum | String | The number of transaction records that are returned. Example: 1000 |
| Offset | String | The number of the page returned. Example: 0 |
| WaterSet | Array of WaterListData | List of transaction records. Example:View |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| InvalidParameter | Parameter error. |