Actions41
- ── Framework ── Actions
- DataServer (Generic) Actions
- Employees (HR) Actions
- Payroll Actions
- Invoice (Stock) Actions
- Stock Movement Actions
- Accounts Payable/Receivable Actions
- Accounting Entry Actions
- Customers / Suppliers Actions
- Users Actions
- Companies Actions
- Enrollment (Education) Actions
Payroll → List Calculations
AI-generatedSummary
List payroll calculations from the TOTVS RM payroll system with optional filtering, pagination, sorting, and selected fields.
Inputs
- SQL Filter — Standard RM SQL filter to narrow results, supports =, LIKE, AND, OR, IN syntax (e.g., CODCOLIGADA=1 AND CODSITUACAO='A').
- Page Size (limit) — Maximum number of records to return, between 1 and 500, default is 50.
- Offset (start) — Starting index for the result set pagination, default is 0.
- Order By — Optional ordering of results, e.g., 'NOME ASC'.
- Select Fields — Comma-separated list of payroll calculation fields to return; all fields returned if empty.
- Company Code Override — Override the company code (CODCOLIGADA) configured in credentials; set to 0 to use credential default.
- RM Context — Additional RM context string such as 'CODSISTEMA=S;CODUSUARIO=admin;CODFILIAL=1'; defaults to credential context if empty.
Output shape
a list of payroll calculation records
Returns an array of payroll calculation objects, each item as a JSON object under output. The payload respects filtering, field selection, pagination, and ordering parameters as provided.
Examples
Example 1: Retrieve first 100 active payroll calculations for company 1, selecting only calculation code and description, ordered by description ascending. Use SQL Filter "CODCOLIGADA=1 AND CODSITUACAO='A'", Limit 100, Select Fields "CODIGO,DESCRICAO", Order By "DESCRICAO ASC".
Set resource to 'Payroll' (rh_folha), operation to 'List Calculations' (getAll). Provide the filter, limit, select, and orderBy accordingly.
