QueryEvaluateList - Expenses and Costs - Alibaba Cloud Documentation Center

Queries a list of objects that are eligible for invoicing.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

bss:QueryEvaluate

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Type	integer	No	The type. Valid values: 1: queries objects with a negative invoiceable amount. 2: queries objects with a positive invoiceable amount. 3: queries all objects with a non-zero invoiceable amount. 4: queries objects with an invoiced amount greater than 0. Note If you leave this parameter empty, all objects are queried.	1
OutBizId	string	No	The order ID, bill ID, or contract ID.	2387432832696
PageNum	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page. Default value: 20. Maximum value: 300.	10
StartAmount	integer	No	The minimum amount for the query.	100
EndAmount	integer	No	The maximum amount for the query.	1000
StartBizTime	string	No	The beginning of the time range to query based on the successful payment time. The format is yyyy-mm-dd hh:mm:ss.	2020-02-02 12:00:00
EndBizTime	string	No	The end of the time range to query based on the successful payment time. The format is yyyy-mm-dd hh:mm:ss.	2020-02-02 15:00:00
SortType	integer	No	The sorting type. Valid values: 1: sorts the results by ID in descending order. 2: sorts the results by type in descending order, and then by ID in descending order. 3: sorts the results by type in ascending order, and then by ID in descending order.	1
StartSearchTime	string	No	The start 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 list of invoicing entities to which the invoiceable objects belong.	ALIYUN
	string	No	The invoicing entity to which the invoiceable object belongs. Examples: ALIYUN_SERVICE: Alibaba Cloud Computing Co., Ltd. (Service) ALICOM_SERVICE: Alibaba Cloud Computing (Beijing) Co., Ltd. (Service)	ALIYUN

Response elements

Parameter	Type	Description	Example
	object
Code	string	The status code.	Success
Message	string	The error message.	Successful！
RequestId	string	The request ID.	D35FF10E-1B2E-4ABA-8401-0AE17725F50B
Success	boolean	Indicates whether the request was successful.	true
Data	object	The returned data.
PageNum	integer	The page number.	1
TotalUnAppliedInvoiceAmount	integer	The total invoiceable amount that meets the filter criteria. Unit: cents.	12344
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of records.	2
TotalInvoiceAmount	integer	The total invoiced amount that meets the filter criteria. Unit: cents.	12344
HostId	string		cn
EvaluateList	object
Evaluate	array<object>	The list of returned data.
	object
Type	integer	The type. Valid values: 1: queries objects with a negative invoiceable amount. 2: queries objects with a positive invoiceable amount. 3: queries all objects with a non-zero invoiceable amount. 4: queries objects with an invoiced amount greater than 0. Note If you leave this parameter empty, all objects are queried.	1
Status	integer	The status of the invoiceable object. 0: Invoiced 1: Not invoiced (invoiceable) 2: Partially invoiced 3: The invoicing request is being processed and the object is locked.	1
BillId	integer		234543254325
UserId	integer	The user ID.	2738543
BillCycle	string	The billing cycle.	202002
CanInvoiceAmount	integer	The remaining invoiceable amount.	123213
OffsetAcceptAmount	integer	The accepted offset amount. Refunds from other orders, such as unsubscribes or downgrades, can offset the amount for this invoicing record. This parameter corresponds to the OffsetCostAmount parameter in the refund data.	500
ItemId	integer		23453245
OutBizId	string	The order ID, bill ID, or contract ID.	124324213421
UserNick	string	The user nickname.	test
GmtModified	string	The time when the record was last modified.	2018-10-10 18:05:44
OpId	string		12341
BizType	string	The invoicing entity to which the invoiceable object belongs. Examples: ALIYUN_SERVICE: Alibaba Cloud Computing Co., Ltd. (Service) ALICOM_SERVICE: Alibaba Cloud Computing (Beijing) Co., Ltd. (Service)	ALIYUN
OriginalAmount	integer	The total invoiceable amount.	-10000
InvoicedAmount	integer	The amount that has been invoiced.	10000
GmtCreate	string	The time when the record was created.	2018-10-10 18:05:44
PresentAmount	integer	The total invoiceable amount.	-10000
BizTime	string	The consumption time.	2018-10-10 18:05:44
Name	string	The name of the invoiceable object.	Refund of a voucher with denomination marked
OffsetCostAmount	integer	The offset amount. Refunds from other orders, such as unsubscribes or downgrades, can offset the amount for this invoicing record. This parameter corresponds to the OffsetAcceptAmount parameter in the refund data.	500
Id	integer	The ID of the invoiceable object.	1325321532

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.