TaxParameters Class
Contains a list of setters to populate the data needed for a tax calculation. The data is passed in the tax callout.
blng
-
Learn more about the methods available with the
TaxParametersclass.
Learn more about the methods available with the TaxParameters class.
The TaxParameters class includes these methods.
-
Returns the value of the
isCommitOnGetTaxparameter. -
Returns the legal entity references.
-
Returns the ID of a single object that requires tax calculation, if any.
-
Returns the list of IDs for objects that require tax calculation.
-
Returns the object type, which can be InvoiceLine, DebitNoteLine, CreditNoteLine, and OrderProduct object.
-
Returns the type of tax method, which is
POSTorGET. -
setSObjectListofIds(listOfSobjectIds)
Sets the list of IDs for objects that require tax calculation.
-
Sets the ID of a single object that requires tax calculation., if any.
-
setLegalEntityReferences(legalEntityReference)
Sets the legal entity for the tax treatment. For example, a company can create legal entities to represent their different branches.
-
setSObjectType(sObjectTypeInstance)
Sets the object type to InvoiceLine, DebitNoteLine, CreditNoteLine, or OrderProduct object.
-
Sets the method to
POSTorGET. -
setIsCommitOnGetTax(isCommitOnGetTax)
Indicates to external tax providers whether to commit tax.
Returns the value of the isCommitOnGetTax parameter.
global Boolean getIsCommitOnGetTax()
isCommitOnGetTax: Type: Boolean
Type: Void
Returns the legal entity references.
global static void getLegalEntityReferences()
legalEntityReference: Type: String
Type: void
Returns the ID of a single object that requires tax calculation, if any.
global static void getSObjectID()
sObjectId: Type: Id
Type: void
Returns the list of IDs for objects that require tax calculation.
global List<Id> getSObjectListOfIds()
listOfSobjectIds: Type: List<Id>
Type: Void
Returns the object type, which can be InvoiceLine, DebitNoteLine, CreditNoteLine, and OrderProduct object.
global static void getSObjectType()
sObjectTypeInstance: Type: SObjectType
Type: void
Returns the type of tax method, which is POST or GET.
global static void setTaxMethod()
taxMethod: Type: String
Type: void
Sets the list of IDs for objects that require tax calculation.
global static Void setSObjectListofIds(List<Id> listOfSobjectIds)
listOfSobjectIds: Type: List<Id>
Type: Void
Sets the ID of a single object that requires tax calculation., if any.
global static void setSObjectID(Id sObjectId)
sObjectId: Type: Id
Type: void
Sets the legal entity for the tax treatment. For example, a company can create legal entities to represent their different branches.
global static void setLegalEntityReferences(String legalEntityReference)
legalEntityReference: Type: String Unique identification number of the legal entity.
Type: void
Sets the object type to InvoiceLine, DebitNoteLine, CreditNoteLine, or OrderProduct object.
global static void setSObjectType(SObjectType sObjectTypeInstance)
sObjectTypeInstance: Type: SObjectType
Type: void
Sets the method to POST or GET.
global static void setTaxMethod(String taxMethod)
taxMethod: Type: String
Type: void
Indicates to external tax providers whether to commit tax.
If the Automatically Post Invoices checkbox is selected on the Invoice Scheduler, tax providers examine the isCommitOnGetTax parameter to commit the tax.
The isCommitOnGetTax parameter value is configured within the Taxparameter instance and transmitted to the external tax provider implementation.
global static Void setIsCommitOnGetTax(Boolean isCommitOnGetTax)
isCommitOnGetTax: Type: Boolean Indicates to external tax providers whether to commit tax on the Get Tax method (true) or not (false).
Type: Void