Copyright © 2024, Oracle and/or its affiliates.
Field Index SQL Mapping

Class /rate

A rate defines how much to charge for an event. Rates define which resources in the account balance array get credited or debited. A rate can impact many resources.

Notes

  • This object can be read by the owner or any billing group leader who is an ancestor of the owner.
  • This object can be modified only by the owner.
  • This object can be created by anyone.

Links



Field Index

Type Field Name
poid PIN_FLD_POID
timestamp PIN_FLD_CREATED_T
timestamp PIN_FLD_MOD_T
string PIN_FLD_READ_ACCESS
string PIN_FLD_WRITE_ACCESS
string PIN_FLD_CREATE_ACCESS
poid PIN_FLD_ACCOUNT_OBJ
poid PIN_FLD_RATE_PLAN_OBJ
string PIN_FLD_DESCR
enum PIN_FLD_PRORATE_FIRST
enum PIN_FLD_PRORATE_LAST
int PIN_FLD_PRORATE_QUANTITY
enum PIN_FLD_TYPE
enum PIN_FLD_STEP_TYPE
int PIN_FLD_STEP_RESOURCE_ID
string PIN_FLD_TAILORMADE_DATA
int PIN_FLD_PRORATION_FLAG
array PIN_FLD_QUANTITY_TIERS
decimal
decimal
array
int
int
decimal
decimal
enum
decimal
int
string
timestamp
timestamp
int
int
int
string
string
decimal


Field Details

poid PIN_FLD_POID

Object Identifier for an instance of this class. Portal object ids have four pieces of information: database number, class type, sequence id, revision.

Notes

  • System defined on object creation
  • Can be modified only by System

Links

timestamp PIN_FLD_CREATED_T

Time the object was created.

Notes

  • System defined on object creation
  • Can be modified only by System

Links

timestamp PIN_FLD_MOD_T

Time the object was last modified.

Notes

  • System defined on object creation
  • Can be modified only by System

Links

string PIN_FLD_READ_ACCESS

Read Access level for object. Valid values are S(Self), G(Global), L(BrandLineage), B(BrandGroup), A(Ancestral).

Notes

  • System defined on object creation
  • Can be modified only by System
  • Maximum length is 255 bytes

Links

string PIN_FLD_WRITE_ACCESS

Write Access level for object. Valid values are S(Self), G(Global), L(BrandLineage), B(BrandGroup), A(Ancestral).

Notes

  • System defined on object creation
  • Can be modified only by System
  • Maximum length is 255 bytes

Links

string PIN_FLD_CREATE_ACCESS

Create Access level for object. Valid values are O(BrandOwner), R(Root), N(Any).

Notes

  • System defined on object creation
  • Can be modified only by System
  • Maximum length is 255 bytes

Links

poid PIN_FLD_ACCOUNT_OBJ

Link to account object for which this object was created.

Notes

  • Required on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

poid PIN_FLD_RATE_PLAN_OBJ

Poid of the rate_plan object the rate object belongs to.

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

string PIN_FLD_DESCR

Rate description.

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.
  • Maximum length is 255 bytes

Links

enum PIN_FLD_PRORATE_FIRST

Prorating option for the first cycle the product is owned. You can charge for a whole month (701), prorate the charge based on the days left in the month (702), or not charge for the partial month (703). Used only for cycle fees rates.

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

enum PIN_FLD_PRORATE_LAST

Prorating option for the last cycle the product is owned. You can charge for a whole month (701), prorate the charge based on the days left in the month (702), or not charge for the partial month (703). Used only for cycle fees rates.

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

int PIN_FLD_PRORATE_QUANTITY

Prorating option for mode MINIMUM_AMOUNT (747) to prorate quantity.

Notes

  • Can be specified on object creation
  • Can be modified

Links

enum PIN_FLD_TYPE

The type of rate determines its applicability for various rate stack passes. Values are Normal(0), Default(740), Default-only(741), Loan(742), Deduct-rental(743), Outstanding amount(744), Rental failure(745), Skip cycle(746), Minimum amount(747) and Auto-renew cancel(748). 'Normal' rates honor credit limits and 'Default' override credit limits. In 'Loan' mode, when balance exceeds credit limit exceeding amount is taken as loan. In 'Deduct rental', deduct rental until balance becomes zero in case of insufficient balance where in 'Outstanding amount' mode record entire rental as outstanding amount. In 'Rental failure' mode, do not deduct rental, suspend retries and consider it a failure. In 'Skip cycle', do not deduct the rental and do not consider rental as failure, just skip the cycle. 'Minimum amount' consider minimum scaled amount in case of insufficient balance. In 'Auto-renew cancel' mode, cancel product after max retries.

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

enum PIN_FLD_STEP_TYPE

Specifies the type of quantity the quantity tiering steps on. Values can be TOTAL_QUANTITY_RATED(0), QUANTITY_RATED_PER_RATE(1) and RESOURCE_QUANTITY(2). If the value is RESOURCE_QUANTITY, step_resource need to be specified as well.

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

int PIN_FLD_STEP_RESOURCE_ID

Numeric value of the resource that quantity tiering steps on.

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

string PIN_FLD_TAILORMADE_DATA

To store resources along with percentage override. Eg: <USD,-10><MIN,-10>. This field will be populated for tailormade rate objects.

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.
  • Maximum length is 1024 bytes

Links

int PIN_FLD_PRORATION_FLAG

For bill cycle change only .Default value 0 means prorate , 703 means do not charge , 701 means full charge

Notes

  • Can be specified on object creation
  • Can be modified

Links

array PIN_FLD_QUANTITY_TIERS

Array of quantity tiers belongs to the rate. Quantity tiers can not overlap.

Notes

  • Can be specified on object creation
  • Can be modified

Links

decimal PIN_FLD_STEP_MIN

Minimum quantity of event that can use this quantity tier. Test is inclusive - quantity must be >= min. A value PIN_NUM_MIN means no minimum limit.

Notes

Links

decimal PIN_FLD_STEP_MAX

Maximum quantity of event that can use this quantity tier. Test is non inclusive - quantity must be < max. A value PIN_NUM_MAX means no maximum limit.

Notes

Links

array PIN_FLD_BAL_IMPACTS

Array of balance operations. Multiple impacts can be defined on the same resource. Array element id is not significant.

Notes

Links

int PIN_FLD_ELEMENT_ID

Numeric value of the resource to be impacted.

Notes

  • Required on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

int PIN_FLD_FLAGS

Balance Impact Flags. Specifies whether the impact is proratable (0x2) and/or discountable (0x1) and/or sponsorable (0x4) and/or grantable (0x8) and/or taxable overridden (0x10).

Notes

  • Required on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

decimal PIN_FLD_FIXED_AMOUNT

Fixed Balance Amount - amount to increment independent of quantity.

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

decimal PIN_FLD_SCALED_AMOUNT

Scaled Balance Amount - amount to increment per unit of quantity.

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

enum PIN_FLD_SCALED_UNIT

Unit scaled_amount is expressed in. Value can be NONE(0), SECOND(1), MINUTE(2), HOUR(3) or DAY(4).

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

decimal PIN_FLD_TAXABLE_AMOUNT

Taxable Amount - amount can be different than actual charge amount.

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

int PIN_FLD_GL_ID

GLID to be used when impacting the resource associated with this balance operation.

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

string PIN_FLD_IMPACT_CATEGORY

Impact category. The balance operation is performed only if the impact category specified by the event's custom analysis module matches this field. See /config/impact_category definition.

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.
  • Maximum length is 255 bytes

Links

timestamp PIN_FLD_START_T

Inclusive start time of the validity period for the balance impact. If the value is 0, the validity starts immediately.

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

timestamp PIN_FLD_END_T

Non inclusive end time of the validity period for the balance impact. If the value is 0, the balance impact does not expire.

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

int PIN_FLD_START_DETAILS

Resource relative start time. Expressed as mode, unit and offset. The lower 8 bits hold mode to indicate start first usage/immediately/absolue/relative,next 4 bits hold unit and next 20 bits hold offset which is relative to grant time.

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

int PIN_FLD_END_DETAILS

Resource relative end time.Expressed as mode, unit and offset value. The lower 8 bits hold mode to indicate end never/absolue/relative, next 4 bits hold unit and next 20 bits hold offset which is relative to grant time.

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

int PIN_FLD_SPLIT_DETAILS

This 32bit field will store the bit fields for processing split logicLower 8 bits store the mode for bucket validity alignment SPLIT_ALIGN_BUCKET(5) - align the bucket validity with bucket split validity SPLIT_ALIGN_TOTAL(6) - align the bucket validity with total validityNext 4 bits for holding unit definition - second/minute/hour/day/month 1 - second, 2 - minute, 3 - hour, 4 - day, 5 - monthRemaining 20 MSB bits to hold offset number of seconds, minutes, hours, days, months

Notes

  • Can be specified on object creation
  • Can be modified

Links

string PIN_FLD_FIXED_PRICE_TAG

Price Tag for the fixed amount.

Notes

  • Can be specified on object creation
  • Can be modified
  • Maximum length is 255 bytes

Links

string PIN_FLD_SCALED_PRICE_TAG

Price Tag for the scaled amount.

Notes

  • Can be specified on object creation
  • Can be modified
  • Maximum length is 255 bytes

Links

decimal PIN_FLD_MINIMUM_SCALED_AMOUNT

Minimum Scaled Balance Amount - amount used with mode Minimum amount (747) and when the balance exceeds credit limit.

Notes

  • Can be specified on object creation
  • Can be modified

Links


SQL Mapping


Type Field Name Table Column Name
base-class /rate rate_t
poid PIN_FLD_POID poid*
timestamp PIN_FLD_CREATED_T created_t
timestamp PIN_FLD_MOD_T mod_t
string PIN_FLD_READ_ACCESS read_access
string PIN_FLD_WRITE_ACCESS wrtie_access
string PIN_FLD_CREATE_ACCESS create_access
poid PIN_FLD_ACCOUNT_OBJ account_obj*
poid PIN_FLD_RATE_PLAN_OBJ rate_plan_obj*
string PIN_FLD_DESCR descr
enum PIN_FLD_PRORATE_FIRST prorate_first
enum PIN_FLD_PRORATE_LAST prorate_last
int PIN_FLD_PRORATE_QUANTITY prorate_quantity
enum PIN_FLD_TYPE type
enum PIN_FLD_STEP_TYPE step_type
int PIN_FLD_STEP_RESOURCE_ID step_resource
string PIN_FLD_TAILORMADE_DATA tailormade_data
int PIN_FLD_PRORATION_FLAG proration_flag
array PIN_FLD_QUANTITY_TIERS rate_quantity_tiers_t
decimal
PIN_FLD_STEP_MIN
 		step_min
decimal
PIN_FLD_STEP_MAX
 		step_max
array
PIN_FLD_BAL_IMPACTS
 		rate_bal_impacts_t
int
PIN_FLD_ELEMENT_ID
element_id
int
PIN_FLD_FLAGS
flags
decimal
PIN_FLD_FIXED_AMOUNT
fix_amount
decimal
PIN_FLD_SCALED_AMOUNT
scaled_amount
enum
PIN_FLD_SCALED_UNIT
scaled_unit
decimal
PIN_FLD_TAXABLE_AMOUNT
taxable_amount
int
PIN_FLD_GL_ID
gl_id
string
PIN_FLD_IMPACT_CATEGORY
impact_category
timestamp
PIN_FLD_START_T
start_t
timestamp
PIN_FLD_END_T
end_t
int
PIN_FLD_START_DETAILS
start_details
int
PIN_FLD_END_DETAILS
end_details
int
PIN_FLD_SPLIT_DETAILS
split_details
string
PIN_FLD_FIXED_PRICE_TAG
fixed_price_tag
string
PIN_FLD_SCALED_PRICE_TAG
scaled_price_tag
decimal
PIN_FLD_MINIMUM_SCALED_AMOUNT
minimum_scaled_amount
Column names marked with * are actually column prefixes. For poid type fields, the column prefix is used to create the columns poid_id0, poid_db and poid_type if the prefix is "poid". For PIN_FLD_POID in the base table, an additional column named poid_rev is created to hold the poid revision. For buffer fields, two columns are created - one in the containing table and one in the buffer table. For example if the prefix is "buf", then the column name in the buffer table is buffer_buf and the column name in the containing table is buffer_size.

Field Index This Class