CHcheckhq

Update the enrollment profile

Changed on

Update the existing enrollment profile for the company

patch/companies/{company}/enrollment_profile

Request

Request body

employee_countinteger

Number of payees who are W2 employees

contractor_countinteger

Number of payees who are 1099 contractors

pay_period_amountinteger

Estimated total amount of money paid to employees and contractors per pay period

previous_payroll_provider'accupay' | 'adp_enterprise' | 'adp_payforce' | 'adp_pcpw' | 'adp_run' | 'adp_totalsource' | 'adp_workforce_now' | 'benefit_mall_compupay' | 'cbiz' | 'ceridian' | 'emangrove' | 'evolution' | 'execupay' | 'gusto' | 'heartland_payroll' | 'isolved' | 'microsoft_dynamics_gp' | 'mint' | 'netpay' | 'onpay' | 'patriot' | 'paychex_flex' | 'paychex_go' | 'paychex_preview' | 'paycom' | 'paycor' | 'paydayonesource' | 'payrollmatters' | 'payroll_people' | 'paylocity' | 'payworks' | 'prime_pay' | 'proliant' | 'quickbooks_online' | 'quickbooks_desktop' | 'rasi' | 'rippling' | 'sage_100' | 'sage_300' | 'sage_hr' | 'square_payroll' | 'sure' | 'toast' | 'trinet' | 'trupay' | 'ultipro_online' | 'ultipro_pc' | 'wave' | 'zeal' | 'zendona' | 'zenefits' | 'manual' | 'accountant' | 'other'

The payroll provider previously used by the company

previous_payroll_provider_otherstring

A custom label for the previous payroll provider, if the previous payroll provider is not available in the above set of options.

first_payrollboolean

Whether or not the company has ever paid people before.

first_payroll_of_yearboolean

Whether or not this is the first payroll of the current calendar year for the company

user_sincestring date

The date at which the company joined the partner's platform

expected_first_paydaystring date

The company's expected first payday on Check

approved_for_payment_processingboolean

Whether or not the company has been approved for payment processing on the partner's platform

existing_payroll_customer_processing_periodstring

If business is already running payroll with you, the processing period they are currently using. One of null, four_day, two_day, or one_day.

average_monthly_revenuenumber float

The average monthly revenue of the company

earliest_known_revenuestring date

The earliest known date that the company generated revenue

months_on_previous_payroll_providerinteger

The number of months that the company used their previous payroll provider

social_mediastring[]

Any social media account URLs associated with the company

products_actively_usedstring[]

A list of the products offered by the partner's platform used by the associated company. Values must be one of timetracking, payments, or scheduling.

account_contactsstring[]

A list of partner employee emails associated with the company

fraud_scorenumber float

A value between 0 and 100 representing the fraud risk presented by the company

predicted_fraudboolean

Whether the fraud score was over the expected threshold for fraud (the company is predicted to be fraudulent)

paying_userboolean

Whether the company pays the partner for services

missed_payments_countinteger

The number of times that the company has failed to pay the partner

payroll_history_access_method'"authorized_access_to_previous_provider"' | '"provided_credentials"' | '"provided_reports"'

The mechanism by which Check Implementation Services will be able to access and migrate payroll history

implementation_services_submission_commentstring

Optional comment for including additional context when submitting a company for Implementation Services

Response

200

Changes

  • 5a54f5eb888bRevision changes
    • breaking

      request property was restricted to a list of enum values

    • info

      added the new optional request property

    • info

      added the new accountant enum value to the request property

    • info

      added the new accupay enum value to the request property

    • info

      added the new adp_enterprise enum value to the request property

    • info

      added the new adp_payforce enum value to the request property

    • info

      added the new adp_pcpw enum value to the request property

    • info

      added the new adp_run enum value to the request property

    • info

      added the new adp_totalsource enum value to the request property

    • info

      added the new adp_workforce_now enum value to the request property

    • info

      added the new benefit_mall_compupay enum value to the request property

    • info

      added the new cbiz enum value to the request property

    • info

      added the new ceridian enum value to the request property

    • info

      added the new emangrove enum value to the request property

    • info

      added the new evolution enum value to the request property

    • info

      added the new execupay enum value to the request property

    • info

      added the new gusto enum value to the request property

    • info

      added the new heartland_payroll enum value to the request property

    • info

      added the new isolved enum value to the request property

    • info

      added the new manual enum value to the request property

    • info

      added the new microsoft_dynamics_gp enum value to the request property

    • info

      added the new mint enum value to the request property

    • info

      added the new netpay enum value to the request property

    • info

      added the new onpay enum value to the request property

    • info

      added the new other enum value to the request property

    • info

      added the new patriot enum value to the request property

    • info

      added the new paychex_flex enum value to the request property

    • info

      added the new paychex_go enum value to the request property

    • info

      added the new paychex_preview enum value to the request property

    • info

      added the new paycom enum value to the request property

    • info

      added the new paycor enum value to the request property

    • info

      added the new paydayonesource enum value to the request property

    • info

      added the new paylocity enum value to the request property

    • info

      added the new payroll_people enum value to the request property

    • info

      added the new payrollmatters enum value to the request property

    • info

      added the new payworks enum value to the request property

    • info

      added the new prime_pay enum value to the request property

    • info

      added the new proliant enum value to the request property

    • info

      added the new quickbooks_desktop enum value to the request property

    • info

      added the new quickbooks_online enum value to the request property

    • info

      added the new rasi enum value to the request property

    • info

      added the new rippling enum value to the request property

    • info

      added the new sage_100 enum value to the request property

    • info

      added the new sage_300 enum value to the request property

    • info

      added the new sage_hr enum value to the request property

    • info

      added the new square_payroll enum value to the request property

    • info

      added the new sure enum value to the request property

    • info

      added the new toast enum value to the request property

    • info

      added the new trinet enum value to the request property

    • info

      added the new trupay enum value to the request property

    • info

      added the new ultipro_online enum value to the request property

    • info

      added the new ultipro_pc enum value to the request property

    • info

      added the new wave enum value to the request property

    • info

      added the new zeal enum value to the request property

    • info

      added the new zendona enum value to the request property

    • info

      added the new zenefits enum value to the request property