Skip to main content
POST
Calculate grossup paycheck

Authorizations

pcc-api-key
string
header
required

API key for CBS API authentication

Query Parameters

report
enum<string>

Report type to generate (requires valid print object)

Available options:
all,
checkbottom,
checkmiddle,
checktop,
deluxe_b100,
deluxe_b211,
deluxe_m102,
deluxe_m145,
deluxe_t104,
deluxe_t111,
earnings,
none,
paystub,
quickbooks_top
showcalc
boolean
default:false

Include calculator object in response

itd
boolean
default:false

Include itemized tax details

Body

application/json

Grossup calculator configuration

Grossup calculator configuration for calculating gross pay from desired net pay

additionalFederalWithholding
number
required

Additional amount to withhold for federal taxes

Required range: x >= 0
Example:

100

federalAllowances
integer<int32>
required

Number of federal tax allowances claimed

Required range: x >= 0
Example:

2

grossPayYTD
number
required

Year-to-date gross pay

Required range: x >= 0
Example:

10000

netPay
number
required

Desired net pay amount to gross up from

Required range: x >= 0
Example:

1000

state
enum<string>
required

Two-letter state abbreviation where the employee works

Available options:
Alabama,
Alaska,
American Samoa,
Arizona,
Arkansas,
California,
Colorado,
Connecticut,
Delaware,
Florida,
Georgia,
Guam,
Hawaii,
Idaho,
Illinois,
Indiana,
Iowa,
Kansas,
Kentucky,
Louisiana,
Maine,
Maryland,
Massachusetts,
Michigan,
Minnesota,
Mississippi,
Missouri,
Montana,
N. Mariana Islands,
Nebraska,
Nevada,
New Hampshire,
New Jersey,
New Mexico,
New York,
North Carolina,
North Dakota,
Ohio,
Oklahoma,
Oregon,
Pennsylvania,
Puerto Rico,
Rhode Island,
South Carolina,
South Dakota,
Tennessee,
Texas,
US Virgin Islands,
Utah,
Vermont,
Virginia,
Washington,
Washington DC,
West Virginia,
Wisconsin,
Wyoming
Example:

"CA"

checkDate
string<date-time>

Date of the paycheck calculation

Example:

"2024-03-15"

deductions2020
number

Deductions amount from W-4 2020+ Step 4b

Required range: x >= 0
Example:

0

dependents2020
number

Dependent amount from W-4 2020+ Step 3

Required range: x >= 0
Example:

4000

exemptFederal
boolean

Whether the employee is exempt from federal tax withholding

Example:

false

exemptFica
boolean

Whether the employee is exempt from FICA (Social Security) tax

Example:

false

exemptMedicare
boolean

Whether the employee is exempt from Medicare tax

Example:

false

federalFilingStatusType
enum<string>

Federal tax filing status

Available options:
HEAD_OF_HOUSEHOLD,
MARRIED,
SINGLE
Example:

"SINGLE"

federalFilingStatusType2020
enum<string>

Federal filing status for W-4 2020+ form

Available options:
HEAD_OF_HOUSEHOLD,
MARRIED_FILING_JOINTLY,
SINGLE
Example:

"SINGLE"

federalSupplementalFlat
boolean

Whether to use federal supplemental flat tax rate

Example:

false

otherIncome
object[]

List of other income sources (imputed income)

otherIncome2020
number

Other income amount from W-4 2020+ Step 4a

Required range: x >= 0
Example:

0

payFrequency
enum<string>

Frequency of pay periods

Available options:
ANNUALLY,
BI_WEEKLY,
DAILY,
MONTHLY,
QUARTERLY,
SEMI_ANNUALLY,
SEMI_MONTHLY,
WEEKLY
Example:

"BI_WEEKLY"

presetDeductions
object[]

List of preset custom deductions

presetImputed
object[]

List of preset imputed income

print
object

Print object for PDF report generation

roundFederalWithholding
boolean

Whether to round federal withholding amounts

Example:

false

stateInfo
object

State-specific parameters for the calculation

twoJobs2020
boolean

Whether employee has two jobs (W-4 2020+ Step 2c)

Example:

false

voluntaryDeductions
object[]

List of voluntary deductions (401k, HSA, custom deductions, etc.)

w42020
boolean

Whether using W-4 form from 2020 or later (vs. pre-2020 W-4)

Example:

false

Response

Calculation successful

HATEOAS response wrapper containing calculator results with hypermedia links

content
object

Calculator calculation results