public class

DistributeTaxRequestType

extends TaxTransactionRequestType
java.lang.Object
   ↳ vertexinc.o_series.tps._6._0.TaxTransactionRequestType
     ↳ vertexinc.o_series.tps._6._0.DistributeTaxRequestType

Class Overview

The request used to accept a combined total tax amount for a purchase and distribute that tax to the appropriate jurisdictions. The combined rates for the taxing jurisdictions are used with the total tax amount to determine the taxable base and then redistribute the calculated taxes to each level for remittance. This request is also used for a tax-only adjustment (debit or credit) so you can reconcile a tax underpayment or overpayment. Vertex Central rules in effect as of the date in the documentDate attribute are used. If records for jurisdiction registration, product exception, or customer exception or exemption are dated on or before that date, they are used in the calculation process. A Distribute Sales Tax transaction does impact revenue except when you designate it as a tax-only adjustment. Distribute Sales Tax transactions are written to the Tax Journal.

Java class for DistributeTaxRequestType complex type.

The following schema fragment specifies the expected content contained within this class. 

 <complexType name="DistributeTaxRequestType">
   <complexContent>
     <extension base="{urn:vertexinc:o-series:tps:6:0}TaxTransactionRequestType">
       <sequence>
         <element ref="{urn:vertexinc:o-series:tps:6:0}Currency" minOccurs="0"/>
         <element ref="{urn:vertexinc:o-series:tps:6:0}OriginalCurrency" minOccurs="0"/>
         <element name="Seller" type="{urn:vertexinc:o-series:tps:6:0}SellerType" minOccurs="0"/>
         <element name="Customer" type="{urn:vertexinc:o-series:tps:6:0}CustomerType" minOccurs="0"/>
         <element ref="{urn:vertexinc:o-series:tps:6:0}TaxOverride" minOccurs="0"/>
         <element ref="{urn:vertexinc:o-series:tps:6:0}ImpositionToProcess" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:vertexinc:o-series:tps:6:0}JurisdictionOverride" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:vertexinc:o-series:tps:6:0}SitusOverride" minOccurs="0"/>
         <element ref="{urn:vertexinc:o-series:tps:6:0}Discount" minOccurs="0"/>
         <element name="LineItem" type="{urn:vertexinc:o-series:tps:6:0}LineItemDTSIType" maxOccurs="unbounded"/>
       </sequence>
       <attGroup ref="{urn:vertexinc:o-series:tps:6:0}DistributeTaxTransactionGroup"/>
     </extension>
   </complexContent>
 </complexType>

Summary

Fields
protected CurrencyType currency
protected CustomerType customer
protected DeliveryTermCodeType deliveryTerm
protected Discount discount
protected XMLGregorianCalendar documentDate
protected String documentNumber
protected List<ImpositionToProcess> impositionToProcess
protected Boolean isTaxOnlyAdjustmentIndicator
protected List<JurisdictionOverride> jurisdictionOverride
protected List<LineItemDTSIType> lineItem
protected String locationCode
protected CurrencyType originalCurrency
protected Boolean postToJournal
protected XMLGregorianCalendar postingDate
protected Boolean returnAssistedParametersIndicator
protected Boolean returnGeneratedLineItemsIndicator
protected SellerType seller
protected SimplificationCodeType simplificationCode
protected SitusOverride situsOverride
protected TaxOverride taxOverride
protected String transactionId
protected SaleTransactionType transactionType
Public Constructors
DistributeTaxRequestType()
Public Methods
CurrencyType getCurrency()
Gets the value of the currency property.
CustomerType getCustomer()
Gets the value of the customer property.
DeliveryTermCodeType getDeliveryTerm()
Gets the value of the deliveryTerm property.
Discount getDiscount()
Gets the value of the discount property.
XMLGregorianCalendar getDocumentDate()
Gets the value of the documentDate property.
String getDocumentNumber()
Gets the value of the documentNumber property.
List<ImpositionToProcess> getImpositionToProcess()
Gets the value of the impositionToProcess property.
List<JurisdictionOverride> getJurisdictionOverride()
Gets the value of the jurisdictionOverride property.
List<LineItemDTSIType> getLineItem()
Gets the value of the lineItem property.
String getLocationCode()
Gets the value of the locationCode property.
CurrencyType getOriginalCurrency()
Gets the value of the originalCurrency property.
XMLGregorianCalendar getPostingDate()
Gets the value of the postingDate property.
SellerType getSeller()
Gets the value of the seller property.
SimplificationCodeType getSimplificationCode()
Gets the value of the simplificationCode property.
SitusOverride getSitusOverride()
Gets the value of the situsOverride property.
TaxOverride getTaxOverride()
Gets the value of the taxOverride property.
String getTransactionId()
Gets the value of the transactionId property.
SaleTransactionType getTransactionType()
Gets the value of the transactionType property.
Boolean isIsTaxOnlyAdjustmentIndicator()
Gets the value of the isTaxOnlyAdjustmentIndicator property.
boolean isPostToJournal()
Gets the value of the postToJournal property.
Boolean isReturnAssistedParametersIndicator()
Gets the value of the returnAssistedParametersIndicator property.
Boolean isReturnGeneratedLineItemsIndicator()
Gets the value of the returnGeneratedLineItemsIndicator property.
void setCurrency(CurrencyType value)
Sets the value of the currency property.
void setCustomer(CustomerType value)
Sets the value of the customer property.
void setDeliveryTerm(DeliveryTermCodeType value)
Sets the value of the deliveryTerm property.
void setDiscount(Discount value)
Sets the value of the discount property.
void setDocumentDate(XMLGregorianCalendar value)
Sets the value of the documentDate property.
void setDocumentNumber(String value)
Sets the value of the documentNumber property.
void setIsTaxOnlyAdjustmentIndicator(Boolean value)
Sets the value of the isTaxOnlyAdjustmentIndicator property.
void setLocationCode(String value)
Sets the value of the locationCode property.
void setOriginalCurrency(CurrencyType value)
Sets the value of the originalCurrency property.
void setPostToJournal(Boolean value)
Sets the value of the postToJournal property.
void setPostingDate(XMLGregorianCalendar value)
Sets the value of the postingDate property.
void setReturnAssistedParametersIndicator(Boolean value)
Sets the value of the returnAssistedParametersIndicator property.
void setReturnGeneratedLineItemsIndicator(Boolean value)
Sets the value of the returnGeneratedLineItemsIndicator property.
void setSeller(SellerType value)
Sets the value of the seller property.
void setSimplificationCode(SimplificationCodeType value)
Sets the value of the simplificationCode property.
void setSitusOverride(SitusOverride value)
Sets the value of the situsOverride property.
void setTaxOverride(TaxOverride value)
Sets the value of the taxOverride property.
void setTransactionId(String value)
Sets the value of the transactionId property.
void setTransactionType(SaleTransactionType value)
Sets the value of the transactionType property.
[Expand]
Inherited Methods
From class java.lang.Object

Fields

protected CurrencyType currency

protected CustomerType customer

protected DeliveryTermCodeType deliveryTerm

protected Discount discount

protected XMLGregorianCalendar documentDate

protected String documentNumber

protected List<ImpositionToProcess> impositionToProcess

protected Boolean isTaxOnlyAdjustmentIndicator

protected List<JurisdictionOverride> jurisdictionOverride

protected List<LineItemDTSIType> lineItem

protected String locationCode

protected CurrencyType originalCurrency

protected Boolean postToJournal

protected XMLGregorianCalendar postingDate

protected Boolean returnAssistedParametersIndicator

protected Boolean returnGeneratedLineItemsIndicator

protected SellerType seller

protected SimplificationCodeType simplificationCode

protected SitusOverride situsOverride

protected TaxOverride taxOverride

protected String transactionId

protected SaleTransactionType transactionType

Public Constructors

public DistributeTaxRequestType ()

Public Methods

public CurrencyType getCurrency ()

Gets the value of the currency property.

Returns

public CustomerType getCustomer ()

Gets the value of the customer property.

Returns

public DeliveryTermCodeType getDeliveryTerm ()

Gets the value of the deliveryTerm property.

Returns

public Discount getDiscount ()

Gets the value of the discount property.

Returns

public XMLGregorianCalendar getDocumentDate ()

Gets the value of the documentDate property.

Returns
  • possible object is XMLGregorianCalendar

public String getDocumentNumber ()

Gets the value of the documentNumber property.

Returns
  • possible object is String

public List<ImpositionToProcess> getImpositionToProcess ()

Gets the value of the impositionToProcess property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the impositionToProcess property.

For example, to add a new item, do as follows: 

    getImpositionToProcess().add(newItem);

Objects of the following type(s) are allowed in the list ImpositionToProcess

public List<JurisdictionOverride> getJurisdictionOverride ()

Gets the value of the jurisdictionOverride property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the jurisdictionOverride property.

For example, to add a new item, do as follows: 

    getJurisdictionOverride().add(newItem);

Objects of the following type(s) are allowed in the list JurisdictionOverride

public List<LineItemDTSIType> getLineItem ()

Gets the value of the lineItem property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the lineItem property.

For example, to add a new item, do as follows: 

    getLineItem().add(newItem);

Objects of the following type(s) are allowed in the list LineItemDTSIType

public String getLocationCode ()

Gets the value of the locationCode property.

Returns
  • possible object is String

public CurrencyType getOriginalCurrency ()

Gets the value of the originalCurrency property.

Returns

public XMLGregorianCalendar getPostingDate ()

Gets the value of the postingDate property.

Returns
  • possible object is XMLGregorianCalendar

public SellerType getSeller ()

Gets the value of the seller property.

Returns

public SimplificationCodeType getSimplificationCode ()

Gets the value of the simplificationCode property.

Returns

public SitusOverride getSitusOverride ()

Gets the value of the situsOverride property.

Returns

public TaxOverride getTaxOverride ()

Gets the value of the taxOverride property.

Returns

public String getTransactionId ()

Gets the value of the transactionId property.

Returns
  • possible object is String

public SaleTransactionType getTransactionType ()

Gets the value of the transactionType property.

Returns

public Boolean isIsTaxOnlyAdjustmentIndicator ()

Gets the value of the isTaxOnlyAdjustmentIndicator property.

Returns
  • possible object is Boolean

public boolean isPostToJournal ()

Gets the value of the postToJournal property.

Returns
  • possible object is Boolean

public Boolean isReturnAssistedParametersIndicator ()

Gets the value of the returnAssistedParametersIndicator property.

Returns
  • possible object is Boolean

public Boolean isReturnGeneratedLineItemsIndicator ()

Gets the value of the returnGeneratedLineItemsIndicator property.

Returns
  • possible object is Boolean

public void setCurrency (CurrencyType value)

Sets the value of the currency property.

Parameters
value Allowed object is CurrencyType

public void setCustomer (CustomerType value)

Sets the value of the customer property.

Parameters
value Allowed object is CustomerType

public void setDeliveryTerm (DeliveryTermCodeType value)

Sets the value of the deliveryTerm property.

Parameters
value Allowed object is DeliveryTermCodeType

public void setDiscount (Discount value)

Sets the value of the discount property.

Parameters
value Allowed object is Discount

public void setDocumentDate (XMLGregorianCalendar value)

Sets the value of the documentDate property.

Parameters
value Allowed object is XMLGregorianCalendar

public void setDocumentNumber (String value)

Sets the value of the documentNumber property.

Parameters
value Allowed object is String

public void setIsTaxOnlyAdjustmentIndicator (Boolean value)

Sets the value of the isTaxOnlyAdjustmentIndicator property.

Parameters
value Allowed object is Boolean

public void setLocationCode (String value)

Sets the value of the locationCode property.

Parameters
value Allowed object is String

public void setOriginalCurrency (CurrencyType value)

Sets the value of the originalCurrency property.

Parameters
value Allowed object is CurrencyType

public void setPostToJournal (Boolean value)

Sets the value of the postToJournal property.

Parameters
value Allowed object is Boolean

public void setPostingDate (XMLGregorianCalendar value)

Sets the value of the postingDate property.

Parameters
value Allowed object is XMLGregorianCalendar

public void setReturnAssistedParametersIndicator (Boolean value)

Sets the value of the returnAssistedParametersIndicator property.

Parameters
value Allowed object is Boolean

public void setReturnGeneratedLineItemsIndicator (Boolean value)

Sets the value of the returnGeneratedLineItemsIndicator property.

Parameters
value Allowed object is Boolean

public void setSeller (SellerType value)

Sets the value of the seller property.

Parameters
value Allowed object is SellerType

public void setSimplificationCode (SimplificationCodeType value)

Sets the value of the simplificationCode property.

Parameters
value Allowed object is SimplificationCodeType

public void setSitusOverride (SitusOverride value)

Sets the value of the situsOverride property.

Parameters
value Allowed object is SitusOverride

public void setTaxOverride (TaxOverride value)

Sets the value of the taxOverride property.

Parameters
value Allowed object is TaxOverride

public void setTransactionId (String value)

Sets the value of the transactionId property.

Parameters
value Allowed object is String

public void setTransactionType (SaleTransactionType value)

Sets the value of the transactionType property.

Parameters
value Allowed object is SaleTransactionType