TOTVS RM icon

TOTVS RM

Interact with TOTVS ERP Linha RM — DataServer REST, native REST APIs, and automatic JWT authentication

Invoice (Stock) → List Invoices

AI-generated

Summary

List invoices from the TOTVS RM system with support for filtering, pagination, ordering, and field selection.

Inputs

  • SQL Filter — Standard RM SQL filter using operators like =, LIKE, AND, OR, IN. Example: CODCOLIGADA=1 AND CODSITUACAO='A'
  • Page Size (limit) — Maximum number of invoices to return per request, between 1 and 500. Defaults to 50.
  • Offset (start) — Starting record number for pagination. Defaults to 0.
  • Order By — SQL order by clause to sort results, e.g., NOME ASC.
  • Select Fields — Comma-separated list of fields to return. Leave empty to return all fields.
  • Company Code Override — Override company code; set to 0 to use the company code from the node credentials.
  • RM Context — Additional RM context string for the request, e.g., CODSISTEMA=S;CODUSUARIO=admin;CODFILIAL=1. Defaults to credential context.

Output shape

a list of invoice records as JSON objects

Returns an array of invoice records matching the filter and pagination criteria. If no select fields are specified, all fields are included. Pagination via 'limit' and 'start' parameters is supported. Errors may appear per item if 'continueOnFail' is enabled.

Examples

Example 1: List up to 100 active invoices for company 1 starting from the first record, ordering by invoice number ascending, and returning specific fields

Set SQL Filter to "CODCOLIGADA=1 AND CODSITUACAO='A'", Page Size to 100, Offset to 0, Order By to "NUMNOTA ASC", Select Fields to "NUMNOTA,DATA_EMISSAO,VALORNOTA".

Links

Discussion