Update Employee Deduction Template

URL Expired

The URL for this request expired after 30 days.

Payload to update an employee deduction template

• deductionTemplateID
  Type: string
  Required: ^[0-9a-f]{32}$
  Description: ID of this template

• agency_address
  Type: string
  Length: ≥ 1
  Description: Name of the agency for a court order (Garnishment only)

• agency_name
  Type: string
  Length: ≥ 1
  Description: Address of the agency for a court order (Garnishment only)

• case_id
  Type: string
  Description: Case ID of a court order (Garnishment only)

• custom_name
  Type: string
  Description: Human-readable name for the deduction template

• effective_end_date
  Type: string
  Format: ^(19|20)\d{2}(-)(0[1-9]|1[1,2])(-)(0[1-9]|[1,2][0-9]|3[0,1])$
  Description: Date the template should become ineffective

• effective_start_date
  Type: string
  Format: ^(19|20)\d{2}(-)(0[1-9]|1[1,2])(-)(0[1-9]|[1,2][0-9]|3[0,1])$
  Description: Date the template should start become effective

• employee_contribution_amount
  Type: number
  Condition: ≥ 0
  Description: Default dollar amount to be contributed by the employee for deductions

• employee_contribution_percentage
  Type: number
  Condition: 0 to 100
  Description: Default percentage of employee's pay to be contributed by the employee for deductions

• employer_contribution_amount
  Type: number
  Condition: ≥ 0
  Description: Default dollar amount to be contributed by the employer for deductions

• employer_contribution_percentage
  Type: number
  Condition: 0 to 100
  Description: Default percentage of employee's pay to be contributed by the employer for deductions

• external_id
  Type: string
  Length: ≥ 1
  Description: ID in a external system related to the template

• hsa_type
  Type: string
  Enum: family, individual
  Description: Contribution limit type for the template (HSA only)

• order_number
  Type: string
  Length: ≥ 1
  Description: Order number of a court order (Garnishment only)

Response Codes

• 200
  Successful response

• 400
  Invalid request error

• 404
  Resource not found error

Example cURL Request

curl --request PATCH \
     --url https://api.zeal.com/employee-deduction-templates/deductionTemplateID \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here!

Status Updates

Updated 6 months ago.