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

Class /invoice

Invoice objects represent invoices. Each bill object can have a corresponding invoice object. Invoice objects can be stored in another database for the purpose of performance improvement.

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
string PIN_FLD_BILL_NO
timestamp PIN_FLD_BILL_DATE_T
int64 PIN_FLD_HEADER_NUM
string PIN_FLD_HEADER_STR
int PIN_FLD_INV_FLAGS
int PIN_FLD_CHECK_SPLIT_FLAGS
array PIN_FLD_STATUSES
enum
timestamp
array PIN_FLD_FORMATS
buffer
int64
decimal
string
string
string
timestamp
enum PIN_FLD_STATUS
poid PIN_FLD_BILLINFO_OBJ
string PIN_FLD_REPORT_NAME
string PIN_FLD_TEMPLATE_NAME
array PIN_FLD_BILLS
timestamp
timestamp
poid
decimal
decimal
decimal
decimal
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

This is a link to the account object for which this object was created.

Notes

  • Required on object creation
  • Can be modified

Links

poid PIN_FLD_BILL_OBJ

This is a link to the bill object for which the invoice is created.

Notes

  • Required on object creation
  • Cannot be modified

Links

string PIN_FLD_BILL_NO

This is the corresponding bill number for the invoice object.

Notes

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

Links

timestamp PIN_FLD_BILL_DATE_T

Time the billing cycle ends, equal toPIN_FLD_END_T in /bill objects

Notes

  • Required on object creation
  • Cannot be modified

Links

int64 PIN_FLD_HEADER_NUM

This is a generic user-definable header number field.

Notes

  • Can be specified on object creation
  • Can be modified

Links

string PIN_FLD_HEADER_STR

This is a generic user-definable header string field.

Notes

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

Links

int PIN_FLD_INV_FLAGS

This is the invoice type, html, xml, xslt, doc1 or plain text.

Notes

  • Can be specified on object creation
  • Can be modified

Links

int PIN_FLD_CHECK_SPLIT_FLAGS

This is split mode of the invoice whether the invoice is consolidated or split : 0 - no split. All parent and subord details are at the parent invoice. 1 - parent invoice has its own details and invoices of subords have their own details.

Notes

  • Can be specified on object creation
  • Can be modified

Links

array PIN_FLD_STATUSES

This holds the statuses for each invoice. Statuses are invoice created, emailed and printed.

Notes

  • Can be specified on object creation
  • Can be modified

Links

enum PIN_FLD_STATUS

The invoice status

Notes

Links

timestamp PIN_FLD_EFFECTIVE_T

This is the time the status becomes effective.

Notes

Links

array PIN_FLD_FORMATS

This array contains the invoice in each format: text/pin_flist, text/xml, text/html, and text/doc1. Each invoice object must be saved in at least one format. The default format is text/pin_flist

Notes

  • Can be specified on object creation
  • Can be modified

Links

buffer PIN_FLD_BUFFER

This holds the content of an invoice in a specific format.

Notes

Links

int64 PIN_FLD_HEADER_NUM

A generic user-definable header number field for each format

Notes

Links

decimal PIN_FLD_INV_SIZE

Invoice Size in KB

Notes

Links

string PIN_FLD_HEADER_STR

A generic user definable header string field for each format

Notes

Links

string PIN_FLD_LOCALE

This holds the preferred locale for invoice. It is used by applicatios. It may be used to drive UI in self-care web pages. The format is Windows NT 3-letter locale code (ISO 639 two letter language and one letter sublanguage). For example for US English the value is ENU.

Notes

Links

string PIN_FLD_TYPE_STR

Invoice file format type string in mime, Default: text/pin_flist

Notes

Links

timestamp PIN_FLD_EFFECTIVE_T

This is the time the status becomes effective.

Notes

Links

enum PIN_FLD_STATUS

Status of the Invoice object whether the Final Invoice Document has been generated or not. Possible values PIN_INV_STATUS_PENDING (0), PIN_INV_STATUS_GENERATED (1), PIN_INV_STATUS_REGENERATED (2), PIN_INV_STATUS_SCHEDULED(3), PIN_INV_STATUS_ERRORED(4), PIN_INV_STATUS_DUPLICATED(5).

Notes

  • Required on object creation
  • Can be modified

Links

poid PIN_FLD_BILLINFO_OBJ

Link to the billinfo object for this Invoice object is created.

Notes

  • Required on object creation
  • Can be modified

Links

string PIN_FLD_REPORT_NAME

Link to the BIP Report Name configured in the report name of Invoicing Business Profile pointed by the billinfo whose invoice is generated.

Notes

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

Links

string PIN_FLD_TEMPLATE_NAME

Link to the template name configured in the template name of Invoicing Business Profile pointed by the billinfo whose invoice is generated.

Notes

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

Links

array PIN_FLD_BILLS

Bill related information for trial billing

Notes

  • Can be specified on object creation
  • Can be modified

Links

timestamp PIN_FLD_START_T

The start_t of bill period

Notes

Links

timestamp PIN_FLD_END_T

The end_t of the bill period

Notes

Links

poid PIN_FLD_AR_BILLINFO_OBJ

Link to AR billinfo object.

Notes

Links

decimal PIN_FLD_DUE

Total charges from items directly owned by this bill

Notes

Links

decimal PIN_FLD_ADJUSTED

Total amount of adjustments that have been made to this bill.

Notes

Links

decimal PIN_FLD_WRITEOFF

Total amount of write-off applied against against the bill.

Notes

Links

decimal PIN_FLD_DISPUTED

Total amount of disputes that are currently open against the bill.

Notes

Links

decimal PIN_FLD_RECVD

Total amount of payments or credits applied against this bill.

Notes

Links



SQL Mapping


PIN_FLD_HEADER_NUM This is a generic user-definable header number field. header_num
PIN_FLD_HEADER_NUM
A generic user-definable header number field for each format header_num_arr
Type Field Name Table Column Name
base-class /invoice invoice_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*
string PIN_FLD_BILL_NO bill_no
timestamp PIN_FLD_BILL_DATE_T bill_date_t
string PIN_FLD_HEADER_STR header_string
int PIN_FLD_INV_FLAGS inv_flags
int PIN_FLD_CHECK_SPLIT_FLAGS check_split_flags
array PIN_FLD_STATUSES invoice_statuses_t
enum
PIN_FLD_STATUS
 		status
timestamp
PIN_FLD_EFFECTIVE_T
 		effective_t
array PIN_FLD_FORMATS invoice_formats_t
buffer
PIN_FLD_BUFFER
 		invoice_formats_buf_t buffer*
decimal
PIN_FLD_INV_SIZE
 		inv_size
string
PIN_FLD_HEADER_STR
 		header_str_arr
string
PIN_FLD_LOCALE
 		locale
string
PIN_FLD_TYPE_STR
 		type_str
timestamp
PIN_FLD_EFFECTIVE_T
 		effective_t
enum PIN_FLD_STATUS status
poid PIN_FLD_BILLINFO_OBJ billinfo_obj*
string PIN_FLD_REPORT_NAME report_name
string PIN_FLD_TEMPLATE_NAME template_name
array PIN_FLD_BILLS invoice_bills_t
timestamp
PIN_FLD_START_T
 		start_t
timestamp
PIN_FLD_END_T
 		end_t
poid
PIN_FLD_AR_BILLINFO_OBJ
 		ar_billinfo_obj*
decimal
PIN_FLD_DUE
 		due
decimal
PIN_FLD_ADJUSTED
 		adjusted
decimal
PIN_FLD_WRITEOFF
 		writeoff
decimal
PIN_FLD_DISPUTED
 		disputed
decimal
PIN_FLD_RECVD
 		recvd
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