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.

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 tax rate and type.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The three-letter currency code for all charges (e.g., USD).

Link copied to clipboard

Provides an aggregated view of estimated tax information for the agreement.

Link copied to clipboard

A list of expected charges for the agreement request.

Link copied to clipboard

The entity responsible for issuing the invoice.

Link copied to clipboard

An itemized list of charges for the agreement request.

Link copied to clipboard

The total value of the agreement, which includes any amendments.

Link copied to clipboard

Expected new agreement value after estimated taxes are applied.

Functions

Link copied to clipboard
inline fun copy(block: ChargeSummary.Builder.() -> Unit = {}): ChargeSummary
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String