BalanceLimitsByPidAndBdid |
Get balance limitsFetches balance limits and send the created UUID along with the data
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 BalanceLimitsByPidAndBdid. 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 |
Data Type |
Required |
Default Value |
Documentation |
|---|---|---|---|---|
bdid |
|
☑ |
|
Balance Definition Id |
blid |
|
☑ |
|
Balance Limit Id |
pid |
|
☑ |
|
Loyalty Program Id |
version |
|
☐ |
|
Version (Values: active, draft) |
Columns of Table Function
The columns of the table function BalanceLimitsByPidAndBdid are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
balanceDefinitionId |
guid |
|
☐ |
Balance definition ID. |
constraintType |
varchar2 |
|
☐ |
Defines the type of constraint (transaction count or amount). |
createdAt |
datetime |
Creation Date |
☐ |
Timestamp of when the balance limit was created. |
durationUnit |
varchar2 |
|
☐ |
Time unit for the balance limit. |
durationValue |
int64 |
|
☐ |
Number of time units the balance limit applies to. |
id |
guid |
ID |
☐ |
Unique identifier for the balance limit. |
slidingSchedule |
char |
|
☐ |
Indicates if the limit resets periodically based on a sliding schedule. |
transactionType |
varchar2 |
|
☐ |
Specifies whether the limit applies to credit or debit transactions. |
updatedAt |
datetime |
|
☐ |
Timestamp of the last update to the balance limit. |
value |
decimal |
Value |
☐ |
The maximum allowed value for the defined constraint. |
Sendinblue API Data Model