Interface Balances.Builder
- All Superinterfaces:
Buildable,CopyableBuilder<Balances.Builder,,Balances> SdkBuilder<Balances.Builder,,Balances> SdkPojo
- Enclosing class:
Balances
-
Method Summary
Modifier and TypeMethodDescriptiondefault Balances.Buildercanceled(Consumer<CurrencyAmount.Builder> canceled) The part of the amount that was canceled and isn't settled, for example when an invoice is voided.canceled(CurrencyAmount canceled) The part of the amount that was canceled and isn't settled, for example when an invoice is voided.default Balances.Builderoutstanding(Consumer<CurrencyAmount.Builder> outstanding) The part of the amount that isn't settled and has no settlement in progress.outstanding(CurrencyAmount outstanding) The part of the amount that isn't settled and has no settlement in progress.default Balances.Builderprocessing(Consumer<CurrencyAmount.Builder> processing) The part of the amount with a settlement in progress, for example a payment that's submitted but not yet confirmed.processing(CurrencyAmount processing) The part of the amount with a settlement in progress, for example a payment that's submitted but not yet confirmed.default Balances.Buildersettled(Consumer<CurrencyAmount.Builder> settled) The part of the amount that is settled.settled(CurrencyAmount settled) The part of the amount that is settled.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
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.- Parameters:
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 includeprocessing.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
This is a convenience method that creates an instance of theprocessing.CurrencyAmount.Builderavoiding the need to create one manually viaCurrencyAmount.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tooutstanding(CurrencyAmount).- Parameters:
outstanding- a consumer that will call methods onCurrencyAmount.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.- Parameters:
processing- The part of the amount with a settlement in progress, for example a payment that's submitted but not yet confirmed. It moves tosettledwhen the settlement completes, and back tooutstandingwhen the settlement fails. This balance is more than 0 only when thestatusisPROCESSING.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
This is a convenience method that creates an instance of thesettledwhen the settlement completes, and back tooutstandingwhen the settlement fails. This balance is more than 0 only when thestatusisPROCESSING.CurrencyAmount.Builderavoiding the need to create one manually viaCurrencyAmount.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toprocessing(CurrencyAmount).- Parameters:
processing- a consumer that will call methods onCurrencyAmount.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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.
This is a convenience method that creates an instance of theCurrencyAmount.Builderavoiding the need to create one manually viaCurrencyAmount.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tosettled(CurrencyAmount).- Parameters:
settled- a consumer that will call methods onCurrencyAmount.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.- Parameters:
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 itssettledbalance, and the rest of the amount moves tocanceled. This balance is more than 0 only when thestatusisCANCELED.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
This is a convenience method that creates an instance of thesettledbalance, and the rest of the amount moves tocanceled. This balance is more than 0 only when thestatusisCANCELED.CurrencyAmount.Builderavoiding the need to create one manually viaCurrencyAmount.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tocanceled(CurrencyAmount).- Parameters:
canceled- a consumer that will call methods onCurrencyAmount.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-