Skip to content

API Documentation

ConceptsThe Worklayer platformAuthenticationRate LimitsError handling

MemberThe Member ResourceCreate a memberRetrieve a memberRetrieve a member by external IDRetrieve a list of membersUpdate a memberAccept terms for a member

JobsThe Job ResourceRetrieve a job by short IDThe job creation flowThe Info Gathering ChecklistCreate a job from a templateRetrieve questionnaireSubmit questionnaire answersRequest a specific ProRequest a previous ProAssign a supporting clientRemove a supporting clientSubmit a jobRetrieve a list of your jobsList job documentsDelete a jobRetrieve a job checklistComplete info gathering for a jobRequest cancellationRequest reopen

Relationship ManagerRelationship Manager ResourceRetrieve a job relationship manager

Job ProgressionsApprove a draftReject a draftMark job as ready to file

ConsultationsThe Consultation Resource

Scope Change RequestsChange job scopeList consultation service itemsCreate job scope change requestApprove a job scope changeReject a job scope change

Job NotesThe Job Note ResourceCreate a job noteGet a job noteList job notes

Job TemplatesThe Job Template ResourceRetrieve available job templates

Personal ProfilesThe Personal Profile ResourceRetrieve a personal profileSave a personal profileProvide a personal profile to a jobRetrieve a personal profile for a job

Spousal ProfilesThe Spousal Profile ResourceRetrieve a spousal profileSave a spousal profileProvide a spousal profile to a jobRetrieve a spousal profile for a job

Dependent ProfilesThe Dependent Profile ResourceList dependent profilesRetrieve a dependent profileCreate a dependent profileUpdate a dependent profileDelist a dependent profileProvide a dependent profile to a jobRemove a dependent profile from a jobRetrieve dependent profiles for a job

Business ProfilesThe Business Profile ResourceList business profilesCreate a business profileUpdate a business profileRetrieve a business profileRetrieve a business profile for a jobDelist a business profileProvide a business profile to a job

Tax Refund MethodsThe Tax Refund Method ResourceList tax refund methodsCreate a tax refund methodRetrieve a tax refund methodRetrieve a tax refund method for a jobUpdate a tax refund methodDelist a tax refund methodProvide a personal refund methodProvide a business refund method

DocumentsThe Document ResourceCreate a documentGet a documentDownload a documentDelete a document

Document TypesThe Document Type ResourceList document types

MessagesThe Message ResourceSend a messageList messagesGet unread count

OCRStart OCR processingGet OCR results

WebhooksConsume webhook eventsEvent resourcesCheck signatures

Magic LinkDashboardJob DetailsWaitlist

PortalPortal embeddingPortal translations

GuidesFilteringPostman Collection

Create Job scope change request

Create a scope change request for a job.

This endpoint allows you to create new job scope change requests.

Path Parameters

job_id

•

string

required

ID of the job to create the scope change request.

Endpoint

Method	Url
`POST`	`/v1.0/jobs/{job_id}/scope_change/consultations`

Request Parameters

reason

•

string

required

A brief message explaining the reason for creating the consultation scope change request.

add

•

list

required

A list of consultation items you want to include in the scope.

remove

•

list

required

A list of consultation items you want to remove from the scope.

Sample Request

bashCopied
1curl -X POST 'https://api.worklayer.com/v1.0/jobs/d3ef618d-752d-4384-9e66-2e11281b89d8/scope_change/consultations' \
2  -H 'Authorization: Bearer {token}' \
3  -d '{
4    "reason": "Add consultation items",
5    "add": [
6      {"consultation_item_id": "ea7dd97b-a485-41b5-9cca-a607915b2f80", "quantity_to_add": 1},
7      {"consultation_item_id": "b1b66b75-c23e-4fc4-b24b-924f25dfd2d0", "quantity_to_add": 1}
8    ],
9    "remove": [
10      {"consultation_item_id": "3bcc8382-cdd5-4895-8ce2-b271955454c6", "quantity_to_remove": 1}
11    ]
12  }'

Response

id

•

guid

The job scope change request ID.

job_id

•

guid

The job ID.

user_id

•

guid

The ID of the user who registered the scope change request.

created_time

•

guid

The creation time of the scope change request.

items

•

list

A list of consultation items to be modified in the scope change requests.

Sample Response

jsonCopied
1{
2  "id": "f8a22b94-b5c7-49c8-9a64-5ac61f6c3fcd",
3  "job_id": "d3ef618d-752d-4384-9e66-2e11281b89d8",
4  "created_by_user_id": "ab1eeae0-3bb0-5318-9bc0-2fa2afe80b9a",
5  "created_time": "2024-12-06T21:19:08.012981Z",
6  "items": [
7    {
8      "name": "Consultation (30 Minutes)",
9      "quantity": 1,
10      "price": 50.0,
11      "consultation_item_id": "b1b66b75-c23e-4fc4-b24b-924f25dfd2d0"
12    },
13    {
14      "name": "Consultation (1 Hour)",
15      "quantity": 1,
16      "price": 100.0,
17      "consultation_item_id": "ea7dd97b-a485-41b5-9cca-a607915b2f80"
18    }
19  ]
20}

Add Item

consultation_item_id

•

guid

required

The unique identifier of the consultation item.

quantity_to_add

•

numeric

required

The quantity of the consultation item to be added.

Remove Item

consultation_item_id

•

guid

required

The unique identifier of the consultation item.

quantity_to_remove

•

numeric

required

The quantity of the consultation item to be removed.

Consultation Item

name

•

string

The name of the consultation item.

quantity

•

numeric

The quantity of the consultation item.

price

•

numeric

The price of the consultation item.

consultation_item_id

•

guid

The unique identifier of the consultation item.

Next steps

Last updated on December 6, 2024

Privacy Policy Terms & Conditions© 2026 Taxfyle