Service Package
A group of tax services used for job creation.
The Service Package resource represents a set of tax services that can be included in jobs for your users, as well as the required information for those services to be completed by the Tax Pro.
Service packages expose a name, description, type, and required questions. The information provided in the service package is for informational purposes. You're not required to display the data as the API returns it, but, in general, it should be safe to show to your users, depending on your use case.
Properties
The id of the service package. This will be necessary for job creation.
The name of the service package. Provided as guidance. Safe to show to your users but not required.
The description of the service package. Provided as guidance. Safe to show to your users but not required.
The type of services in this package. Could be PERSONAL
, BUSINESS
, or ADD_ON
The time the service package was created.
The time the service package was last modified.
The list of required questions you'll need to answer when adding this type of service package to one of your jobs. Questions can be of the following types, which require information to be sent in a certain format:
Type | Answer Format |
---|---|
BOOL | A boolean; either true or false |
NUMERIC | A number; e.g 23 |
TEXT | A string; e.g. "Hello world" |
DATE_TIME | A string of a timestamp; e.g "2022-11-04T04:00:00.000Z" |
SINGLE_SELECT | The id of one of the options exposed in the package; e.g."OPTION1" |
MULTI_SELECT | An array of ids from the provide options ; e.g. [“OPTION1”, "OPTION2"] |
Copied1{2 "id": "21e42d52-4145-465e-94bd-322c13bbe5fa",3 "name": "1040 Tier 1",4 "type": "PERSONAL",5 "description": "Service Package Description",6 "create_time": "2022-08-23T13:54:27.612477Z",7 "modified_time": "2022-08-23T13:54:27.612477Z",8 "required_questions": [9 {10 "id": "QUESTION_1",11 "type": "BOOL",12 "question_text": "New Yes/No Question",13 "options": []14 },15 {16 "id": "QUESTION_2",17 "type": "NUMERIC",18 "question_text": "New Numeric Question",19 "options": []20 },21 {22 "id": "QUESTION_3",23 "type": "TEXT",24 "question_text": "New Text Question",25 "options": []26 },27 {28 "id": "QUESTION_4",29 "type": "DATE_TIME",30 "question_text": "New Date & Time Question",31 "options": []32 },33 {34 "id": "QUESTION_5",35 "type": "SINGLE_SELECT",36 "question_text": "New Select Question",37 "options": [38 {39 "id": "OPTION1",40 "text": "Option1"41 },42 {43 "id": "OPTION2",44 "text": "Option2"45 }46 ]47 },48 {49 "id": "QUESTION_6",50 "type": "MULTI_SELECT",51 "question_text": "New Select Question",52 "options": [53 {54 "id": "OPTION1",55 "text": "Option1"56 },57 {58 "id": "OPTION2",59 "text": "Option2"60 },61 {62 "id": "OPTION3",63 "text": "Option3"64 }65 ]66 }67 ]68}