Results for “cn_payment_api_all”

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

The CN_PAYMENT_API_ALL table is a core transactional object within the Oracle EBS Incentive Compensation (CN) module. It holds the output of the payment process, meaning it stores the calculated incentive compensation amounts that are generated for sales representatives once a payrun completes. In the 12.1.1 and 12.2.2 releases, this table functions as the interface layer between the Incentive Compensation calculation engine and the downstream payment or payroll disbursement systems.

From a data modeling perspective, the metadata identifies this object as a link classification under Data Vault heuristics. This mapping reflects the table's role as an associative entity: its primary purpose is to record relationships between a payrun, a period, a sales representative, and payment attributes rather than acting as a standalone master or hub entity. This is consistent with its heavy foreign-key footprint, which connects it to period statuses, payruns, and salesrep records.

Key Information Stored

The table exposes 18 documented columns. The most significant include:

• PAYMENT_API_ID — the surrogate primary key, enforced by the CN_PAYMENT_API_PK constraint. This is the unique identifier for each payment output record.
• PAYRUN_ID — identifies the payrun that produced the payment, joined to CN_PAYRUNS_ALL.
• PERIOD_ID — the incentive compensation period, joined to CN_PERIOD_STATUSES_ALL.
• SALESREP_ID — the sales representative receiving payment, joined to CN_SALESREPS_API_ALL.
• AMOUNT — the calculated payment amount for the salesrep under the given payrun and period.
• PAY_DATE — the effective payment date.
• PAYMENT_TYPE — categorizes the payment (e.g., direct, draw, adjustment).
• ROLE_ID — the role associated with the payment record.
• COST_CENTER_ID — the cost center credited or charged.
• ORG_ID — operating unit/multi-org discriminator.
• FROM_CREDIT_TYPE_ID / TO_CREDIT_TYPE_ID — credit type movement references.
• SECURITY_GROUP_ID — row-level security grouping, tied to FND_SECURITY_GROUPS.

Two unique indexes define business-key candidates: CN_PAYMENT_API_U1 on (PAYMENT_API_ID, ORG_ID) and CN_PAYMENT_API_U2 on (PAYRUN_ID, SALESREP_ID, PERIOD_ID, PAYMENT_TYPE, ROLE_ID). The second index is the meaningful natural key, uniquely identifying a payment for a salesrep within a payrun/period/type/role combination. Standard WHO columns (CREATED_BY, CREATION_DATE, LAST_UPDATE_DATE, LAST_UPDATED_BY, LAST_UPDATE_LOGIN) support audit and interface processing.

Common Use Cases and Queries

Typical reporting scenarios include reconciling total payments per payrun, auditing amounts paid to a salesrep, and feeding downstream payroll integration. Common query patterns join back to the parent tables:

• Summing AMOUNT grouped by PAYRUN_ID to reconcile payrun totals against CN_PAYRUNS_ALL.
• Filtering by SALESREP_ID and PERIOD_ID to produce a salesrep payment statement.
• Isolating rows by PAYMENT_TYPE to separate draws from regular incentive payments.
• Enforcing ORG_ID and SECURITY_GROUP_ID predicates to respect operating unit and row-level security.

Because this table represents process output, it is frequently queried in reconciliation and audit reports rather than updated by end users.

Related Objects

• CN_PAYRUNS_ALL — joined on PAYRUN_ID; the payrun that generated the output.
• CN_PERIOD_STATUSES_ALL — joined on PERIOD_ID; defines the compensation period.
• CN_SALESREPS_API_ALL — joined on SALESREP_ID; the payee.
• FND_SECURITY_GROUPS — joined on SECURITY_GROUP_ID; row-level security.

These relationships make CN_PAYMENT_API_ALL a central integration point for Incentive Compensation payment reporting and downstream disbursement processes.