Table: dbo.Firm
This table contains all the firm level information.
Columns
Name | Type | Constraints | Description
firm_KEY | int (4) | NOT NULL | Database assigned primary key for this table.
CSI_firm_ID | int (4) | NOT NULL |
security_enabled | bit (1) | NOT NULL |
remember_logon_allowed | bit (1) | NOT NULL |
office_KEY | int (4) | NOT NULL | Key from the main office.
name_1 | nvarchar (100) | NOT NULL |
name_2 | nvarchar (100) | NOT NULL |
federal_tin | nvarchar (22) | NOT NULL | The Firm's Federal tax ID. There is also an alternate_federal_tin in this table.
electronic_filing__contact_KEY | int (4) |  | Contact Key for the contact used in Electronic Filing
compress_ssn_verification_file | bit (1) | NOT NULL | Boolean for whether or not the SSN Verification file should be compressed when created
show_verified_ssn_employees | bit (1) | NOT NULL | Boolean for whether or not employees who have already had their ssn verified should be displayed on the ssn verification screen
new_hire_electronic_filing__ste_state_code_KEY | nvarchar (4) |  | The state format to use for new hire electronic filing.
create_separate_monthly_files_for_export_to_csa | bit (1) | NOT NULL | Create separate files for each month when exporting journal entries?
include_previously_exported_checks_in_export_to_csa | bit (1) | NOT NULL | Include previously exported checks when exporting journal entries?
license | binary (512) |  | Most recent raw license data.
export_to_separate_folder_for_each_client_for_export_to_csa | bit (1) | NOT NULL | Export to separate folders for each client when exporting payroll journal entries?
create_separate_files_for_each_statement_for_export_to_csa | bit (1) | NOT NULL | Create separate files for each statment when exporting reconciliation adjustments?
is_auto_retrieve_insurepay_consent_files | bit (1) |  | A bool flag to indicate if user likes to retrieve insurepay consent files automatically. Default setting is off.
is_auto_process_transmit_insurepay_files | bit (1) |  | A bool flag to indicate if user likes to process and transmit insurepay files automatically. Default setting is off.
is_auto_retrieve_xactpay_consent_files | bit (1) |  | A bool flag to indicate if user likes to retrieve XactPay consent files automatically. Default setting is off.
is_auto_process_transmit_xactpay_files | bit (1) |  | A bool flag to indicate if user likes to process and transmit XactPay files automatically. Default setting is off.
process_transmit_xactpay_file_time | datetime (8, 3) |  | User definded daily file transmission time for XactPay client if automation is enabled.
intercept_login | nvarchar (50) | NOT NULL | Login for InterceptEFT
intercept_pin | nvarchar (50) | NOT NULL | PIN for InterceptEFT
intercept_multifactor_authorization | nvarchar (100) | NOT NULL | Multifactor authorization for InterceptEFT
event_tracking_enabled | bit (1) | NOT NULL | Indicates if the firm is tracking events.
is_auto_print_tax_liability_corresponding_payment_form | bit (1) | NOT NULL | Does this user want to automatically print corresponding payment forms when printing tax liabilities?
enter_transaction_data_entry_mode_KEY | int (4) | NOT NULL | This is for defaulting the mode to use in Enter Transactions
global_report_profile_KEY | int (4) |  | The key which links us to a Global_Report_Profile table record. NULL indicates that a profile has yet to be specified.
disable_data_sharing | bit (1) | NOT NULL |
disable_data_sharing_while_opening | bit (1) | NOT NULL |
tax_form_grouping_KEY | int (4) | NOT NULL | The way the tax forms should be grouped together.
exclude_federal_forms_from_tax_form_grouping | bit (1) | NOT NULL | When the tax forms are to be grouped by jurisdiction, when this option is marked, the federal forms will ["BR"]still be split out by their form type. If the option is not marked, then they will all be grouped together.
has_accounting | bit (1) | NOT NULL | Current set of licenses has Accounting. This is updated at program startup when checking for license changes.
has_compliance | bit (1) | NOT NULL | Current set of licenses has Compliance. This is updated at program startup when checking for license changes.
has_payroll | bit (1) | NOT NULL | Current set of licenses has Payroll. This is updated at program startup when checking for license changes.
separate_internet_form_files_by_staff | bit (1) | NOT NULL | When false, internet files will work as they always have where all staff members will ["BR"] add to the same file. When true, internet files will be created for each staff member
has_workpapers | bit (1) | NOT NULL | Current set of licenses has Workpapers. This is updated at program startup when checking for license changes.
alternate_name | nvarchar (100) | NOT NULL | Firms alternate name if license allows it
alternate_information_queued | bit (1) | NOT NULL | The alternate firm information is queued and awaiting transmission to the portal.
enable_w2_employee_copy_instructions | bit (1) | NOT NULL | When true, this option will force the employee copy of Ws-2 to print duplexed with the W-2 instructions on the back of each W-2 for output types such as paper or pdf file. This setting has no effect on copies transmitted to employee portals such as ESS and WorkforceHub as the instructions are always included for portal copies.
open_pdf_workpaper_in_native_pdf_application | bit (1) | NOT NULL | When true, this firm-level option will indicate that a PDF workpaper will be opened by the native PDF Application. If the option is not marked a PDF workpaper will be opened by the PDF-XChange Viewer Application.
tickmark_stamps__file_storage_KEY | int (4) |  | Contains a stamp file that consists of the firms tickmarks.
is_auto_practice_cs_export | bit (1) | NOT NULL | If Automatically export finalized invoices is set to true, allow exporting invoices automatically.
disable_non_negotiable_watermark_on_checks | bit (1) | NOT NULL | Allows firm to disable the NON-NEGOTIABLE watermark from being printed on checks that are sent to FileCabinetCS.
logo__report_image_KEY | int (4) |  |
signature_1__report_image_KEY | int (4) |  |
signature_2__report_image_KEY | int (4) |  |
signature_3__report_image_KEY | int (4) |  |
adjust_tax_liability_due_date_for_previous_banking_day | bit (1) | NOT NULL | When true, the tax liability due date will be adjusted to the previous banking day if date is nonbanking day
require_electronic_file_transmission_from_file_preview | bit (1) | NOT NULL |
require_internet_magnetic_file_creation_from_file_preview | bit (1) | NOT NULL |
limit_payments_to_funded_only | bit (1) | NOT NULL | True if payments are limited to funded liabilities only.
suppress_stub_direct_deposit | bit (1) | NOT NULL | True if check stub output for magnetic payments is to be suppressed.
suppress_stub_internet | bit (1) | NOT NULL | True if check stub output for internet payments is to be suppressed.
suppress_stub_electronic | bit (1) | NOT NULL | True if check stub output for electronic payments is to be suppressed.
suppress_stub_eftps | bit (1) | NOT NULL | True if check stub output for eftps payments is to be suppressed.
suppress_stub_magnetic | bit (1) | NOT NULL | True if check stub output for magnetic payments is to be suppressed.
organize_print_jobs_by_category | bit (1) | NOT NULL | Allows the firm to enable the ability to sort print jobs in FileCabinetCS by category instead of by date.
require_employee_hire_date | bit (1) | NOT NULL | If the required employee hire date is set to true, then the hire date field of the employee being added or edited should not be blank.
require_employee_ssn | bit (1) | NOT NULL | If the required employee Ssn is set to true, then the Ssn field of the employee being added or edited should not be blank.
automatically_select_funded_transactions_for_direct_deposit | bit (1) | NOT NULL | If true, the associated direct deposit transactions in the ["BR"] Process Direct Deposit screen will automatically be marked for selection ["BR"] including the just processed funding transactions after coming back from the Funding screen.["BR"] If false, only the just processed funding transactions will be marked in the Process Direct Deposit screen.["BR"] Default to false (this means default not to select associated direct deposits).
automatically_run_funding_activity_report_after_direct_deposit | bit (1) | NOT NULL | Display Funding Activity report after creating ACH files.["BR"] Default to false (this means default not to pop up ACH report).
firm_hosted_client_access__file_storage_KEY | int (4) |  | Used to link to the remote desktop protocol file linked to this firm for usage with firm hosted client access. A null value indicates that no file is currently associated.
firm_hosted_client_access__group_id | int (4) |  | The firm hosted client access portal group id. The group id is the relative portion of the URL where the firm can upload its RDP file. A Null id means that the group to upload the RDP file to is unspecified.
group_brokerage_forms | bit (1) | NOT NULL | When true, this firm-level option will indicate that user can group brokerage forms into a single document. If the option is not marked, documents will be generated for each brokerage form.
ultra_tax_w2_tax_firm_id | nvarchar (14) | NOT NULL | Referring accountants id used by UltraTax to process employee W-2s
preview_report_when_pay_selected | bit (1) | NOT NULL | An option that when selected will automatically display a report preview when processing pay selected requests.
disable_w2_export_to_ultra_tax | bit (1) | NOT NULL | Flag which indicates the user wishes to suppress the export of W2s to UltraTax.
include_state_id_in_form_name_for_file_cabinet | bit (1) | NOT NULL | Flag which indicates the user wishes to include state id when grouping forms in FileCabinet CS. This option allows forms with the same name but from different states to be printed separately to FileCabinet CS.
prompt_for_payment_date_override | bit (1) | NOT NULL | An option that when selected will automatically display a payment date override prompt when processing pay selected requests.
append_date_to_document_name_of_reports | bit (1) | NOT NULL | Flag which indicates if the document date should be appended to the document name of a report when printing to File Cabinet.
append_date_to_document_name_of_checks | bit (1) | NOT NULL | Flag which indicates if the document date should be appended to the document name of check layouts when printing to File Cabinet.
append_date_to_document_name_of_billing_invoices | bit (1) | NOT NULL | Flag which indicates if the document date should be appended to the document name of a billing invoices when printing to File Cabinet.
is_dnp_reason_selection_necessary | bit (1) |  |
require_employee_date_of_birth | bit (1) | NOT NULL | The require_employee_date_of_birth is only used for active retirement plan deduction. True indicates that the system will need to verify the Birth date field for the current employee is not blank if the employee has an active item with a special type of retirement plan and that the checkbox for Do not apply Catch-up limit is not checked when the staff member attempts to save the employee.
process_transmit_insurepay_file_time | datetime (8, 3) |  | User defined daily file transmission time for InsurePay client if automation is enabled. ["BR"] When [is_auto_process_transmit_insurepay_files] is true then [process_transmit_insurepay_file_time] must not be NULL and ["BR"] when [is_auto_process_transmit_insurepay_files] is false then [process_transmit_insurepay_file_time] should be ignored.["BR"] Even though the datatype of this column is datetime, only time part will be considered by the code by ignoring date part.
enable_batch_check_entry_date_confirm_firm | bit (1) | NOT NULL | Whether or not firm staff should see the batch check entry date confirmation prompt.
enable_batch_check_entry_date_confirm_client | bit (1) | NOT NULL | Whether or not client staff should see the batch check entry date confirmation prompt.
gfr__disable_non_negotiable_watermark_on_checks | bit (1) | NOT NULL | Allows firm to disable the NON-NEGOTIABLE watermark from being printed on checks that are sent to GoFileRoom.
gfr__configuration | nvarchar (-1) | NOT NULL | Contains GoFileRoom integration configuration data in an xml format.
group_k1s | bit (1) | NOT NULL | When true, this firm-level option will indicate that user can group k1s into a single document. If the option is not marked, documents will be generated for each k1.
complete_payroll_output_liability_payment_method_KEY | int (4) | NOT NULL | User selection of which payment method to use in Complete Payroll Output (CPO)
auto_sort_tax_organizer | bit (1) | NOT NULL | When true, the system generates the Tax Organizer of Source Document Processing as multiple files. When false, the Tax Organizer is stored as a single file.
use_client_name_in_export_file_name | bit (1) | NOT NULL | When true, this firm-level option will indicate that when exporting use the client name in the file name instead of the client ID.
alternate_federal_tin | nvarchar (22) | NOT NULL | Firm's alternate federal tin if license allows it
complete_forms_output_liability_adjustment_threshold | decimal (9, 2) | NOT NULL | The CFO liability adjustment threshold value to look at when the CFO liability adjustment threshold limit is turned on. If the liability adjustment value is at or below this value, it will be automatically processed.
automatically_override_prenote_waiting_status | bit (1) | NOT NULL | If true, the prenote status will be automatically ["BR"] overridden from waiting to approved after 3 banking days.["BR"] Default is false, where this behavior is not automatic.
complete_forms_output_exclude_withholding_forms | bit (1) | NOT NULL | A bool flag to indicate if user likes Complete Forms Output to exclude withholding forms from liability adjustment threshold.
workpapers_protect__signoff_type_KEY | int (4) |  | Firm preference: workpapers - firm option to select a unique PROTECT signoff key. When documents are signed off with that specific key, said document will automatically be marked to be PROTECTed (aka frozen) to future edits. A NULL value indicates this option is disabled.
disable_watermark_on_client_copy_forms | bit (1) | NOT NULL | A bool flag to indicate whether the client copy watermark should be disabled on client copy forms.
non_paper__tax_form_selection_filing_instruction_type_KEY | tinyint (1) | NOT NULL | The global default filing instruction type for non-paper tax forms
paper__tax_form_selection_filing_instruction_type_KEY | tinyint (1) | NOT NULL | The global default filing instruction type for paper tax forms
display_all_clients_for_1099_form_processing | bit (1) | NOT NULL | A bool flag to indicate whether to display all available clients for 1099 form processing.
print_engagement_binder_folder_structure | bit (1) | NOT NULL | 1 means print engagement binder with folder structure to FileCabinet CS and 0 means print engagement binder as a single PDF to FileCabinet CS.
encrypted_intercept_password | nvarchar (-1) | NOT NULL | A field to store the encrypted password for National Payment Corporation authentication.
enable_client_staff_client_access_confirmation | bit (1) | NOT NULL | 0 means confirmation is not required. 1 means that confirmation is required when in Setup > Firm Information > Client Staff, access is granted to a given Client.
enable_warning_when_transaction_date_not_in_the_posting_period | bit (1) | NOT NULL | allows the client to enable or disable the warning when transaction date is not in the posting period.
enable_prompt_to_generate_liabilities | bit (1) | NOT NULL | The default value 0 indicates that no prompt of General Liabilties dialog in Enter Transactions screen and ["BR"] 1 means enables the prompt whenever the liabilities of Handwritten Payroll checks are not generated.
suppress_warning_messages_for_impound_payments | bit (1) | NOT NULL | When true will suppress warning messages displayed while making impound payments. When false allow such warnings to display to the user
disallow_restricted_clients_from_being_removed | bit (1) | NOT NULL | The default value 0 indicates that no prompt of restricted clients dialog in Process Internet\Magnetic files screen and 1 means enables the prompt when restricted clients are present.
enable_prompt_when_creating_multiple_jurisdiction_files_simultaneously | bit (1) | NOT NULL | The default value 0 indicates that no prompt when creating multiple jurisdiction files simultaneously on Process Internet/Magnetic Files screen and 1 means enables the prompt when creating multiple jurisdiction files simultaneously.
distinguish_overrides_by_period_end_date_for_reconciliation_form_type | bit (1) | NOT NULL | When 1, the system maintains distinct override sets for each period-end for reconciliation forms. When 0 the system maintains only one override set which may be adjusted to the most-recently-used period-end for the given form.
distinguish_overrides_by_period_end_date_for_payment_form_type | bit (1) | NOT NULL | When 1, the system maintains distinct override sets for each period-end for payment forms. When 0 the system maintains only one override set which may be adjusted to the most-recently-used period-end for the given form.
distinguish_overrides_by_period_end_date_for_w2_form_type | bit (1) | NOT NULL | When 1, the system maintains distinct override sets for each period-end for w-2 forms. When 0 the system maintains only one override set which may be adjusted to the most-recently-used period-end for the given form.
distinguish_overrides_by_period_end_date_for_1099_form_type | bit (1) | NOT NULL | When 1, the system maintains distinct override sets for each period-end for 1099 forms. When 0 the system maintains only one override set which may be adjusted to the most-recently-used period-end for the given form.
distinguish_overrides_by_period_end_date_for_1095c_form_type | bit (1) | NOT NULL | When 1, the system maintains distinct override sets for each period-end for 1095-c forms. When 0 the system maintains only one override set which may be adjusted to the most-recently-used period-end for the given form.
distinguish_overrides_by_period_end_date_for_corrected_form_type | bit (1) | NOT NULL | When 1, the system maintains distinct override sets for each period-end for corrected forms. When 0 the system maintains only one override set which may be adjusted to the most-recently-used period-end for the given form.
swipe_clock_accountant_guid | uniqueidentifier (16) | NOT NULL | New GUID for each data row. Value of this column will be used at the time of Workforce nextgen and ACS/SBPR integration.

Primary key
Name | Columns | Description
PK_Firm | firm_KEY |

Foreign keys
Name | Columns | Referenced table | Description
FK_Firm__Contact__electronic_filing__contact_KEY | electronic_filing__contact_KEY | Contact (contact_KEY) |
FK_Firm__Enter_Transaction_Data_Entry_Mode__enter_transaction_data_entry_mode_KEY | enter_transaction_data_entry_mode_KEY | Enter_Transaction_Data_Entry_Mode (enter_transaction_data_entry_mode_KEY) |
FK_Firm__File_Storage__firm_hosted_client_access__file_storage_KEY | firm_hosted_client_access__file_storage_KEY | File_Storage (file_storage_KEY) |
FK_Firm__File_Storage__tickmark_stamps__file_storage_KEY | tickmark_stamps__file_storage_KEY | File_Storage (file_storage_KEY) |
FK_Firm__Global_Report_Profile__global_report_profile_KEY | global_report_profile_KEY | Global_Report_Profile (global_report_profile_KEY) |
FK_Firm__Tax_Form_Selection_Filing_Instruction_Type__non_paper__tax_form_selection_filing_instruction_type_KEY | non_paper__tax_form_selection_filing_instruction_type_KEY | Tax_Form_Selection_Filing_Instruction_Type (tax_form_selection_filing_instruction_type_KEY) |
FK_Firm__Office__office_KEY | office_KEY | Office (office_KEY) |
FK_Firm__Report_Image__logo__report_image_KEY | logo__report_image_KEY | Report_Image (report_image_KEY) |
FK_Firm__Tax_Form_Selection_Filing_Instruction_Type__paper__tax_form_selection_filing_instruction_type_KEY | paper__tax_form_selection_filing_instruction_type_KEY | Tax_Form_Selection_Filing_Instruction_Type (tax_form_selection_filing_instruction_type_KEY) |
FK_Firm__Report_Image__signature_1__report_image_KEY | signature_1__report_image_KEY | Report_Image (report_image_KEY) |
FK_Firm__Report_Image__signature_2__report_image_KEY | signature_2__report_image_KEY | Report_Image (report_image_KEY) |
FK_Firm__Report_Image__signature_3__report_image_KEY | signature_3__report_image_KEY | Report_Image (report_image_KEY) |
FK_Firm__Ste_State_Code__new_hire_electronic_filing__ste_state_code_KEY | new_hire_electronic_filing__ste_state_code_KEY | Ste_State_Code (ste_state_code_KEY) |
FK_Firm__Tax_Form_Grouping__tax_form_grouping_KEY | tax_form_grouping_KEY | Tax_Form_Grouping (tax_form_grouping_KEY) |
FK_Firm__Signoff_Type__workpapers_protect__signoff_type_KEY | workpapers_protect__signoff_type_KEY | Signoff_Type (signoff_type_KEY) |
FK_Firm__complete_payroll_output_liability_payment_method_KEY | complete_payroll_output_liability_payment_method_KEY | Complete_Payroll_Output_Liability_Payment_Method (complete_payroll_output_liability_payment_method_KEY) |

Incoming foreign keys
Name | Columns | Referencing table | Description
FK_Report_Designer_Page_Setup_Default__Firm__firm_KEY | firm_KEY | Report_Designer_Page_Setup_Default |
FK_Firm_Transitory_Information__Firm__firm_KEY | firm_KEY | Firm_Transitory_Information |
FK_Firm_Contact_Payroll_Tax_Information__Firm__firm_KEY | firm_KEY | Firm_Contact_Payroll_Tax_Information |
FK_Firm_Preferences_Swipe_Clock_Partner_Login_Credentials__Firm__firm_KEY | firm_KEY | Firm_Preferences_Swipe_Clock_Partner_Login_Credentials | Firm key on which Swipeclock partner login credentials are displayed, and it is Foreign-keyed to Firm.
FK_Firm_Preferences_Workforce_Hub_Login_Credentials__Firm__firm_KEY | firm_KEY | Firm_Preferences_Workforce_Hub_Login_Credentials | Firm key on which WorkforceHub login credentials are displayed, and it is Foreign-keyed to Firm.
FK_Conversion_Wizard_Segment_Choice__Firm__firm_KEY | firm_KEY | Conversion_Wizard_Segment_Choice |
FK_Conversion_Wizard_Client_Payroll_Information__Firm__firm_KEY | firm_KEY | Conversion_Wizard_Client_Payroll_Information |
FK_Firm_Electronic_Filing_Information__Firm__firm_KEY | firm_KEY | Firm_Electronic_Filing_Information |
FK_Data_Entry_Confirmation__Firm__firm_KEY | firm_KEY | Data_Entry_Confirmation |
FK_Custom_Value_Firm__Firm__firm_KEY | firm_KEY | Custom_Value_Firm |