v1
latestOpenAPI 3.1.02026-07-2414339465.7 KBGet Paperwork Templates
post/paperwork/templates
Request body
Example request
{
"worker_type": "Employee",
"companyID": "fc235fcccee46aa8a082f357715bcfa",
"jurisdictions": {
"type": "include",
"jurisdictions": [
"CA",
"NY"
]
},
"jurisdiction_type": "WorkLocation",
"effective_date": "2023-07-01",
"archive_date": "2024-06-30"
}Response
Successful response
Example response
{
"templates": [
{
"templateID": "form-58ec16d8-54c9-4137-a867-23e60f02ec51",
"form_name": "California W-4",
"paperwork_type": "W4",
"worker_type": "Employee",
"jurisdictions_filter": {
"type": "include",
"jurisdictions": [
"CA"
]
},
"jurisdiction_type": "WorkLocation",
"effective_date": "2023-01-01",
"archive_date": "",
"form_fields": [
{
"field_name": "signature_text",
"label": "Signature Text",
"error_text": "A signature is required",
"type": "base64",
"zeal_autofill": false,
"required": false,
"fieldName": "signature_text",
"x": 130.924,
"y": 369.69,
"width": 231.13699999999997,
"height": 23.083000000000027,
"_id": "66ad78fc79101a05d8c4e32d"
},
{
"field_name": "filingstatus",
"error_text": "This field needs to be filled",
"required": true,
"options": [
{
"label": "Single or Married (with two or more income)",
"value": "sm2"
},
{
"label": "Married (one income)",
"value": "m1"
},
{
"label": "Head of Household",
"value": "h"
}
],
"zeal_autofill": false,
"label": "Filing Status",
"type": "enum",
"inherits_tax_param": "FILINGSTATUS",
"fieldName": "filingstatus",
"x": 309.608,
"y": 609.639,
"width": 9.95999999999998,
"height": 9.960000000000036,
"_id": "66ad78fc79101a05d8c4e32f"
},
{
"field_name": "regular_allowances",
"label": "Regular Allowances",
"error_text": "This field needs to be filled",
"constraint": {
"min": 0,
"max": null
},
"required": true,
"type": "integer",
"inherits_tax_param": "REGULAR_ALLOWANCES",
"description": "Total up the number of allowances applicable to you:\n\n(A) Allowance for yourself - 1 allowance\n(B) Allowance for your spouse (if not separately claimed by your spouse) - 1 allowance\n(C) Allowance for blindness (you) - 1 allowance\n(D) Allowance for blindness (your spouse, if not separately claimed by them) - 1 allowance.\n(E) Allowances for dependents (excluding yourself and your spouse) - 1 allowance per dependent.\n\nPlease also refer to Worksheet A of California Form DE 4 for additional instructions regarding allowances ({FORM_URL}).\n",
"fieldName": "regular_allowances",
"x": 449.192,
"y": 550.663,
"width": 32.39999999999998,
"height": 9.755999999999972,
"_id": "66ad78fc79101a05d8c4e325"
},
{
"field_name": "additional_wh",
"error_text": "This field needs to be filled",
"constraint": {
"min": 0,
"max": null
},
"required": true,
"zeal_autofill": false,
"label": "Additional Withholding",
"type": "dollars",
"inherits_tax_param": "ADDITIONAL_WH",
"description": "Please refer to Worksheet C of California Form DE 4 to compute additional amounts you may want to withhold ({FORM_URL}).\n",
"fieldName": "additional_wh",
"x": 449.192,
"y": 509.522,
"width": 32.39999999999998,
"height": 11.04000000000002,
"_id": "66ad78fc79101a05d8c4e327"
},
{
"field_name": "additional_allowances",
"label": "Additional Allowances from Estimated Deductions",
"error_text": "This field needs to be filled",
"constraint": {
"min": 0,
"max": null
},
"required": true,
"type": "integer",
"inherits_tax_param": "ADDITIONAL_ALLOWANCES",
"description": "Please refer to Worksheet B of California Form DE 4 to determine additional allowances ({FORM_URL}).\n",
"fieldName": "additional_allowances",
"x": 448.7,
"y": 538.335,
"width": 34.196000000000026,
"height": 10.490999999999985,
"_id": "66ad78fc79101a05d8c4e326"
},
{
"field_name": "today_full",
"required": false,
"label": "Date autofill field",
"type": "string",
"zeal_autofill": true,
"fieldName": "today_full",
"x": 500.34,
"y": 370.442,
"width": 72.00000000000006,
"height": 13.5,
"_id": "66ad78fc79101a05d8c4e328"
},
{
"field_name": "business_ein",
"required": false,
"label": "Company object autofill field",
"type": "string",
"zeal_autofill": true,
"fieldName": "business_ein",
"x": 310.25,
"y": 326.232,
"width": 261,
"height": 13.5,
"_id": "66ad78fc79101a05d8c4e32a"
},
{
"field_name": "ssn",
"required": false,
"label": "Employee object autofill field",
"type": "string",
"zeal_autofill": true,
"fieldName": "ssn",
"x": 310.25,
"y": 642.482,
"width": 261,
"height": 13.5,
"_id": "66ad78fc79101a05d8c4e324"
},
{
"field_name": "business_name",
"required": false,
"label": "Company object autofill field",
"type": "string",
"zeal_autofill": true,
"fieldName": "business_name",
"x": 40.25,
"y": 330.53,
"width": 261,
"height": 13.872000000000014,
"_id": "66ad78fc79101a05d8c4e329"
},
{
"field_name": "city",
"required": false,
"label": "Employee object autofill field",
"type": "string",
"zeal_autofill": true,
"fieldName": "city",
"x": 40.25,
"y": 584.192,
"width": 144.828,
"height": 14.422000000000025,
"_id": "66ad78fc79101a05d8c4e323"
},
{
"field_name": "state",
"required": false,
"label": "Employee object autofill field",
"type": "string",
"zeal_autofill": true,
"fieldName": "state",
"x": 187.13,
"y": 583.792,
"width": 48.93899999999999,
"height": 14.422000000000025,
"_id": "66ad78fc79101a05d8c4e32b"
},
{
"field_name": "zip",
"required": false,
"label": "Employee object autofill field",
"type": "string",
"zeal_autofill": true,
"fieldName": "zip",
"x": 247.06,
"y": 583.792,
"width": 58.160000000000025,
"height": 14.422000000000025,
"_id": "66ad78fc79101a05d8c4e32c"
},
{
"field_name": "business_address",
"required": false,
"label": "Company object autofill field",
"type": "string",
"zeal_autofill": true,
"fieldName": "business_address",
"x": 40.5316,
"y": 316.983,
"width": 261.0004,
"height": 12.567999999999984,
"_id": "66ad78fc79101a05d8c4e32e"
},
{
"field_name": "business_city",
"required": false,
"label": "Company object autofill field",
"type": "string",
"zeal_autofill": true,
"fieldName": "business_city",
"x": 41.042,
"y": 302.598,
"width": 85.524,
"height": 12.567999999999984,
"_id": "66ad78fc79101a05d8c4e331"
},
{
"field_name": "business_state",
"required": false,
"label": "Company object autofill field",
"type": "string",
"zeal_autofill": true,
"fieldName": "business_state",
"x": 131.63,
"y": 302.223,
"width": 76.031,
"height": 13.11099999999999,
"_id": "66ad78fc79101a05d8c4e330"
},
{
"field_name": "business_zip",
"required": false,
"label": "Company object autofill field",
"type": "string",
"zeal_autofill": true,
"fieldName": "business_zip",
"x": 220.317,
"y": 302.274,
"width": 76.03199999999998,
"height": 13.11099999999999,
"_id": "66ad78fc79101a05d8c4e332"
},
{
"field_name": "first_name",
"required": false,
"label": "Employee object autofill field",
"type": "string",
"zeal_autofill": true,
"fieldName": "first_name",
"x": 40.25,
"y": 642.482,
"width": 118.38999999999999,
"height": 13.5,
"_id": "66ad78fc79101a05d8c4e321"
},
{
"field_name": "last_name",
"required": false,
"label": "Employee object autofill field",
"type": "string",
"zeal_autofill": true,
"fieldName": "last_name",
"x": 186.432,
"y": 642.64,
"width": 118.39000000000001,
"height": 13.5,
"_id": "66ad78fc79101a05d8c4e333"
},
{
"field_name": "middle_initial",
"required": false,
"label": "Employee object autofill field",
"type": "string",
"zeal_autofill": true,
"fieldName": "middle_initial",
"x": 163.164,
"y": 642.265,
"width": 19.31400000000002,
"height": 13.5,
"_id": "66ad78fc79101a05d8c4e334"
},
{
"field_name": "address",
"required": false,
"label": "Employee object autofill field",
"type": "string",
"zeal_autofill": true,
"fieldName": "address",
"x": 40.25,
"y": 611.692,
"width": 144.66,
"height": 13.5,
"_id": "66ad78fc79101a05d8c4e322"
},
{
"field_name": "address_line2",
"required": false,
"label": "Employee object autofill field",
"type": "string",
"zeal_autofill": true,
"fieldName": "address_line2",
"x": 188.871,
"y": 611.692,
"width": 112.386,
"height": 13.5,
"_id": "66ad78fc79101a05d8c4e335"
},
{
"field_name": "general_exemption",
"label": "Exempt from Withholding?",
"description": "By checking this box, you are certifying that you meet the following conditions for exemption:\n\n1. You did not owe any federal/state income tax last year, and\n2. You do not expect to owe any federal/state income tax this year. The exemption is good for one year.\n\nIf you continue to qualify for the exempt filing status, a new DE 4 designating exempt must be submitted by February 15 each year to continue your exemption. If you are not having federal/state income tax withheld this year but expect to have a tax liability next year, you are required to give your employer a new DE 4 by December 1.\n",
"type": "boolean",
"required": true,
"zeal_autofill": false,
"fieldName": "general_exemption",
"x": 563.291,
"y": 472.169,
"width": 21.380999999999972,
"height": 22.226,
"_id": "66ad78fc79101a05d8c4e338"
},
{
"field_name": "military_exemption",
"label": "Exempt under the Military Spouses Residency Relief Act (MSRRA)?",
"description": "To claim exemption under the Member Service Civil Relief Act, as provided by the Military Spouses Residency Relief Act and the Veterans Benefits and Transition Act of 2018, you may be exempt from California income tax withholding on your wages if:\n\n(i) Your spouse is a member of the armed forces present in California in compliance with military orders;\n(ii) You are present in California solely to be with your spouse; and\n(iii) You maintain your domicile in another state.\n\nIf you claim exemption under this act, check the box. You may be required to provide proof of exemption upon request.\n",
"type": "boolean",
"required": true,
"zeal_autofill": false,
"fieldName": "military_exemption",
"x": 564.684,
"y": 422.739,
"width": 18,
"height": 18,
"_id": "66ad78fc79101a05d8c4e337"
}
],
"status": "Active",
"urls": []
}
]
}