Package Avalara.SDK.model.A1099.V2

Class JobResponse

  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.7.0")
public class JobResponse
extends Object
    Response model for job operations

    • Constructor Detail

      • JobResponse

        public JobResponse()

    • Method Detail

      • getId

        @Nullable
public String getId()
        Unique identifier for the job
        Returns:
        id

      • setId

        public void setId​(String id)

      • getType

        @Nullable
public String getType()
        Job type identifier. Will always be \"update_job\" for bulk upsert operations
        Returns:
        type

      • setType

        public void setType​(String type)

      • getErrorMessage

        @Nullable
public String getErrorMessage()
        Error message if the job failed, null otherwise
        Returns:
        errorMessage

      • setErrorMessage

        public void setErrorMessage​(String errorMessage)

      • getTotalProcessed

        @Nullable
public Integer getTotalProcessed()
        Total number of forms processed. Value can be 0 or another value based on what the job has available
        Returns:
        totalProcessed

      • setTotalProcessed

        public void setTotalProcessed​(Integer totalProcessed)

      • getTotalRows

        @Nullable
public Integer getTotalRows()
        Total number of forms in the request. Value can be 0 or another value based on what the job has available
        Returns:
        totalRows

      • setTotalRows

        public void setTotalRows​(Integer totalRows)

      • getUpdatedValid

        @Nullable
public Integer getUpdatedValid()
        Number of forms updated and valid for e-filing and e-delivery. Value can be 0 or another value based on what the job has available
        Returns:
        updatedValid

      • setUpdatedValid

        public void setUpdatedValid​(Integer updatedValid)

      • getUpdatedNoEmail

        @Nullable
public Integer getUpdatedNoEmail()
        Number of forms updated and valid for e-filing but missing email or email is undeliverable. Value can be 0 or another value based on what the job has available
        Returns:
        updatedNoEmail

      • setUpdatedNoEmail

        public void setUpdatedNoEmail​(Integer updatedNoEmail)

      • getUpdatedInvalid

        @Nullable
public Integer getUpdatedInvalid()
        Number of forms updated but invalid for e-filing. Value can be 0 or another value based on what the job has available
        Returns:
        updatedInvalid

      • setUpdatedInvalid

        public void setUpdatedInvalid​(Integer updatedInvalid)

      • getSkippedDuplicate

        @Nullable
public Integer getSkippedDuplicate()
        Number of forms skipped because they would have updated a record already updated once in the request. Value can be 0 or another value based on what the job has available
        Returns:
        skippedDuplicate

      • setSkippedDuplicate

        public void setSkippedDuplicate​(Integer skippedDuplicate)

      • getSkippedInvalid

        @Nullable
public Integer getSkippedInvalid()
        Number of forms skipped because they would have made a form invalid and the form is already e-filed or scheduled for e-filing. Value can be 0 or another value based on what the job has available
        Returns:
        skippedInvalid

      • setSkippedInvalid

        public void setSkippedInvalid​(Integer skippedInvalid)

      • skippedMultipleMatches

        public JobResponse skippedMultipleMatches​(Integer skippedMultipleMatches)

      • getSkippedMultipleMatches

        @Nullable
public Integer getSkippedMultipleMatches()
        Number of forms skipped because they matched multiple forms. Value can be 0 or another value based on what the job has available
        Returns:
        skippedMultipleMatches

      • setSkippedMultipleMatches

        public void setSkippedMultipleMatches​(Integer skippedMultipleMatches)

      • getNotFound

        @Nullable
public Integer getNotFound()
        Number of forms skipped because no matching form or issuer could be found. Value can be 0 or another value based on what the job has available
        Returns:
        notFound

      • setNotFound

        public void setNotFound​(Integer notFound)

      • getCreatedInvalid

        @Nullable
public Integer getCreatedInvalid()
        Number of new forms created because no matching form could be found (and `upsert` was true) - with errors. Value can be 0 or another value based on what the job has available
        Returns:
        createdInvalid

      • setCreatedInvalid

        public void setCreatedInvalid​(Integer createdInvalid)

      • getCreatedNoEmail

        @Nullable
public Integer getCreatedNoEmail()
        Number of new forms created because no matching form could be found (and `upsert` was true) - valid for e-filing but missing email or email is undeliverable. Value can be 0 or another value based on what the job has available
        Returns:
        createdNoEmail

      • setCreatedNoEmail

        public void setCreatedNoEmail​(Integer createdNoEmail)

      • getCreatedValid

        @Nullable
public Integer getCreatedValid()
        Number of new forms created because no matching form could be found (and `upsert` was true) - valid for e-filing and e-delivery. Value can be 0 or another value based on what the job has available
        Returns:
        createdValid

      • setCreatedValid

        public void setCreatedValid​(Integer createdValid)

      • getDryRun

        @Nullable
public Boolean getDryRun()
        Dry run. If `true`, this job only simulates the changes but doesn't actually persist them.
        Returns:
        dryRun

      • setDryRun

        public void setDryRun​(Boolean dryRun)

      • getUpsert

        @Nullable
public Boolean getUpsert()
        Upsert. If `true`, this job will first attempt to update existing records if matches can be found. Matches are done in the following order: Form ID, Form Reference ID and tax year, Form TIN and tax year.
        Returns:
        upsert

      • setUpsert

        public void setUpsert​(Boolean upsert)

      • getLink

        @Nullable
public String getLink()
        Link to access the job details
        Returns:
        link

      • setLink

        public void setLink​(String link)

      • getProcessedForms

        @Nullable
public List<Get1099Form200Response> getProcessedForms()
        List of processed forms returned when bulk-upsert processes ≤1000 records. Same format as GET /1099/forms response. Only available in bulk-upsert endpoint responses.
        Returns:
        processedForms

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • validateJsonElement

        public static void validateJsonElement​(com.google.gson.JsonElement jsonElement)
                                throws IOException
        Validates the JSON Element and throws an exception if issues found
        Parameters:
        jsonElement - JSON Element
        Throws:
        IOException - if the JSON Element is invalid with respect to JobResponse

      • fromJson

        public static JobResponse fromJson​(String jsonString)
                            throws IOException
        Create an instance of JobResponse given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of JobResponse
        Throws:
        IOException - if the JSON string is invalid with respect to JobResponse

      • toJson

        public String toJson()
        Convert an instance of JobResponse to an JSON string
        Returns:
        JSON string