Copyright (c) 1996, 2015, Oracle and/or its affiliates. All rights reserved.
This material is the confidential property of Oracle Corporation or its licensors and may be used, reproduced, stored or transmitted only in accordance with a valid Oracle license or sublicense agreement.

Field Index SQL Mapping

Class /history_bills

This object represents a copy of the bill object. It is created when a corrective bill is generated.

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_ACCOUNT_OBJ
poid PIN_FLD_BILL_OBJ
poid PIN_FLD_BILLINFO_OBJ
poid PIN_FLD_AR_BILLINFO_OBJ
poid PIN_FLD_PARENT_BILLINFO_OBJ
poid PIN_FLD_INVOICE_OBJ
string PIN_FLD_BILL_NO
int PIN_FLD_CURRENCY
enum PIN_FLD_CURRENCY_OPERATOR
decimal PIN_FLD_CURRENCY_RATE
int PIN_FLD_CURRENCY_SECONDARY
decimal PIN_FLD_CURRENT_TOTAL
timestamp PIN_FLD_DUE_T
timestamp PIN_FLD_END_T
int PIN_FLD_FLAGS
string PIN_FLD_NAME
poid PIN_FLD_PARENT
decimal PIN_FLD_PREVIOUS_TOTAL
timestamp PIN_FLD_START_T
decimal PIN_FLD_SUBORDS_TOTAL
decimal PIN_FLD_TOTAL_DUE
decimal PIN_FLD_ADJUSTED
decimal PIN_FLD_DISPUTED
decimal PIN_FLD_DUE
decimal PIN_FLD_RECVD
decimal PIN_FLD_WRITEOFF
decimal PIN_FLD_TRANSFERED
array PIN_FLD_INVOICES
string
string
int PIN_FLD_AR_HIERARCHY_SIZE
array PIN_FLD_ITEMS
poid
decimal
poid
timestamp PIN_FLD_CLOSED_T
string PIN_FLD_STATE
timestamp PIN_FLD_LAST_NOTIFICATION_T
string PIN_FLD_LAST_NOTIFICATION_OFFSET


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 bill was created.

Notes

  • Required on object creation
  • Can be modified

Links

poid PIN_FLD_BILL_OBJ

Link to the original bill objectcreated.

Notes

  • Required on object creation
  • Can be modified

Links

poid PIN_FLD_BILLINFO_OBJ

Link to billinfo object for which this bill was created.

Notes

  • Required on object creation
  • Can be modified

Links

poid PIN_FLD_AR_BILLINFO_OBJ

Link to AR billinfo object. It is used for updating of subordinate bill objects for entire hierarchy.

Notes

  • Can be specified on object creation
  • Can be modified

Links

poid PIN_FLD_PARENT_BILLINFO_OBJ

Link to billinfo object for which is one up level in subordinate hierarchy.

Notes

  • Can be specified on object creation
  • Can be modified

Links

poid PIN_FLD_INVOICE_OBJ

Link to corresponding invoice object

Notes

  • Can be specified on object creation
  • Can be modified

Links

string PIN_FLD_BILL_NO

Customer visible bill number. By default, bill numbers are guaranteed sequential. Custom bill numbering is possible via the PCM_OP_BILL_POL_PREP_BILLNO policy. Bill objects for subordinate accounts inherit their bill numbers from the parent bill object.

Notes

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

Links

int PIN_FLD_CURRENCY

Primary currency for the bill. Copied from the primary currency of the account owning the bill.

Notes

  • Can be specified on object creation
  • Can be modified

Links

enum PIN_FLD_CURRENCY_OPERATOR

Defines conversion operator for converting primary currency to secondary currency (muliply or divide).

Notes

  • Can be specified on object creation
  • Can be modified

Links

decimal PIN_FLD_CURRENCY_RATE

Conversion ratio for converting primary currency to secondary currency. Since currency ratios fluctuate, the ratio at bill creation must be recorded so secondary currency amounts can be correctly treated at any time in the future.

Notes

  • Can be specified on object creation
  • Can be modified

Links

int PIN_FLD_CURRENCY_SECONDARY

Secondary currency for the bill. Copied from the secondary currency of the account owning the bill.

Notes

  • Can be specified on object creation
  • Can be modified

Links

decimal PIN_FLD_CURRENT_TOTAL

Total charges from items directly owned by this bill object (charges against the account directly)

Notes

  • Can be specified on object creation
  • Can be modified

Links

timestamp PIN_FLD_DUE_T

Due date of the bill. Calculated at bill processing time based on system configuration. See PIN_FLD_DUE_DOM and PIN_FLD_RELATIVE_DUE_T in /payinfo.

Notes

  • Can be specified on object creation
  • Can be modified

Links

timestamp PIN_FLD_END_T

Date of the end of the billing cycle that this bill represents. Will be zero, until billing is run.

Notes

  • Required on object creation
  • Can be modified

Links

int PIN_FLD_FLAGS

flags, currently used to mark on-demand, bill_now or regular bill type. See pin_bill.h.

Notes

  • Can be specified on object creation
  • Can be modified

Links

string PIN_FLD_NAME

This field besides PIN_FLD_FLAGS helps differentiatebetween Regular,Bill_Now and Bill On Demand Bills.Main possible values are PIN Bill,PIN Bill NOW andPIN Bill On Demand. For additional feature specificvalues please refer pin_bill.h.

Notes

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

Links

poid PIN_FLD_PARENT

Link to parent bill object if this bill is owned by a subordinate account. NULL means owning account was not subordinate when bill processing was run for this bill.

Notes

  • Can be specified on object creation
  • Can be modified

Links

decimal PIN_FLD_PREVIOUS_TOTAL

Amount of A/R from all the previous bills that is still due at the time this bill was processed. Not updated after bill creation.

Notes

  • Can be specified on object creation
  • Can be modified

Links

timestamp PIN_FLD_START_T

Date of the start of the billing cycle that this bill represents.

Notes

  • Required on object creation
  • Can be modified

Links

decimal PIN_FLD_SUBORDS_TOTAL

Total charges from items owned by subordinate bills but rolling up into this bill object (charges against subordinate accounts)

Notes

  • Can be specified on object creation
  • Can be modified

Links

decimal PIN_FLD_TOTAL_DUE

Total amount due for this bill. Calculation of this total depends on the accounting configuration for the account. For bills belonging to subordinate accounts, this field is set to zero.

Notes

  • Can be specified on object creation
  • Can be modified

Links

decimal PIN_FLD_ADJUSTED

Total amount of adjustments that have been made to this bill. Includes both debit and credit adjustments (net). Amount is stored in primary currency.

Notes

  • Can be specified on object creation
  • Can be modified

Links

decimal PIN_FLD_DISPUTED

Total amount of disputes that are currently open against the bill. Amount is stored in primary currency.

Notes

  • Can be specified on object creation
  • Can be modified

Links

decimal PIN_FLD_DUE

Amount still due in this item. Due = Total - adjusted - disputed - recvd + or - transferred. Amount is stored in primary currency.

Notes

  • Can be specified on object creation
  • Can be modified

Links

decimal PIN_FLD_RECVD

Total amount of payments or credits applied against this bill. Amount is stored in primary currency.

Notes

  • Can be specified on object creation
  • Can be modified

Links

decimal PIN_FLD_WRITEOFF

Total amount of write-off applied against this bill. Amount is stored in primary currency.

Notes

  • Can be specified on object creation
  • Can be modified

Links

decimal PIN_FLD_TRANSFERED

Total amount transferred out of this billthis bill. Amount is stored in primary currency.

Notes

  • Can be specified on object creation
  • Can be modified

Links

array PIN_FLD_INVOICES

Reference to bill object's invoice. Invoices contains only one element. Array element id is not significant.

Notes

  • Can be specified on object creation
  • Can be modified

Links

string PIN_FLD_HANDLE

Name and path relative to invoice_dir. Handle is stored in the following format.

Notes

Links

string PIN_FLD_TYPE_STR

Invoice file format type is always set to html.

Notes

Links

int PIN_FLD_AR_HIERARCHY_SIZE

number of subordinate bills under AR bill hierarchy.

Notes

  • Can be specified on object creation
  • Can be modified

Links

array PIN_FLD_ITEMS

This array contains data for the billable items which have been impacted by the AR actions between the previous bill and a current one. Also, the array contains special items which have been allocated to the current bill. The array may exist only for a parent or a single billinfo (but not for a subord billinfo)

Notes

  • Can be specified on object creation
  • Can be modified

Links

poid PIN_FLD_ITEM_OBJ

Poid of the impacted by AR billable items

Notes

Links

decimal PIN_FLD_DELTA_DUE

This amount presents the impact of AR operations which have been allocated to the item between the previous bill and a current one. In order to get the previous value of the PIN_FLD_DUE for the item, the PIN_FLD_DELTA_DUE should be subtracted from the current PIN_FLD_DUE.

Notes

Links

poid PIN_FLD_BILL_OBJ

Pointer to the owner of this item. If the item is a subordinate one then this pointer indicates a subord bill

Notes

Links

timestamp PIN_FLD_CLOSED_T

This will be updated with the date, when the bill was completely paid off.

Notes

  • Can be specified on object creation
  • Can be modified

Links

string PIN_FLD_STATE

field to store bill stateValues: Undefined, New, Inprogress PartiallyPaid, Settled, OnHold Sent, Validated

Notes

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

Links

timestamp PIN_FLD_LAST_NOTIFICATION_T

The last time this object was processed/checked for bill due notification.

Notes

  • Can be specified on object creation
  • Can be modified

Links

string PIN_FLD_LAST_NOTIFICATION_OFFSET

The offset with which the last time this object was processed/checked for bill due notification.

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 /history_bills history_bills_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_BILL_OBJ bill_obj*
poid PIN_FLD_BILLINFO_OBJ billinfo_obj*
poid PIN_FLD_AR_BILLINFO_OBJ ar_billinfo_obj*
poid PIN_FLD_PARENT_BILLINFO_OBJ parent_billinfo_obj*
poid PIN_FLD_INVOICE_OBJ invoice_obj*
string PIN_FLD_BILL_NO bill_no
int PIN_FLD_CURRENCY currency
enum PIN_FLD_CURRENCY_OPERATOR currency_oper
decimal PIN_FLD_CURRENCY_RATE currency_rate
int PIN_FLD_CURRENCY_SECONDARY currency_secondary
decimal PIN_FLD_CURRENT_TOTAL current_total
timestamp PIN_FLD_DUE_T due_t
timestamp PIN_FLD_END_T end_t
int PIN_FLD_FLAGS flags
string PIN_FLD_NAME name
poid PIN_FLD_PARENT parent*
decimal PIN_FLD_PREVIOUS_TOTAL previous_total
timestamp PIN_FLD_START_T start_t
decimal PIN_FLD_SUBORDS_TOTAL subords_total
decimal PIN_FLD_TOTAL_DUE total_due
decimal PIN_FLD_ADJUSTED adjusted
decimal PIN_FLD_DISPUTED disputed
decimal PIN_FLD_DUE due
decimal PIN_FLD_RECVD recvd
decimal PIN_FLD_WRITEOFF writeoff
decimal PIN_FLD_TRANSFERED transferred
array PIN_FLD_INVOICES history_bills_invoices_t
string
PIN_FLD_HANDLE
 		handle
string
PIN_FLD_TYPE_STR
 		type_str
int PIN_FLD_AR_HIERARCHY_SIZE ar_hierarchy_size
array PIN_FLD_ITEMS history_bills_items_t
poid
PIN_FLD_ITEM_OBJ
 		item_obj*
decimal
PIN_FLD_DELTA_DUE
 		delta_due
poid
PIN_FLD_BILL_OBJ
 		bill_obj*
timestamp PIN_FLD_CLOSED_T closed_t
string PIN_FLD_STATE state
timestamp PIN_FLD_LAST_NOTIFICATION_T last_notification_t
string PIN_FLD_LAST_NOTIFICATION_OFFSET last_notification_offset
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