Class: Aws::Payments::Types::GetAccountBalanceRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Payments::Types::GetAccountBalanceRequest
- Defined in:
- gems/aws-sdk-payments/lib/aws-sdk-payments/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#balance_type ⇒ String
The balance to retrieve.
-
#max_results ⇒ Integer
The maximum number of results to return in one page.
-
#next_token ⇒ String
The pagination token from the
nextTokenof the previous response.
Instance Attribute Details
#balance_type ⇒ String
The balance to retrieve. You can specify only one balance type in a
single request. Each balance adds up the outstanding balance of
the records that have the status OUTSTANDING. A record that is
PROCESSING, SETTLED, or CANCELED isn't included, even when
part of its amount is outstanding. The following values are valid:
INVOICES_DUE– The outstanding balance of yourOUTSTANDINGinvoices that aren't past their due date, wheredueStatusisDUE.INVOICES_PAST_DUE– The outstanding balance of yourOUTSTANDINGinvoices that are past their due date, wheredueStatusisPAST_DUE.OUTSTANDING_CREDIT_MEMOS– The outstanding balance of yourOUTSTANDINGcredit memos: the credit that isn't yet applied to an invoice.
672 673 674 675 676 677 678 |
# File 'gems/aws-sdk-payments/lib/aws-sdk-payments/types.rb', line 672 class GetAccountBalanceRequest < Struct.new( :balance_type, :next_token, :max_results) SENSITIVE = [] include Aws::Structure end |
#max_results ⇒ Integer
The maximum number of results to return in one page. The default is
100. A page can contain fewer results even when more remain. Use
nextToken to find out whether more results are available.
672 673 674 675 676 677 678 |
# File 'gems/aws-sdk-payments/lib/aws-sdk-payments/types.rb', line 672 class GetAccountBalanceRequest < Struct.new( :balance_type, :next_token, :max_results) SENSITIVE = [] include Aws::Structure end |
#next_token ⇒ String
The pagination token from the nextToken of the previous response.
Omit it to get the first page. Tokens expire. If the token is
malformed or expired, or doesn't match the original request, the
request fails with ValidationException and the reason
INVALID_PAGINATION_TOKEN. In that case, start again from the first
page.
672 673 674 675 676 677 678 |
# File 'gems/aws-sdk-payments/lib/aws-sdk-payments/types.rb', line 672 class GetAccountBalanceRequest < Struct.new( :balance_type, :next_token, :max_results) SENSITIVE = [] include Aws::Structure end |