Child pages
  • Admin API Method doUnitTransaction

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 will return a newly created Unit Transaction Object.
Style
Document
Input (Literal)
The input of this method is the argument doUnitTransaction of type doUnitTransaction having the structure defined by the following table.

Element

Type

Occurs

Description

customerUUID

string

0..1

The UUID of the customer to which the transaction applies

description

string

0..1

An optional textual description of the transaction

transactionType

transactionType

0..1

The type of the transaction (either credit or debit)

units

double

1..1

The number of units for the transactions

unitType

unitType

0..1

The type of units (either carry-over or non-carry-over)

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

Element

Type

Occurs

Description

unitTransaction

unitTransaction

0..1

The unit transaction object that has been created

Remarks
On an exception, no transaction is committed.

  • No labels