Navigation: Catalog: Brevo > Schemas > Schema: Balance > Tables

BalanceDefinitionsByPid

Get balance definition listReturns balance definition page

Catalog: Brevo

Schema: Balance

This is a read-only table function. The Sendinblue API may not support changing the data or the Invantive UniversalSQL driver for Sendinblue does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Sendinblue API.

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function BalanceDefinitionsByPid. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name	Required	Documentation
pid	☑	Loyalty Program Id
sortField	☐	Field to sort by (Values: name, created_at, updated_at)
version	☐	Version (Values: active, draft)

Columns of Table Function

The columns of the table function BalanceDefinitionsByPid are shown below. Each column has an SQL data type.

Name	Data Type	Label	Required	Documentation
balanceAvailabilityDurationModifier	varchar2		☐	Modifier for balance availability duration. startOfPeriod causes expiry at the start of the period, endOfPeriod at the end. noModification uses the exact duration from the credit date.
balanceAvailabilityDurationUnit	varchar2		☐	Unit of time for the balance availability duration.
balanceAvailabilityDurationValue	int64		☐	Number of time units before the balance expires.
balanceExpirationDate	varchar2		☐	Fixed expiration date in dd/mm format. The balance expires when this date next appears in the calendar. Only one of balanceExpirationDate or balance availability duration fields can be used.
balanceOptionAmountOvertakingStrategy	varchar2		☐	Partial enables partial credit of balance if maximum balance limit is reached. Strict enables rejection of a transaction if it will breach the max balance limit.
balanceOptionCreditRounding	varchar2		☐	Rounding strategy for credit transactions.
balanceOptionDebitRounding	varchar2		☐	Rounding strategy for debit transactions.
createdAt	datetime	Creation Date	☐	Timestamp of balance definition creation.
deletedAt	datetime		☐	Timestamp of balance definition deletion (nullable).
description	varchar2	Description	☐	Short description of the balance definition.
id	guid	ID	☐	Unique identifier for the balance definition.
imageRef	varchar2		☐	Optional image reference URL.
maxAmount	decimal		☐	Maximum allowable balance.
maxCreditAmountLimit	decimal		☐	Maximum credit allowed per operation.
maxDebitAmountLimit	decimal		☐	Maximum debit allowed per operation.
meta	varchar2		☐	Additional metadata for the balance definition.
minAmount	decimal		☐	Minimum allowable balance.
name	varchar2	Name	☐	Name of the balance definition.
unit	varchar2		☐	Unit of balance measurement.
updatedAt	datetime		☐	Timestamp of the last update.

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.

Please enable JavaScript to view this site.

Sendinblue API Data Model

BalanceDefinitionsByPid

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information