Acumatica API - Endpoint Default 23 200 001Install

Summary

Inserts or updates an Employee Payroll Settings record in Acumatica.

Inputs

• AddressInfo — Mailing address for the employee payroll record. Contains AddressLine1, AddressLine2, City, Country, PostalCode, State, Validated.
• Compensation — Array of compensation items. Each item includes Active, EarningCode, EarningDescription, EndDate, LastModifiedDateTime, PayRate, StartDate, UnitOfPay.
• DeductionsAndBenefits — Container for deduction and benefit settings. Includes DeductionAndBenefitUseClassDefaults, LastModifiedDateTime, and an array of DeductionsAndBenefitsDetails. Each detail contains Active, ContributionAmount, ContributionMax, ContributionMaximumFrequency, ContributionPercent, DeductionAmount, DeductionCode, DeductionMax, DeductionMaximumFrequency, DeductionPercent, Description, EndDate, GarnishmentDetails (GarnCourtDate, GarnCourtName, GarnDocRefNbr, GarnOrigAmount, GarnPaidAmount, GarnVendorID, GarnVendorInvDescr), IsGarnish, Sequence, StartDate, UseContributionDefaults, UseDeductionDefaults.
• DeductionSplitMethod — String value defining how deductions are split.
• MaxPercOfNetPayForAllGarnishm — Maximum percentage of net pay allowed for all garnishments.
• DirectDepositDetails — Array of direct deposit entries. Each entry includes AccountNumber, AccountType, Amount, BankName, BankRoutingNumber, DepositSequenceNbr, GetsRemainder, LastModifiedDateTime, Percent.
• EmploymentDates — HireDate and TerminationDate for the employee.
• EmploymentRecords — Array of employment history records. Each record contains Active, EndDate, FinalPayment (value), Position, RehireEligible, StartDate, StartReason, ProbationPeriodEndDate, Terminated, TerminationReason.
• GeneralInfo — General payroll settings. Includes Calendar, CalendarClassDefault, CertifiedProjectHoursperYear, DefaultUnion, DefaultWCCCode, ExemptFromCertReporting, ExemptFromCertReportingClassDefault, ExemptFromOvertimeRules, ExemptFromOvertimeRulesClassDefault, NetPayMinClassDefault, NetPayMinimum, OverrideHoursPerYearForCertClassDefault, OverrideHrsPerYearForCertProjects, PayGroup, PayGroupClassDefault, UnionClassDefault, UseClassDefaultValueHoursPerYearForCertifiedUseDflt, WCCCodeClassDefault, WeeksPerYearClassDefault, WorkingHoursPerWeek, WorkingHoursPerYear, WorkingWeeksPerYear (value).
• GLAccounts — General ledger account mapping. Includes BenefitExpenseAccount, BenefitExpenseSub, BenefitLiabilityAccount, BenefitLiabilitySub, DeductionLiabilityAccount, DeductionLiabilitySub, EarningsAccount, EarningsSub, PTOAssetAccount, PTOAssetSub, PTOExpenseAccount, PTOExpenseSub, PTOLiabilityAccount, PTOLiabilitySub, TaxExpenseAccount, TaxExpenseSub, TaxLiabilityAccount, TaxLiabilitySub.
• PaidTimeOff — Paid time off policy. Includes UseCustomSettings and an array of PaidTimeOffDetails. Each detail contains AccrualMethod, AccrualPercent, Active, AllowNegativeBalance, AllowViewAvailablePTOPaidHours, BalanceLimit, BandingRule, CanOnlyDisbursefromCarryover, CarryoverHours, CarryoverType, Description, FrontLoadingHours, HoursperYear, LastModifiedDateTime, OnSettlement, ProbationPeriodBehaviour, PTOBank, StartDate, TransferDate.
• Taxes — Array of tax configurations. Each includes Active, LastModifiedDateTime, TaxCode, TaxCodeSettings (array of AdditionalInformation, CompanyNotes, FormBox, Name, Required, UseDefault, Value), and TaxDescription.
• TaxSettings — Array of tax setting definitions. Each includes AdditionalInformation, CompanyNotes, FormBox, LastModifiedDateTime, Name, Required, Setting, State, UseDefault, UsedforGovernmentReporting, UsedforTaxCalculation, Value.
• WorkLocations — Work location configuration. Includes UseClassDefaultValueUsePayrollProjectWorkLocationUseDflt, UsePayrollWorkLocationfromProject, WorkLocationClassDefaults, and an array of WorkLocationDetails. Each detail contains DefaultWorkLocation, LastModifiedDateTime, LocationID, LocationName.
• additionalFields — Additional free‑form fields. Includes Active, CashAccount, ClassID, EmployeeID, EmployeeName, EmployeeType, LastModifiedDateTime, PaymentMethod, EmployeeTypeClassDefault.

Output shape

object

The node returns the raw API response from Acumatica for the upserted Employee Payroll Settings record.

Examples

Example 1: Create a new employee payroll record

Provide required key fields (typically EmployeeID) within additionalFields and fill desired sections such as AddressInfo, Compensation, EmploymentDates, etc.

Example 2: Update an existing record

Supply the existing EmployeeID in additionalFields along with any fields to change; omitted fields retain their current values.

Links

• n8n community nodes installation guide