ChargeSummary
The ChargeSummary provides a detailed breakdown of charges that are
associated with an agreement request. This is applicable only when a request is created for
a PurchaseAgreement.
Note
Tax and invoicing fields (such as estimatedTaxes, amountAfterTax,
newAgreementValueAfterTax, and invoicingEntity) are returned on
a best-effort basis and do not cause the request to fail if unavailable.
A null tax amount can have two meanings:
-
Tax estimation was unavailable at the time of the request.
-
The charge timing is
BILLING_PERIOD, so the charge amount is not determined at request time. In this case, the tax breakdown may still include the taxrateandtype.
Contents
Note
In the following list, the required parameters are described first.
- currencyCode
-
The three-letter currency code for all charges (e.g., USD).
Type: String
Length Constraints: Fixed length of 3.
Pattern:
[A-Z]+Required: No
- estimatedTaxes
-
Provides an aggregated view of estimated tax information for the agreement.
Type: EstimatedTaxes object
Required: No
- expectedCharges
-
A list of expected charges for the agreement request.
Type: Array of ExpectedCharge objects
Required: No
- invoicingEntity
-
The entity responsible for issuing the invoice.
Type: InvoicingEntity object
Required: No
- itemizedCharges
-
An itemized list of charges for the agreement request.
Type: Array of ItemizedCharge objects
Required: No
- newAgreementValue
-
The total value of the agreement, which includes any amendments.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
Pattern:
(.)+Required: No
- newAgreementValueAfterTax
-
Expected new agreement value after estimated taxes are applied.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
Pattern:
(.)+Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
