System APIs
Description
System administration APIs covering users, roles, permissions, webhooks, scheduled jobs, automated flows, custom fields, output and print configuration, applications, extensions, and error messages.
Tags and resources
API operation instance
Configured instances of API operations registered for use within the RamBase system.
Application
RamBase client applications, each representing a configured UI entry point in the RamBase platform.
Automated flow
Automated flows define event-driven automation: when a trigger condition is met, one or more configured actions execute automatically.
Automated flow action
A configured action type that can be executed as part of an automated flow (e.g., send email, create object, call API).
Automated flow template
Templates for automated flows, providing reusable trigger-action configurations that can be instantiated as automated flows.
Client framework
The RamBase web client framework configuration, including navigation menus and context menu collections.
Custom field
Custom fields extend standard RamBase objects with company-specific data, supported on many object types.
Custom number series
Custom document number series allowing companies to define their own numbering sequences for RamBase objects.
Deployment package
Deployment packages bundle extensions, configurations, and customizations for versioned deployment across RamBase environments.
Duty
Duties are atomic permission units in RamBase, each defining one allowed action. Duties are grouped into roles.
Error message
Translatable system error messages used throughout RamBase, identified by error code.
Extension
RamBase extensions add partner or company-specific functionality on top of the core platform, bundling custom fields, media, and configurations.
Global rate source
Global exchange rate provider configurations used to fetch and synchronize currency exchange rates.
Local rate source
Company-specific exchange rate source configurations for currency conversion.
Module
A top-level functional area in RamBase (e.g., Sales, Finance). Modules group related submodules and applications.
OTP Exception
One-time password (OTP) exceptions defining scenarios where OTP authentication is bypassed.
Output
Output system configuration: print connectors, output designs, object definitions, themes, logos, footers, and batch print setup.
Permission
Permissions define what actions users may perform on specific resource or object types in RamBase.
Privilege
Privileges add data-level restrictions to permissions, limiting a user's access to specific subsets of records.
RamBase Event Type
Event types in RamBase that can trigger webhooks or automated flows when they occur.
Report
System-level reports covering usage, audit, and configuration data.
Report definition
Custom report definitions specifying data source, columns, filters, and layout.
Report job
Scheduled report jobs that automatically generate and distribute reports on a defined interval.
Role
Security roles that group duties and permissions. Assigned to users to control their access in RamBase.
Role template
Predefined role templates providing a standard set of duties as a starting point when creating new roles.
Setting
Company-level configuration settings that control module behavior in RamBase.
Submodule
A functional subgroup within a RamBase module, used for organizing permissions and menu structure.
System job
Scheduled and on-demand system jobs: import jobs, output jobs, batch jobs, and job sequences.
User
RamBase system users with login credentials, role assignments, dashboards, and access configuration.
Webhook
Outbound webhooks that POST to external URLs when configured RamBase events occur. Linked to RamBase Event Types.