Class Balances
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<Balances.Builder,Balances>
How much of the record's amount is outstanding, processing, settled, and canceled. The four balances add
up to amount. Each balance is in the currency of amount, and a balance with nothing in it
is 0.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic Balances.Builderbuilder()final CurrencyAmountcanceled()The part of the amount that was canceled and isn't settled, for example when an invoice is voided.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final inthashCode()final CurrencyAmountThe part of the amount that isn't settled and has no settlement in progress.final CurrencyAmountThe part of the amount with a settlement in progress, for example a payment that's submitted but not yet confirmed.static Class<? extends Balances.Builder> final CurrencyAmountsettled()The part of the amount that is settled.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
outstanding
The part of the amount that isn't settled and has no settlement in progress. For an invoice, this is what remains to pay. For a credit memo, this is the credit that isn't yet applied. This balance doesn't include
processing.- Returns:
- The part of the amount that isn't settled and has no settlement in progress. For an invoice, this is what
remains to pay. For a credit memo, this is the credit that isn't yet applied. This balance doesn't
include
processing.
-
processing
The part of the amount with a settlement in progress, for example a payment that's submitted but not yet confirmed. It moves to
settledwhen the settlement completes, and back tooutstandingwhen the settlement fails. This balance is more than 0 only when thestatusisPROCESSING.- Returns:
- The part of the amount with a settlement in progress, for example a payment that's submitted but not yet
confirmed. It moves to
settledwhen the settlement completes, and back tooutstandingwhen the settlement fails. This balance is more than 0 only when thestatusisPROCESSING.
-
settled
The part of the amount that is settled. For an invoice, this is the amount paid or covered by credit memos. For a credit memo, this is the amount applied to invoices. This balance is 0 when nothing is settled yet.
- Returns:
- The part of the amount that is settled. For an invoice, this is the amount paid or covered by credit memos. For a credit memo, this is the amount applied to invoices. This balance is 0 when nothing is settled yet.
-
canceled
The part of the amount that was canceled and isn't settled, for example when an invoice is voided. When a partly settled record is canceled, it keeps its
settledbalance, and the rest of the amount moves tocanceled. This balance is more than 0 only when thestatusisCANCELED.- Returns:
- The part of the amount that was canceled and isn't settled, for example when an invoice is voided. When a
partly settled record is canceled, it keeps its
settledbalance, and the rest of the amount moves tocanceled. This balance is more than 0 only when thestatusisCANCELED.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<Balances.Builder,Balances> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-