Class: Aws::Payments::Types::Balances
- Inherits:
-
Struct
- Object
- Struct
- Aws::Payments::Types::Balances
- Defined in:
- gems/aws-sdk-payments/lib/aws-sdk-payments/types.rb
Overview
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.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#canceled ⇒ Types::CurrencyAmount
The part of the amount that was canceled and isn't settled, for example when an invoice is voided.
-
#outstanding ⇒ Types::CurrencyAmount
The part of the amount that isn't settled and has no settlement in progress.
-
#processing ⇒ Types::CurrencyAmount
The part of the amount with a settlement in progress, for example a payment that's submitted but not yet confirmed.
-
#settled ⇒ Types::CurrencyAmount
The part of the amount that is settled.
Instance Attribute Details
#canceled ⇒ Types::CurrencyAmount
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 settled balance, and the rest of the amount
moves to canceled. This balance is more than 0 only when the
status is CANCELED.
102 103 104 105 106 107 108 109 |
# File 'gems/aws-sdk-payments/lib/aws-sdk-payments/types.rb', line 102 class Balances < Struct.new( :outstanding, :processing, :settled, :canceled) SENSITIVE = [] include Aws::Structure end |
#outstanding ⇒ Types::CurrencyAmount
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.
102 103 104 105 106 107 108 109 |
# File 'gems/aws-sdk-payments/lib/aws-sdk-payments/types.rb', line 102 class Balances < Struct.new( :outstanding, :processing, :settled, :canceled) SENSITIVE = [] include Aws::Structure end |
#processing ⇒ Types::CurrencyAmount
The part of the amount with a settlement in progress, for example a
payment that's submitted but not yet confirmed. It moves to
settled when the settlement completes, and back to outstanding
when the settlement fails. This balance is more than 0 only when the
status is PROCESSING.
102 103 104 105 106 107 108 109 |
# File 'gems/aws-sdk-payments/lib/aws-sdk-payments/types.rb', line 102 class Balances < Struct.new( :outstanding, :processing, :settled, :canceled) SENSITIVE = [] include Aws::Structure end |
#settled ⇒ Types::CurrencyAmount
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.
102 103 104 105 106 107 108 109 |
# File 'gems/aws-sdk-payments/lib/aws-sdk-payments/types.rb', line 102 class Balances < Struct.new( :outstanding, :processing, :settled, :canceled) SENSITIVE = [] include Aws::Structure end |