Job Creation Flow (click to expand)

To create an under-construction job for a user, you'll need two things:

1. The id of the user you want to create the job for
2. The id of the job template you want to use

You can get a job template id from the list of available job templates in your workspace by calling the List Job Templates API and noting a job template id.

Once you have the user id and the job template id, you can use the Create Job API to create an under-construction job for your user. You'll get a job id that you can use to retrieve information about the job that will be used to create links, answer questions, and submit to the pool of Tax Pros.

Once you have an under-construction job, you'll likely want to specify some services the Tax Pro should perform for your user. Each job template supports a set of service packages available for that job. That list is defined in the supported_service_packages field of the Job Templates Resource payload.

Service Packages can either be of type PERSONAL, BUSINESS, or ADD_ON. Your workspace may have more than one PERSONAL package or more than one BUSINESS package. You can choose up to 1 PERSONAL package and as many of the BUSINESS and ADD_ON types as needed.

Each service package can specify a list of required_questions necessary to submit a job to the pool. You can see a list of the required questions for each service package as well as information on the type by calling one of the Service Packages API variants.

After you've identified the service packages you want to include in a job, you're free to collect the required information however you want. Service packages expose a set of questions that are safe to show to your users, along with information on the format required for those answers. Read more on the question/answer format on the Service Package Resource page.

Once you have collected the required information, you can use the Submit Job Answers endpoint to send the required information and prepare the job for submission. Something to keep in mind is that the submit answers endpoint follows PUT semantics, meaning you should always send the complete set of answers for all service packages.

You can send partial answers as often as you want, and the returned job will reflect any changes caused by the new answers, like price updates.

If you want to request a previous Pro to work on the job, you can use the Request Previous Pro endpoint to do so. This must be done prior to submitting the job. Note that this is only applicable for returning customers, as their job history is used to determine which Pro to request.

Please note that even if a specific Pro is requested, they are not guaranteed to be the one assigned to the job If they are not available, the job will be picked up by the first available Pro.

At this point, you've provided all the answers for the required questions in your desired service packages. Next, you can provide any supporting documents like the previous year's return or form of identification via the Document Creation API, or you can submit the job to the pool of Taxfyle Pros via the Job Submit Endpoint.

Once the job is submitted, it'll transition to the UNCLAIMED status while awaiting being picked up by a matching pro and will then transition to CLAIMED once in progress. If Info Gathering is enabled in the workspace, it'll transition to INFO_GATHERING before UNCLAIMED. Info Gathering guides the Client through providing all required information via the Info Gathering Checklist.