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

AI agent

AI chat message

Tracks usage of AI chat in RamBase Client

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.

Batch Job

A batch job instance executing a set of operations across multiple records.

Batch Print Exception

Exception rules overriding standard batch print routing for specific conditions.

Bulk Job Definition

Defines a bulk job for performing mass operations across multiple RamBase records.

Company Setting Definition

Context Menu Collection

A collection of context menu items available on specific objects in the RamBase client.

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.

Data Source

Data sources specifying which data fields are available for output document generation.

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.

Import job

An import job instance that processes external data files into RamBase records.

Import Job Definition

Defines an import job including source file format, field mappings, and transformation rules.

Job definition

Defines the configuration and schedule for a recurring or on-demand system job.

Job Log

Execution log for a system job run, including status, timestamps, and error details.

Job sequence

A job sequence chains multiple jobs to execute in a defined order.

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 Design

Template designs defining the visual layout of output documents.

Output job

Output jobs that generate and distribute documents or reports.

Output logo

Company logos used in output document templates.

Output Object Definition

Defines how a RamBase object type is rendered for output, covering format, email, FTP, and print delivery settings.

Output theme

Visual themes applied to output documents to control colors and branding.

Permission

Permissions define what actions users may perform on specific resource or object types in RamBase.

Print Configuration

A print configuration defining printers, routing rules, and exceptions for output.

Print Connector

A connector linking RamBase to a physical or virtual printer.

Print Group

A group of output components sharing common print configuration.

Privilege

Privileges add data-level restrictions to permissions, limiting a user's access to specific subsets of records.

Publisher

RamBase Event Type

Event types in RamBase that can trigger webhooks or automated flows when they occur.

RamBase Menu

The navigation menu structure of the RamBase client, organizing applications into logical groups.

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.

Submodule

A functional subgroup within a RamBase module, used for organizing permissions and menu structure.

System Setting

System Setting Definition

Company-level configuration settings that control module behavior in RamBase.

User

RamBase system users with login credentials, role assignments, dashboards, and access configuration.

Verification log

Verification log entries produced during a system job run.

Webhook

Outbound webhooks that POST to external URLs when configured RamBase events occur. Linked to RamBase Event Types.