Revenue Cloud Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
AbstractTransactionResponse Class
Abstract class that contains methods for setting tax fields based on
the external tax provider's response. Response classes that extend AbstractTransactionResponse inherit these methods.
Namespace
AbstractTransactionResponse Methods
Learn more about the methods for AbstractTransactionResponse class.
The AbstractTransactionResponse class includes these methods.
setAddresses(addresses)
Signature
global void setAddresses(commercetax.AddressesResponse addresses)
Parameters
- addresses
- Type: AddressesResponse
- Class that contains methods to set the Ship To, Ship From, and Sold To address information.
Return Value
Type: void
setAmountDetails(amountDetails)
Uses an instance of AmountDetailsResponse to set tax amount fields such as exemption amount and tax
amount.
Signature
global void setAmountDetails(commercetax.AmountDetailsResponse amountDetails)
Parameters
- amountDetails
- Type: AmountDetailsResponse
- Class that contains methods to set the tax exemption amount, tax amount, total amount, and total amount with tax.
Return Value
Type: void
setDocumentCode(documentCode)
Sets the DocumentCode field. Document codes are often used to
reference tax documents that the external tax engine uses in the tax calculation process.
Document code acts as a unique link to chain-related transactions, such as amendment or
refunds.
Signature
global void setDocumentCode(String documentCode)
Parameters
- documentCode
- Type: String
- Code for a tax document used in the tax calculation process.
Return Value
Type: void
setEffectiveDate(effectiveDate)
Sets the EffectiveDate field. Effective Date fields are optional
fields that store the date that a transaction takes effect. We provide these fields only for
recordkeeping purposes – for example, if you must report an effective date to an
external general ledger system. Salesforce doesn't use them to calculate any tax or payment
values.
Signature
global void setEffectiveDate(Datetime effectiveDate)
Parameters
- effectiveDate
- Type: Datetime
- Optional field that stores the date that a transaction takes effect.
Return Value
Type: void
setLineItems(lineItems)
Uses an instance of the LineItemResponse class to set a list of line items. Each line item represents an
item sent to an external tax engine for tax calculation.
Signature
global void setLineItems(List<commercetax.LineItemResponse> lineItems)
Parameters
- lineItems
- Type: List<LineItemResponse>
- A list of line items sent to an external tax engine for tax calculation.
Return Value
Type: void
setReferenceDocumentCode(referenceDocumentCode)
Sets the ReferenceDocumentCode field. Use this field to store the
code of an additional document used in the tax calculation process. For example, use this
field in case of a refund for a previously taxed purchase.
Signature
global void setReferenceDocumentCode(String referenceDocumentCode)
Parameters
- referenceDocumentCode
- Type: String
- The code for a document used in the tax calculation process.
Return Value
Type: void
setReferenceEntityId(referenceEntityId)
Sets the ID of a reference entity. In Commerce Tax, a reference
entity represents a record related to the items sent to the external tax engine for tax
calculation. For example, if you sent order items for tax calculation, you could define the
parent order as the reference entity.
Signature
global void setReferenceEntityId(String referenceEntityId)
Parameters
- referenceEntityId
- Type: String
- ID of a record related to the items sent for tax calculation.
Return Value
Type: void
setTaxTransactionId(taxTrxnId)
Sets the TaxTransactionId field using the ID of a tax transaction
record. In Commerce Tax, a tax transaction record stores information about a specific tax
calculation process.
Signature
global void setTaxTransactionId(String taxTrxnId)
Parameters
- taxTrxnId
- Type: String
- The ID of a tax transaction record in Commerce Tax.
Return Value
Type: void