`mixins.clearing`

Provides functionality to clearable Transactions for assignment to assignable Transactions.

Module Contents

This class provides clearable Transactions functionality for assigning them to

class mixins.clearing.ClearingMixin

This class provides clearable Transactions functionality for assigning them to assignable Transactions.

cleared(session) → decimal.Decimal

Gets how much of the Transaction amount has been cleared by assignable Transactions.

Parameters:: session (Session) – The accounting session to which the Transaction belongs.
Returns:: The total amount of assignments made against Transaction.
Return type:: Decimal

clearances(session) → list

Gets the assignments made to clear the Transaction.

Parameters:: session (Session) – The accounting session to which the Transaction belongs.
Returns:: A List of assignments made to clear the Transaction.

unclear(session) → None

Removes all assignments made to clear this Transaction.

Parameters:: session (Session) – The accounting session to which the Transaction belongs.
Returns:: None