net.avalara.avatax.rest.client.enums

Enum DocumentType

java.lang.Object

java.lang.Enum<DocumentType>

net.avalara.avatax.rest.client.enums.DocumentType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DocumentType>

public enum DocumentType
extends java.lang.Enum<DocumentType>

Represents the different types of transactions that AvaTax can process.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Any Not a real document type.
InventoryTransferInvoice Represents a movement of inventory from one jurisdiction to another that has been finalized.
InventoryTransferOrder Represents a proposed movement of inventory from one jurisdiction to another.
PurchaseInvoice Represents a sale that has been finalized.
PurchaseOrder Represents an estimate, or a purchase order, or a quote.
ReturnInvoice Represents an refund that has been finalized.
ReturnOrder Represents an estimate of tax to be refunded if a refund or return is processed.
ReverseChargeInvoice Represents a VAT "Reverse Charge" mechanism transaction as defined in the European Union.
ReverseChargeOrder Represents a VAT "Reverse Charge" mechanism transaction as defined in the European Union.
SalesInvoice Represents a sale that has been finalized.
SalesOrder Represents an estimate, or a sales order, or a quote.

Method Summary

Modifier and Type	Method and Description
static DocumentType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DocumentType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SalesOrder

public static final DocumentType SalesOrder

Represents an estimate, or a sales order, or a quote. This document type is used before a sale has occurred to estimate the final amount of tax to be paid when the sale is completed. For a sales order, the `companyCode` of the transaction refers to the seller and the `customerVendorCode` refers to the buyer. This is a temporary document type and is not saved in tax history.

SalesInvoice

public static final DocumentType SalesInvoice

Represents a sale that has been finalized. This document type is used to record a final transaction and calculate the final tax amount with all necessary information. For a sales invoice, the `companyCode` of the transaction refers to the seller and the `customerVendorCode` refers to the buyer. This is a permanent document and is recorded in AvaTax.

PurchaseOrder

public static final DocumentType PurchaseOrder

Represents an estimate, or a purchase order, or a quote. This document type is used before a sale has occurred to estimate the final amount of tax to be paid when the sale is completed. For a purchase order, the `companyCode` of the transaction refers to the buyer and the `customerVendorCode` refers to the seller. This is a temporary document type and is not saved in tax history.

PurchaseInvoice

public static final DocumentType PurchaseInvoice

Represents a sale that has been finalized. This document type is used to record a final transaction and calculate the final tax amount with all necessary information. For a purchase invoice, the `companyCode` of the transaction refers to the buyer and the `customerVendorCode` refers to the seller. This is a permanent document and is recorded in AvaTax.

ReturnOrder

public static final DocumentType ReturnOrder

Represents an estimate of tax to be refunded if a refund or return is processed. This document type is used before a customer chooses to request a refund for a previous sale, and it estimates the final amount of tax to be refunded when the refund is completed. For a return order, the `companyCode` of the transaction refers to the seller who is giving the refund and the `customerVendorCode` refers to the buyer who is requesting the refund. This is a temporary document type and is not saved in tax history.

ReturnInvoice

public static final DocumentType ReturnInvoice

Represents an refund that has been finalized. This document type is used when a customer chooses to request a refund for a previous sale, and it records the final amount of tax that has been refunded when the refund is completed. For a return invoice, the `companyCode` of the transaction refers to the seller who is giving the refund and the `customerVendorCode` refers to the buyer who is requesting the refund. This is a permanent document and is recorded in AvaTax. Please note that many jurisdictions around the United States have special rules about how to report refunds on a sales tax filing, and some refund transactions may be unable to file immediately due to credit netting rules.

InventoryTransferOrder

public static final DocumentType InventoryTransferOrder

Represents a proposed movement of inventory from one jurisdiction to another. This document type is used when physical goods are shipped from one jurisdiction to another, and it may cause updates in the tax liability for various jurisdictions. For an inventory transfer invoice, the `companyCode` of the transaction refers to the owner of the inventory that will be moved from one location to another. This is a temporary document type and is not saved in tax history.

InventoryTransferInvoice

public static final DocumentType InventoryTransferInvoice

Represents a movement of inventory from one jurisdiction to another that has been finalized. This document type is used when physical goods are shipped from one jurisdiction to another, and it may cause updates in the tax liability for various jurisdictions. For an inventory transfer invoice, the `companyCode` of the transaction refers to the owner of the inventory that will be moved from one location to another. This is a permanent document and is recorded in AvaTax.

ReverseChargeOrder

public static final DocumentType ReverseChargeOrder

Represents a VAT "Reverse Charge" mechanism transaction as defined in the European Union. A Reverse Charge transaction moves the responsibility for VAT reporting from the seller to the buyer, and is intended to allow simplification of commerce and reduce the reporting requirements for sellers that deliver goods and services into the single market. This is a temporary document type and is not saved in tax history.

ReverseChargeInvoice

public static final DocumentType ReverseChargeInvoice

Represents a VAT "Reverse Charge" mechanism transaction as defined in the European Union. A Reverse Charge transaction moves the responsibility for VAT reporting from the seller to the buyer, and is intended to allow simplification of commerce and reduce the reporting requirements for sellers that deliver goods and services into the single market. This is a permanent document and is recorded in AvaTax.

Any

public static final DocumentType Any

Not a real document type. This value is used when querying for documents. You can specify the type `Any` in some cases to permit the system to find any document matching other criteria.

Method Detail

values

public static DocumentType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DocumentType c : DocumentType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DocumentType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null