Payroll & salaries
Salaries resources
Employees, payroll paycheck batches, salary parameters, payslips, settlement points, and salary obligations.
The Validation schema column links to the DTD or XSD file that the request message of a POST resource is validated against. A DTD defines the elements, their order and how many times each may occur; an XSD additionally defines data types, maximum lengths and allowed values. A dash (–) means that the resource has no request message (GET resources and POST resources that only take URL parameters) or that no schema is published for it.
Downloading DTD files: right-click the link and choose Save link as. Opening a DTD link directly in the browser may show an XML error, because the browser tries to display the DTD as an XML document. The file itself is not affected.
Resource | Method | Validation schema | Description |
|---|---|---|---|
POST | Add a job period to an existing employee | ||
POST | Attach an employee to a payroll settlement point with an insurance type and validity window | ||
POST | – | Delete a job period | |
POST | Edit an existing job period | ||
POST | Create or update an employee record | ||
POST | Import a dimension-link curve (time-windowed dimension assignments) for an employee | ||
POST | Import salary-parameter ratios for an employee | ||
GET | – | Get a single employee | |
GET | – | List employees | |
GET | – | Get salary parameter ratios for a single employee | |
GET | – | List payroll parties (insurance providers, unions, foreclosure recipients) | |
GET | – | Get a payroll paycheck batch | |
GET | – | List payroll paycheck batches by payment date range | |
POST | Partial update of an existing employee record | ||
POST | Import a payroll advance payment | ||
POST | Import a batch of external payroll payments | ||
POST | Import an external salary payment | ||
GET | – | Get payroll obligation status | |
POST | Import a payroll paycheck batch | ||
POST | Import a payroll period collector entry | ||
GET | – | List payroll ratios by source |
XSD files include the shared type definitions in netvisorgeneraltypes.xsd. When you validate messages locally, download it to the same folder as the resource's XSD file.