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

Class /account

The account object represents a customer in Billing system. It stores information about the customer including addresses and phone numbers. The account object is uniquely identified with its POID. The account POID acts as a key to identify the objects associated with the account, for instance, services, payment methods, balance groups, billinfo's, purchased products and purchased discounts. The account objects can be in a hiararchy, thus allowing an account to become a parent or a child of another account. The account will have a default balance group associated with it. The account status, tax exemptions and locale are also stored as part of the account object. Additional information about account may be captured in one or more profile objects.

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
string PIN_FLD_AAC_ACCESS
string PIN_FLD_AAC_PACKAGE
string PIN_FLD_AAC_PROMO_CODE
string PIN_FLD_AAC_SERIAL_NUM
string PIN_FLD_AAC_SOURCE
string PIN_FLD_AAC_VENDOR
string PIN_FLD_ACCESS_CODE1
string PIN_FLD_ACCESS_CODE2
string PIN_FLD_ACCOUNT_NO
int PIN_FLD_ATTRIBUTE
enum PIN_FLD_ACCOUNT_TYPE
string PIN_FLD_GL_SEGMENT
poid PIN_FLD_BRAND_OBJ
timestamp PIN_FLD_CLOSE_WHEN_T
string PIN_FLD_TIMEZONE_ID
int PIN_FLD_CURRENCY
int PIN_FLD_CURRENCY_SECONDARY
string PIN_FLD_CUSTOMER_SEGMENT_LIST
array PIN_FLD_EXEMPTIONS
decimal
enum
string
timestamp
timestamp
poid PIN_FLD_GROUP_OBJ
buffer PIN_FLD_INTERNAL_NOTES
string PIN_FLD_ITEM_POID_LIST
poid PIN_FLD_BAL_GRP_OBJ
string PIN_FLD_NEXT_ITEM_POID_LIST
string PIN_FLD_LASTSTAT_CMNT
timestamp PIN_FLD_LAST_STATUS_T
string PIN_FLD_LINEAGE
string PIN_FLD_LOCALE
string PIN_FLD_NAME
array PIN_FLD_NAMEINFO
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
enum
array
string
enum
string
poid
string
string
string
enum PIN_FLD_STATUS
int PIN_FLD_STATUS_FLAGS
string PIN_FLD_VAT_CERT
enum PIN_FLD_RESIDENCE_FLAG
enum PIN_FLD_INCORPORATED_FLAG
string PIN_FLD_ACCOUNT_TAG
enum PIN_FLD_BUSINESS_TYPE
timestamp PIN_FLD_EFFECTIVE_T
enum PIN_FLD_OBJECT_CACHE_TYPE


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

string PIN_FLD_AAC_ACCESS

Automatic account creation fields. This is used to track the details of account registration for marketing intelligence. These are typically user-defined.

Notes

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

Links

string PIN_FLD_AAC_PACKAGE

Name of the package used for registration using automatic account creation mechanisms. For example, the name of the package the subscriber used to register into the system.

Notes

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

Links

string PIN_FLD_AAC_PROMO_CODE

Promotion code. This is user-defined to track the details of account registration. For example, the promotion code used identifies the marketing channel which attracted this new subscriber.

Notes

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

Links

string PIN_FLD_AAC_SERIAL_NUM

Serial number used when the user was registered. Typically these serial numbers are pre-authorized by the service provider to allow restricted initial access to the subscriber.

Notes

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

Links

string PIN_FLD_AAC_SOURCE

Source name. This is a user-defined field to track the details of account registration.

Notes

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

Links

string PIN_FLD_AAC_VENDOR

Vendor name. This is a user-defined field to track the details of account registration. This field identifies the vendor through which the subscriber got access to the registration software.

Notes

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

Links

string PIN_FLD_ACCESS_CODE1

Stores a secret word that only the customer would know (mother's maiden name is very common). This provides an authentication test for customer service requests. Even though this field is optional by default, this can be made as a required field by modifying PCM_OP_CUST_POL_PRE_COMMIT policy.

Notes

  • Cannot specify on object creation
  • Can be modified
  • Maximum length is 30 bytes

Links

string PIN_FLD_ACCESS_CODE2

Stores an additional secret word to further authenticate users during a customer service request. Even though this field is optional by default, this can be made as a required field by modifying PCM_OP_CUST_POL_PRE_COMMIT policy.

Notes

  • Cannot specify on object creation
  • Can be modified
  • Maximum length is 30 bytes

Links

string PIN_FLD_ACCOUNT_NO

Customer visible account number (separate from internal account object ID). By default, this is system generated, and derived from account object ID. The custom numbering can be implemented in PCM_OP_CUST_POL_PREP_ACCTINFO policy.

Notes

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

Links

int PIN_FLD_ATTRIBUTE

Attribute field to determine if this is a remittance account or not.

Notes

  • Can be specified on object creation
  • Can be modified

Links

enum PIN_FLD_ACCOUNT_TYPE

Specifier used to determine if an account is a specialtype or normal. Currently, this can be one of thethree values: PIN_ACCOUNT_TYPE_STANDARD(1), PIN_ACCOUNT_TYPE_BRAND(2) or PIN_ACCOUNT_TYPE_SUBSCRIPTION(3). Note that once thisvalue has been set, it cannot be reset.

Notes

  • Required on object creation
  • Cannot be modified

Links

string PIN_FLD_GL_SEGMENT

GL segment this account belongs to. This information is used in the ledger reports to group the accounts based on which GL segment they belong.

Notes

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

Links

poid PIN_FLD_BRAND_OBJ

Reference to the brand account to which an account belongs. This field is managed by the Infranet system, and should not be updated by any apps.

Notes

  • Required on object creation
  • Can be modified

Links

timestamp PIN_FLD_CLOSE_WHEN_T

Date that account should be automatically closed. Used to schedule account closure in advance. A value of 0 indicates that this account has not been set to close automatically.

Notes

  • Cannot specify on object creation
  • Can be modified

Links

string PIN_FLD_TIMEZONE_ID

TimeZone ID associated with the Account as a String.

Notes

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

Links

int PIN_FLD_CURRENCY

Primary currency for account. This is stored as the resource ID of the currency (ISO 4217 standard). All A/R for account is tracked in primary currency.

Notes

  • Cannot specify on object creation
  • Can be modified

Links

int PIN_FLD_CURRENCY_SECONDARY

Secondary currency. A/R can be viewed and payments/disputes/adjustments made in secondary currency, but all impacts are translated to 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

string PIN_FLD_CUSTOMER_SEGMENT_LIST

The string of Customer Segments associated with the account.

Notes

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

Links

array PIN_FLD_EXEMPTIONS

Tax exemptions for this account. The array element-id is not significant.

Notes

  • Can be specified on object creation
  • Can be modified

Links

decimal PIN_FLD_PERCENT

Percentage of the total amount which should be exempted from taxing. This is a fractional number. For example, 0.5 means 50% and 1.0 means 100%.

Notes

Links

enum PIN_FLD_TYPE

Exemption jurisdiction type. Federal (0), State (1), County (2), City (3), Secondary County (4), Secondary City (5), Territory (6), Secondary State (7), District(8), Secondary Federal (9), County District (10), City District (11) and Other (12).

Notes

Links

string PIN_FLD_CERTIFICATE_NUM

Exemption cerificate number. This field indicates the number on an exemption certificate that uniquely identifies the exempt customer. The numbers are assigned by the jurisdiction. Not all jurisdictions require certificate numbers.

Notes

Links

timestamp PIN_FLD_START_T

Inclusive start time of the validity period for the exemption certificate.

Notes

Links

timestamp PIN_FLD_END_T

Non-inclusive end time of the validity period for the exemption certificate.

Notes

Links

poid PIN_FLD_GROUP_OBJ

Link to the billing group object if this account is a parent of a billing group. It is possible that this account itself may be a member of another billing group.

Notes

  • Cannot specify on object creation
  • Can be modified

Links

buffer PIN_FLD_INTERNAL_NOTES

Free form notepad for CSRs to record information about the customer. This field contains a series of entries marked by the name of the CSR and the time of entry.

Notes

  • Can be specified on object creation
  • Can be modified

Links

string PIN_FLD_ITEM_POID_LIST

List of currently active items(account level). This field indicates the charge to the account in the current monthly cycle that may be assigned to the /item/misc. The items that may be stored in the list are /item/misc, /item/sponsor etc.

Notes

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

Links

poid PIN_FLD_BAL_GRP_OBJ

Link to /balance_group object for this account.

Notes

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

Links

string PIN_FLD_NEXT_ITEM_POID_LIST

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

Notes

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

Links

string PIN_FLD_LASTSTAT_CMNT

Descriptive reason for the last status change to this account. This provides CSR a snapshot of why the status was changed.

Notes

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

Links

timestamp PIN_FLD_LAST_STATUS_T

Time that account status was last changed.

Notes

  • Cannot specify on object creation
  • Can be modified

Links

string PIN_FLD_LINEAGE

Stores a snapshot of an account in a hierarchy. This is primarily designed to be a field by which accounts and and data tied to accounts can be searched through quickly.

Notes

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

Links

string PIN_FLD_LOCALE

Preferred locale for account. This field is used by Billing system applications. This may be used to drive UI in self-care web pages. The format is based on ISO 639 which is a 3 letter locale code, first two letters indicate the language and the third letter indicates the sub-language. For example, the locale code for US English is ENU.

Notes

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

Links

string PIN_FLD_NAME

OBSOLETE FIELD. NOT USED ANYMORE.

Notes

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

Links

array PIN_FLD_NAMEINFO

Contact information for account. This array contains any number of contacts with the description for the type of contact. The element-id is not significant except for the billing contact (1) and mailing contact (2). The element-id's 3-100 are reserved.

Notes

  • Can be specified on object creation
  • Can be modified

Links

string PIN_FLD_ADDRESS

Street address of the contact. The street address can have multiple lines. The Multiple lines can be stored with newline separator.

Notes

Links

string PIN_FLD_CANON_COMPANY

Canonical version of Company field. This is System controlled, used to improve matching for searches on Company. The locale specified in PIN_FLD_LOCALE is used for canonicalization.

Notes

Links

string PIN_FLD_CANON_COUNTRY

Canonical version of Country field. This is System controlled, used to improve matching for searches on Country. WorldTax package is used for canonicalization.

Notes

Links

string PIN_FLD_CITY

City portion of the contact's address.

Notes

Links

string PIN_FLD_COMPANY

Company represented by the contact.

Notes

Links

string PIN_FLD_CONTACT_TYPE

Description of type of contact. Some values are recognized by system - 'billing', 'mailing'. Other values are user configurable.

Notes

Links

string PIN_FLD_COUNTRY

Country portion of the contact's address.

Notes

Links

string PIN_FLD_EMAIL_ADDR

Email address for the contact.

Notes

Links

string PIN_FLD_FIRST_CANON

Canonical version of First Name field. This is System controlled, used to improve matching for searches on name. The locale specified in PIN_FLD_LOCALE is used for canonicalization.

Notes

Links

string PIN_FLD_FIRST_NAME

First name of the contact.

Notes

Links

string PIN_FLD_LAST_CANON

Canonical version of Last Name field. This is System controlled, used to improve matching for searches on name. The locale specified in PIN_FLD_LOCALE is used for canonicalization.

Notes

Links

string PIN_FLD_LAST_NAME

Last name of the contact.

Notes

Links

string PIN_FLD_MIDDLE_CANON

Canonical version of Middle Name field. This is System controlled, used to improve matching for searches on name. The locale specified in PIN_FLD_LOCALE is used for canonicalization.

Notes

Links

string PIN_FLD_MIDDLE_NAME

Middle name of the contact.

Notes

Links

string PIN_FLD_GEOCODE

Tax engine specific GeoCode of the address used for taxation

Notes

Links

enum PIN_FLD_TAXPKG_TYPE

Indicators of the Tax Engine used in the system. For example, value of 0 indicates custom tax, 1 indicates Taxware Sales, 2 indicates Taxware WorldTax, 3 indicates Vertex Quantum, 4 indicates CommTax21 .

Notes

Links

array PIN_FLD_PHONES

Array of phone numbers for this contact. Each number has a type description, and any number of elements can be stored for a contact. Array element-id's are not significant.

Notes

Links

string PIN_FLD_PHONE

Phone number. By default, format is limited to TAPI and validated using the PCM_OP_CUST_POL_VALID_NAMEINFO policy.

Notes

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

Links

enum PIN_FLD_TYPE

Phone types defined by Infranet are Home (1), Work (2), Fax (3), Pager (3), Portable (4), POP (5), Support (6).

Notes

  • Required on object creation
  • Can be modified

Links

string PIN_FLD_SALUTATION

Salutation for the contact name.

Notes

Links

poid PIN_FLD_SERVICE_OBJ

Link to the service object that this contact element represents. Reserved for future use.

Notes

Links

string PIN_FLD_STATE

State or Province portion of the contact's address.

Notes

Links

string PIN_FLD_TITLE

Job title of the contact.

Notes

Links

string PIN_FLD_ZIP

Zip code or postal code portion of the contact's address.

Notes

Links

enum PIN_FLD_STATUS

Status of the account. The values are defunct (0), active (10100), inactive (10102) and closed (10103). Typically user access to services is blocked unless active (policy controlled).

Notes

  • Cannot specify on object creation
  • Can be modified

Links

int PIN_FLD_STATUS_FLAGS

System and user-defined modifier flags to track the reasons for the account being inactive. See pin_cust.h for possible values.

Notes

  • Cannot specify on object creation
  • Can be modified

Links

string PIN_FLD_VAT_CERT

Buyer's VAT certificate for VAT registered companies. This is typically used with business accounts outside the USA. An account with a buyer VAT is not charged taxes by the taxing package. It is the responsibility of this account to pay taxes directly.

Notes

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

Links

enum PIN_FLD_RESIDENCE_FLAG

Flag that identifies the customer being taxed as a Residential (0) customer or as a Business customer (1). Some taxes apply to business or residential customers only, and this flag is used to determine whether a particular tax should be calculated, depending on the type of customer.

Notes

  • Can be specified on object creation
  • Can be modified

Links

enum PIN_FLD_INCORPORATED_FLAG

Flag that indicates whether the address (or GeoCode) for an account specifies an area Inside (0) or Outside (1) the incorporated area of the city. This determines whether county or city taxes apply.

Notes

  • Can be specified on object creation
  • Can be modified

Links

string PIN_FLD_ACCOUNT_TAG

OBSOLETE FIELD. NOT USED ANYMORE. DO NOT POPULATE VALUE FOR THIS FIELD.

Notes

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

Links

enum PIN_FLD_BUSINESS_TYPE

Enumeration used to identify the type of account. Currently there are two business types, consumer (1) or business (2). This allows for the policy validation decisions to be based on the account type.

Notes

  • Can be specified on object creation
  • Can be modified

Links

timestamp PIN_FLD_EFFECTIVE_T

Effective time of modification of this account on an external system.

Notes

  • Can be specified on object creation
  • Can be modified

Links

enum PIN_FLD_OBJECT_CACHE_TYPE

Stores the cache residency distinction value for an object instance. The possible values are DEFAULT(0), REALTIME(1) and BATCH(2).

Notes

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

Links



SQL Mapping


Type Field Name Table Column Name
base-class /account account_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
string PIN_FLD_AAC_ACCESS aac_access
string PIN_FLD_AAC_PACKAGE aac_package
string PIN_FLD_AAC_PROMO_CODE aac_promo_code
string PIN_FLD_AAC_SERIAL_NUM aac_serial_num
string PIN_FLD_AAC_SOURCE aac_source
string PIN_FLD_AAC_VENDOR aac_vendor
string PIN_FLD_ACCESS_CODE1 access_code1
string PIN_FLD_ACCESS_CODE2 access_code2
string PIN_FLD_ACCOUNT_NO account_no
int PIN_FLD_ATTRIBUTE attribute
enum PIN_FLD_ACCOUNT_TYPE account_type
string PIN_FLD_GL_SEGMENT gl_segment
poid PIN_FLD_BRAND_OBJ brand_obj*
timestamp PIN_FLD_CLOSE_WHEN_T close_when_t
string PIN_FLD_TIMEZONE_ID timezone_id
int PIN_FLD_CURRENCY currency
int PIN_FLD_CURRENCY_SECONDARY currency_secondary
string PIN_FLD_CUSTOMER_SEGMENT_LIST cust_seg_list
array PIN_FLD_EXEMPTIONS account_exemptions_t
decimal
PIN_FLD_PERCENT
 		percent
enum
PIN_FLD_TYPE
 		type
string
PIN_FLD_CERTIFICATE_NUM
 		certificate_num
timestamp
PIN_FLD_START_T
 		exempt_start_t
timestamp
PIN_FLD_END_T
 		exempt_end_t
poid PIN_FLD_GROUP_OBJ group_obj*
buffer PIN_FLD_INTERNAL_NOTES account_internal_notes_buf internal_notes*
string PIN_FLD_ITEM_POID_LIST item_poid_list
poid PIN_FLD_BAL_GRP_OBJ bal_grp_obj*
string PIN_FLD_NEXT_ITEM_POID_LIST next_item_poid_list
string PIN_FLD_LASTSTAT_CMNT laststat_cmnt
timestamp PIN_FLD_LAST_STATUS_T last_status_t
string PIN_FLD_LINEAGE lineage
string PIN_FLD_LOCALE locale
string PIN_FLD_NAME name
array PIN_FLD_NAMEINFO account_nameinfo_t
string
PIN_FLD_ADDRESS
 		address
string
PIN_FLD_CANON_COMPANY
 		canon_company
string
PIN_FLD_CANON_COUNTRY
 		canon_country
string
PIN_FLD_CITY
 		city
string
PIN_FLD_COMPANY
 		company
string
PIN_FLD_CONTACT_TYPE
 		contact_type
string
PIN_FLD_COUNTRY
 		country
string
PIN_FLD_EMAIL_ADDR
 		email_addr
string
PIN_FLD_FIRST_CANON
 		first_canon
string
PIN_FLD_FIRST_NAME
 		first_name
string
PIN_FLD_LAST_CANON
 		last_canon
string
PIN_FLD_LAST_NAME
 		last_name
string
PIN_FLD_MIDDLE_CANON
 		middle_canon
string
PIN_FLD_MIDDLE_NAME
 		middle_name
string
PIN_FLD_GEOCODE
 		geocode
enum
PIN_FLD_TAXPKG_TYPE
 		taxpkg_type
array
PIN_FLD_PHONES
 		account_phones_t
string
PIN_FLD_PHONE
phone
enum
PIN_FLD_TYPE
type
string
PIN_FLD_SALUTATION
 		salutation
poid
PIN_FLD_SERVICE_OBJ
 		service_obj*
string
PIN_FLD_STATE
 		state
string
PIN_FLD_TITLE
 		title
string
PIN_FLD_ZIP
 		zip
enum PIN_FLD_STATUS status
int PIN_FLD_STATUS_FLAGS status_flags
string PIN_FLD_VAT_CERT vat_cert
enum PIN_FLD_RESIDENCE_FLAG residence_flag
enum PIN_FLD_INCORPORATED_FLAG incorporated_flag
string PIN_FLD_ACCOUNT_TAG account_tag
enum PIN_FLD_BUSINESS_TYPE business_type
timestamp PIN_FLD_EFFECTIVE_T effective_t
enum PIN_FLD_OBJECT_CACHE_TYPE object_cache_type
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