Pricefx Backend Server - Clover Club 12.2.2-SNAPSHOT API

Welcome to the documentation for the Pricefx Groovy API, a flexible solution for configuring the Pricefx system.

Using the Groovy language you can manipulate data, create and read user inputs, lookup data, execute logics, and much more within the given Pricefx partition.

icon

Public Groovy API

This is the entry point to Pricefx Groovy API. With the Public Groovy API (accessible via the binding variable "api"), you have access to a wide range of methods for Pricefx configuration.

icon

Knowledge Base

For more insights on how to use the Groovy API, visit the Pricefx Knowledge Base. It contains getting started guides, how-to tutorials, and practical usage examples for the Pricefx API configuration.

icon

Best Practices

Enhance the project performance and stability, along with writing logics effectively. Read about code conventions, adopt functional practices, and employ performance practices to optimize and streamline your code.

icon

Pricefx Studio

Install, setup, and learn how to use Pricefx Studio IntelliJ IDEA plugin. Pricefx Studio helps you improve productivity when developing calculation logics during project implementation.



Examples (internal access only)

Requires internal access permissions! As the current Groovy API documentation does not yet provide examples for some methods, you can also search for code snippets via gitgrep.pricefx.eu.

Groovy API Fulltext Search (experimental)

As the standard Groovy API documentation (Javadoc) lacks a fulltext search by design, we provide you with an experimental version of Groovy API fulltext search (allows also search through other documentation sources).

Pricefx Training Portal

Register for learning paths, instructor-led training, or certification exams via Pricefx Training Portal.

Code Quality

Employ the code quality plugin to ensure compliance with Pricefx standards.

Pricefx REST API Documentation

In case you need to perform an HTTP call, you can find the desired endpoint and request/response examples in our REST API documentation.

Release Notes

Check out Pricefx Release Notes to stay informed about the latest development.

Pricefx Unity Documentation

Documentation for the Pricefx Unity user interface.

Versions

The version of Groovy currently used for the Pricefx configuration and the Java version used on the backend.
Groovy 2.4.21
JDK 17
Packages
Package
Description
Provides histogram class.
Filter is used by the Search class to specify a restriction on what results should be returned in the search.
Provides several classes commonly used in Pricefx API.
Chart API to work with charts.
 
Provides CalculationFlow API.
Chart Builder API to work with charts.
Calculable Line Item Collection (clicoll) API can be used to manipulate Quotes, Contracts and Rebate Agreements from header logic.
CompensationBuilder API allows to manipulate a rebate agreement object from a header logic.
ContractBuilder API allows to manipulate a contract object from a header logic.
 
QuoteBuilder API allows to manipulate a quote object from a quote header logic.
RebateAgreementBuilder API allows to manipulate a rebate agreement object from a header logic.
Defines set of data transfer object (DTO) classes.
 
Provides set of util classes.
Defines set of domain object classes.
Provides Formula Engine API classes.
 
Provides API related to scripting, including interface PublicGroovyAPI, that represents what can be reached in the Groovy element syntax as api.
Provides InputBuilderFactory as a convenient way to create Inputs.
 
Defines set of data transfer object (DTO) classes.
Defines set of data transfer object (DTO) classes related to Calculations.
Provides Dashboard API classes.
 
Provides StreamResults interface.
 
Provides ItemSummaryQuery interface.
Provides Workflow API.