application Id
applicationId : string
Optionalconfig Id
configId ?: string
Optionalconfig Version
configVersion ?: number
currency
currency : string
errors
errors : { code : string ; field ?: string ; message : string } []
kind
kind : "cart_estimate" | "checkout_final" | "quote" | "external_snapshot"
prompts
prompts : { code : "missing_info" ; field : string ; message : string } []
Optionalprovider Messages
providerMessages ?: { citationCode ?: string ; details ?: string ; refersTo ?: string ; severity ?: string ; source ?: string ; summary : string ; } []
Type Declaration
OptionalcitationCode ?: string
Optionaldetails ?: string
OptionalrefersTo ?: string
Optionalseverity ?: string
Optionalsource ?: string
summary : string
Optionalselected Shipping Method Id
selectedShippingMethodId ?: string | null
shipping
shipping : { errors : { code : string ; field ?: string ; message : string } [] ; matchedZoneIds : string [] ; methods : ShippingTaxMethod [] ; selectedMethod : ShippingTaxMethod | null ; shippingRequired : boolean ; warnings : { code : string ; field ?: string ; message : string } [] ; }
shipping Required
shippingRequired : boolean
Optionalsnapshot Id
snapshotId ?: string
source
source : "off" | "byo" | "calculated" | "app_based" | "external_push"
status
status : "estimated" | "final" | "failed"
tax
tax : { errors : { code : string ; field ?: string ; message : string } [] ; lines : TaxLine [] ; matchedRegionIds : string [] ; taxTotal : number ; warnings : { code : string ; field ?: string ; message : string } [] ; }
totals
totals : { discountTotal : number ; shippingTotal : number ; subtotal : number ; taxTotal : number ; total : number ; }
warnings
warnings : { code : string ; field ?: string ; message : string } []
Optionalworkspace Id
workspaceId ?: string
Verbatim messaging the tax engine returned about this transaction. In several EU member states the engine's own wording is what makes the invoice compliant, so it is carried through rather than paraphrased.