Skip to content

Provide Business Refund Method

Provide a business tax refund method to a job.

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

Endpoint

MethodUrl
POST/v1.0/jobs/:job_id/checklist/:supporting_item_id/provide-business-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 business tax refund method to provide.

refund_method_version
integer
required

Version number of the business 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-business-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
Last updated on December 9, 2024