Job scope change requests
Managing a scope change request for a job.
Sometimes there are services that aren't captured in the job but are identified by the Tax Pro. In these cases, the Tax Pro may request a scope change to amend the services on the job.
When a scope change is requested, the Job will be put ON_HOLD
, and a webhook notification will be emitted to let you know that the scope change is pending approval.
The request can then be either accepted or rejected on behalf of the client.
If accepted, the scope change pricing will be applied to the job, and the job will move back to the CLAIMED
status.
If rejected, the scope change is dismissed, and the job will remain ON_HOLD
.
Endpoints Used
Method | Url |
---|---|
POST | /v1.0/jobs/{job_id}/scope_change/approve |
POST | /v1.0/jobs/{job_id}/scope_change/reject |
Job Scope Change Properties
The ID of the scope change.
The ID of the job the scope change corresponds to.
The ID of the user who requested the scope change.
When the scope change was requested.
The requested items.
Job Scope Change Item Properties
Each item describes a service, alongside a price inclusive of the total quantity.
A name describing the service.
The item quantity.
The total price of the service.
Copied1{2 "id": "60b0888a-2ab2-490b-bfc2-ecdc365e7e71",3 "job_id": "65b332cc-bbe6-4f0a-831a-14c5e7e402dc",4 "created_by_user_id": "7628012a-d5e0-45b8-bc0d-72ebce39f836",5 "create_time": "2022-12-09T06:48:15.672362Z",6 "items": [7 {8 "name": "1040NR",9 "quantity": 1,10 "price": 20.311 }12 ]13}