Interface GetAccountBalanceRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<GetAccountBalanceRequest.Builder,,GetAccountBalanceRequest> PaymentsRequest.Builder,SdkBuilder<GetAccountBalanceRequest.Builder,,GetAccountBalanceRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
GetAccountBalanceRequest
-
Method Summary
Modifier and TypeMethodDescriptionbalanceType(String balanceType) The balance to retrieve.balanceType(BalanceType balanceType) The balance to retrieve.maxResults(Integer maxResults) The maximum number of results to return in one page.The pagination token from thenextTokenof the previous response.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.services.payments.model.PaymentsRequest.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
balanceType
The balance to retrieve. You can specify only one balance type in a single request. Each balance adds up the
outstandingbalance of the records that have the statusOUTSTANDING. A record that isPROCESSING,SETTLED, orCANCELEDisn'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.
- Parameters:
balanceType- The balance to retrieve. You can specify only one balance type in a single request. Each balance adds up theoutstandingbalance of the records that have the statusOUTSTANDING. A record that isPROCESSING,SETTLED, orCANCELEDisn'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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
balanceType
The balance to retrieve. You can specify only one balance type in a single request. Each balance adds up the
outstandingbalance of the records that have the statusOUTSTANDING. A record that isPROCESSING,SETTLED, orCANCELEDisn'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.
- Parameters:
balanceType- The balance to retrieve. You can specify only one balance type in a single request. Each balance adds up theoutstandingbalance of the records that have the statusOUTSTANDING. A record that isPROCESSING,SETTLED, orCANCELEDisn'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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
nextToken
The pagination token from the
nextTokenof 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 withValidationExceptionand the reasonINVALID_PAGINATION_TOKEN. In that case, start again from the first page.- Parameters:
nextToken- The pagination token from thenextTokenof 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 withValidationExceptionand the reasonINVALID_PAGINATION_TOKEN. In that case, start again from the first page.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxResults
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
nextTokento find out whether more results are available.- Parameters:
maxResults- The maximum number of results to return in one page. The default is 100. A page can contain fewer results even when more remain. UsenextTokento find out whether more results are available.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
GetAccountBalanceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
overrideConfiguration- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
GetAccountBalanceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-