Acumatica API - Endpoint Default 25 200 001Install

Summary

Insert a new Employee record or update an existing one in the Acumatica ERP system by providing detailed employee information.

Inputs

• Attributes — Set multiple employee attribute entries, each containing an identifier, description, value, and flags for activity and requirement.
• Company Tree Info — Provide company tree details including workgroup ID, active status, and ownership.
• Contact Info — Input active status and a collection of employee activity records with details such as category, time spent, project information, owner, and status.
• Address — Specify the employee's address details including multiple address lines, city, state, country, postal code, and additional location-specific fields.
• Override Account Address — Flag to determine if the default account address should be overridden by the provided address.
• Business Account — Associate the employee with a specific business account.
• Campaigns — Define campaigns associated with the employee including campaign ID, name, contact ID, and stage.
• Cases — List cases related to the employee with identifiers, dates, reasons, status, and severity details.
• Company Name — Set the company name associated with the employee.
• Contact Class — Specify the contact classification of the employee.
• Email — Email address of the employee.
• Fax and Fax Type — Fax number and type associated with the employee.
• First Name — Employee's first name.
• Gender — Gender of the employee.
• Job Title — Employee's job title.
• Language Or Locale — Language or locale preference of the employee.
• Last Name — Employee's last name.
• Marketing Lists — Marketing lists specifying contact IDs, subscription status, and list details.
• Middle Name — Employee's middle name.
• Notifications — Notification settings related to the employee including active status and description.
• Opportunities — Sales opportunities involving the employee with currency, probability, status, and stage.
• Owner and Owner Employee Name — Owner identifier and name for the employee record.
• Phone Numbers and Types — Up to three phone numbers with associated types.
• Qualification Date — Date when the employee was qualified.
• Reason — Reason or explanation related to the employee record.
• Relations — Relationships to other entities, including account, contact details, role, and document references.
• Role Assignments — Roles assigned to the employee with IDs, creation dates, and types.
• Source and Source Campaign — Source of the employee record and any source campaign related information.
• Spouse Or Partner Name — Name of the spouse or partner.
• Status — Current status of the employee.
• Synchronize — Flag to indicate if the employee information should be synchronized.
• Title — Title for the employee.
• Type — Type/category designation for the employee.
• User Info — User account details including login, password, roles, and status.
• Web Site — Website associated with the employee.
• Workgroup and Workgroup Description — Workgroup identifiers and description linked to the employee record.
• Note ID — Note identifier associated with the employee.
• Full Name — Full name of the employee.
• Ext Ref Nbr — External reference number for the employee.
• Delegates — List of delegates including their employee names, delegation periods, and active status.
• Employee Settings — Settings regarding branch, calendar, currency, department, employee class, and other HR-specific details.
• Employment History — Historical employment data entries with dates, positions, and termination details.
• Financial Settings — Financial account information including AP account, expense accounts, payment instructions, and tax zone.
• Additional Fields — Additional fields including unique identifiers, employee name, modified date, and status.

Output shape

a single employee record JSON object reflecting the inserted or updated employee data

The output contains the result of the upsert operation, typically the employee data as stored in Acumatica. The operation updates an existing employee if the identifier matches; otherwise, it inserts a new employee. Optional fields may be omitted and defaults will be applied by the system as per its configuration.

Examples

Example 1: Insert a new employee with basic identification and contact info

Provide at least EmployeeID or unique identifier and populate key fields like FirstName, LastName, Email, and ContactInfo.

Example 2: Update existing employee's address and employment history

Set EmployeeID for the target employee and provide updated Address and EmploymentHistory data collections.

Links

• n8n community nodes installation guide