Child pages
  • Admin API Method listUnitTransactions

This documentation is for a previous version of Flexiant Cloud Orchestrator. The most recent version is v5.0. For the most recent documentation please see here

Skip to end of metadata
Go to start of metadata

Description
This function searches for a list of unit transactions.
Style
Document
Input (Literal)
The input of this method is the argument listUnitTransactions of type listUnitTransactions having the structure defined by the following table.

Element

Type

Occurs

Description

searchFilter

searchFilter

0..1

The filter to apply

queryLimit

queryLimit

0..1

The query limit for the filter

Output (Literal)
The output of this method is the argument listUnitTransactionsResponse of type listUnitTransactionsResponse having the structure defined by the following table.

Element

Type

Occurs

Description

listUnitTransaction

listResult

0..1

The list of unit transactions

Remarks
On an exception, no unit transactions are returned.
The unit transactions searched for are specified by the searchFilter and the queryLimit specified by the caller. For documentation on how the filter and query limit work, see the complex types searchFilter and queryLimit.
Unit transactions each represent a credit or a debit to the unit balance within an individual customer account, and are typically either the result of the customer being billed for a virtual resource for one or more billing periods, or because the customer has purchased units. For more details, see the unitTransaction complex type. As unit transactions are the lowest level billing item, they are produced in large quantity by the system. We therefore recommend using listUnitTransactionSummary if possible.

  • No labels