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

Class /billinfo

BillInfo objects contain the account's billing information such as billing status, billing and accounting cycle, and hierarchy. Each account will have at least one BillInfo. A Balance group contains a pointer to a BillInfo. Similarly, a BillInfo contains a pointer to its default balance group.

Notes

  • The system will assign poid ids above 1000 to objects of this class. The range below this is reserved for creating objects with well-known poid ids.
  • This object can be read by the owner or any billing group leader within the brand who is an ancestor of the owner.
  • This object can be modified by the owner or any billing group leader within the brand who is an ancestor of 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_BUSINESS_PROFILE_OBJ
string PIN_FLD_BILLINFO_ID
enum PIN_FLD_BILLING_STATE
enum PIN_FLD_BILLING_STATUS
int PIN_FLD_BILLING_STATUS_FLAGS
enum PIN_FLD_STATUS
int PIN_FLD_STATUS_FLAGS
poid PIN_FLD_ACCOUNT_OBJ
timestamp PIN_FLD_EFFECTIVE_T
int PIN_FLD_ACTG_CYCLE_DOM
enum PIN_FLD_ACTG_TYPE
timestamp PIN_FLD_ACTG_LAST_T
timestamp PIN_FLD_ACTG_NEXT_T
timestamp PIN_FLD_ACTG_FUTURE_T
int PIN_FLD_BILL_ACTGCYCLES_LEFT
int PIN_FLD_BILL_WHEN
timestamp PIN_FLD_LAST_BILL_T
poid PIN_FLD_LAST_BILL_OBJ
timestamp PIN_FLD_ACTUAL_LAST_BILL_T
poid PIN_FLD_ACTUAL_LAST_BILL_OBJ
timestamp PIN_FLD_NEXT_BILL_T
poid PIN_FLD_NEXT_BILL_OBJ
timestamp PIN_FLD_FUTURE_BILL_T
poid PIN_FLD_BILL_OBJ
int PIN_FLD_CURRENCY
int PIN_FLD_CURRENCY_SECONDARY
int PIN_FLD_PARENT_FLAGS
int PIN_FLD_SPONSOR_FLAGS
int PIN_FLD_SPONSOREE_FLAGS
decimal PIN_FLD_PENDING_RECV
poid PIN_FLD_AR_BILLINFO_OBJ
poid PIN_FLD_PARENT_BILLINFO_OBJ
poid PIN_FLD_PAYINFO_OBJ
enum PIN_FLD_PAY_TYPE
poid PIN_FLD_SCENARIO_OBJ
int PIN_FLD_EXEMPT_FROM_COLLECTIONS
enum PIN_FLD_BILLING_SEGMENT
int PIN_FLD_ACCT_SUPPRESSED
int PIN_FLD_NUM_SUPPRESSED_CYCLES
int PIN_FLD_SUPPRESSION_CYCLES_LEFT
poid PIN_FLD_PAYMENT_EVENT_OBJ
timestamp PIN_FLD_COLLECTION_DATE
string PIN_FLD_EVENT_POID_LIST
poid PIN_FLD_BAL_GRP_OBJ
enum PIN_FLD_OBJECT_CACHE_TYPE
string PIN_FLD_ASSOC_BUS_PROFILE_OBJ_LIST
string PIN_FLD_UNIQUE_ID


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_BUSINESS_PROFILE_OBJ

Link to the business profile object to which this billinfo belongs.

Notes

  • Can be specified on object creation
  • Can be modified

Links

string PIN_FLD_BILLINFO_ID

A string identifying the billinfo by name.

Notes

  • Required on object creation
  • Can be modified
  • Maximum length is 60 bytes

Links

enum PIN_FLD_BILLING_STATE

Used to track the billing state of a billinfo. Legal values are PIN_ACTG_CYCLE_OPEN - this value is set during account creation or when the bill is finalized during billing outside of the billing delay interval. PIN_ACTG_CYCLE_CLOSED - this value is set during billing inside of the delay interval. PIN_ACTG_CYCLE_ALL_CHARGES_DONE - this value is set when cycle charges are applied during billing outside of the billing delay interval.

Notes

  • Can be specified on object creation
  • Can be modified

Links

enum PIN_FLD_BILLING_STATUS

Used to track the billing status of a billinfo. Legal values are PIN_BILL_ACTIVE - indicates that billing should be provided for the account in a standard (regular) way. This is a default value. PIN_BILL_INACTIVE - indicates that billing should be suspended for the billinfo. PIN_BILL_ERROR - indicates that an error occurred when the billing application tried to bill this billinfo. If an error occurs for a subordinate billinfo, the parent billinfo's status will also be set to PIN_BILL_ERROR.

Notes

  • Can be specified on object creation
  • Can be modified

Links

int PIN_FLD_BILLING_STATUS_FLAGS

Reason for changing of BILLING_STATUS. Legal values are PIN_BILL_FLAGS_DUE_TO_STOP_BILL_CLOSE_ACCT (0x01), PIN_BILL_FLAGS_DUE_TO_RESUME_BILLING (0x02), PIN_BILL_FLAGS_DUE_TO_STOP_BILL_CLOSE_ACCT_SUBORD (0x04), PIN_BILL_FLAGS_DUE_TO_BILLING (0x08), PIN_BILL_FLAGS_DUE_TO_SUBORD_BILLING (0x10), PIN_BILL_FLAGS_DUE_TO_SPONSOREE_BILLING (0x20), PIN_BILL_FLAGS_DUE_TO_MIGRATION (0x40), PIN_BILL_FLAGS_DUE_TO_CUSTOMER_REQUEST (0x80), PIN_BILL_FLAGS_CF_ERROR (0x100), PIN_BILL_FLAGS_DEF_CF_ERROR (0x200), PIN_BILL_FLAGS_DEF_PURCHASE_ERROR (0x400), PIN_BILL_FLAGS_DEF_CANCEL_ERROR (0x800), PIN_BILL_FLAGS_CF_NOT_APPLIED (0x1000), PIN_BILL_FLAGS_UPDATE_JOURNALS_ERROR (0x2000), PIN_BILL_FLAGS_UPDATE_ITEMS_ERROR (0x4000), PIN_BILL_FLAGS_STOP_BILLING_PATCH_ONHOLD_STATE (0x10000), PIN_BILL_FLAGS_RESUME_BILLING_PATCH_INPROGRESS_STATE (0x20000).

Notes

  • Can be specified on object creation
  • Can be modified

Links

enum PIN_FLD_STATUS

Status of the billinfo. Values are PIN_STATUS_DEFUNCT(0), PIN_STATUS_ACTIVE(10100), PIN_STATUS_INACTIVE(10102), and PIN_STATUS_CLOSED(10103). Typically, user access to services is blocked unless the account is activated using the PCM_OP_CUST_SET_STATUS opcode.

Notes

  • Can be specified on object creation
  • Can be modified

Links

int PIN_FLD_STATUS_FLAGS

System and user-defined modifier flags to track reasons for account being inactive/closed. System defined values are PIN_STATUS_FLAG_ACTIVATE - Activate in Future (0x01), PIN_STATUS_FLAG_DEBT - Debt (0x02), PIN_STATUS_FLAG_MANUAL - Manual (0x04), PIN_STATUS_FLAG_DUE_TO_PARENT - Due to Parent (0x10), PIN_STATUS_FLAG_PO_EXHAUSTED - PO exhausted (0x20).

Notes

  • Can be specified on object creation
  • Can be modified

Links

poid PIN_FLD_ACCOUNT_OBJ

Link to the account object to which this billinfo belongs.

Notes

  • Required on object creation
  • Can be modified

Links

timestamp PIN_FLD_EFFECTIVE_T

Effective time of modification of this billinfo.

Notes

  • Can be specified on object creation
  • Can be modified

Links

int PIN_FLD_ACTG_CYCLE_DOM

Day-of-month that a monthly cycle begins for this billinfo. Cycle fees, folds and deferred taxation are synchronized to this day of the month. Legal values are 1-31. Additional restrictions are enforced using the PCM_OP_CUST_POL_PREP_ACTGINFO policy.

Notes

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

Links

enum PIN_FLD_ACTG_TYPE

Accounting type for this billinfo. The legal values are PIN_ACTG_TYPE_OPEN_ITEMS (1) and PIN_ACTG_TYPE_BALANCE_FORWARD (2).

Notes

  • Can be specified on object creation
  • Can be modified

Links

timestamp PIN_FLD_ACTG_LAST_T

Date that the current monthly cycle began (and last monthly cycle ended).

Notes

  • Can be specified on object creation
  • Can be modified

Links

timestamp PIN_FLD_ACTG_NEXT_T

Date that the current monthly cycle ends (and next monthly cycle begins). The monthly billing gets triggered based on this field. If an event associated with this billinfo arrives with an end time beyond this date, the monthly billing is triggered automatically.

Notes

  • Can be specified on object creation
  • Can be modified

Links

timestamp PIN_FLD_ACTG_FUTURE_T

Date for when the next monthly cycle (cycle after the current one) will end. Generally, this equates to the 2nd next occurrance of the actg day-of-month. If the customer changes the day-of-month, this field is used to synchronize to the new cycle.

Notes

  • Can be specified on object creation
  • Can be modified

Links

int PIN_FLD_BILL_ACTGCYCLES_LEFT

Number of monthly cycles remaining until the current billing cycle ends. Billing cycles are always a multiple of monthly cycles; this field counts down each month until billing is run.

Notes

  • Can be specified on object creation
  • Can be modified

Links

int PIN_FLD_BILL_WHEN

Frequency for billing, stored as number of monthly cycles in each billing cycle (monthly billing = 1, bi-monthly = 2, quarterly = 3, annual = 12).

Notes

  • Can be specified on object creation
  • Can be modified

Links

timestamp PIN_FLD_LAST_BILL_T

Date that the current billing cycle started and the previous billing cycle ended.

Notes

  • Can be specified on object creation
  • Can be modified

Links

poid PIN_FLD_LAST_BILL_OBJ

Link to the bill object for the bill cycle previous to the current one. Provides the system a fast path to the last completed bill. This points to the latest finalized regular bill object by regular billing only. This field is not updated by Bill_Now or Bill On-Demand.

Notes

  • Can be specified on object creation
  • Can be modified

Links

timestamp PIN_FLD_ACTUAL_LAST_BILL_T

Actual Date when last billing happened from bill_now or bill_on_demand.

Notes

  • Can be specified on object creation
  • Can be modified

Links

poid PIN_FLD_ACTUAL_LAST_BILL_OBJ

Link to the bill object for the previous billing. Provides the system a fast path to last completed bill. Bill_Now and On-Demand Billing updates this field with the bill_obj which has got generated due to Bill Now or Ondemand Billing. This field is also updated by Regular billing.

Notes

  • Can be specified on object creation
  • Can be modified

Links

timestamp PIN_FLD_NEXT_BILL_T

Date that the current billing cycle ends.

Notes

  • Can be specified on object creation
  • Can be modified

Links

poid PIN_FLD_NEXT_BILL_OBJ

If you have delayed batch events coming into the system, and you have configured it to have a delay for the billing run so that all the events for the current billing cycle are received before billing is actually run, this field will store the bill object for next cycle (given that the billing for the current cycle is not yet run).

Notes

  • Can be specified on object creation
  • Can be modified

Links

timestamp PIN_FLD_FUTURE_BILL_T

Date that the future billing cycle ends.

Notes

  • Can be specified on object creation
  • Can be modified

Links

poid PIN_FLD_BILL_OBJ

Link to the bill object for the current billing cycle. A bill object is created at the beginning of a billing cycle. The bill object is not ready for collection until the billing cycle ends and bill processing is run for the billinfo.

Notes

  • Can be specified on object creation
  • Can be modified

Links

int PIN_FLD_CURRENCY

Primary currency for this billinfo. Stored as the resource ID of the currency (ISO 4217 standard). All A/R for the billinfo is tracked in the primary currency.

Notes

  • Required on object creation
  • Can be modified

Links

int PIN_FLD_CURRENCY_SECONDARY

Secondary currency for this billinfo. A/R can be viewed and payments/disputes/adjustments made in the secondary currency, but all impacts are translated to the primary currency for actual A/R tracking. Only Euro and EMU currencies are supported as secondary currencies currently.

Notes

  • Can be specified on object creation
  • Can be modified

Links

int PIN_FLD_PARENT_FLAGS

Indicates whether this billinfo object has a subordinate billinfo. This field will be used to see if we need to walk through the subordinates in the case of triggering of billing.

Notes

  • Can be specified on object creation
  • Can be modified

Links

int PIN_FLD_SPONSOR_FLAGS

Indicates whether this billinfo has a sponsoree billinfo. This field will be used to see if we need to walk through the sponsorees in the case of triggering of billing.

Notes

  • Can be specified on object creation
  • Can be modified

Links

int PIN_FLD_SPONSOREE_FLAGS

Indicates whether this billinfo has a sponsor billinfo. This field will be used by the pin_bill_accts application to select only sponsoree billinfos for billing.

Notes

  • Can be specified on object creation
  • Can be modified

Links

decimal PIN_FLD_PENDING_RECV

Used only as a binary value to determine if the outstanding billed A/R is zero or non-zero. This field is used to trigger the collection process using the pin_collect application. The value is equal to the sum of all open A/R. May become obsolete in the future.

Notes

  • Can be specified on object creation
  • Can be modified

Links

poid PIN_FLD_AR_BILLINFO_OBJ

This is a link to the A/R billinfo. For a single billinfo, there is no A/R. In this case, this field is the same as the billinfo POID. This field is used for picking up subordinate billinfos during billing.

Notes

  • Can be specified on object creation
  • Can be modified

Links

poid PIN_FLD_PARENT_BILLINFO_OBJ

This is a link to the billinfo which is one level up in the hierarchy (but this object not necessarily being the subordinate). If the given billinfo is not a child, then this field will be NULL.

Notes

  • Can be specified on object creation
  • Can be modified

Links

poid PIN_FLD_PAYINFO_OBJ

Link to the payment info object for this billinfo. The payment info object contains details of how payments are collected from the billinfo.

Notes

  • Can be specified on object creation
  • Can be modified

Links

enum PIN_FLD_PAY_TYPE

Pay type, like PIN_PAY_TYPE_INVOICE - invoice (10001), PIN_PAY_TYPE_CC - credit card (10003), PIN_PAY_TYPE_DD - direct debit (10005), or PIN_PAY_TYPE_SUBORD - subordinate (10007).

Notes

  • Can be specified on object creation
  • Can be modified

Links

poid PIN_FLD_SCENARIO_OBJ

The poid linked to the active scenario object if the billinfo is in collections.

Notes

  • Can be specified on object creation
  • Can be modified

Links

int PIN_FLD_EXEMPT_FROM_COLLECTIONS

A flag to exempt the billinfo from getting into the collections process.

Notes

  • Can be specified on object creation
  • Can be modified

Links

enum PIN_FLD_BILLING_SEGMENT

A billing segment ID for the billinfo. This is a user-defined category, such as wholesale, retail, or senior citizen, that controls the accounting DOMs to which a billinfo can be assigned, and allows to load-balance billing operations more effectively.

Notes

  • Can be specified on object creation
  • Can be modified

Links

int PIN_FLD_ACCT_SUPPRESSED

Used for manual account suppresion. A non-zero value indicates that this billinfo is in suppression state, and thus the bill will be suppressed.

Notes

  • Can be specified on object creation
  • Can be modified

Links

int PIN_FLD_NUM_SUPPRESSED_CYCLES

Current number of consecutive bill suppressions performed on the bill.

Notes

  • Can be specified on object creation
  • Can be modified

Links

int PIN_FLD_SUPPRESSION_CYCLES_LEFT

Counter for number of bills to suppress. Used for Manual Bill Suppression. While the value is positive, the system will suppress the Bill and decrement by one for each bill cycle.

Notes

  • Can be specified on object creation
  • Can be modified

Links

poid PIN_FLD_PAYMENT_EVENT_OBJ

The payment event poid. This will contain the poid of the payment event which resulted from an early full payment.

Notes

  • Can be specified on object creation
  • Can be modified

Links

timestamp PIN_FLD_COLLECTION_DATE

Payment collection date for online/offline payment.

Notes

  • Can be specified on object creation
  • Can be modified

Links

string PIN_FLD_EVENT_POID_LIST

List of cumulative event poids - all events related to this month's billing rollovers.

Notes

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

Links

poid PIN_FLD_BAL_GRP_OBJ

This provides a link to the default balance_group object for this billinfo.

Notes

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

Links

enum PIN_FLD_OBJECT_CACHE_TYPE

Stores the cache residency distinction value for an object instance. Possible values are CACHE_RESIDENCY_TYPE_DEFAULT(0), CACHE_RESIDENCY_TYPE_REALTIME(1), and CACHE_RESIDENCY_TYPE_BATCH(2).

Notes

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

Links

string PIN_FLD_ASSOC_BUS_PROFILE_OBJ_LIST

Link to the /associated_bus_profile object holding to the business profile object for Invoice

Notes

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

Links

string PIN_FLD_UNIQUE_ID

It is a unique identifier which is used as external id

Notes

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

Links



SQL Mapping


Type Field Name Table Column Name
base-class /billinfo billinfo_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_BUSINESS_PROFILE_OBJ business_profile_obj*
string PIN_FLD_BILLINFO_ID bill_info_id
enum PIN_FLD_BILLING_STATE billing_state
enum PIN_FLD_BILLING_STATUS billing_status
int PIN_FLD_BILLING_STATUS_FLAGS billing_status_flags
enum PIN_FLD_STATUS status
int PIN_FLD_STATUS_FLAGS status_flags
poid PIN_FLD_ACCOUNT_OBJ account_obj*
timestamp PIN_FLD_EFFECTIVE_T effective_t
int PIN_FLD_ACTG_CYCLE_DOM actg_cycle_dom
enum PIN_FLD_ACTG_TYPE actg_type
timestamp PIN_FLD_ACTG_LAST_T actg_last_t
timestamp PIN_FLD_ACTG_NEXT_T actg_next_t
timestamp PIN_FLD_ACTG_FUTURE_T actg_future_t
int PIN_FLD_BILL_ACTGCYCLES_LEFT bill_actgcycles_left
int PIN_FLD_BILL_WHEN bill_when
timestamp PIN_FLD_LAST_BILL_T last_bill_t
poid PIN_FLD_LAST_BILL_OBJ last_bill_obj*
timestamp PIN_FLD_ACTUAL_LAST_BILL_T actual_last_bill_t
poid PIN_FLD_ACTUAL_LAST_BILL_OBJ actual_last_bill_obj*
timestamp PIN_FLD_NEXT_BILL_T next_bill_t
poid PIN_FLD_NEXT_BILL_OBJ next_bill_obj*
timestamp PIN_FLD_FUTURE_BILL_T future_bill_t
poid PIN_FLD_BILL_OBJ bill_obj*
int PIN_FLD_CURRENCY currency
int PIN_FLD_CURRENCY_SECONDARY currency_secondary
int PIN_FLD_PARENT_FLAGS parent_flags
int PIN_FLD_SPONSOR_FLAGS sponsor_flags
int PIN_FLD_SPONSOREE_FLAGS sponsoree_flags
decimal PIN_FLD_PENDING_RECV pending_recv
poid PIN_FLD_AR_BILLINFO_OBJ ar_billinfo_obj*
poid PIN_FLD_PARENT_BILLINFO_OBJ parent_billinfo_obj*
poid PIN_FLD_PAYINFO_OBJ payinfo_obj*
enum PIN_FLD_PAY_TYPE pay_type
poid PIN_FLD_SCENARIO_OBJ scenario_obj*
int PIN_FLD_EXEMPT_FROM_COLLECTIONS exempt_from_collections
enum PIN_FLD_BILLING_SEGMENT billing_segment
int PIN_FLD_ACCT_SUPPRESSED account_suppressed
int PIN_FLD_NUM_SUPPRESSED_CYCLES num_suppressed_cycles
int PIN_FLD_SUPPRESSION_CYCLES_LEFT suppression_cycles_left
poid PIN_FLD_PAYMENT_EVENT_OBJ payment_event_obj*
timestamp PIN_FLD_COLLECTION_DATE collection_date
string PIN_FLD_EVENT_POID_LIST event_poid_list
poid PIN_FLD_BAL_GRP_OBJ bal_grp_obj*
enum PIN_FLD_OBJECT_CACHE_TYPE object_cache_type
string PIN_FLD_ASSOC_BUS_PROFILE_OBJ_LIST assoc_bus_profile_obj_list
string PIN_FLD_UNIQUE_ID unique_id
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