QueryEvaluateList - BSS OpenAPI - Alibaba Cloud Documentation Center

Queries the information about the orders for which you want to apply for invoices.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
bss:QueryEvaluate	READ	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Type	integer	No	The type of orders to be queried. Valid values: 1: the orders in which the invoiceable amount is negative. 2: the orders in which the invoiceable amount is positive. 3: the orders in which the invoiceable amount is not 0. 4: the orders in which the amount that has been invoiced is greater than 0. Note By default, this parameter is left empty. If this parameter is left empty, all orders are queried.	1
OutBizId	string	No	The ID of the external order.	2387432832696
PageNum	integer	No	The number of the page to return.	1
PageSize	integer	No	The number of entries to return on each page.	10
StartAmount	long	No	The minimum amount to be queried.	100
EndAmount	long	No	The maximum amount to be queried.	1000
StartBizTime	string	No	The earliest time when an order is paid. Specify the time in the yyyy-mm-dd hh:mm:ss format.	2020-02-02 12:00:00
EndBizTime	string	No	The latest time when an order is paid Specify the time in the yyyy-mm-dd hh:mm:ss format.	2020-02-02 15:00:00
SortType	integer	No	The type of the sort. Valid values: 1: Sort invoices by ID in descending order. 2: Sort invoices by invoice type in descending order, and then sort invoices of the same type by ID in descending order. 3: Sort invoices by invoice type in ascending order, and then sort invoices of the same type by ID in descending order.	1
StartSearchTime	string	No	The beginning of the time range to query.	2020-02-02 12:00:00
EndSearchTime	string	No	The end of the time range to query.	2020-03-02 12:00:00
BillCycle	string	No	The billing cycle.	202003
BizTypeList	array	No	The market types in invoices. Note By default, this parameter is left empty. If this parameter is left empty, all market types are queried.
	string	No	The market type in the invoice. Valid values: ALIYUN: Alibaba Cloud MARKETPLACE: Alibaba Cloud Marketplace	ALIYUN

Response parameters

Parameter	Type	Description	Example
	object
Code	string	The status code.	Success
Message	string	The error message returned.	Successful！
RequestId	string	The ID of the request.	D35FF10E-1B2E-4ABA-8401-0AE17725F50B
Success	boolean	Indicates whether the request was successful.	true
Data	object	The data returned.
PageNum	integer	The number of the page returned.	1
TotalUnAppliedInvoiceAmount	long	The invoiceable amount that meets the query conditions. Unit: Cent.	12344
PageSize	integer	The number of entries returned per page.	10
TotalCount	integer	The total number of returned entries.	2
TotalInvoiceAmount	long	The invoiced amount that meets the query conditions. Unit: Cent.	12344
HostId	string	The ID of the host.	cn
EvaluateList	object []	The data returned.
Type	integer	The type of orders that are queried. Valid values: 1: the orders in which the invoiceable amount is negative. 2: the orders in which the invoiceable amount is positive. 3: the orders in which the invoiceable amount is not 0. 4: the orders in which the amount that has been invoiced is greater than 0. Note By default, this parameter is left empty. If this parameter is left empty, all orders are queried.	1
Status	integer	The status of the invoiceable amount.	1
BillId	long	The ID of the bill.	234543254325
UserId	long	The ID of the user.	2738543
BillCycle	string	The billing cycle.	202002
CanInvoiceAmount	long	The invoiceable amount.	123213
OffsetAcceptAmount	long	If a refund is issued due to an order such as an unsubscription order or a configuration downgrade order, the refund amount is used to offset the amount of the invoice. The value is consistent with the value of the OffsetCostAmount parameter.	500
ItemId	long	The ID of the item.	23453245
OutBizId	string	The ID of the external order.	124324213421
UserNick	string	The nickname of the user.	test
GmtModified	string	The modification time.	2018-10-10 18:05:44
OpId	string	The ID of the external object.	12341
BizType	string	The market type in the invoice. Valid values: ALIYUN: Alibaba Cloud MARKETPLACE: Alibaba Cloud Marketplace	ALIYUN
OriginalAmount	long	The original amount.	-10000
InvoicedAmount	long	The invoiced amount.	10000
GmtCreate	string	The creation time.	2018-10-10 18:05:44
PresentAmount	long	The balance.	-10000
BizTime	string	The time.	2018-10-10 18:05:44
Name	string	The name of the object to be invoiced.	Refund of a voucher with denomination marked
OffsetCostAmount	long	The refund amount used to offset the amount of the invoice. If a refund is issued due to an order such as an unsubscription order or a configuration downgrade order, the refund amount is used to offset the amount of the invoice. The value is consistent with the value of the OffsetAcceptAmount parameter.	500
Id	long	The ID of the invoice.	1325321532

Examples

Sample success responses

JSONformat

{
  "Code": "Success",
  "Message": "Successful！",
  "RequestId": "D35FF10E-1B2E-4ABA-8401-0AE17725F50B",
  "Success": true,
  "Data": {
    "PageNum": 1,
    "TotalUnAppliedInvoiceAmount": 12344,
    "PageSize": 10,
    "TotalCount": 2,
    "TotalInvoiceAmount": 12344,
    "HostId": "cn",
    "EvaluateList": {
      "Evaluate": [
        {
          "Type": 1,
          "Status": 1,
          "BillId": 234543254325,
          "UserId": 2738543,
          "BillCycle": "202002",
          "CanInvoiceAmount": 123213,
          "OffsetAcceptAmount": 500,
          "ItemId": 23453245,
          "OutBizId": "124324213421",
          "UserNick": "test",
          "GmtModified": "2018-10-10 18:05:44",
          "OpId": "12341",
          "BizType": "ALIYUN",
          "OriginalAmount": -10000,
          "InvoicedAmount": 10000,
          "GmtCreate": "2018-10-10 18:05:44",
          "PresentAmount": -10000,
          "BizTime": "2018-10-10 18:05:44",
          "Name": "Refund of a voucher with denomination marked\n",
          "OffsetCostAmount": 500,
          "Id": 1325321532
        }
      ]
    }
  }
}

Error codes

For a list of error codes, visit the Service error codes.