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

Class /agreement

Agreement object associated with accounts.

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
string PIN_FLD_NAME
string PIN_FLD_AGREEMENT_ID
int PIN_FLD_VERSION_ID
timestamp PIN_FLD_START_T
timestamp PIN_FLD_END_T
timestamp PIN_FLD_INITIALIZE_T
timestamp PIN_FLD_COMPLETED_T
timestamp PIN_FLD_CLOSED_T
timestamp PIN_FLD_EFFECTIVE_T
timestamp PIN_FLD_PLAN_END_T
string PIN_FLD_DESCR
string PIN_FLD_DOC_NO
string PIN_FLD_URL
int PIN_FLD_LIFECYCLE_STATE
enum PIN_FLD_STATUS
array PIN_FLD_AGREEMENT_ITEMS
poid
poid
array
string
string
array PIN_FLD_PROFILES
poid


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

Reference to the root account object.

Notes

  • Required on object creation
  • Can be modified

Links

string PIN_FLD_NAME

Name of the agreement.

Notes

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

Links

string PIN_FLD_AGREEMENT_ID

External agreement identifier.

Notes

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

Links

int PIN_FLD_VERSION_ID

Version ID of the agreement.

Notes

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

Links

timestamp PIN_FLD_START_T

Start time of the agreement.

Notes

  • Required on object creation
  • Can be modified

Links

timestamp PIN_FLD_END_T

End time of the agreement.

Notes

  • Required on object creation
  • Can be modified

Links

timestamp PIN_FLD_INITIALIZE_T

Initialization time of the agreement.

Notes

  • Can be specified on object creation
  • Can be modified

Links

timestamp PIN_FLD_COMPLETED_T

Completion time of the agreement.

Notes

  • Can be specified on object creation
  • Can be modified

Links

timestamp PIN_FLD_CLOSED_T

Closed time of the agreement.

Notes

  • Can be specified on object creation
  • Can be modified

Links

timestamp PIN_FLD_EFFECTIVE_T

Effective time of the agreement.

Notes

  • Required on object creation
  • Can be modified

Links

timestamp PIN_FLD_PLAN_END_T

Planned end time of the agreement.

Notes

  • Can be specified on object creation
  • Can be modified

Links

string PIN_FLD_DESCR

Description of the agreement.

Notes

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

Links

string PIN_FLD_DOC_NO

Document ID associated with the agreement.

Notes

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

Links

string PIN_FLD_URL

Store customer document URL.

Notes

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

Links

int PIN_FLD_LIFECYCLE_STATE

Agreement lifecycle state e.g. 101 Draft, 102 Inactive, 103 Active, 104 Closed.

Notes

  • Required on object creation
  • Can be modified

Links

enum PIN_FLD_STATUS

Status of the account. The values are defunct (0), active (10100), inactive (10102) and closed (10103).

Notes

  • Required on object creation
  • Can be modified

Links

array PIN_FLD_AGREEMENT_ITEMS

Array of agreement items.

Notes

  • Can be specified on object creation
  • Can be modified

Links

poid PIN_FLD_PRODUCT_OBJ

POID of the product or discount object.

Notes

Links

poid PIN_FLD_OFFERING_OVERRIDE_VALUES_OBJ

POID of agreement override values.

Notes

Links

array PIN_FLD_ATTRIBUTES

Attributes array

Notes

Links

string PIN_FLD_NAME

Attribute name (e.g., 'Cycle Charge Type').

Notes

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

Links

string PIN_FLD_VALUE

Attribute value (e.g., 'Cycle Forward').

Notes

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

Links

array PIN_FLD_PROFILES

Array of profiles associated with the agreement.

Notes

  • Can be specified on object creation
  • Can be modified

Links

poid PIN_FLD_PROFILE_OBJ

POID of profile object.

Notes

Links



SQL Mapping


Type Field Name Table Column Name
base-class /agreement agreement_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*
string PIN_FLD_NAME name
string PIN_FLD_AGREEMENT_ID agreement_id
int PIN_FLD_VERSION_ID version_id
timestamp PIN_FLD_START_T start_t
timestamp PIN_FLD_END_T end_t
timestamp PIN_FLD_INITIALIZE_T initialize_t
timestamp PIN_FLD_COMPLETED_T completed_t
timestamp PIN_FLD_CLOSED_T closed_t
timestamp PIN_FLD_EFFECTIVE_T effective_t
timestamp PIN_FLD_PLAN_END_T plan_end_t
string PIN_FLD_DESCR descr
string PIN_FLD_DOC_NO doc_id
string PIN_FLD_URL url
int PIN_FLD_LIFECYCLE_STATE lifecycle_state
enum PIN_FLD_STATUS status
array PIN_FLD_AGREEMENT_ITEMS agreement_items_t
poid
PIN_FLD_PRODUCT_OBJ
 		product_obj*
poid
PIN_FLD_OFFERING_OVERRIDE_VALUES_OBJ
 		offer_override_val_obj*
array
PIN_FLD_ATTRIBUTES
 		agreement_item_attr_t
string
PIN_FLD_NAME
attr_name
string
PIN_FLD_VALUE
attr_value
array PIN_FLD_PROFILES agreement_profiles_t
poid
PIN_FLD_PROFILE_OBJ
 		profiles_obj*
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