Package net.avalara.avatax.rest.client.models

Class AuditModel

java.lang.Object
net.avalara.avatax.rest.client.models.AuditModel
public class AuditModel extends Object
Provides detailed information about an API call. The information on this record was captured by AvaTax when your API call was made. If you are unsure why you received an error, you can fetch these audit objects and examine the `RequestUrl`, `RequestBody`, and `ErrorMessage` fields to determine root cause for the error.

  • Constructor Summary

    Constructors
    Constructor
    Description
    AuditModel()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Integer
    getAccountId()
    Getter for accountId The unique ID number of the account to which the user belongs.
    String
    getAdapterName()
    Getter for adapterName If your API call specified a `AdapterName` in the [Client Profile Headers](https://developer.avalara.com/avatax/client-headers/), this variable will contain its value.
    String
    getAdapterVersion()
    Getter for adapterVersion If your API call specified a `AdapterVersion` in the [Client Profile Headers](https://developer.avalara.com/avatax/client-headers/), this variable will contain its value.
    String
    getAuditMessage()
    Getter for auditMessage Reserved for Avalara internal usage.
    String
    getClientName()
    Getter for clientName If your API call specified a `ClientName` in the [Client Profile Headers](https://developer.avalara.com/avatax/client-headers/), this variable will contain its value.
    String
    getClientVersion()
    Getter for clientVersion If your API call specified a `ClientVersion` in the [Client Profile Headers](https://developer.avalara.com/avatax/client-headers/), this variable will contain its value.
    Integer
    getDatabaseCallCount()
    Getter for databaseCallCount If this API call included requests made to any of the AvaTax data layers, this contains the number of requests that were traced.
    String
    getDatabaseCallDuration()
    Getter for databaseCallDuration If this API call included requests made to any of the AvaTax data layers, this contains the total duration time measured for all the requests.
    String
    getErrorMessage()
    Getter for errorMessage If this API call reported an error, this contains the name of the error that was returned.
    ArrayList<AuditEvent>
    getEvents()
    Getter for events Reserved for Avalara internal usage.
    String
    getIpAddress()
    Getter for ipAddress The origin IP address from which AvaTax received this API call.
    Boolean
    getIsQueued()
    Getter for isQueued Reserved for Avalara internal usage.
    Integer
    getLoadBalancerDuration()
    Getter for loadBalancerDuration Reserved for Avalara internal usage.
    String
    getMachineName()
    Getter for machineName If your API call specified a `MachineName` in the [Client Profile Headers](https://developer.avalara.com/avatax/client-headers/), this variable will contain its value.
    String
    getOperation()
    Getter for operation The operation name of this API call.
    Integer
    getRecordCount()
    Getter for recordCount If this API call returned an array of information, this value contains the number of records returned.
    String
    getReferenceAuthorization()
    Getter for referenceAuthorization Reserved for Avalara internal usage.
    String
    getReferenceCode()
    Getter for referenceCode A context-dependent reference code for this API call.
    Long
    getReferenceId()
    Getter for referenceId A context-dependent reference ID for this API call.
    String
    getRemoteCallDuration()
    Getter for remoteCallDuration If this API call included interoperation with other Avalara services, this contains the amount of time taken by those services.
    ArrayList<AuditModel>
    getRemoteCalls()
    Getter for remoteCalls Reserved for Avalara internal usage.
    String
    getRequestBody()
    Getter for requestBody If this request was an HTTP request that included a body such as a POST or a PUT, this will contain the request body sent by the client.
    String
    getRequestUrl()
    Getter for requestUrl The original request URL as provided by the client.
    String
    getResponseBody()
    Getter for responseBody The entire response body sent from the AvaTax server to the client.
    Integer
    getResponseStatus()
    Getter for responseStatus The HTTP response code that was sent by the server.
    Integer
    getServerDuration()
    Getter for serverDuration The number of milliseconds that the AvaTax server took to respond to this API call.
    String
    getServerName()
    Getter for serverName The server name of the AvaTax server that responded to this API call.
    Date
    getServerTimestamp()
    Getter for serverTimestamp The server timestamp, in UTC, of the time when the server received this API call.
    String
    getServerVersion()
    Getter for serverVersion The software version number of the currently deployed AvaTax API software on the server that responded to this API call.
    String
    getServiceName()
    Getter for serviceName The service name of the AvaTax API service that responded to this API call.
    Integer
    getSeverityLevelId()
    Getter for severityLevelId If the API contained a specific type of error code, this value would contain the unique ID number of the severity level of the response returned to the client.
    Long
    getTransactionId()
    Getter for transactionId A unique ID number referring to this individual API call.
    Integer
    getUserId()
    Getter for userId The unique ID number of the user that performed this API call.
    void
    setAccountId(Integer value)
    Setter for accountId The unique ID number of the account to which the user belongs.
    void
    setAdapterName(String value)
    Setter for adapterName If your API call specified a `AdapterName` in the [Client Profile Headers](https://developer.avalara.com/avatax/client-headers/), this variable will contain its value.
    void
    setAdapterVersion(String value)
    Setter for adapterVersion If your API call specified a `AdapterVersion` in the [Client Profile Headers](https://developer.avalara.com/avatax/client-headers/), this variable will contain its value.
    void
    setAuditMessage(String value)
    Setter for auditMessage Reserved for Avalara internal usage.
    void
    setClientName(String value)
    Setter for clientName If your API call specified a `ClientName` in the [Client Profile Headers](https://developer.avalara.com/avatax/client-headers/), this variable will contain its value.
    void
    setClientVersion(String value)
    Setter for clientVersion If your API call specified a `ClientVersion` in the [Client Profile Headers](https://developer.avalara.com/avatax/client-headers/), this variable will contain its value.
    void
    setDatabaseCallCount(Integer value)
    Setter for databaseCallCount If this API call included requests made to any of the AvaTax data layers, this contains the number of requests that were traced.
    void
    setDatabaseCallDuration(String value)
    Setter for databaseCallDuration If this API call included requests made to any of the AvaTax data layers, this contains the total duration time measured for all the requests.
    void
    setErrorMessage(String value)
    Setter for errorMessage If this API call reported an error, this contains the name of the error that was returned.
    void
    setEvents(ArrayList<AuditEvent> value)
    Setter for events Reserved for Avalara internal usage.
    void
    setIpAddress(String value)
    Setter for ipAddress The origin IP address from which AvaTax received this API call.
    void
    setIsQueued(Boolean value)
    Setter for isQueued Reserved for Avalara internal usage.
    void
    setLoadBalancerDuration(Integer value)
    Setter for loadBalancerDuration Reserved for Avalara internal usage.
    void
    setMachineName(String value)
    Setter for machineName If your API call specified a `MachineName` in the [Client Profile Headers](https://developer.avalara.com/avatax/client-headers/), this variable will contain its value.
    void
    setOperation(String value)
    Setter for operation The operation name of this API call.
    void
    setRecordCount(Integer value)
    Setter for recordCount If this API call returned an array of information, this value contains the number of records returned.
    void
    setReferenceAuthorization(String value)
    Setter for referenceAuthorization Reserved for Avalara internal usage.
    void
    setReferenceCode(String value)
    Setter for referenceCode A context-dependent reference code for this API call.
    void
    setReferenceId(Long value)
    Setter for referenceId A context-dependent reference ID for this API call.
    void
    setRemoteCallDuration(String value)
    Setter for remoteCallDuration If this API call included interoperation with other Avalara services, this contains the amount of time taken by those services.
    void
    setRemoteCalls(ArrayList<AuditModel> value)
    Setter for remoteCalls Reserved for Avalara internal usage.
    void
    setRequestBody(String value)
    Setter for requestBody If this request was an HTTP request that included a body such as a POST or a PUT, this will contain the request body sent by the client.
    void
    setRequestUrl(String value)
    Setter for requestUrl The original request URL as provided by the client.
    void
    setResponseBody(String value)
    Setter for responseBody The entire response body sent from the AvaTax server to the client.
    void
    setResponseStatus(Integer value)
    Setter for responseStatus The HTTP response code that was sent by the server.
    void
    setServerDuration(Integer value)
    Setter for serverDuration The number of milliseconds that the AvaTax server took to respond to this API call.
    void
    setServerName(String value)
    Setter for serverName The server name of the AvaTax server that responded to this API call.
    void
    setServerTimestamp(Date value)
    Setter for serverTimestamp The server timestamp, in UTC, of the time when the server received this API call.
    void
    setServerVersion(String value)
    Setter for serverVersion The software version number of the currently deployed AvaTax API software on the server that responded to this API call.
    void
    setServiceName(String value)
    Setter for serviceName The service name of the AvaTax API service that responded to this API call.
    void
    setSeverityLevelId(Integer value)
    Setter for severityLevelId If the API contained a specific type of error code, this value would contain the unique ID number of the severity level of the response returned to the client.
    void
    setTransactionId(Long value)
    Setter for transactionId A unique ID number referring to this individual API call.
    void
    setUserId(Integer value)
    Setter for userId The unique ID number of the user that performed this API call.
    String
    toString()
    Returns a JSON string representation of AuditModel

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • AuditModel

      public AuditModel()

  • Method Details

    • getTransactionId

      public Long getTransactionId()
      Getter for transactionId A unique ID number referring to this individual API call.

    • setTransactionId

      public void setTransactionId(Long value)
      Setter for transactionId A unique ID number referring to this individual API call.

    • getAccountId

      public Integer getAccountId()
      Getter for accountId The unique ID number of the account to which the user belongs.

    • setAccountId

      public void setAccountId(Integer value)
      Setter for accountId The unique ID number of the account to which the user belongs.

    • getUserId

      public Integer getUserId()
      Getter for userId The unique ID number of the user that performed this API call.

    • setUserId

      public void setUserId(Integer value)
      Setter for userId The unique ID number of the user that performed this API call.

    • getIpAddress

      public String getIpAddress()
      Getter for ipAddress The origin IP address from which AvaTax received this API call. If you use a proxy layer or other gateway, this IP address may be the address of the gateway. This information is not guaranteed to be accurate and may change based on network conditions between your site and AvaTax.

    • setIpAddress

      public void setIpAddress(String value)
      Setter for ipAddress The origin IP address from which AvaTax received this API call. If you use a proxy layer or other gateway, this IP address may be the address of the gateway. This information is not guaranteed to be accurate and may change based on network conditions between your site and AvaTax.

    • getMachineName

      public String getMachineName()
      Getter for machineName If your API call specified a `MachineName` in the [Client Profile Headers](https://developer.avalara.com/avatax/client-headers/), this variable will contain its value. This information is self-reported by the client and is not guaranteed to be present.

    • setMachineName

      public void setMachineName(String value)
      Setter for machineName If your API call specified a `MachineName` in the [Client Profile Headers](https://developer.avalara.com/avatax/client-headers/), this variable will contain its value. This information is self-reported by the client and is not guaranteed to be present.

    • getClientName

      public String getClientName()
      Getter for clientName If your API call specified a `ClientName` in the [Client Profile Headers](https://developer.avalara.com/avatax/client-headers/), this variable will contain its value. This information is self-reported by the client and is not guaranteed to be present.

    • setClientName

      public void setClientName(String value)
      Setter for clientName If your API call specified a `ClientName` in the [Client Profile Headers](https://developer.avalara.com/avatax/client-headers/), this variable will contain its value. This information is self-reported by the client and is not guaranteed to be present.

    • getClientVersion

      public String getClientVersion()
      Getter for clientVersion If your API call specified a `ClientVersion` in the [Client Profile Headers](https://developer.avalara.com/avatax/client-headers/), this variable will contain its value. This information is self-reported by the client and is not guaranteed to be present.

    • setClientVersion

      public void setClientVersion(String value)
      Setter for clientVersion If your API call specified a `ClientVersion` in the [Client Profile Headers](https://developer.avalara.com/avatax/client-headers/), this variable will contain its value. This information is self-reported by the client and is not guaranteed to be present.

    • getAdapterName

      public String getAdapterName()
      Getter for adapterName If your API call specified a `AdapterName` in the [Client Profile Headers](https://developer.avalara.com/avatax/client-headers/), this variable will contain its value. This information is self-reported by the client and is not guaranteed to be present.

    • setAdapterName

      public void setAdapterName(String value)
      Setter for adapterName If your API call specified a `AdapterName` in the [Client Profile Headers](https://developer.avalara.com/avatax/client-headers/), this variable will contain its value. This information is self-reported by the client and is not guaranteed to be present.

    • getAdapterVersion

      public String getAdapterVersion()
      Getter for adapterVersion If your API call specified a `AdapterVersion` in the [Client Profile Headers](https://developer.avalara.com/avatax/client-headers/), this variable will contain its value. This information is self-reported by the client and is not guaranteed to be present.

    • setAdapterVersion

      public void setAdapterVersion(String value)
      Setter for adapterVersion If your API call specified a `AdapterVersion` in the [Client Profile Headers](https://developer.avalara.com/avatax/client-headers/), this variable will contain its value. This information is self-reported by the client and is not guaranteed to be present.

    • getServerName

      public String getServerName()
      Getter for serverName The server name of the AvaTax server that responded to this API call.

    • setServerName

      public void setServerName(String value)
      Setter for serverName The server name of the AvaTax server that responded to this API call.

    • getServerVersion

      public String getServerVersion()
      Getter for serverVersion The software version number of the currently deployed AvaTax API software on the server that responded to this API call.

    • setServerVersion

      public void setServerVersion(String value)
      Setter for serverVersion The software version number of the currently deployed AvaTax API software on the server that responded to this API call.

    • getReferenceId

      public Long getReferenceId()
      Getter for referenceId A context-dependent reference ID for this API call. This reference ID is not guaranteed to contain a specific value and may be used differently by various API calls.

    • setReferenceId

      public void setReferenceId(Long value)
      Setter for referenceId A context-dependent reference ID for this API call. This reference ID is not guaranteed to contain a specific value and may be used differently by various API calls.

    • getSeverityLevelId

      public Integer getSeverityLevelId()
      Getter for severityLevelId If the API contained a specific type of error code, this value would contain the unique ID number of the severity level of the response returned to the client.

    • setSeverityLevelId

      public void setSeverityLevelId(Integer value)
      Setter for severityLevelId If the API contained a specific type of error code, this value would contain the unique ID number of the severity level of the response returned to the client.

    • getServerTimestamp

      public Date getServerTimestamp()
      Getter for serverTimestamp The server timestamp, in UTC, of the time when the server received this API call.

    • setServerTimestamp

      public void setServerTimestamp(Date value)
      Setter for serverTimestamp The server timestamp, in UTC, of the time when the server received this API call.

    • getServerDuration

      public Integer getServerDuration()
      Getter for serverDuration The number of milliseconds that the AvaTax server took to respond to this API call.

    • setServerDuration

      public void setServerDuration(Integer value)
      Setter for serverDuration The number of milliseconds that the AvaTax server took to respond to this API call.

    • getServiceName

      public String getServiceName()
      Getter for serviceName The service name of the AvaTax API service that responded to this API call.

    • setServiceName

      public void setServiceName(String value)
      Setter for serviceName The service name of the AvaTax API service that responded to this API call.

    • getOperation

      public String getOperation()
      Getter for operation The operation name of this API call.

    • setOperation

      public void setOperation(String value)
      Setter for operation The operation name of this API call.

    • getReferenceCode

      public String getReferenceCode()
      Getter for referenceCode A context-dependent reference code for this API call. This reference code is not guaranteed to contain a specific value and may be used differently by various API calls.

    • setReferenceCode

      public void setReferenceCode(String value)
      Setter for referenceCode A context-dependent reference code for this API call. This reference code is not guaranteed to contain a specific value and may be used differently by various API calls.

    • getErrorMessage

      public String getErrorMessage()
      Getter for errorMessage If this API call reported an error, this contains the name of the error that was returned. You can look up more information about AvaTax error messages on the [AvaTax REST Error Page](https://developer.avalara.com/avatax/errors/).

    • setErrorMessage

      public void setErrorMessage(String value)
      Setter for errorMessage If this API call reported an error, this contains the name of the error that was returned. You can look up more information about AvaTax error messages on the [AvaTax REST Error Page](https://developer.avalara.com/avatax/errors/).

    • getAuditMessage

      public String getAuditMessage()
      Getter for auditMessage Reserved for Avalara internal usage.

    • setAuditMessage

      public void setAuditMessage(String value)
      Setter for auditMessage Reserved for Avalara internal usage.

    • getLoadBalancerDuration

      public Integer getLoadBalancerDuration()
      Getter for loadBalancerDuration Reserved for Avalara internal usage.

    • setLoadBalancerDuration

      public void setLoadBalancerDuration(Integer value)
      Setter for loadBalancerDuration Reserved for Avalara internal usage.

    • getRecordCount

      public Integer getRecordCount()
      Getter for recordCount If this API call returned an array of information, this value contains the number of records returned.

    • setRecordCount

      public void setRecordCount(Integer value)
      Setter for recordCount If this API call returned an array of information, this value contains the number of records returned.

    • getReferenceAuthorization

      public String getReferenceAuthorization()
      Getter for referenceAuthorization Reserved for Avalara internal usage.

    • setReferenceAuthorization

      public void setReferenceAuthorization(String value)
      Setter for referenceAuthorization Reserved for Avalara internal usage.

    • getIsQueued

      public Boolean getIsQueued()
      Getter for isQueued Reserved for Avalara internal usage.

    • setIsQueued

      public void setIsQueued(Boolean value)
      Setter for isQueued Reserved for Avalara internal usage.

    • getDatabaseCallCount

      public Integer getDatabaseCallCount()
      Getter for databaseCallCount If this API call included requests made to any of the AvaTax data layers, this contains the number of requests that were traced. Please note that not all data layers support this measurement.

    • setDatabaseCallCount

      public void setDatabaseCallCount(Integer value)
      Setter for databaseCallCount If this API call included requests made to any of the AvaTax data layers, this contains the number of requests that were traced. Please note that not all data layers support this measurement.

    • getDatabaseCallDuration

      public String getDatabaseCallDuration()
      Getter for databaseCallDuration If this API call included requests made to any of the AvaTax data layers, this contains the total duration time measured for all the requests. Please note that not all data layers support this measurement.

    • setDatabaseCallDuration

      public void setDatabaseCallDuration(String value)
      Setter for databaseCallDuration If this API call included requests made to any of the AvaTax data layers, this contains the total duration time measured for all the requests. Please note that not all data layers support this measurement.

    • getRemoteCallDuration

      public String getRemoteCallDuration()
      Getter for remoteCallDuration If this API call included interoperation with other Avalara services, this contains the amount of time taken by those services.

    • setRemoteCallDuration

      public void setRemoteCallDuration(String value)
      Setter for remoteCallDuration If this API call included interoperation with other Avalara services, this contains the amount of time taken by those services.

    • getEvents

      public ArrayList<AuditEvent> getEvents()
      Getter for events Reserved for Avalara internal usage.

    • setEvents

      public void setEvents(ArrayList<AuditEvent> value)
      Setter for events Reserved for Avalara internal usage.

    • getRequestUrl

      public String getRequestUrl()
      Getter for requestUrl The original request URL as provided by the client.

    • setRequestUrl

      public void setRequestUrl(String value)
      Setter for requestUrl The original request URL as provided by the client.

    • getRequestBody

      public String getRequestBody()
      Getter for requestBody If this request was an HTTP request that included a body such as a POST or a PUT, this will contain the request body sent by the client. This request body is represented as a string, exactly as it was received from the client. Regardless of whether the request was JSON, Base64 encoded bytes, or a CSV file, this contains the exact contents of the request body.

    • setRequestBody

      public void setRequestBody(String value)
      Setter for requestBody If this request was an HTTP request that included a body such as a POST or a PUT, this will contain the request body sent by the client. This request body is represented as a string, exactly as it was received from the client. Regardless of whether the request was JSON, Base64 encoded bytes, or a CSV file, this contains the exact contents of the request body.

    • getResponseStatus

      public Integer getResponseStatus()
      Getter for responseStatus The HTTP response code that was sent by the server.

    • setResponseStatus

      public void setResponseStatus(Integer value)
      Setter for responseStatus The HTTP response code that was sent by the server.

    • getResponseBody

      public String getResponseBody()
      Getter for responseBody The entire response body sent from the AvaTax server to the client. This value is returned as a string regardless of whether the results were JSON-formatted text, CSV files, or raw strings.

    • setResponseBody

      public void setResponseBody(String value)
      Setter for responseBody The entire response body sent from the AvaTax server to the client. This value is returned as a string regardless of whether the results were JSON-formatted text, CSV files, or raw strings.

    • getRemoteCalls

      public ArrayList<AuditModel> getRemoteCalls()
      Getter for remoteCalls Reserved for Avalara internal usage.

    • setRemoteCalls

      public void setRemoteCalls(ArrayList<AuditModel> value)
      Setter for remoteCalls Reserved for Avalara internal usage.

    • toString

      public String toString()
      Returns a JSON string representation of AuditModel
      Overrides:
      toString in class Object