Appendix: Understanding the Data Generated

Payroll Processing Types and Job Status Codes

payrollProcessingJobStatusCode

The payrollProcessingJobStatusCode is the group item for the payroll type and status. In the following two tables:

  • codeValue is the payroll's Type and Status, and is 6 characters in length.
  • Format is TT-SSS.

Types (TT)

Full Description

PR

Payroll

OS

Out of Sequence Payroll

QS

QuickStart

NS

NewStart

AD

Adjustment

AC

Adjustment

MP

Mass Process

TF

Tax Filing Convert

 

Status (SSS)

shortName

Type (TT)

PVC

Preview Complete

PR, OS, QS

PRC

Payroll Complete

PR, OS, QS, NS

PVI

Preview Processing In Progress

PR, OS, QS

NTI

NET Processing In Progress

PR, OS, QS, NS

CNA

Check Numbers Available

PR, OS, QS

ADC

Adjustment Payroll Complete

AD, AC

MPC

Mass Process Complete

MP

TFC

Tax Filing Convert Complete

TF

EER

Edit Errors Found

any except TF

EDL

Rejected

any

BAD

Bad Payroll

any

EIP

Edit In Progress

any

PVP

Preview Calc In Progress

PR, OS, QS

NIP

Calc In Progress

any

AIP

Accept in Progress

PR, OS, QS

INV

Under Investigation

any

WTP

Waiting to Process

any On Demand activity

TBE

Turbo Failure (Payroll OK, Error in Turbo processing)

any

PayrollSummary configurationTags

The PayrollSummary is an array of configurationTags relevant to the tax type within the category and payment type in a specific payroll.

In the following table:

  • tagCode is the name of the configuration tag and tagType.
  • dataTypeCode is the data type of the configuration tag, which can be Number, String, or Boolean.
  • tagValue is the possible values for the configuration tag.
tagCode dataTypeCode tagValue or Description

Required Configuration Tags:

Payroll Type

String

Values are:

  • Normal Payroll
  • Out of sequence
  • Quick Start
  • New Start
  • Tax Filing convert
  • Adjustment
  • Mass Process

Quarter Number

Number

Values are:

  • 1
  • 2
  • 3
  • 4

Out of Sequence

Boolean

 

Version

String

Values are:

  • A
  • B
  • C

Pay Warning Threshold Amount

Number

Values are:

  • 0
  • 1000

Pays Over Limit

Number

Number of pays over limit.

Flagged Pays

Number

Number of flagged pays.

Relevant only to selected payrolls:

Accumulations as of Date time

String

Payroll date and time.

Relevant only to B version payrolls:

Allocation Type

String

Values are:

  • Department
  • Cost Number

Relevant only to reports:

Reports

String

Values are:

  • Benefit Accrual Current
  • Benefit Accrual Transfer and Reset
  • WGPS Reports
  • New Hire Compliance Report

Reports Setup

String

Values are:

  • Benefit Accrual Current
  • Benefit Accrual Transfer and Reset
  • WGPS Reports
  • New Hire Compliance Report

Relevant only to payroll runs PR, OS, QS when a stat summary message is required:

Pay Date

String

Pay date in yyyy-mm-dd format.

Period End Date 1

String

Period end date 1 in yyyy-mm-dd format.

Period End Date 2

String

Period end date 2 in yyyy-mm-dd format.

Period Begin Date 1

String

Period begin date 1 in yyyy-mm-dd format.

Period Begin Date 2

String

Period begin date 2 in yyyy-mm-dd format.

Messages

String

Values are:

  • Includes Adjustments and Taxes that are your responsibility
  • Includes Adjustments that are your responsibility
  • Includes Taxes that are your responsibility
  • The date on which you submitted your payroll input does not permit enough time to debit your account for tax liabilities and may impact the timely submission of your tax deposits. As a result, tax penalties may be incurred. Contact your ADP Representative for clarification. Thank You.
  • The date on which you submitted your payroll input does not permit enough time to debit your account for tax liabilities and may impact the timely submission of your tax deposits. As a result, tax penalties will be incurred. Contact your ADP Representative for clarification. Thank You.
  • The total taxes debited amount reflected on this report will not be debited from your account at this time. If ADP is authorized to file an amended return you will be invoiced separately for any taxes and applicable fees.

Earning Codes and Earning Categories

EarningsSummarySection

Summary of earnings in a specific payroll. This area contains a summary of the earning and hours information across all employees in a specific payroll.

Section

Description

earningsSummarySections (Array[EarningsSummarySection])

Specifies the Group Array Item.

Each occurrence includes information for a certain category of earning. Within each category, the earnings and hours information are segregated by earning code and earning field.

Note:

An occurrence may contain an earning amount with several hours, just an earning amount, or just several hours.

payrollAccumulations ( Array[PayrollAccumulation])

Specifies the Group Array Item.

There will be only one occurrence, which is used for the total gross for all employees in this payroll.

  • accumulatorCode is:
    • codeValue, which is "GRS"
    • shortName, which is "Gross"
  • accumulatorDescription, which is "Gross This Payroll"
  • accumulatorTimeUnitCode is:
    • codeValue, which is "P"
    • shortName, which is "This Payroll"
  • accumulatedAmount is:
    • amountValue, which is the total amount
    • currencyCode, which is "USD", "CAD"

earningsSummaryItems

Specifies the Group Array Item.

Each occurrence includes the information for a certain earning code and earning field within the category. For an uncoded earning, the possible default codes and descriptions are:

  • *RG (Regular)
  • *ST (Straight Time)
  • *OP (Overtime Premium)
  • *OT (Overtime)
  • *DT (Double Time)
  • blank (Other Earnings)

sectionCategory

Indicates the category of the earning.

It’s derived from the special comp code associated with the earnings, per the company setup. If there is no special comp code for the earning, this will be blank. Examples are as follows:

  • Benefit
  • Retirement
  • Other

SectionName

(If applicable) Specifies the special taxation associated with the earning.

It’s derived from the special comp code associated with the earnings, per the company setup. If there is no special comp code for the earning, this will be blank. Examples are as follows:

  • Cafeteria 125 Taxable Benefit (Benefit)
  • ER Paid Individual Retirement Acct (Retirement)
  • Puerto Rico Exempt Salary (Other)

PayrollAccumulation

Section

Description

accumulatedAmount (StandardAmount)

Specifies the total accumulated amount for the item:

The amountValue is the total accumulated amount.

accumulatedTimeWorkedQuantity
(StandardTime, optional),
accumulatorCode(StandardCode)

Indicates the accumulator code.

The following are possible values (codeValue / shortName):

  • GRS / Gross
  • Accumulator Code/"FLDSYM:XXX" (XXX is the code related to the accumulator) (Used only in Pay level)
  • Special Comp code + "-SC" (for special compensation codes in Earnings item
  • Special Comp code + "-P" (for prior special compensation codes in Earnings item)

accumulatorDescription (string)

  • For current payroll gross, this will be "Gross This Payroll".
  • For YTD gross, this will be "Year To Date Gross".
  • For special comp accumulator, this will be the description of the special comp code.
  • For prior special comp accumulator, this will be the description of the special comp code prefixed with Prior.

accumulatorTimeUnitCode (StandardCode)

Specifies the Accumulator Period.

Values are:

  • P / This Payroll
  • YTD / Year To Date
  • QTD / Quarter To Date (Used only in Pay level)
  • Q4TD / Quarter 4 To Date (Used only in Pay level)

ReportableEarningsAndBenefitsSummarySection

Section

Description

(Array[ReportableEarningsAndBenefitsSummaryItem])

Specifies the Group Array Item.

Each occurrence represents memo information.

sectionCategory (string)

Indicates the category of the reportable Earnings and Benefits.

Values are:

  • Benefit
  • Retirement
  • Other

sectionName (string)

Indicates the type of reportable Earnings and Benefits. These define any special taxation associated with the memos.

Examples are as follows:

  • Employee Discount
  • Employer Paid Whole Life Insurance
  • Financial Planning Assistance
  • Group Term Life Insurance
  • Employer Health Savings Account Contribution
  • Employer Paid Health Savings Account

ReimbursementsSummarySection

Section

Description

ReimbursementsSummaryItems (Array[ReimbursementsSummaryItem])

Specifies the Group Array Item.

Each occurrence includes information for a certain reimbursement (reverse deduction).

sectionCategory (string)

Indicates the Category of Reimbursements.

Values are:

  • Benefit
  • Retirement
  • Other

sectionName (string)

Specifies the type of reimbursement.

Examples:

  • Adoption Assistance
  • Cafeteria 125 Cash Out
  • Educational Assistance Exclusion
  • Educational Assistance Inclusion
  • SEP Contribution
  • Other Compensation (1099)
  • Tip Credits
  • Employee Paid Same Sex Spouse Benefit

Statutory Deductions Tax Categories and Payment Types

StatutoryDeductionsSummarySection

The StatutoryDeductionsSummarySection are an internally generated identifier for an occurrence in this area.

Section

Description

sectionCategory

Specifies the category of the tax.

Values are:

  • Federal
  • State
  • Local

sectionName

Indicates the type of payment.

Values are:

  • Normal Pay
  • Adjustment
  • Third Party Sick Pay
  • Third Party Sick Pay Adjustment

statutoryDeductionTypeCode

The statutoryDeductionTypeCode is a tax type.

  • codeValue is a code associated with the tax type.
  • shortName is the name of the tax type.

The possible values (code/name) are as follows:

  • Federal taxes:
    • FIT / Federal Income Tax
    • SS / Social Security Tax
    • MED / Medicare Tax
    • MEDST / Medicare Surtax
    • FUTA / FUTA Tax
  • State taxes:
    • SIT / State Income Tax
    • SUI / State Unemployment Insurance Tax
    • SDI / State Disability Insurance Tax
    • VPDI / Voluntary Plan Disability Insurance Tax
    • VFLI / Voluntary Family Leave Insurance
    • FLI / Family Leave Insurance Tax
    • MLI/Medical Leave Insurance Tax
    • WCA / Workers Comp Assessment Tax
    • TRNST / Transit Tax
  • Local taxes:
    • LIT / Local Income Tax
    • HEAD / Head Tax
    • LST / Local Services Tax
    • SDT / School District tax
    • MTA / MTA Tax
    • OTH / Other Local Tax

statutoryJurisdiction

The statutoryJurisdiction is the group item to identify the specific jurisdiction. This may contain:

  • just country
  • country and state
  • country, state, and local code

Employee / Employer Tax and Taxable List

Country & Tax Level statutoryDeductionTypeCode
codeValue
statutoryDeductionTypeCode
shortName
EE Tax EE Taxable ER Tax ER Taxable

Quarter to Date

Year to Date

Quarter to Date

Year to Date

EE Tax EE Taxable EE Tax EE Taxable ER Tax ER Taxable ER Tax ER Taxable
U.S. & Canadian Federal FIT Federal Income Tax Y Y N N Y  Y Y  Y N N  N
U.S. Federal MED Medicare Tax Y Y Y Y Y Y  Y N N
U.S. Federal MEDST Medicare Surtax Y Y N N Y  N Y  N N N  N
U.S. Federal SS Social Security Tax Y Y Y Y Y  Y Y N  Y N  Y
U.S. Federal FUTA FUTA Tax n/a n/a  Y Y N N  Y N N
U.S.State SIT State Income Tax Y Y N N Y Y  Y N N N
U.S.State SUI State Unemployment Insurance Tax Y Y Y Y Y  Y Y N N
U.S.State SDI State Disability Insurance Tax Y Y Y N Y  Y Y N N
U.S.State VPDI Voluntary Plan Disability Insurance Tax Y Y Y Y Y Y N N N N
U.S.State VFLI Voluntary Family Leave Insurance Y Y NA NA Y Y n/a n/a  n/a n/a
U.S.State FLI Family Leave Insurance Tax Y Y NA - except for WA/DC/MA NA - except for WA/DC/MA Y Y N N - except for WA/DC/MA N  N - except for WA/DC/MA
U.S.State MLI Medical Leave Insurance Tax Y Y Y Y Y Y  Y N  Y N Y
U.S.State WCA Workers Comp Assessment Tax N NA Y Y Y Y  Y N NA N NA
U.S.State TRNST Transit Tax Y Y NA NA Y Y Y Y NA NA NA NA
U.S. Local LIT Local Income Tax Y Y N N Y Y N  N N  N
U.S. Local LST Local Services Tax Y Y N N Y  Y Y N  N N
U.S. Local SDT School District Tax Y Y N N Y Y N  N N  N
U.S. Local MTA MTA Tax NA NA Y Y Y Y N  N N
U.S. Local HEAD Head Tax Y Y Y Y Y  Y Y N  N N
U.S. Local OTH Other Local Tax Y Y Y Y N N N N
Canadian Federal EIT Employment Insurance Tax Y Y Y Y Y Y N  N N  N
Canadian Federal CPP Canada Pension Plan Y Y Y Y Y  Y Y Y Y
Canadian Provincial QIT Quebec Income Tax Y Y N N Y  Y Y N  N N  N
Canadian Provincial PPT Provincial Payroll  Tax Y Y N N Y  Y Y N N
Canadian Provincial QPP Quebec Pension Plan Y Y Y Y Y Y Y  N Y
Canadian Provincial HSF Health Services Fund NA NA Y Y NA NA NA  NA N N  Y
Canadian Provincial EHT Employer Health Tax NA NA Y Y NA NA NA NA N N
Canadian Provincial PPIP Provincial Parental Insurance Plan Y Y Y Y Y N  N N  N
Canadian Provincial PWC Provincial Workers Comp NA NA Y Y NA NA NA NA N N
Canadian Provincial HAPSET Health and Post Secondary Education Tax NA NA Y Y NA NA NA NA NA NA Y

NonStatutoryDeductionSummarySection

Section

Description

impoundInformation (ImpoundInformation, optional)

 

nonStatutoryDeductionsSummaryItems (Array[NonStatutoryDeductionsSummaryItem], optional)

Specifies the Group Array Item.

Each occurrence represents a type of deduction with positive amounts.

SectionCategory (string, optional)

Category of the deductions.

Values are:

  • Benefit
  • Garnishment
  • Retirement
  • Other

SectionName (string, optional)

Indicates the type of deduction.

Values are:

  • Cafeteria 125 Dental Insurance Plan
  • Cafeteria 125 Cash Out
  • 501( C) Plan
  • 401(K) Plan
configurationTags (Array[ConfigurationTag], optional)Tags  

MemosSummarySection

Section

Description

MemosSummaryItems (Array[MemosSummaryItem])

Specifies the Group Array Item.

Each occurrence includes information for a memo code.

SectionCategory (string, optional)

 

SectionName (string, optional)

 

PaymentDistributionSummary

Section

Description

checkImpoundInformation (ImpoundInformation)

Specifies the group item to identify the details of the check impounds.

configurationTags (Array[ConfigurationTag], optional) ,depositImpoundInformation (ImpoundInformation)

Specifies the group item to identify impound information.

totalCashAmount (StandardAmount, optional),totalCheckAmount (StandardAmount)

Specifies the net earnings amount for a check. This is included only for check type:

The amountValue is the Net Earnings amount.

totalDirectDeposits (Array[TotalDirectDeposit])

Specifies the group item to identify the information on direct deposits in a payroll.

totalPayDocumentQuantities (Array[TotalPayDocumentQuantity])

Specifies the Group Array item.

Each occurrence identifies the type of pay document.

Payroll Adjustment Information

Section

Description

adjustmentTypeCode

Specifies the Adjustment Type.

  • codeValue is the adjustment code type.
  • Possible values (code):
    • Third Party Sick Pay
    • Recalc
    • Third Party Sick Pay Recalc
    • Void

totalAdjustmentAmount

Specifies the sum of adjustments and voids in the earnings.

The amountValue is the sum of adjustments and voids.

totalAdjustmentQuantity

Specifies the number of adjustments or voids.

TotalDirectDeposit

Section

Description

depositID ( StandardPayrollItemID)

Indicates the deduction code associated with the deposit.

  • idValue is the Deposit Deduction code
  • idDescription is the literal associated with the Deduction code

financialAccountTypeCode ( StandardCode)

Specifies the type of financial account.

  • codeValue is the Account Type
  • Possible values (code):
    • Checking
    • Savings
    • Loan
    • Checking Debit
    • Savings Debit

itemID ( string, optional)

 

totalDepositAmount ( StandardAmount)

Total of deposit amounts.

The amountValue is the sum of deposit amounts.

totalDepositQuantity (number)

Number of total deposit accounts.

TotalPayDocumentQuantity 

Section

Description

payDocumentTypeCode ( StandardCode)

Specifies the pay document type:

  • codeValue is a code associated with the document type.
  • shortName is the description of the code.
    ---|--- codeValue|shortName C|Check V|Voucher eV|eVoucher

totalPayDocumentQuantity ( number):

Indicates the count of pays that are either checks, vouchers, or e-Vouchers.

ThirdPartyPayment

Section

Description

impoundInformation (ImpoundInformation, optional),
thirdPartyCode (StandardCode)

Indicates the Third Party related to the payment code.

  • codeValue is a code associated with the Third party.
  • shortName is the corresponding description.
  • Possible values (codeValue / shortName):
    • AVS / Added Value Services
    • RS / Retirement Services 

thirdPartyPaymentTypeCode (StandardCode)

Specifies the Third Party Payment Code.

  • codeValue is a Payment Code associated with the Third party.
  • shortName is the corresponding description.
  • Possible values (codeValue / shortName):
    • WGPS / Wage Garnishments
    • PBP / Pay by Pay
    • 401K / 401K RecordKeeping
    • 401L / 401K Loan Repayment
    • 529 / 529 Plan

totalThirdPartyPaymentAmount (StandardAmount)

Indicates the amount associated with this third party code within the specific type.

PaymentSummary {configurationTags (Array[ConfigurationTag])

Specifies the array of configuration tags relevant to this tax type within the category and payment type in this payroll.

  • tagCode is the name of the configuration tag, tagType (dataTypeCode is the type of the configuration tag (Number, String, Boolean), tagValue is the value of the configuration tag.
  • Required configuration tags:
    • File Number (String, value: File Number)
    • Pay Number (String, value: Pay Number)
  • Other configuration tags:
    • Relevant only to Special Pays:
      • Special Pay (String, possible values are: Void, Pay To Company, Pay To Net, Third Party Sick Pay, Adjustment, Third Party Sick Pay Adjustment, Recalc, Third Party Sick Pay Recalc)
      • Special Calc (String, value: Gross Computed from Net)
    • Relevant only to Pays:
      • Pay Warning (String, possible values are: Net Cash Over Limit, Flagged Pay)
  • Basis of Pay (String, value: Basis of Pay)

PaymentSummary {configurationTags (Array[ConfigurationTag])

Relevant only to Total Hours worked:

  • Total Hours Worked (Number, value: total Hours worked)
  • Input Total Hours Worked (Boolean)
    • Relevant only to Chron Numbers of adjusted numbers:
      • Adjusted Quarter (String, value: QuarterNumber being adjusted)
    • Relevant only to Register Only Memos:
      • Register Only Memo (Boolean)

PaymentSummary {configurationTags (Array[ConfigurationTag])

Relevant only to Department payments:

  • Department Paid (String, value: Department Number)
    • Relevant only to accepted payrolls:
      • Accumulations as of Date (String, value: date and time of the payroll)
    • Relevant only to check payments:
      • Manual Check Number (String, value: Check Number)
    • Relevant only when prior or next file numbers exists:
      • Prior File Number (String, value: File number)
      • New File Number (String, value: File number)
      • Prior Payroll Group (String, value: Company Code)
    • Relevant only to Crossfoot Error:
      • Cross Foot error (Boolean)
    • Relevant only to WGPS Liens:
      • WGPS Lien UnderWithheld (Boolean, value: Lien UnderWithheld flag)

Payments

Includes information for employee pays.

Payment Summary

Provides the default level information for the selected payroll, followed by a summary of the associate payment information for the associates having activity in the selected payroll.

NonStatutoryDeductionsItem

The amount of the deduction. This is the amount prior to any add-back.

  • amountValue is the total amount.

Section

Description

associateDeductionCarryOverAmount
(StandardAmount, optional),associateDeductionInArrearsAmount (StandardAmount)

Specifies the amount of the deduction in arrears.

This is the total amount in arrears for the deduction.

The amountValue is the total amount.

associateDeductionTakenAmount (StandardAmount)

Specifies the deduction amount taken, considering any add-back due to insufficient net.

The amountValue is the total amount.

associateDeductionUntakenAmount (StandardAmount)

Indicates the amount of the deduction.

This is the amount taken, less any add-back amount.

The amountValue is the total amount.

configurationTags (Array[ConfigurationTag])

Specifies the array of configuration tags relevant to this tax type within the category and payment type in this payroll.

  • tagCode is the name of the configuration tag, tagType (dataTypeCode is the type of the configuration tag (Number, String, Boolean), tagValue is the value of the configuration tag.
  • Required configuration tags:
    • (none)

configurationTags (Array[ConfigurationTag])

  • Other configuration tags:
    • Relevant only to lien deductions:
      • WGPS Calc Factor (String, value: Deduction Code)
      • Funds Disbursement (Boolean)
      • WGPS Lien Number (Number, value: Lien Sequence Number)
      • WGPS Lien Amount to Take Number, value: Lien amount to Take)
      • WGPS Always Take (Boolean)
      • WGPS Payee Code (String, value: Payee code)
      • WGPS Priority (Number, value: Lien Priority Number)
      • WGPS State Service Charge Deducted (Number, value: Fee Withdrawal amount)
      • WGPS State Service Charge To Take (Number, value: Fee to take)
      • WGPS Goal to Date Amount (Number, value: Goal Amount)
      • WGPS Goal Limit (Number, value: Goal Limit)
      • WGPS Jurisdiction Sub Type (String , value: Jurisdiction Type)
    • Relevant only to Goal deductions:
      • Goal Amount (Number, value: Goal Limit Amount)

configurationTags (Array[ConfigurationTag])

  • Goal Accumulated Amount (Number, value: Goal Accumulated Amount)
  • Goal Number (Number, value: Goal Number)
    • Relevant only to last pay of employee:
      • Deduction Not Taken Reason (String, possible values are: 28 or 29 - "Goal Limit Reached", 39 - "Goal Limit Exceeded", 10 - "Account in Prenote", 31 - "Negative Gross Crossfoot Error", 32 or 34 - "Grid Causing Negative Taxable", 33 or 35 - "Negative Taxable and Negative Net", 20 - "529 Plan Not Effective", 11, 12, 13 or 15 - "Employee Not Paid", TT, TC, 22, 24 or 25 - "Insufficient Net Pay", FM - An HSA memo amount where all pays in a tax period are blocked for HSA memos, Other Reason" 

deductionID (StandardPayrollItemID)

Specifies the Deduction code.

  • idValue is the Deduction Code.
  • idDescription is the Literal associated with the Deduction code.

ReimbursementsItem

Section

Description

payrollAccumulations (Array[PayrollAccumulation], optional),reimbursementAmount (StandardAmount)

Specifies the total of all negative deductions for the deduction code in the payroll.

The amountValue is the Total amount.

reimbursementID (StandardPayrollItemID)

Indicates the Reverse Deduction code.

  • idValue is the Deduction Code.
  • idDescription is the Literal associated with the Deduction code.

ReportableEarningsAndBenefitsItem

The ReportableEarningsAndBenefitsItem is an array of configuration tags relevant to this tax type within the category and payment type in this payroll.

  • tagCode is the name of the configuration tag, tagType (dataTypeCode is the type of the configuration tag (Number, String, Boolean), tagValue is the value of the configuration tag.
  • Required configuration tags:
    • Print on Pay (Boolean)
    • Memo (String, possible values: Input, Output)
  • Other configuration tags:
    • (none) 

Section

Description

payrollAccumulations (Array[PayrollAccumulation])

Specifies the group item to identify payroll accumulations.

reportableEarningAndBenefitAmount (StandardAmount)

Total amount of the memo in the payroll.

The amountValue is the Total Memo amount.

reportableEarningAndBenefitID (StandardPayrollItemID):

Memo code.

  • idValue is the Memo Code.
  • idDescription is the literal associated with the Memo code.

StatutoryDeductionsItem

Section

Description

associateDeductionAmount (StandardAmount, optional),
associateDeductionCarryOverAmount (StandardAmount, optional),associateDeductionInArrearsAmount (StandardAmount, optional),associateDeductionTakenAmount (StandardAmount)

Specifies the total amount of employee tax taken for this tax type within the category and payment type in this payroll.

The amountValue is the total amount.

Note:

Employee taxable is not applicable to all tax types in all jurisdictions.

associateDeductionUntakenAmount (StandardAmount, optional),associateTaxableAmount (StandardAmount)

Indicates the total amount of employee taxable for this tax type within the category and payment type in this payroll.

The amountValue is the total amount.

Note:

Employee taxable is not applicable to all tax types in all jurisdictions.

configurationTags (Array[ConfigurationTag])

Specifies the array of configuration tags relevant to this tax type within the category and payment type in this payroll.

  • tagCode is the name of the configuration tag, tagType (dataTypeCode is the type of the configuration tag (Number, String, Boolean), tagValue is the value of the configuration tag.
  • Required configuration tags:
    • (none)
  • Other configuration tags:
    • Relevant only to Tax type LIT:
      • Tax Filing Code (String, value: the tax filing code associated with the local code)
      • Local Number (Number, possible values: 1,2,3,4,5,900)
    • Relevant only to SDT, VPDI, WCA, TRNST and MEDST:
      • Deduction Code (String, value: the associated deduction code)
      • Deduction Literal (String, value: the literal associated with the deduction code)
    • Relevant only to FUTA:
      • Subject Wages (Number, value: Subject wages)
    • Relevant only to PA location:
      • Remit To (String, value: Remit To Location)
    • Relevant only to Canadian MRN companies:
      • Remittance Number (String, Federal/Provincial)

employerPaidAmount (StandardAmount)

Specifies the total amount of employer tax for this tax type within the category and payment type in this payroll.

The amountValue is the total amount.

Note:

Employee taxable is not applicable to all tax types in all jurisdictions.

employerTaxableAmount (StandardAmount)

Total amount of employer taxable for this tax type within the category and payment type in this payroll.

The amountValue is the total amount.

Note:

Employee taxable is not applicable to all tax types in all jurisdictions.

payrollAccumulations (Array[PayrollAccumulation], optional),statutoryDeductionTypeCode (StandardCode)

Specifies the tax type.

  • codeValue is a code associated with the tax type.
  • shortName is the name of the tax type.
  • Possible values (code / name):
    • Federal taxes:
      • FIT / Federal Income Tax
      • SS / Social Security Tax
      • MED / Medicare Tax
      • MEDST / Medicare Surtax
      • FUTA / FUTA Tax
    • State taxes:
      • SIT / State Income Tax
      • SUI / State Unemployment Insurance Tax
      • SDI / State Disability Insurance Tax
      • VPDI / Voluntary Plan Disability Insurance Tax
      • VFLI / Voluntary Family Leave Insurance
      • FLI / Family Leave Insurance Tax
      • MLI / Medical Leave Insurance Tax
      • WCA / Workers Comp Assessment Tax
      • TRNST / Transit Tax
      • PRYEW/ Puerto Rico Youth Exempt Wage ( YTD PRYEW)
    • Local taxes:
      • LIT / Local Income Tax
      • HEAD / Head Tax
      • LST / Local Services Tax
      • SDT / School District tax
      • MTA / MTA Tax
      • OTH / Other Local Tax 

statutoryJurisdiction (StatutoryJurisdiction)

Specifies the group item to identify the specific jurisdiction.

This may contain:

  • country
  • country and state
  • country, state, and local code

AdministrativeLevel codeValue (string, optional)

 

StandardRateAmount {baseUnitCode (StandardCode)

Time factor associated with the numerator. It is either an hourly rate, daily rate or a pay period rate.

Possible values (codevalue / shortName):

  • Hour / Hour
  • Day / Day
  • Pay Period / Pay Period

PaymentAllocation

Section

Description

configurationTags (Array[ConfigurationTag])

Specifies an array of configuration tags relevant to a specific tax type within the category and payment type in a specific payroll.

  • tagCode is the name of the configuration tag, tagType (dataTypeCode is the type of the configuration tag (Number, String, Boolean), tagValue is the value of the configuration tag.
  • Required configuration tags:
    • File Number (String, value: File Number)
    • Pay Number (String, value: Pay Number)
    • Distribution Number (Number, value: Pay Calc Sequence Number)
  • Other configuration tags:
    • Relevant only to Tax Frequency:
      • Posted Tax Frequency (String, possible values are: 1-9, B, C, D, F, H, M, S, T)
    • Relevant only to Crossfoot Error:
    • Crossfoot Error (Boolean) 

Earnings (Earnings)

Specifies the Group Array Item.

Each occurrence includes the information for a certain earning in the associated department/cost Number.

Memos (Memos)

Specifies the Group Array Item.

Each occurrence includes information for a memo.

nonStatutoryDeductions (NonStatutoryDeductions)

Specifies the Group Array Item.

Each occurrence includes information for a certain category of deduction within a certain type of payment. Each category represents a type of positive deduction associated with the department/cost Number

payAllocationID (StandardCodeID)

Indicates the Department Number or Cost Number in which the payment is made.

The idValue is the Department/Cost Number.

Reimbursements (Reimbursements)

Specifies the Group Array Item.

Each occurrence represents a type of reverse deduction associated with department/cost Number.

reportableEarningsAndBenefits (ReportableEarningsAndBenefits)

Specifies the Group Array Item.

Each occurrence includes information of tax related memos.

statutoryDeductions (StatutoryDeductions)

Specifies the Group Array Item.

Each occurrence includes certain category of tax within a certain type of payment associated with the department/cost number. Each category represents a type of tax, and includes employee tax, employee taxable, employer tax, and employer taxable information.

PaymentDistribution

Section

Description

checkImpoundInformation (ImpoundInformation)

Specifies the group item to identify the details of the check impounds.

configurationTags (Array[ConfigurationTag], optional),depositImpoundInformation (ImpoundInformation)

Specifies the group item to identify impound information.

totalCashAmount (StandardAmount, optional),totalCheckAmount (StandardAmount)

Indicates the net earnings amount for a check. This is included only for check type.

The amountValue is the Net Earnings amount.

totalDirectDeposits (Array[TotalDirectDeposit])

Indicates the group item to identify the information on direct deposits in a payroll.

totalPayDocumentQuantities (Array[TotalPayDocumentQuantity])

Specifies the Group Array item.

Each occurrence identifies the type of pay document.

Payment Section Configuration Tags

configurationTags (Array[ConfigurationTag], optional)

Array of configuration tags relevant to this tax type within the category and payment type in this payroll.

  • tagCode is the name of the configuration tag, tagType (dataTypeCode is the type of the configuration tag (Number, String, Boolean), tagValue is the value of the configuration tag.
  • Required configuration tags:
    • File Number (String, value: File Number)
    • Pay Number (String, value: Pay Number)
  • Other configuration tags:
    • Relevant only to Special Pays:
      • Special Pay (String, possible values are: Void, Pay To Company, Pay To Net, Third Party Sick Pay, Adjustment, Third Party Sick Pay Adjustment, Recalc, Third Party Sick Pay Recalc)
      • Special Calc (String, value: Gross Computed from Net)
    • Relevant only to Pays:
      • Pay Warning (String, possible values are: Net Cash Over Limit, Flagged Pay)
      • Basis of Pay (String, value: Basis of Pay)
    • Relevant only to Total Hours worked:
      • Total Hours Worked (Number, value: total Hours worked)
      • Input Total Hours Worked (Boolean)
    • Relevant only to Chron Numbers of adjusted numbers:
      • Adjusted Quarter (String, value: QuarterNumber being adjusted)
    • Relevant only to Register Only Memos:
      • Register Only Memo (Boolean)
    • Relevant only to Department payments:
      • Department Paid (String, value: Department Number)
    • Relevant only to accepted payrolls:
      • Accumulations as of Date (String, value: date and time of the payroll)
    • Relevant only to check payments:
      • Manual Check Number (String, value: Check Number)
    • Relevant only when prior or next file numbers exists:
      • Prior File Number (String, value: File number)
      • New File Number (String, value: File number)
      • Prior Payroll Group (String, value: Company Code)
    • Relevant only to Crossfoot Error:
      • Cross Foot error (Boolean)
    • Relevant only to Flex accumulations:
      • RSV accumulators ( String, value: details in " Accumulator Code:Accumulator time unit code:QTD/YTD:Accumulated amount " format)
    • Relevant only to WGPS Liens:
      • WGPS Lien UnderWithheld (Boolean, value: Lien UnderWithheld flag

Frequently Asked Questions (FAQs)

Question 1: Why is a tax amount (that is zero) not available in Turbo?

Answer: Turbo doesn't send any amounts that are zero. This is applicable to all amounts (taxes, deductions, memos and accumulations as well).

Question 2: What is Adjustment processing?

Answer: With Adjustment payrolls, adjustments are run for a quarter number and not a previous payroll run with (PID). With adjustment processing the payroll data for a previous run is not updated. Only the EMP accumulations data is updated in Autopay that are the Quarter-to-Dates (QTDs) and Year-to-Dates (YTDs). Any adjustments made to employees will be available in the Turbo response for the adjustment runs.
For example, consider an employee has a payroll run in week 10 (in quarter 1) of 2020, and an adjustment was made to Q1 in week 21 of 2020. The employee’s payroll data for week 10 doesn't change after the adjustment is run. You would need to read the Turbo response for week 21 where adjustment was run for the updated values. Turbo will provide the updated amounts and accumulations for the employee.

Question 3: What is the difference between nonStatutoryDeductionsSections → payrollAccumulations and nonStatutoryDeductionSection → nonStatutoryDeductionItems → payrollAccumulations?

Answer: The section level accumulators are generally S1 and S2 accumulators setup in AutoPay. These are multi-deduction accumulators, so are returned in section level. Item level deductions are accumulations amounts for each of the deduction code.

Question 4: Why does two consecutive PVC notifications sent without an accept/reject?

Answer: When a payroll is run and preview is completed a PVC notification is sent. After the PVC, the client can call in and a Client Service Representative (CSR) can make changes, add or delete employees, and reprocess the payroll from AutoPay Mainframe screens, and the payroll goes to preview complete. This would initiate a PVC notification again. Therefore, two PVCs can be sent through Turbo without an accept/reject in-between.