Skip to content

API Documentation

ConceptsThe Worklayer platformAuthentication

MemberThe Member ResourceCreate a memberRetrieve a list of membersUpdate a member

JobsThe Job ResourceThe job creation flowThe Info Gathering ChecklistCreate a job from a templateRetrieve questionnaireSubmit questionnaire answersRequest a specific ProRequest a previous ProSubmit a jobRetrieve a list of your jobsList job documentsRetrieve a job url - DEPRECATEDDelete a jobRetrieve a job checklistComplete info gathering for a job

ConsultationsThe Consultation Resource

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

Job TemplatesThe Job Template ResourceRetrieve available job templates

Service PackagesThe Service Package ResourceRetrieve a list of your service packagesSubmit service package answers

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 ResourceRetrieve a dependent profileCreate a dependent profileUpdate a dependent profileProvide a dependent profile to a jobRemove a dependent profile from a jobRetrieve dependent profiles for a job

Business ProfilesThe Business Profile ResourceCreate a business profileUpdate a business profileRetrieve a business profileRetrieve a business profile for a jobProvide a business profile to a job

Tax Refund MethodsThe Tax Refund Method ResourceCreate a tax refund methodRetrieve a tax refund methodRetrieve a tax refund method for a jobUpdate a tax refund methodProvide a personal refund methodProvide a business refund method

DocumentsThe Document ResourceCreate a documentGet a documentDownload a document

Document TypesThe Document Type ResourceList document types

WebhooksConsume webhook eventsEvent resourcesCheck signatures

Magic LinkDashboardJob Details

GuidesFilteringPostman Collection

Provide Personal Refund Method

Provide a personal tax refund method to a job.

This endpoint provides an existing personal tax refund method to a job's supporting item. The refund method being provided must belong to the client on the job.

Endpoint

Method	Url
`POST`	`/v1.0/jobs/:job_id/checklist/:supporting_item_id/provide-personal-refund-method`

Path Parameters

job_id

•

string

required

ID of the job.

supporting_item_id

•

string

required

The unique identifier of the supporting item. Obtained from the job's checklist input.

Request Body

refund_method_id

•

string

required

ID of the personal tax refund method to provide.

refund_method_version

•

integer

required

Version number of the personal tax refund method.

Sample Request

Copied
1curl -X POST 'https://api.worklayer.com/v1.0/jobs/3b31f309-93ad-463a-ad1d-c39cac1c0a3d/checklist/7a9e1d5b-8f32-4c9a-b95e-9c3a7d518e42/provide-personal-refund-method' \
2-H 'Authorization: Bearer {token}' \
3-H 'Content-Type: application/json' \
4-d '{
5  "refund_method_id": "550e8400-e29b-41d4-a716-446655440000",
6  "refund_method_version": 1
7}'

Response

Empty response object.

Errors

403: Not authorized to provide this refund method
404: The job was not found
404: The supporting item was not found
404: The refund method was not found
400: Invalid supporting item type - the supporting item is not of the right type for this action

Next steps

Retrieve a refund method for a job

Last updated on December 9, 2024

Privacy Policy Terms & Conditions© 2025 Taxfyle