Package net.avalara.avatax.rest.client.enums

Enum DocumentStatus

java.lang.Object
java.lang.Enum<DocumentStatus>
net.avalara.avatax.rest.client.enums.DocumentStatus
All Implemented Interfaces:
Serializable, Comparable<DocumentStatus>, java.lang.constant.Constable
public enum DocumentStatus extends Enum<DocumentStatus>
The `DocumentStatus` value indicates the state of the document as it moves through the AvaTax document workflow. More information about the AvaTax document workflow is available in the [AvaTax Developer Guide](https://developer.avalara.com/avatax/dev-guide/transactions/should-i-commit).

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    Adjusted
    An older version of a document that has been adjusted.
    Any
    DEPRECATED - Represents "a document in any status" when searching.
    Cancelled
    A document that has been cancelled.
    Committed
    A posted document that has been committed.
    PendingApproval
    Indicates that this document requires approval from a governmental agency before it can be finalized.
    Posted
    A posted document (not committed).
    Queued
    DEPRECATED - A document which is queued for later processing.
    Saved
    Saved document (SalesInvoice or PurchaseInvoice) ready to be posted.
    Temporary
    Temporary document not saved (SalesOrder, PurchaseOrder).
    Uncommitted
    This new status is added for Reporting API to download get reports with Saved(1) and Posted(2) state.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getValue()
     
    static DocumentStatus
    valueOf(int intValue)
    Returns the enum constant of this type with the specified name.
    static DocumentStatus
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static DocumentStatus[]
    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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • Temporary

      public static final DocumentStatus Temporary
      Temporary document not saved (SalesOrder, PurchaseOrder). This document has not been recorded to AvaTax

    • Saved

      public static final DocumentStatus Saved
      Saved document (SalesInvoice or PurchaseInvoice) ready to be posted. This status indicates that the transaction has been saved to AvaTax, but is not available to be reported on a tax filing, and has not yet been verified by a business process that posts transactions. To mark this transaction as `Posted`, please call `VerifyTransaction` or `SettleTransaction`. To mark this transaction as `Committed`, please call `CommitTransaction` or `SettleTransaction`. To adjust or void this transaction, call `AdjustTransaction`, `CreateOrAdjustTransaction`, or `VoidTransaction`.

    • Posted

      public static final DocumentStatus Posted
      A posted document (not committed). This status indicates that the transaction has been saved to AvaTax, and has been verified by a business process that posts transactions, but is not ready to report on a tax filing. To mark this transaction as `Committed`, please call `CommitTransaction` or `SettleTransaction`. To adjust or void this transaction, call `AdjustTransaction`, `CreateOrAdjustTransaction`, or `VoidTransaction`.

    • Committed

      public static final DocumentStatus Committed
      A posted document that has been committed. This status indicates that the transaction has been saved to AvaTax and can be reported on a tax filing. If you use Avalara's Managed Returns Service, these transactions will be captured and reported on a tax return. When this occurs, the transaction's `locked` flag will be set to true. Once the transaction is locked, no further changes may occur. As long as the transaction has not been locked, you may adjust or void this transaction using `AdjustTransaction`, `CreateOrAdjustTransaction`, or `VoidTransaction`.

    • Cancelled

      public static final DocumentStatus Cancelled
      A document that has been cancelled. This status indicates that the transaction has been cancelled or voided. Cancelled and Voided are synonyms. When a transaction has been cancelled, it is considered to no longer exist. You are free to create a new transaction with the same code.

    • Adjusted

      public static final DocumentStatus Adjusted
      An older version of a document that has been adjusted. When you call `AdjustTransaction`, AvaTax preserves a record of the old document as well as a record of the new document. The old document is changed to the status `Adjusted`, and the new document is created in the status you requested.

    • Queued

      public static final DocumentStatus Queued
      DEPRECATED - A document which is queued for later processing.

    • PendingApproval

      public static final DocumentStatus PendingApproval
      Indicates that this document requires approval from a governmental agency before it can be finalized. Some governments require active verification of transactions before they can be finalized. When AvaTax detects that a transaction must be verified with a governmental agency, this transaction will be flagged as `PendingApproval` until the government has certified the transaction.

    • Uncommitted

      public static final DocumentStatus Uncommitted
      This new status is added for Reporting API to download get reports with Saved(1) and Posted(2) state.

    • Any

      public static final DocumentStatus Any
      DEPRECATED - Represents "a document in any status" when searching. Please search using the [Filtering in REST](/avatax/filtering-in-rest/) documentation.

  • Method Details

    • values

      public static DocumentStatus[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static DocumentStatus valueOf(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:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • valueOf

      public static DocumentStatus valueOf(int intValue)
      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:
      intValue - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • getValue

      public int getValue()