[Home] [Help]
[Dependency Information]
Object Name: | OKS_K_HEADERS_B |
---|---|
Object Type: | TABLE |
Owner: | OKS |
FND Design Data: | ![]() |
Subobject Name: | |
Status: | VALID |
Records are created in OKS_K_HEADERS_B for Service Agreements, Subscription agreements, Warranty and Extended Warranty contracts from any of the following sources
Service Contracts Authoring Form :
Order Management and IB Integration
Contract Renewal process
Copy Contract
Data specific to service contracts is stored in OKS_K_HEADERS_B. It can be broadly classified into
Renewal attributes
Revenue estimation
Header billing attributes.
Tax related information
Payment methods
Table OKS_K_HEADERS_B is an extension of table OKC_K_HEADERS_B. There is a one to one mandatory relationship between OKC_K_HEADERS_B and OKS_K_HEADERS_B. Column CHR_ID of OKS_K_HEADERS_B maps to column ID of OKC_K_HEADERS_B.ID.
OKS_K_HEADERS_B.chr_id = OKC_K_HEADERS_B.id
Tablespace: | ![]() |
---|---|
PCT Free: | 10 |
PCT Used: |
Index | Type | Uniqueness | Tablespace | Column |
---|---|---|---|---|
OKS_K_HEADERS_B_U1 | NORMAL | UNIQUE |
![]() |
![]() |
OKS_K_HEADERS_B_U2 | NORMAL | UNIQUE |
![]() |
![]() |
OKS_K_HEADERS_B_N1 | NORMAL | NONUNIQUE |
![]() |
![]() |
OKS_K_HEADERS_B_N2 | NORMAL | NONUNIQUE |
![]() |
![]() |
OKS_K_HEADERS_B_N3 | NORMAL | NONUNIQUE |
![]() |
![]() |
OKS_K_HEADERS_B_N4 | NORMAL | NONUNIQUE |
![]() |
![]() |
OKS_K_HEADERS_B_N5 | NORMAL | NONUNIQUE |
![]() |
![]() |
Name | Datatype | Length | Mandatory | Comments |
---|---|---|---|---|
ID | NUMBER | Yes | Unique identifier for Service Contract Header in OKS_K_HEADERS_B | |
CHR_ID | NUMBER | Yes | Unique Identifier for Contract Header | |
ACCT_RULE_ID | NUMBER | Revenue recognition rule identifier. References RA_RULES.RULE_ID | ||
PAYMENT_TYPE | VARCHAR2 | (30) | This column stores Payment MethodValid values are 'CCR': 'Credit Card''COM'. 'Commitment'References FND_LOOKUPS, where LOOKUP_TYPE = "OKS_PAYMENT_METHODS" | |
CC_NO | VARCHAR2 | (80) | No longer used as the credit card details are stored in iPayments schema. | |
CC_EXPIRY_DATE | DATE | No longer used as the credit card details are stored in iPayments schema. | ||
CC_BANK_ACCT_ID | NUMBER | No longer used as the credit card details are stored in iPayments schema. | ||
CC_AUTH_CODE | VARCHAR2 | (150) | Credit Card Authorization Code is retrieved from iPayment while authorizing the amount. This is populated at the time of QA Check. | |
COMMITMENT_ID | NUMBER | If Payment Type is Commitment number, then commitment id is stored in this Column. References RA_CUSTOMER_TRX_ALL.CUSTOMER_TRX_ID | ||
GRACE_DURATION | NUMBER | The length of time an expired contract can still be eligible for Entitlement.This value is valid only for Service, Warranty and Extended Warranty contract lines. | ||
GRACE_PERIOD | VARCHAR2 | (30) | Time Period for GRACE_DURATION. References MTL_UNITS_OF_MEASURE_TL.UOM_CODE | |
EST_REV_PERCENT | NUMBER | Estimated percentage value of a contract that a Salesrep expects/foresees, to close the deal | ||
EST_REV_DATE | DATE | Date on which Estimated Revenue percentage was entered | ||
TAX_AMOUNT | NUMBER | This is the total tax incurred for the contract. | ||
TAX_STATUS | VARCHAR2 | (30) | This column indicates the valid tax statuses e.g. Standard, Exemp, Require etc. This references FND_LOOKUPS.LOOKUP_CODE, where LOOKUP_TYPE = 'ZX_EXEMPTION_CONTROL' | |
TAX_CODE | NUMBER | Not Used | ||
TAX_EXEMPTION_ID | NUMBER | This is no longer used as the new columns EXEMPT_CERTIFICATE_NUMBER and EXEMPT_REASON_CODE store all exemption related information. | ||
BILLING_PROFILE_ID | NUMBER | Unique identifier for specifying the billing profile which will be used at the time of Contract Renewal. References OKS_BILLING_PROFILES_B.ID | ||
RENEWAL_STATUS | VARCHAR2 | (30) | Stores the state in which the contract is currently in during the negotiation phase i.e. before it is approved. Once the contract is approved, the column is set to 'COMPLETE'. References FND_LOOKUPS.LOOKUP_CODE, where LOOKUP_TYPE = 'OKS_AUTO_RENEW_STATUS'. | |
ELECTRONIC_RENEWAL_FLAG | VARCHAR2 | (1) | No longer used as a new renewal type of ERN (Electronic renewal) has been introduced. | |
QUOTE_TO_CONTACT_ID | NUMBER | Holds customer account contact id to which the Quote letter will be sent, at the time of renewal. References HZ_CUST_ACCOUNTS.CUST_ACCOUNT_ROLE_ID | ||
QUOTE_TO_SITE_ID | NUMBER | This column is used to store the Site id associated with Customer Account ID stored in OKS_K_HEADERS_B.QUOTE_TO_CONTACT_ID.. References HZ_CUST_ACCOUNTS.CUST_ACCT_SITE_ID | ||
QUOTE_TO_EMAIL_ID | NUMBER | This column is used to store the email address associated with Customer Account ID stored in OKS_K_HEADERS_B.QUOTE_TO_CONTACT_ID. References HZ_CONTACT_POINTS.CONTACT_POINT_ID where HZ_CONTACT_POINTS.CONTACT_POINT_TYPE = 'EMAIL' | ||
QUOTE_TO_PHONE_ID | NUMBER | This column is used to store phone number of the contact point. Associated with Customer Account ID stored in OKS_K_HEADERS_B.QUOTE_TO_CONTACT_ID. References HZ_CONTACT_POINTS.CONTACT_POINT_ID Where HZ_CONTACT_POINTS.CONTACT_POINT_ID = 'PHONE' | ||
QUOTE_TO_FAX_ID | NUMBER | This column is used to store phone number of the contact point. Associated with Customer Account ID stored in OKS_K_HEADERS_B.QUOTE_TO_CONTACT_ID. References HZ_CONTACT_POINTS.CONTACT_POINT_ID Where HZ_CONTACT_POINTS.CONTACT_POINT_ID = 'FAX' | ||
RENEWAL_PO_REQUIRED | VARCHAR2 | (1) | Valid values are 'Y' and 'N'.If this flag is set to 'Y', the renewal process will look for PO number at the time of Contract renewal. If renewal process does not find a PO number, QA check will fail. | |
RENEWAL_PO_NUMBER | VARCHAR2 | (240) | Customer Purchase order Number, used at the time of Contract Renewal. In the renewed contract, this value gets copied to OKC_K_HEADERS_B.CUST_PO_NUMBER & to OKS_K_HEADERS_B.RENEWAL_PO_NUMBER | |
RENEWAL_PRICE_LIST | NUMBER | Stores Price list id for renewal. This is required if RENEWAL_PRICING_TYPE is 'LST'. References QP_LIST_HEADERS.LIST_HEADER_ID. | ||
RENEWAL_PRICING_TYPE | VARCHAR2 | (30) | Holds the pricing methods at time of renewal. Based upon the value of this column, the contract price (Total value) is calculated differently.Valid Values are'LST': Makes OKS_K_HEADERS_B.RENEWAL_PRICE_LIST mandatory. OKS_K_HEADERS_B.RENEWAL_PRICE_LIST is used to price the contract at the time of renewal.'MAN': Contract will not be priced at the time of renewal. User will have to open the renewed contract and manually price it.'PCT': Makes RENEWAL_MARKUP_PERCENT mandatory. At the time of contract renewal, the original contract's value is marked up or down by the percentage value stored in RENEWAL_MARKUP_PERCENT. At the same time, the renewed contract is also priced using price list stored in OKS_K_HEADERS_B.RENEWAL_PRICE_LIST or OKC_K_HEADERS_B.PRICE_LIST_ID.Value of the renewed contract is set to be the minimum of the two Contract values computed as mentioned above | |
RENEWAL_MARKUP_PERCENT | NUMBER | Stores percentage value by which a Contract will be marked up or down, at the time of renewalThis column is mandatory if RENEWAL_PRICING_TYPE is 'PCT' | ||
RENEWAL_GRACE_DURATION | NUMBER | Grace duration for entitlements that will be set for the renewed contract, when the current contract is renewed. This value is valid only for Service, Warranty and Extended Warranty contract lines. | ||
RENEWAL_GRACE_PERIOD | VARCHAR2 | (30) | Time Period for RENEWAL_GRACE_DURATION. References MTL_UNITS_OF_MEASURE_TL.UOM_CODE) | |
RENEWAL_EST_REV_PERCENT | NUMBER | Value defined in this column gets copied to column EST_REV_PERCENT, in the renewed contract | ||
RENEWAL_EST_REV_DURATION | NUMBER | Value defined in this column becomes the Estimated Revenue duration, in the renewed contract | ||
RENEWAL_EST_REV_PERIOD | VARCHAR2 | (30) | Value defined in this column becomes the Estimated Revenue period, in the renewed contract | |
RENEWAL_PRICE_LIST_USED | NUMBER | Renewal History - Value in column RENEWAL_PRICE_LIST of the original contract is copied to this column, after renewal. | ||
RENEWAL_TYPE_USED | VARCHAR2 | (30) | Renewal History - Value in column OKC_K_HEADERS_B.RENEWAL_TYPE_USED of the original contract is copied to this column, after renewal. | |
RENEWAL_NOTIFICATION_TO | NUMBER | This column holds the user_id notified in the case of Renewals. This user corresponds to the salesrep or the helpdesk (if salesrep is not found in the contract) specified in Global Contract Defaults. References FND_USER.USER_ID. | ||
RENEWAL_PO_USED | VARCHAR2 | (1) | Renewal History - Value in column RENEWAL_PO_NUMBER of the original contract is copied to this column, after renewal. | |
RENEWAL_PRICING_TYPE_USED | VARCHAR2 | (30) | Renewal History - Value in column RENEWAL_PRICING_TYPE of the original contract is copied to this column, after renewal. | |
RENEWAL_MARKUP_PERCENT_USED | NUMBER | Renewal History - Markup Percent used at the time of contract renewal | ||
REV_EST_PERCENT_USED | NUMBER | Renewal History - Value in column RENEWAL_EST_PERCENT of the original contract is copied to this column, after renewal. | ||
REV_EST_DURATION_USED | NUMBER | Renewal History - Value in column RENEWAL_EST_DURATION of the original contract is copied to this column, after renewal. | ||
REV_EST_PERIOD_USED | VARCHAR2 | (30) | Renewal History - Value in column RENEWAL_EST_PERIOD of the original contract is copied to this column, after renewal. | |
BILLING_PROFILE_USED | NUMBER | Renewal History - Value in column BILLING_PROFILE_ID of the original contract is copied to this column, after contract renewal. | ||
ERN_FLAG_USED_YN | VARCHAR2 | (1) | This column is no longer used. Renewal Type Used column will hold 'ERN' if Electronic renewal is used. | |
EVN_THRESHOLD_AMT | NUMBER | Stores the upper limit of the contract value under which a contract will be treated as an 'Evergreen' contract during renewals. If the derived renewal type (from Contract or GCD) is 'EVN' or the contract value is less than 'Evergreen Threshold Amount' of Global Contracts Defaults form, the contract will be marked as Evergreen contract. This column will be updated with Evergreen threshold amount defined in Global Contracts Defaults form during renewal | ||
EVN_THRESHOLD_CUR | VARCHAR2 | (30) | Currency code for the Evergreen threshold amount. Used in conjunction with EVN_THRESHOLD_AMT. | |
ERN_THRESHOLD_AMT | NUMBER | Stores the upper limit of the contract value under which a contract will be considered for Electronic renewals. If the renewal type (derived from Contract or Global Contract Defaults) is derived as 'ERN' or the contract value is less than 'Electronic renewals Threshold Amount' of Global Contracts Defaults , the contract will be considered for Electronic renewals. This column will be updated with Electronic renewals threshold amount defined in Global Contracts Defaults form during renewal. | ||
ERN_THRESHOLD_CUR | VARCHAR2 | (30) | Currency Code for Electronic renewals threshold amount. Used in conjunction with ERN_THRESHOLD_AMT. | |
RENEWAL_GRACE_DURATION_USED | NUMBER | Renewal History - Value in column RENEWAL_GRACE_DURATION of the original contract is copied to this column, after renewal. | ||
RENEWAL_GRACE_PERIOD_USED | VARCHAR2 | (30) | Renewal History - Value in column RENEWAL_GRACE_PERIOD of the original contract is copied to this column, after renewal | |
INV_TRX_TYPE | VARCHAR2 | (30) | Stores the transaction type name for invoices and credit memos. References RA_CUSTOMER_TRX_TYPES_ALL.NAME | |
INV_PRINT_PROFILE | VARCHAR2 | (1) | Not used | |
AR_INTERFACE_YN | VARCHAR2 | (1) | Valid values are 'Y' and 'N'. 'Y' indicates transactions must be interfaced to Accounts Receivables | |
HOLD_BILLING | VARCHAR2 | (1) | Valid values are 'Y' and 'N'. 'Y' indicates to hold the credit till next billing cycle (Hold Credit functionality). | |
SUMMARY_TRX_YN | VARCHAR2 | (1) | Valid values are 'Y' or 'N'.If this column is set to 'Y', billing transactions of contract lines are interfaced to AR. 'N' indicates, billing transactions of Contract sub lines are interfaced to AR | |
SERVICE_PO_NUMBER | VARCHAR2 | (240) | Valid values are 'Y' or 'N'. IF it is 'Y' then a PO number is essential for creating a Service Request. | |
SERVICE_PO_REQUIRED | VARCHAR2 | (1) | This is the PO Number, which will be used by Service Request charges. IT is irrespective of whether SERVICE_PO_REQUIRED is 'Y' or 'N' | |
BILLING_SCHEDULE_TYPE | VARCHAR2 | (10) | Valid values are 'E': 'Equal Amount' -Billing Schedule is created for contract line and is instantiated to sub lines. Effectivity of Contract line and sub line must be the same.'T': 'Top Level' - Billing Schedule is created for contract line and is instantiated to sub lines. . Effectivity of Contract line and sub line need not be the same.'P': 'Covered Level' - Billing Schedule is created for contract sub line. User specifies billing amount for the billing period.Reference FND_LOOKUPS where lookup_type = 'OKS_BILLSCH_LEVEL' | |
OBJECT_VERSION_NUMBER | NUMBER | Yes | Sequential number set at 1 on insert and incremented on update. Used by APIs to ensure current record is passed | |
SECURITY_GROUP_ID | NUMBER | Used to create a Virtual Private Database, which was originally designed to be used by Hosting services. Now obsolete | ||
REQUEST_ID | NUMBER | Unique Identifier of a concurrent request | ||
CREATED_BY | NUMBER | (15) | Yes | Standard who column |
CREATION_DATE | DATE | Yes | Standard who column | |
LAST_UPDATED_BY | NUMBER | (15) | Yes | Standard who column |
LAST_UPDATE_DATE | DATE | Yes | Standard who column | |
LAST_UPDATE_LOGIN | NUMBER | (15) | Standard who column | |
FOLLOW_UP_ACTION | VARCHAR2 | (30) | This column stores the action that the salesrep needs to follow up with the customer or internally e.g. Call Customer. References FND_LOOKUP_VALUES.LOOKUP_CODE where LOOKUP_TYPE='OKS_FOLLOWUP_ACTION' | |
FOLLOW_UP_DATE | DATE | The date by which the salesrep needs to follow up. | ||
TRXN_EXTENSION_ID | NUMBER | This column stores the transaction id for the credit card transactions stored in iPayments schema. References IBY_FNDCPT_TX_EXTENSIONS.TRXN_EXTENSION_ID. | ||
DATE_ACCEPTED | DATE | The date on which the customer accepted the contract. | ||
ACCEPTED_BY | NUMBER | The person who accepted the contract i.e. the customer for on-line acceptance or any vendor side user accepting on behalf of the customer by submitting for approval. | ||
RMNDR_SUPPRESS_FLAG | VARCHAR2 | (1) | This is set by the salesrep to reminder notice being sent to the customer by the auto-reminder process. Valid values are 'Y' or 'N'. | |
RMNDR_SENT_FLAG | VARCHAR2 | (1) | This flag indicates if any reminder notice is sent to the customer for acceptance. Valid values are 'Y' or 'N'. | |
QUOTE_SENT_FLAG | VARCHAR2 | (1) | This flag indicates if an on-line quote is sent to the customer for acceptance. Valid values are 'Y' or 'N'. | |
PROCESS_REQUEST_ID | NUMBER | This column stores the request ids for email customer or QA check concurrent processes. These requests can be monitored from the Service Contracts workbench. | ||
WF_ITEM_KEY | VARCHAR2 | (240) | This column stores the item key for the contract process (item type=OKSKPRCS) workflow. It is a concatenation of the contract id and the timestamp in YYYYMMDDHHMISS format. | |
PERIOD_START | VARCHAR2 | (30) | Partial Period attribute that defines how partial periods are calculated. 'Service Start' - count full periods from service start date, then partial period at end.'Calendar Month Start' - count full periods based on full calendar months that span the duration. Partial period can occur at beginning of duration, end of duration, or at both beginning and end of the duration. | |
PERIOD_TYPE | VARCHAR2 | (10) | Partial Period attribute represents type of period i.e. Fixed or Actual. While calculating partial periods, 'Fixed' type divides number of days in partial period by 30 days all months, 'Actual' the divides with actual number days in the calendar month. | |
PRICE_UOM | VARCHAR2 | (10) | Partial Periods Computation - Price UOM used for partial period computation | |
PERSON_PARTY_ID | NUMBER | This is the party id of the person who is marked as the quote to contact for the contract. References HZ_PARTIES.PARTY_ID. | ||
TAX_CLASSIFICATION_CODE | VARCHAR2 | (50) | This column stores the tax codes e.g. Exempt, VAT etc. References zx_output_classifications_v.lookup_code | |
EXEMPT_CERTIFICATE_NUMBER | VARCHAR2 | (80) | This column stores the exemption certificate number and is populated when the tax classification code = 'EXEMPT'. References ZX_EXEMPTIONS_V.EXEMPT_CERTIFICATE_NUMBER | |
EXEMPT_REASON_CODE | VARCHAR2 | (30) | This column stores the exemption reason and is populated when the tax classification code = 'EXEMPT'. References ZX_EXEMPTIONS_V.EXEMPT_REASON_CODE | |
APPROVAL_TYPE_USED | VARCHAR2 | (30) | This column stores the approval type used for the renewal of the contract. e.g. Required, Not required, Automatic etc. Valid values are 'M', 'Y', 'N', 'A'. References FND_LOOKUP_VALUES.LOOKUP_CODE where LOOKUP_TYPE='OKS_REN_ONLINE_APPROVAL' for Renewal Type = ERN. For other renewal types, this column references FND_LOOKUP_VALUES.LOOKUP_CODE where LOOKUP_TYPE='OKS_MANUAL_ONLINE_APPROVAL' | |
RENEWAL_COMMENT | VARCHAR2 | (600) | ||
CC_EMAIL_ADDRESS | VARCHAR2 | (2000) |
Cut, paste (and edit) the following text to query this object:
SELECT ID
, CHR_ID
, ACCT_RULE_ID
, PAYMENT_TYPE
, CC_NO
, CC_EXPIRY_DATE
, CC_BANK_ACCT_ID
, CC_AUTH_CODE
, COMMITMENT_ID
, GRACE_DURATION
, GRACE_PERIOD
, EST_REV_PERCENT
, EST_REV_DATE
, TAX_AMOUNT
, TAX_STATUS
, TAX_CODE
, TAX_EXEMPTION_ID
, BILLING_PROFILE_ID
, RENEWAL_STATUS
, ELECTRONIC_RENEWAL_FLAG
, QUOTE_TO_CONTACT_ID
, QUOTE_TO_SITE_ID
, QUOTE_TO_EMAIL_ID
, QUOTE_TO_PHONE_ID
, QUOTE_TO_FAX_ID
, RENEWAL_PO_REQUIRED
, RENEWAL_PO_NUMBER
, RENEWAL_PRICE_LIST
, RENEWAL_PRICING_TYPE
, RENEWAL_MARKUP_PERCENT
, RENEWAL_GRACE_DURATION
, RENEWAL_GRACE_PERIOD
, RENEWAL_EST_REV_PERCENT
, RENEWAL_EST_REV_DURATION
, RENEWAL_EST_REV_PERIOD
, RENEWAL_PRICE_LIST_USED
, RENEWAL_TYPE_USED
, RENEWAL_NOTIFICATION_TO
, RENEWAL_PO_USED
, RENEWAL_PRICING_TYPE_USED
, RENEWAL_MARKUP_PERCENT_USED
, REV_EST_PERCENT_USED
, REV_EST_DURATION_USED
, REV_EST_PERIOD_USED
, BILLING_PROFILE_USED
, ERN_FLAG_USED_YN
, EVN_THRESHOLD_AMT
, EVN_THRESHOLD_CUR
, ERN_THRESHOLD_AMT
, ERN_THRESHOLD_CUR
, RENEWAL_GRACE_DURATION_USED
, RENEWAL_GRACE_PERIOD_USED
, INV_TRX_TYPE
, INV_PRINT_PROFILE
, AR_INTERFACE_YN
, HOLD_BILLING
, SUMMARY_TRX_YN
, SERVICE_PO_NUMBER
, SERVICE_PO_REQUIRED
, BILLING_SCHEDULE_TYPE
, OBJECT_VERSION_NUMBER
, SECURITY_GROUP_ID
, REQUEST_ID
, CREATED_BY
, CREATION_DATE
, LAST_UPDATED_BY
, LAST_UPDATE_DATE
, LAST_UPDATE_LOGIN
, FOLLOW_UP_ACTION
, FOLLOW_UP_DATE
, TRXN_EXTENSION_ID
, DATE_ACCEPTED
, ACCEPTED_BY
, RMNDR_SUPPRESS_FLAG
, RMNDR_SENT_FLAG
, QUOTE_SENT_FLAG
, PROCESS_REQUEST_ID
, WF_ITEM_KEY
, PERIOD_START
, PERIOD_TYPE
, PRICE_UOM
, PERSON_PARTY_ID
, TAX_CLASSIFICATION_CODE
, EXEMPT_CERTIFICATE_NUMBER
, EXEMPT_REASON_CODE
, APPROVAL_TYPE_USED
, RENEWAL_COMMENT
, CC_EMAIL_ADDRESS
FROM OKS.OKS_K_HEADERS_B;
OKS.OKS_K_HEADERS_B does not reference any database object
OKS.OKS_K_HEADERS_B is referenced by following:
|
|
|