java.lang.Object
- net.avalara.avatax.rest.client.models.CreateTransactionModel

public class CreateTransactionModel
extends java.lang.Object

Create a transaction

Constructor Summary

Constructors
Constructor Description

CreateTransactionModel()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AddressesModel`	`getAddresses()`	Getter for addresses Default addresses for all lines in this document.
`java.lang.String`	`getBatchCode()`	Getter for batchCode BatchCode for batch operations.
`java.lang.String`	`getBusinessIdentificationNo()`	Getter for businessIdentificationNo VAT business identification number for the customer for this transaction.
`java.lang.String`	`getCode()`	Getter for code The internal reference code used by the client application.
`java.lang.Boolean`	`getCommit()`	Getter for commit Causes the document to be committed if true.
`java.lang.String`	`getCompanyCode()`	Getter for companyCode Company Code - Specify the code of the company creating this transaction here.
`java.lang.String`	`getCurrencyCode()`	Getter for currencyCode The three-character ISO 4217 currency code for this transaction.
`java.lang.String`	`getCustomerCode()`	Getter for customerCode Customer Code - The client application customer reference code.
`java.lang.String`	`getCustomerUsageType()`	Getter for customerUsageType DEPRECATED - Date: 10/16/2017, Version: 17.11, Message: Please use entityUseCode instead.
`java.util.Date`	`getDate()`	Getter for date Transaction Date - The date on the invoice, purchase order, etc.
`TaxDebugLevel`	`getDebugLevel()`	Getter for debugLevel If the user wishes to request additional debug information from this transaction, specify a level higher than `normal`.
`java.lang.String`	`getDescription()`	Getter for description User-supplied description for this transaction.
`java.math.BigDecimal`	`getDiscount()`	Getter for discount Discount - The discount amount to apply to the document.
`java.lang.String`	`getEmail()`	Getter for email User-supplied email address relevant for this transaction.
`java.lang.String`	`getEntityUseCode()`	Getter for entityUseCode Entity Use Code - The client application customer or usage type.
`java.math.BigDecimal`	`getExchangeRate()`	Getter for exchangeRate Currency exchange rate from this transaction to the company base currency.
`java.lang.String`	`getExchangeRateCurrencyCode()`	Getter for exchangeRateCurrencyCode Optional three-character ISO 4217 reporting exchange rate currency code for this transaction.
`java.util.Date`	`getExchangeRateEffectiveDate()`	Getter for exchangeRateEffectiveDate Effective date of the exchange rate.
`java.lang.String`	`getExemptionNo()`	Getter for exemptionNo Exemption Number for this document.
`java.lang.Boolean`	`getIsSellerImporterOfRecord()`	Getter for isSellerImporterOfRecord Specifies if the transaction should have value-added and cross-border taxes calculated with the seller as the importer of record.
`java.util.ArrayList<LineItemModel>`	`getLines()`	Getter for lines A list of line items that will appear on this transaction.
`java.util.ArrayList<TransactionParameterModel>`	`getParameters()`	Getter for parameters Special parameters for this transaction.
`java.lang.String`	`getPosLaneCode()`	Getter for posLaneCode Sets the Point of Sale Lane Code sent by the User for this document.
`java.lang.String`	`getPurchaseOrderNo()`	Getter for purchaseOrderNo Purchase Order Number for this document.
`java.lang.String`	`getReferenceCode()`	Getter for referenceCode Customer-provided Reference Code with information about this transaction.
`java.lang.String`	`getReportingLocationCode()`	Getter for reportingLocationCode Sets the sale location code (Outlet ID) for reporting this document to the tax authority.
`java.lang.String`	`getSalespersonCode()`	Getter for salespersonCode Salesperson Code - The client application salesperson reference code.
`ServiceMode`	`getServiceMode()`	Getter for serviceMode Specifies whether the tax calculation is handled Local, Remote, or Automatic (default).
`TaxOverrideModel`	`getTaxOverride()`	Getter for taxOverride Specifies a tax override for the entire document
`DocumentType`	`getType()`	Getter for type Specifies the type of document to create.
`void`	`setAddresses(AddressesModel value)`	Setter for addresses Default addresses for all lines in this document.
`void`	`setBatchCode(java.lang.String value)`	Setter for batchCode BatchCode for batch operations.
`void`	`setBusinessIdentificationNo(java.lang.String value)`	Setter for businessIdentificationNo VAT business identification number for the customer for this transaction.
`void`	`setCode(java.lang.String value)`	Setter for code The internal reference code used by the client application.
`void`	`setCommit(java.lang.Boolean value)`	Setter for commit Causes the document to be committed if true.
`void`	`setCompanyCode(java.lang.String value)`	Setter for companyCode Company Code - Specify the code of the company creating this transaction here.
`void`	`setCurrencyCode(java.lang.String value)`	Setter for currencyCode The three-character ISO 4217 currency code for this transaction.
`void`	`setCustomerCode(java.lang.String value)`	Setter for customerCode Customer Code - The client application customer reference code.
`void`	`setCustomerUsageType(java.lang.String value)`	Setter for customerUsageType DEPRECATED - Date: 10/16/2017, Version: 17.11, Message: Please use entityUseCode instead.
`void`	`setDate(java.util.Date value)`	Setter for date Transaction Date - The date on the invoice, purchase order, etc.
`void`	`setDebugLevel(TaxDebugLevel value)`	Setter for debugLevel If the user wishes to request additional debug information from this transaction, specify a level higher than `normal`.
`void`	`setDescription(java.lang.String value)`	Setter for description User-supplied description for this transaction.
`void`	`setDiscount(java.math.BigDecimal value)`	Setter for discount Discount - The discount amount to apply to the document.
`void`	`setEmail(java.lang.String value)`	Setter for email User-supplied email address relevant for this transaction.
`void`	`setEntityUseCode(java.lang.String value)`	Setter for entityUseCode Entity Use Code - The client application customer or usage type.
`void`	`setExchangeRate(java.math.BigDecimal value)`	Setter for exchangeRate Currency exchange rate from this transaction to the company base currency.
`void`	`setExchangeRateCurrencyCode(java.lang.String value)`	Setter for exchangeRateCurrencyCode Optional three-character ISO 4217 reporting exchange rate currency code for this transaction.
`void`	`setExchangeRateEffectiveDate(java.util.Date value)`	Setter for exchangeRateEffectiveDate Effective date of the exchange rate.
`void`	`setExemptionNo(java.lang.String value)`	Setter for exemptionNo Exemption Number for this document.
`void`	`setIsSellerImporterOfRecord(java.lang.Boolean value)`	Setter for isSellerImporterOfRecord Specifies if the transaction should have value-added and cross-border taxes calculated with the seller as the importer of record.
`void`	`setLines(java.util.ArrayList<LineItemModel> value)`	Setter for lines A list of line items that will appear on this transaction.
`void`	`setParameters(java.util.ArrayList<TransactionParameterModel> value)`	Setter for parameters Special parameters for this transaction.
`void`	`setPosLaneCode(java.lang.String value)`	Setter for posLaneCode Sets the Point of Sale Lane Code sent by the User for this document.
`void`	`setPurchaseOrderNo(java.lang.String value)`	Setter for purchaseOrderNo Purchase Order Number for this document.
`void`	`setReferenceCode(java.lang.String value)`	Setter for referenceCode Customer-provided Reference Code with information about this transaction.
`void`	`setReportingLocationCode(java.lang.String value)`	Setter for reportingLocationCode Sets the sale location code (Outlet ID) for reporting this document to the tax authority.
`void`	`setSalespersonCode(java.lang.String value)`	Setter for salespersonCode Salesperson Code - The client application salesperson reference code.
`void`	`setServiceMode(ServiceMode value)`	Setter for serviceMode Specifies whether the tax calculation is handled Local, Remote, or Automatic (default).
`void`	`setTaxOverride(TaxOverrideModel value)`	Setter for taxOverride Specifies a tax override for the entire document
`void`	`setType(DocumentType value)`	Setter for type Specifies the type of document to create.
`java.lang.String`	`toString()`	Returns a JSON string representation of CreateTransactionModel

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateTransactionModel
```
public CreateTransactionModel()
```
- Method Detail
  - getCode
```
public java.lang.String getCode()
```
    Getter for code The internal reference code used by the client application. This is used for operations such as Get, Adjust, Settle, and Void. If you leave the transaction code blank, a GUID will be assigned to each transaction.
  - setCode
```
public void setCode(java.lang.String value)
```
    Setter for code The internal reference code used by the client application. This is used for operations such as Get, Adjust, Settle, and Void. If you leave the transaction code blank, a GUID will be assigned to each transaction.
  - getLines
```
public java.util.ArrayList<LineItemModel> getLines()
```
    Getter for lines A list of line items that will appear on this transaction.
  - setLines
```
public void setLines(java.util.ArrayList<LineItemModel> value)
```
    Setter for lines A list of line items that will appear on this transaction.
  - getType
```
public DocumentType getType()
```
    Getter for type Specifies the type of document to create. A document type ending with `Invoice` is a permanent transaction that will be recorded in AvaTax. A document type ending with `Order` is a temporary estimate that will not be preserved. If you omit this value, the API will assume you want to create a `SalesOrder`.
  - setType
```
public void setType(DocumentType value)
```
    Setter for type Specifies the type of document to create. A document type ending with `Invoice` is a permanent transaction that will be recorded in AvaTax. A document type ending with `Order` is a temporary estimate that will not be preserved. If you omit this value, the API will assume you want to create a `SalesOrder`.
  - getCompanyCode
```
public java.lang.String getCompanyCode()
```
    Getter for companyCode Company Code - Specify the code of the company creating this transaction here. If you leave this value null, your account's default company will be used instead.
  - setCompanyCode
```
public void setCompanyCode(java.lang.String value)
```
    Setter for companyCode Company Code - Specify the code of the company creating this transaction here. If you leave this value null, your account's default company will be used instead.
  - getDate
```
public java.util.Date getDate()
```
    Getter for date Transaction Date - The date on the invoice, purchase order, etc. By default, this date will be used to calculate the tax rates for the transaction. If you wish to use a different date to calculate tax rates, please specify a `taxOverride` of type `taxDate`.
  - setDate
```
public void setDate(java.util.Date value)
```
    Setter for date Transaction Date - The date on the invoice, purchase order, etc. By default, this date will be used to calculate the tax rates for the transaction. If you wish to use a different date to calculate tax rates, please specify a `taxOverride` of type `taxDate`.
  - getSalespersonCode
```
public java.lang.String getSalespersonCode()
```
    Getter for salespersonCode Salesperson Code - The client application salesperson reference code.
  - setSalespersonCode
```
public void setSalespersonCode(java.lang.String value)
```
    Setter for salespersonCode Salesperson Code - The client application salesperson reference code.
  - getCustomerCode
```
public java.lang.String getCustomerCode()
```
    Getter for customerCode Customer Code - The client application customer reference code. Note: This field is case sensitive. To have exemption certificates apply, this value should be the same as the one passed to create a customer.
  - setCustomerCode
```
public void setCustomerCode(java.lang.String value)
```
    Setter for customerCode Customer Code - The client application customer reference code. Note: This field is case sensitive. To have exemption certificates apply, this value should be the same as the one passed to create a customer.
  - getCustomerUsageType
```
public java.lang.String getCustomerUsageType()
```
    Getter for customerUsageType DEPRECATED - Date: 10/16/2017, Version: 17.11, Message: Please use entityUseCode instead. Customer Usage Type - The client application customer or usage type.
  - setCustomerUsageType
```
public void setCustomerUsageType(java.lang.String value)
```
    Setter for customerUsageType DEPRECATED - Date: 10/16/2017, Version: 17.11, Message: Please use entityUseCode instead. Customer Usage Type - The client application customer or usage type.
  - getEntityUseCode
```
public java.lang.String getEntityUseCode()
```
    Getter for entityUseCode Entity Use Code - The client application customer or usage type. For a list of available usage types, use [ListEntityUseCodes](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListEntityUseCodes/) API.
  - setEntityUseCode
```
public void setEntityUseCode(java.lang.String value)
```
    Setter for entityUseCode Entity Use Code - The client application customer or usage type. For a list of available usage types, use [ListEntityUseCodes](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListEntityUseCodes/) API.
  - getDiscount
```
public java.math.BigDecimal getDiscount()
```
    Getter for discount Discount - The discount amount to apply to the document. This value will be applied only to lines that have the `discounted` flag set to true. If no lines have `discounted` set to true, this discount cannot be applied.
  - setDiscount
```
public void setDiscount(java.math.BigDecimal value)
```
    Setter for discount Discount - The discount amount to apply to the document. This value will be applied only to lines that have the `discounted` flag set to true. If no lines have `discounted` set to true, this discount cannot be applied.
  - getPurchaseOrderNo
```
public java.lang.String getPurchaseOrderNo()
```
    Getter for purchaseOrderNo Purchase Order Number for this document. This is required for single use exemption certificates to match the order and invoice with the certificate.
  - setPurchaseOrderNo
```
public void setPurchaseOrderNo(java.lang.String value)
```
    Setter for purchaseOrderNo Purchase Order Number for this document. This is required for single use exemption certificates to match the order and invoice with the certificate.
  - getExemptionNo
```
public java.lang.String getExemptionNo()
```
    Getter for exemptionNo Exemption Number for this document. If you specify an exemption number for this document, this document will be considered exempt, and you may be asked to provide proof of this exemption certificate in the event that you are asked by an auditor to verify your exemptions. Note: This is same as 'exemptNo' in TransactionModel.
  - setExemptionNo
```
public void setExemptionNo(java.lang.String value)
```
    Setter for exemptionNo Exemption Number for this document. If you specify an exemption number for this document, this document will be considered exempt, and you may be asked to provide proof of this exemption certificate in the event that you are asked by an auditor to verify your exemptions. Note: This is same as 'exemptNo' in TransactionModel.
  - getAddresses
```
public AddressesModel getAddresses()
```
    Getter for addresses Default addresses for all lines in this document. These addresses are the default values that will be used for any lines that do not have their own address information. If you specify addresses for a line, then no default addresses will be loaded for that line.
  - setAddresses
```
public void setAddresses(AddressesModel value)
```
    Setter for addresses Default addresses for all lines in this document. These addresses are the default values that will be used for any lines that do not have their own address information. If you specify addresses for a line, then no default addresses will be loaded for that line.
  - getParameters
```
public java.util.ArrayList<TransactionParameterModel> getParameters()
```
    Getter for parameters Special parameters for this transaction. To get a full list of available parameters, please use the [ListParameters](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListParameters/) endpoint.
  - setParameters
```
public void setParameters(java.util.ArrayList<TransactionParameterModel> value)
```
    Setter for parameters Special parameters for this transaction. To get a full list of available parameters, please use the [ListParameters](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListParameters/) endpoint.
  - getReferenceCode
```
public java.lang.String getReferenceCode()
```
    Getter for referenceCode Customer-provided Reference Code with information about this transaction. This field could be used to reference the original document for a return invoice, or for any other reference purpose.
  - setReferenceCode
```
public void setReferenceCode(java.lang.String value)
```
    Setter for referenceCode Customer-provided Reference Code with information about this transaction. This field could be used to reference the original document for a return invoice, or for any other reference purpose.
  - getReportingLocationCode
```
public java.lang.String getReportingLocationCode()
```
    Getter for reportingLocationCode Sets the sale location code (Outlet ID) for reporting this document to the tax authority. This value is used by Avalara Managed Returns to group documents together by reporting locations for tax authorities that require location-based reporting.
  - setReportingLocationCode
```
public void setReportingLocationCode(java.lang.String value)
```
    Setter for reportingLocationCode Sets the sale location code (Outlet ID) for reporting this document to the tax authority. This value is used by Avalara Managed Returns to group documents together by reporting locations for tax authorities that require location-based reporting.
  - getCommit
```
public java.lang.Boolean getCommit()
```
    Getter for commit Causes the document to be committed if true. This option is only applicable for invoice document types, not orders.
  - setCommit
```
public void setCommit(java.lang.Boolean value)
```
    Setter for commit Causes the document to be committed if true. This option is only applicable for invoice document types, not orders.
  - getBatchCode
```
public java.lang.String getBatchCode()
```
    Getter for batchCode BatchCode for batch operations.
  - setBatchCode
```
public void setBatchCode(java.lang.String value)
```
    Setter for batchCode BatchCode for batch operations.
  - getTaxOverride
```
public TaxOverrideModel getTaxOverride()
```
    Getter for taxOverride Specifies a tax override for the entire document
  - setTaxOverride
```
public void setTaxOverride(TaxOverrideModel value)
```
    Setter for taxOverride Specifies a tax override for the entire document
  - getCurrencyCode
```
public java.lang.String getCurrencyCode()
```
    Getter for currencyCode The three-character ISO 4217 currency code for this transaction.
  - setCurrencyCode
```
public void setCurrencyCode(java.lang.String value)
```
    Setter for currencyCode The three-character ISO 4217 currency code for this transaction.
  - getServiceMode
```
public ServiceMode getServiceMode()
```
    Getter for serviceMode Specifies whether the tax calculation is handled Local, Remote, or Automatic (default). This only applies when using an AvaLocal server.
  - setServiceMode
```
public void setServiceMode(ServiceMode value)
```
    Setter for serviceMode Specifies whether the tax calculation is handled Local, Remote, or Automatic (default). This only applies when using an AvaLocal server.
  - getExchangeRate
```
public java.math.BigDecimal getExchangeRate()
```
    Getter for exchangeRate Currency exchange rate from this transaction to the company base currency. This only needs to be set if the transaction currency is different than the company base currency. It defaults to 1.0.
  - setExchangeRate
```
public void setExchangeRate(java.math.BigDecimal value)
```
    Setter for exchangeRate Currency exchange rate from this transaction to the company base currency. This only needs to be set if the transaction currency is different than the company base currency. It defaults to 1.0.
  - getExchangeRateEffectiveDate
```
public java.util.Date getExchangeRateEffectiveDate()
```
    Getter for exchangeRateEffectiveDate Effective date of the exchange rate.
  - setExchangeRateEffectiveDate
```
public void setExchangeRateEffectiveDate(java.util.Date value)
```
    Setter for exchangeRateEffectiveDate Effective date of the exchange rate.
  - getExchangeRateCurrencyCode
```
public java.lang.String getExchangeRateCurrencyCode()
```
    Getter for exchangeRateCurrencyCode Optional three-character ISO 4217 reporting exchange rate currency code for this transaction. The default value is USD.
  - setExchangeRateCurrencyCode
```
public void setExchangeRateCurrencyCode(java.lang.String value)
```
    Setter for exchangeRateCurrencyCode Optional three-character ISO 4217 reporting exchange rate currency code for this transaction. The default value is USD.
  - getPosLaneCode
```
public java.lang.String getPosLaneCode()
```
    Getter for posLaneCode Sets the Point of Sale Lane Code sent by the User for this document.
  - setPosLaneCode
```
public void setPosLaneCode(java.lang.String value)
```
    Setter for posLaneCode Sets the Point of Sale Lane Code sent by the User for this document.
  - getBusinessIdentificationNo
```
public java.lang.String getBusinessIdentificationNo()
```
    Getter for businessIdentificationNo VAT business identification number for the customer for this transaction. This number will be used for all lines in the transaction, except for those lines where you have defined a different business identification number. If you specify a VAT business identification number for the customer in this transaction and you have also set up a business identification number for your company during company setup, this transaction will be treated as a business-to-business transaction for VAT purposes and it will be calculated according to VAT tax rules.
  - setBusinessIdentificationNo
```
public void setBusinessIdentificationNo(java.lang.String value)
```
    Setter for businessIdentificationNo VAT business identification number for the customer for this transaction. This number will be used for all lines in the transaction, except for those lines where you have defined a different business identification number. If you specify a VAT business identification number for the customer in this transaction and you have also set up a business identification number for your company during company setup, this transaction will be treated as a business-to-business transaction for VAT purposes and it will be calculated according to VAT tax rules.
  - getIsSellerImporterOfRecord
```
public java.lang.Boolean getIsSellerImporterOfRecord()
```
    Getter for isSellerImporterOfRecord Specifies if the transaction should have value-added and cross-border taxes calculated with the seller as the importer of record. Some taxes only apply if the seller is the importer of record for a product. In cases where companies are working together to ship products, there may be mutual agreement as to which company is the entity designated as importer of record. The importer of record will then be the company designated to pay taxes marked as being obligated to the importer of record. Set this value to `true` to consider your company as the importer of record and collect these taxes. This value may also be set at the Nexus level. See `NexusModel` for more information.
  - setIsSellerImporterOfRecord
```
public void setIsSellerImporterOfRecord(java.lang.Boolean value)
```
    Setter for isSellerImporterOfRecord Specifies if the transaction should have value-added and cross-border taxes calculated with the seller as the importer of record. Some taxes only apply if the seller is the importer of record for a product. In cases where companies are working together to ship products, there may be mutual agreement as to which company is the entity designated as importer of record. The importer of record will then be the company designated to pay taxes marked as being obligated to the importer of record. Set this value to `true` to consider your company as the importer of record and collect these taxes. This value may also be set at the Nexus level. See `NexusModel` for more information.
  - getDescription
```
public java.lang.String getDescription()
```
    Getter for description User-supplied description for this transaction.
  - setDescription
```
public void setDescription(java.lang.String value)
```
    Setter for description User-supplied description for this transaction.
  - getEmail
```
public java.lang.String getEmail()
```
    Getter for email User-supplied email address relevant for this transaction.
  - setEmail
```
public void setEmail(java.lang.String value)
```
    Setter for email User-supplied email address relevant for this transaction.
  - getDebugLevel
```
public TaxDebugLevel getDebugLevel()
```
    Getter for debugLevel If the user wishes to request additional debug information from this transaction, specify a level higher than `normal`.
  - setDebugLevel
```
public void setDebugLevel(TaxDebugLevel value)
```
    Setter for debugLevel If the user wishes to request additional debug information from this transaction, specify a level higher than `normal`.
  - toString
```
public java.lang.String toString()
```
    Returns a JSON string representation of CreateTransactionModel
    
    Overrides:
    
    toString in class java.lang.Object

Class CreateTransactionModel

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CreateTransactionModel

Method Detail

getCode

setCode

getLines

setLines

getType

setType

getCompanyCode

setCompanyCode

getDate

setDate

getSalespersonCode

setSalespersonCode

getCustomerCode

setCustomerCode

getCustomerUsageType

setCustomerUsageType

getEntityUseCode

setEntityUseCode

getDiscount

setDiscount

getPurchaseOrderNo

setPurchaseOrderNo

getExemptionNo

setExemptionNo

getAddresses

setAddresses

getParameters

setParameters

getReferenceCode

setReferenceCode

getReportingLocationCode

setReportingLocationCode

getCommit

setCommit

getBatchCode

setBatchCode

getTaxOverride

setTaxOverride

getCurrencyCode

setCurrencyCode

getServiceMode

setServiceMode

getExchangeRate

setExchangeRate

getExchangeRateEffectiveDate

setExchangeRateEffectiveDate

getExchangeRateCurrencyCode

setExchangeRateCurrencyCode

getPosLaneCode

setPosLaneCode

getBusinessIdentificationNo

setBusinessIdentificationNo

getIsSellerImporterOfRecord

setIsSellerImporterOfRecord

getDescription

setDescription

getEmail

setEmail

getDebugLevel

setDebugLevel

toString